GCC(1)

๐Ÿ“ฆ
version 14.4.1 ยท 3 versions
, in fedora 43

๐Ÿ‘‘ GCC(1) ๐Ÿ‘‘

okay bestie, settle in ๐Ÿ’– this is the manual page for gcc, the GNU project C and C++ compiler, and it is long. grab a snack ๐Ÿ“, hydrate ๐Ÿ’ง, and let's get into it.


๐ŸŒธ NAME ๐ŸŒธ

gcc โ€” GNU project C and C++ compiler โœจ


โœจ SYNOPSIS โœจ

gcc [-c|-S|-E] [-std=standard]
    [-g] [-pg] [-Olevel]
    [-Wwarn...] [-Wpedantic]
    [-Idir...] [-Ldir...]
    [-Dmacro[=defn]...] [-Umacro]
    [-foption...] [-mmachine-option...]
    [-o outfile] [@file] infile...
okay so real talk: only the most useful options are listed up there ๐Ÿ‘† see below for the remainder. and g++ accepts mostly the same options as gcc, so no stress ๐Ÿซถ

๐Ÿ’… DESCRIPTION ๐Ÿ’…

okay so when you invoke GCC, it normally does preprocessing, compilation, assembly and linking โ€” the whole pipeline, the full main-character arc ๐Ÿ‘‘. The "overall options" let you stop this process at an intermediate stage, like hitting pause mid-glow-up. For example, the -c option says do not run the linker. Then the output consists of object files output by the assembler. iconic behavior fr fr.

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. lowkey you'll probably never touch them and that's fine ๐Ÿ’….

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. no gatekeeping here ๐ŸŒˆ.

The usual way to run GCC is to run the executable called gcc, or machine-gcc when cross-compiling, or machine-gcc-version to run a specific version of GCC. When you compile C++ programs, you should invoke GCC as g++ instead. it's giving "same energy, different name" ๐Ÿ˜Œ.

The gcc program accepts options and file names as operands. Many options have multi-letter names; therefore multiple single-letter options may not be grouped: -dv is very different from -d -v. do not merge them, I am begging ๐Ÿ™ˆ.

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 -L more than once, the directories are searched in the order specified. Also, the placement of the -l option is significant. so likeโ€ฆ vibes are flexible, but -L and -l are keeping receipts ๐Ÿงพ.

Many options have long names starting with -f or with -W---for example, -fmove-loop-invariants, -Wformat and so on. Most of these have both positive and negative forms; the negative form of -ffoo is -fno-foo. This manual documents only one of these two forms, whichever one is not the default. so if you're looking for the other one, just flip it, bestie ๐Ÿ”„.

Some options take one or more arguments typically separated either by a space or by the equals sign (=) 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 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 kB and KiB for kilobyte and kibibyte, respectively, MB and MiB for megabyte and mebibyte, GB and GiB for gigabyte and gigibyte, and so on. Such arguments are designated by 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. yes this is the unit-lore section, we love a standards moment ๐Ÿ“โœจ


๐ŸŽ€ OPTIONS ๐ŸŽ€

๐ŸŒˆ Option Summary ๐ŸŒˆ

okay so here's the whole menu โ€” a summary of all the options, grouped by type. Explanations are in the following sections, so don't panic, we're getting there ๐Ÿ’–

๐Ÿ’ซ Overall Options

-c  -S  -E  -o file -dumpbase dumpbase  -dumpbase-ext auxdropsuf
-dumpdir dumppfx  -x language -v  -###  --help[=class[,...]]
--target-help  --version -pass-exit-codes  -pipe  -specs=file
-wrapper @file  -ffile-prefix-map=old=new  -fcanon-prefix-map
-fplugin=file  -fplugin-arg-name=arg -fdump-ada-spec[-slim]
-fada-spec-parent=unit  -fdump-go-spec=file

๐Ÿ’ซ C Language Options

-ansi  -std=standard  -aux-info filename -fno-asm -fno-builtin
-fno-builtin-function  -fcond-mismatch -ffreestanding  -fgimple
-fgnu-tm  -fgnu89-inline  -fhosted -flax-vector-conversions
-fms-extensions -foffload=arg  -foffload-options=arg -fopenacc
-fopenacc-dim=geom -fopenmp  -fopenmp-simd
-fopenmp-target-simd-clone[=device-type]
-fpermitted-flt-eval-methods=standard -fplan9-extensions
-fsigned-bitfields  -funsigned-bitfields -fsigned-char
-funsigned-char  -fstrict-flex-arrays[=n] -fsso-struct=endianness

๐Ÿ’ซ C++ Language Options

-fabi-version=n  -fno-access-control -faligned-new=n
-fargs-in-order=n  -fchar8_t  -fcheck-new -fconstexpr-depth=n
-fconstexpr-cache-depth=n -fconstexpr-loop-limit=n
-fconstexpr-ops-limit=n -fno-elide-constructors
-fno-enforce-eh-specs -fno-gnu-keywords -fno-immediate-escalation
-fno-implicit-templates -fno-implicit-inline-templates
-fno-implement-inlines -fmodule-header[=kind] -fmodule-only
-fmodules-ts -fmodule-implicit-inline -fno-module-lazy
-fmodule-mapper=specification -fmodule-version-ignore
-fms-extensions -fnew-inheriting-ctors -fnew-ttp-matching
-fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names
-fno-optional-diags -fno-pretty-templates -fno-rtti
-fsized-deallocation -ftemplate-backtrace-limit=n -ftemplate-depth=n
-fno-threadsafe-statics  -fuse-cxa-atexit -fno-weak  -nostdinc++
-fvisibility-inlines-hidden -fvisibility-ms-compat
-fext-numeric-literals -flang-info-include-translate[=header]
-flang-info-include-translate-not -flang-info-module-cmi[=module]
-stdlib=libstdc++,libc++ -Wabi-tag  -Wcatch-value  -Wcatch-value=n
-Wno-class-conversion  -Wclass-memaccess -Wcomma-subscript
-Wconditionally-supported -Wno-conversion-null
-Wctad-maybe-unsupported -Wctor-dtor-privacy  -Wdangling-reference
-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 -Weffc++
-Wno-elaborated-enum-base -Wno-exceptions -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-literal-suffix -Wmismatched-new-delete -Wmismatched-tags
-Wmultiple-inheritance  -Wnamespaces  -Wnarrowing -Wnoexcept
-Wnoexcept-type  -Wnon-virtual-dtor -Wpessimizing-move
-Wno-placement-new  -Wplacement-new=n -Wrange-loop-construct
-Wredundant-move -Wredundant-tags -Wreorder  -Wregister
-Wstrict-null-sentinel  -Wno-subobject-linkage  -Wtemplates
-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-id-cdtor -Wno-terminate  -Wno-vexing-parse
-Wvirtual-inheritance -Wno-virtual-move-assign  -Wvolatile
-Wzero-as-null-pointer-constant

๐Ÿ’ซ Objective-C and Objective-C++ Language Options

-fconstant-string-class=class-name -fgnu-runtime  -fnext-runtime
-fno-nil-receivers -fobjc-abi-version=n -fobjc-call-cxx-cdtors
-fobjc-direct-dispatch -fobjc-exceptions -fobjc-gc -fobjc-nilcheck
-fobjc-std=objc1 -fno-local-ivars
-fivar-visibility=[public|protected|private|package]
-freplace-objc-classes -fzero-link -gen-decls -Wassign-intercept
-Wno-property-assign-default -Wno-protocol -Wobjc-root-class
-Wselector -Wstrict-selector-match -Wundeclared-selector

๐Ÿ’ซ Diagnostic Message Formatting Options

-fmessage-length=n -fdiagnostics-plain-output
-fdiagnostics-show-location=[once|every-line]
-fdiagnostics-color=[auto|never|always]
-fdiagnostics-urls=[auto|never|always]
-fdiagnostics-format=[text|sarif-stderr|sarif-file|json|json-stderr|json-file]
-fno-diagnostics-json-formatting -fno-diagnostics-show-option
-fno-diagnostics-show-caret -fno-diagnostics-show-labels
-fno-diagnostics-show-line-numbers -fno-diagnostics-show-cwe
-fno-diagnostics-show-rule -fdiagnostics-minimum-margin-width=width
-fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch
-fdiagnostics-show-template-tree  -fno-elide-type
-fdiagnostics-path-format=[none|separate-events|inline-events]
-fdiagnostics-show-path-depths -fno-show-column
-fdiagnostics-column-unit=[display|byte]
-fdiagnostics-column-origin=origin
-fdiagnostics-escape-format=[unicode|bytes]
-fdiagnostics-text-art-charset=[none|ascii|unicode|emoji]

๐Ÿฆ‹ and that's just the summary bestie โ€” the explanations are coming in the following sections, so stay tuned ๐Ÿ’œ

โœจ Warning Options โœจ

bestie. sit down. hydrate. because this is the main character list of the whole manpage and it is long. these are all the flags that make gcc ๐Ÿ‘€ look at your code and go "girlโ€ฆ" โ€” every single one of them, no skips, no shortcuts, we are doing this properly ๐Ÿ’…

here's the full lineup:

  • -fsyntax-only
  • -fmax-errors=n
  • -Wpedantic
  • -pedantic-errors
  • -fpermissive
  • -w
  • -Wextra
  • -Wall
  • -Wabi=n
  • -Waddress
  • -Wno-address-of-packed-member
  • -Waggregate-return
  • -Walloc-size
  • -Walloc-size-larger-than=byte-size
  • -Walloc-zero
  • -Walloca
  • -Walloca-larger-than=byte-size
  • -Wno-aggressive-loop-optimizations
  • -Warith-conversion
  • -Warray-bounds
  • -Warray-bounds=n
  • -Warray-compare
  • -Warray-parameter
  • -Warray-parameter=n
  • -Wno-attributes
  • -Wattribute-alias=n
  • -Wno-attribute-alias
  • -Wno-attribute-warning
  • -Wbidi-chars=[none|unpaired|any|ucn]
  • -Wbool-compare
  • -Wbool-operation
  • -Wno-builtin-declaration-mismatch
  • -Wno-builtin-macro-redefined
  • -Wc90-c99-compat
  • -Wc99-c11-compat
  • -Wc11-c23-compat
  • -Wc++-compat
  • -Wc++11-compat
  • -Wc++14-compat
  • -Wc++17-compat
  • -Wc++20-compat
  • -Wno-c++11-extensions
  • -Wno-c++14-extensions
  • -Wno-c++17-extensions
  • -Wno-c++20-extensions
  • -Wno-c++23-extensions
  • -Wcalloc-transposed-args
  • -Wcast-align
  • -Wcast-align=strict
  • -Wcast-function-type
  • -Wcast-qual
  • -Wchar-subscripts
  • -Wclobbered
  • -Wcomment
  • -Wcompare-distinct-pointer-types
  • -Wno-complain-wrong-lang
  • -Wconversion
  • -Wno-coverage-mismatch
  • -Wno-cpp
  • -Wdangling-else
  • -Wdangling-pointer
  • -Wdangling-pointer=n
  • -Wdate-time
  • -Wno-deprecated
  • -Wno-deprecated-declarations
  • -Wno-designated-init
  • -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-extra-args
  • -Wformat-nonliteral
  • -Wformat-overflow=n
  • -Wformat-security
  • -Wformat-signedness
  • -Wformat-truncation=n
  • -Wformat-y2k
  • -Wframe-address
  • -Wframe-larger-than=byte-size
  • -Wno-free-nonheap-object
  • -Wno-if-not-aligned
  • -Wno-ignored-attributes
  • -Wignored-qualifiers
  • -Wno-incompatible-pointer-types
  • -Whardened
  • -Wimplicit
  • -Wimplicit-fallthrough
  • -Wimplicit-fallthrough=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
  • -Wlarger-than=byte-size
  • -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
  • -Wno-missing-profile
  • -Wno-multichar
  • -Wmultistatement-macros
  • -Wnonnull
  • -Wnonnull-compare
  • -Wnormalized=[none|id|nfc|nfkc]
  • -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-prio-ctor-dtor
  • -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=n
  • -Wsign-compare
  • -Wsign-conversion
  • -Wno-sizeof-array-argument
  • -Wsizeof-array-div
  • -Wsizeof-pointer-div
  • -Wsizeof-pointer-memaccess
  • -Wstack-protector
  • -Wstack-usage=byte-size
  • -Wstrict-aliasing
  • -Wstrict-aliasing=n
  • -Wstrict-overflow
  • -Wstrict-overflow=n
  • -Wstring-compare
  • -Wno-stringop-overflow
  • -Wno-stringop-overread
  • -Wno-stringop-truncation
  • -Wstrict-flex-arrays
  • -Wsuggest-attribute=[pure|const|noreturn|format|malloc]
  • -Wswitch
  • -Wno-switch-bool
  • -Wswitch-default
  • -Wswitch-enum
  • -Wno-switch-outside-range
  • -Wno-switch-unreachable
  • -Wsync-nand
  • -Wsystem-headers
  • -Wtautological-compare
  • -Wtrampolines
  • -Wtrigraphs
  • -Wtrivial-auto-var-init
  • -Wno-tsan
  • -Wtype-limits
  • -Wundef
  • -Wuninitialized
  • -Wunknown-pragmas
  • -Wunsuffixed-float-constants
  • -Wunused
  • -Wunused-but-set-parameter
  • -Wunused-but-set-variable
  • -Wunused-const-variable
  • -Wunused-const-variable=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=n
  • -Wuseless-cast
  • -Wno-varargs
  • -Wvariadic-macros
  • -Wvector-operation-performance
  • -Wvla
  • -Wvla-larger-than=byte-size
  • -Wno-vla-larger-than
  • -Wvolatile-register-var
  • -Wwrite-strings
  • -Wno-xor-used-as-pow
  • -Wzero-length-bounds

๐Ÿ”ฌ Static Analyzer Options ๐Ÿ”ฌ

okay so this next group is the detective squad ๐Ÿ•ต๏ธโ™€๏ธ โ€” the -fanalyzer family and all its little siblings. they go digging through your code for the drama, and there's a whole bunch of -Wno-analyzer-* flags for when you're like "no bestie, I know, I know, let it go ๐Ÿ™ˆ". every one of them, coming right up:

  • -fanalyzer
  • -fanalyzer-call-summaries
  • -fanalyzer-checker=name
  • -fno-analyzer-feasibility
  • -fanalyzer-fine-grained
  • -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=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-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
  • -Wanalyzer-symbol-too-complex
  • -Wanalyzer-too-complex
  • -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

๐ŸŽ C and Objective-C-only Warning Options ๐ŸŽ

these ones are exclusive โ€” C and Objective-C only, no C++ invited to this party ๐ŸŽ€. if you're a C girlie these are your besties:

  • -Wbad-function-cast
  • -Wmissing-declarations
  • -Wmissing-parameter-type
  • -Wdeclaration-missing-parameter-type
  • -Wmissing-prototypes
  • -Wmissing-variable-declarations
  • -Wnested-externs
  • -Wold-style-declaration
  • -Wold-style-definition
  • -Wstrict-prototypes
  • -Wtraditional
  • -Wtraditional-conversion
  • -Wdeclaration-after-statement
  • -Wpointer-sign

๐Ÿ› Debugging Options ๐Ÿ›

last group for this part, bestie โ€” the debug era โœจ. this is where you tell gcc to bake all that juicy debug info into your binary so your debugger can actually see what's going on, and it's giving very much "let me tell you everything" energy. all of them, in order:

  • -g
  • -glevel
  • -gdwarf
  • -gdwarf-version
  • -gbtf
  • -gctf
  • -gctflevel
  • -ggdb
  • -grecord-gcc-switches
  • -gno-record-gcc-switches
  • -gstrict-dwarf
  • -gno-strict-dwarf
  • -gas-loc-support
  • -gno-as-loc-support
  • -gas-locview-support
  • -gno-as-locview-support
  • -gcodeview
  • -gcolumn-info
  • -gno-column-info
  • -gdwarf32
  • -gdwarf64
  • -gstatement-frontiers
  • -gno-statement-frontiers
  • -gvariable-location-views
  • -gno-variable-location-views
  • -ginternal-reset-location-views
  • -gno-internal-reset-location-views
  • -ginline-points
  • -gno-inline-points
  • -gvms
  • -gz[=type]
  • -gsplit-dwarf
  • -gdescribe-dies
  • -gno-describe-dies
  • -fdebug-prefix-map=old=new
  • -fdebug-types-section
  • -fno-eliminate-unused-debug-types
  • -femit-struct-debug-baseonly
  • -femit-struct-debug-reduced
  • -femit-struct-debug-detailed[=spec-list]
  • -fno-eliminate-unused-debug-symbols
  • -femit-class-debug-always
  • -fno-merge-debug-strings
  • -fno-dwarf2-cfi-asm
  • -fvar-tracking
  • -fvar-tracking-assignments

โœจ Optimization Options โœจ

okay bestie, deep breath ๐Ÿซถ this is the big one โ€” every single knob GCC has for making your code faster, smaller, or frankly just weirder. No descriptions on this roster, just the whole squad lined up. Let's read 'em out. ๐Ÿ’…

  • -faggressive-loop-optimizations
  • -falign-functions[=n[:m:[n2[:m2]]]]
  • -falign-jumps[=n[:m:[n2[:m2]]]]
  • -falign-labels[=n[:m:[n2[:m2]]]]
  • -falign-loops[=n[:m:[n2[:m2]]]]
  • -fmin-function-alignment=[n]
  • -fno-allocation-dce
  • -fallow-store-data-races
  • -fassociative-math
  • -fauto-profile
  • -fauto-profile[=path]
  • -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
  • -fdata-sections
  • -fdce
  • -fdelayed-branch
  • -fdelete-null-pointer-checks
  • -fdevirtualize
  • -fdevirtualize-speculatively
  • -fdevirtualize-at-ltrans
  • -fdse
  • -fearly-inlining
  • -fipa-sra
  • -fexpensive-optimizations
  • -ffat-lto-objects
  • -ffast-math
  • -ffinite-math-only
  • -ffloat-store
  • -fexcess-precision=style
  • -ffinite-loops
  • -fforward-propagate
  • -ffp-contract=style
  • -ffunction-sections
  • -fgcse
  • -fgcse-after-reload
  • -fgcse-las
  • -fgcse-lm
  • -fgraphite-identity
  • -fgcse-sm
  • -fhoist-adjacent-loads
  • -fif-conversion
  • -fif-conversion2
  • -findirect-inlining
  • -finline-stringops[=fn]
  • -finline-functions
  • -finline-functions-called-once
  • -finline-limit=n
  • -finline-small-functions
  • -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-stack-alignment
  • -fipa-icf
  • -fira-algorithm=algorithm
  • -flive-patching=level
  • -fira-region=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
  • -flto-partition=alg
  • -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-fp-int-builtin-inexact
  • -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-sibling-calls
  • -fpartial-inlining
  • -fpeel-loops
  • -fpredictive-commoning
  • -fprefetch-loop-arrays
  • -fprofile-correction
  • -fprofile-use
  • -fprofile-use=path
  • -fprofile-partial-training
  • -fprofile-values
  • -fprofile-reorder-functions
  • -freciprocal-math
  • -free
  • -frename-registers
  • -freorder-blocks
  • -freorder-blocks-algorithm=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[=n]
  • -fsched-stalled-insns[=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
  • -fsplit-paths
  • -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-dce
  • -ftree-dominator-opts
  • -ftree-dse
  • -ftree-forwprop
  • -ftree-fre
  • -fcode-hoisting
  • -ftree-loop-if-convert
  • -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=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
  • --param name=value
  • -O
  • -O0
  • -O1
  • -O2
  • -O3
  • -Os
  • -Ofast
  • -Og
  • -Oz

and that's the whole optimization roster, no cap ๐Ÿ˜ญ๐Ÿ’– it's giving infinite scroll fr fr.


๐Ÿ’– Program Instrumentation Options ๐Ÿ’–

okay so this cluster is all about watching what your program actually does โ€” profiling, coverage, sanitizers, hardening, stack stuff. Very "main character who reads her own logs" energy. โœจ

  • -p
  • -pg
  • -fprofile-arcs
  • --coverage
  • -ftest-coverage
  • -fcondition-coverage
  • -fprofile-abs-path
  • -fprofile-dir=path
  • -fprofile-generate
  • -fprofile-generate=path
  • -fprofile-info-section
  • -fprofile-info-section=name
  • -fprofile-note=path
  • -fprofile-prefix-path=path
  • -fprofile-update=method
  • -fprofile-filter-files=regex
  • -fprofile-exclude-files=regex
  • -fprofile-reproducible=[multithreaded|parallel-runs|serial]
  • -fsanitize=style
  • -fsanitize-recover
  • -fsanitize-recover=style
  • -fsanitize-trap
  • -fsanitize-trap=style
  • -fasan-shadow-offset=number
  • -fsanitize-sections=s1,s2,...
  • -fsanitize-undefined-trap-on-error
  • -fbounds-check
  • -fcf-protection=[full|branch|return|none|check]
  • -fharden-compares
  • -fharden-conditional-branches
  • -fhardened
  • -fharden-control-flow-redundancy
  • -fhardcfr-skip-leaf
  • -fhardcfr-check-exceptions
  • -fhardcfr-check-returning-calls
  • -fhardcfr-check-noreturn-calls=[always|no-xthrow|nothrow|never]
  • -fstack-protector
  • -fstack-protector-all
  • -fstack-protector-strong
  • -fstack-protector-explicit
  • -fstack-check
  • -fstack-limit-register=reg
  • -fstack-limit-symbol=sym
  • -fno-stack-limit
  • -fsplit-stack
  • -fstrub=disable
  • -fstrub=strict
  • -fstrub=relaxed
  • -fstrub=all
  • -fstrub=at-calls
  • -fstrub=internal
  • -fvtable-verify=[std|preinit|none]
  • -fvtv-counts
  • -fvtv-debug
  • -finstrument-functions
  • -finstrument-functions-once
  • -finstrument-functions-exclude-function-list=sym,sym,...
  • -finstrument-functions-exclude-file-list=file,file,...
  • -fprofile-prefix-map=old=new
  • -fpatchable-function-entry=N[,M]

๐Ÿฆ‹ Preprocessor Options ๐Ÿฆ‹

the preprocessor era ๐Ÿ’… all the #define-adjacent behavior, macro tracing, and the flags that decide which flavor of C your headers live in. it's giving "I read the include guards for fun".

  • -Aquestion=answer
  • -A-question[=answer]
  • -C
  • -CC
  • -Dmacro[=defn]
  • -dD
  • -dI
  • -dM
  • -dN
  • -dU
  • -fdebug-cpp
  • -fdirectives-only
  • -fdollars-in-identifiers
  • -fexec-charset=charset
  • -fextended-identifiers
  • -finput-charset=charset
  • -flarge-source-files
  • -fmacro-prefix-map=old=new
  • -fmax-include-depth=depth
  • -fno-canonical-system-headers
  • -fpch-deps
  • -fpch-preprocess
  • -fpreprocessed
  • -ftabstop=width
  • -ftrack-macro-expansion
  • -fwide-exec-charset=charset
  • -fworking-directory
  • -H
  • -imacros file
  • -include file
  • -M
  • -MD
  • -MF
  • -MG
  • -MM
  • -MMD
  • -MP
  • -MQ
  • -MT
  • -Mno-modules
  • -no-integrated-cpp
  • -P
  • -pthread
  • -remap
  • -traditional
  • -traditional-cpp
  • -trigraphs
  • -Umacro
  • -undef
  • -Wp,option
  • -Xpreprocessor option

๐ŸŽ€ Assembler Options ๐ŸŽ€

short and sweet, two of them, icons only. ๐Ÿ‘‘

  • -Wa,option
  • -Xassembler option

๐ŸŒˆ Linker Options ๐ŸŒˆ

the linking era โ€” where all your little .o girlies finally meet and become one executable. plus a whole lotta static/shared drama. ๐Ÿ’…

  • object-file-name
  • -fuse-ld=linker
  • -llibrary
  • -nostartfiles
  • -nodefaultlibs
  • -nolibc
  • -nostdlib
  • -nostdlib++
  • -e entry
  • --entry=entry
  • -pie
  • -pthread
  • -r
  • -rdynamic
  • -s
  • -static
  • -static-pie
  • -static-libgcc
  • -static-libstdc++
  • -static-libasan
  • -static-libtsan
  • -static-liblsan
  • -static-libubsan
  • -shared
  • -shared-libgcc
  • -symbolic
  • -T script
  • -Wl,option
  • -Xlinker option
  • -u symbol
  • -z keyword

๐Ÿงš Directory Options ๐Ÿงš

where does GCC look for your headers and libs, bestie? this is the whole search-path mood board. ๐Ÿ—บ๏ธ

  • -Bprefix
  • -Idir
  • -I-
  • -idirafter dir
  • -imacros file
  • -imultilib dir
  • -iplugindir=dir
  • -iprefix file
  • -iquote dir
  • -isysroot dir
  • -isystem dir
  • -iwithprefix dir
  • -iwithprefixbefore dir
  • -Ldir
  • -no-canonical-prefixes
  • --no-sysroot-suffix
  • -nostdinc
  • -nostdinc++
  • --sysroot=dir

๐ŸŒธ Code Generation Options ๐ŸŒธ

the "how exactly do I want the machine code to look" section ๐Ÿ’œ registers, structs, PIC/PIE, visibility, all of it.

  • -fcall-saved-reg
  • -fcall-used-reg
  • -ffixed-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[=n]
  • -fleading-underscore
  • -ftls-model=model
  • -fstack-reuse=reuse_level
  • -ftrampolines
  • -ftrampoline-impl=[stack|heap]
  • -ftrapv
  • -fwrapv
  • -fvisibility=[default|internal|hidden|protected]
  • -fstrict-volatile-bitfields
  • -fsync-libcalls

๐Ÿ’œ Developer Options ๐Ÿ’œ

and finally, the deep lore โ€” the debug, dump, report and "I am literally a GCC developer" flags. if you're here, you're not like the other girls, you're compiling GCC itself. ๐Ÿ˜ญ๐Ÿ‘‘

  • -dletters
  • -dumpspecs
  • -dumpmachine
  • -dumpversion
  • -dumpfullversion
  • -fcallgraph-info[=su,da]
  • -fchecking
  • -fchecking=n
  • -fdbg-cnt-list
  • -fdbg-cnt=counter-value-list
  • -fdisable-ipa-pass_name
  • -fdisable-rtl-pass_name
  • -fdisable-rtl-pass-name=range-list
  • -fdisable-tree-pass_name
  • -fdisable-tree-pass-name=range-list
  • -fdump-debug
  • -fdump-earlydebug
  • -fdump-noaddr
  • -fdump-unnumbered
  • -fdump-unnumbered-links
  • -fdump-final-insns[=file]
  • -fdump-ipa-all
  • -fdump-ipa-cgraph
  • -fdump-ipa-inline
  • -fdump-lang-all
  • -fdump-lang-switch
  • -fdump-lang-switch-options
  • -fdump-lang-switch-options=filename
  • -fdump-passes
  • -fdump-rtl-pass
  • -fdump-rtl-pass=filename
  • -fdump-statistics
  • -fdump-tree-all
  • -fdump-tree-switch
  • -fdump-tree-switch-options
  • -fdump-tree-switch-options=filename
  • -fcompare-debug[=opts]
  • -fcompare-debug-second
  • -fenable-kind-pass
  • -fenable-kind-pass=range-list
  • -fira-verbose=n
  • -flto-report
  • -flto-report-wpa
  • -fmem-report-wpa
  • -fmem-report
  • -fpre-ipa-mem-report
  • -fpost-ipa-mem-report
  • -fopt-info
  • -fopt-info-options[=file]
  • -fmultiflags
  • -fprofile-report
  • -frandom-seed=string
  • -fsched-verbose=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-file-name=library
  • -print-libgcc-file-name
  • -print-multi-directory
  • -print-multi-lib
  • -print-multi-os-directory
  • -print-prog-name=program
  • -print-search-dirs
  • -Q
  • -print-sysroot
  • -print-sysroot-headers-suffix
  • -save-temps
  • -save-temps=cwd
  • -save-temps=obj
  • -time[=file]

๐ŸŒˆ Machine-Dependent Options ๐ŸŒˆ

okay bestie, buckle UP, because this is the part where every chip family on earth gets its own lil menu of flags. no cap, this is the most "we contain multitudes" section of the whole page. one bullet per option, exactly like the source, because we do not skip. ๐Ÿ’…


๐Ÿงš AArch64 Options

  • -mabi=name
  • -mbig-endian
  • -mlittle-endian
  • -mgeneral-regs-only
  • -mcmodel=tiny
  • -mcmodel=small
  • -mcmodel=large
  • -mstrict-align
  • -mno-strict-align
  • -momit-leaf-frame-pointer
  • -mtls-dialect=desc
  • -mtls-dialect=traditional
  • -mtls-size=size
  • -mfix-cortex-a53-835769
  • -mfix-cortex-a53-843419
  • -mlow-precision-recip-sqrt
  • -mlow-precision-sqrt
  • -mlow-precision-div
  • -mpc-relative-literal-loads
  • -msign-return-address=scope
  • -mbranch-protection=none|standard|pac-ret[+leaf +b-key]|bti
  • -mharden-sls=opts
  • -march=name
  • -mcpu=name
  • -mtune=name
  • -moverride=string
  • -mverbose-cost-dump
  • -mstack-protector-guard=guard
  • -mstack-protector-guard-reg=sysreg
  • -mstack-protector-guard-offset=offset
  • -mtrack-speculation
  • -moutline-atomics
  • -mearly-ldp-fusion
  • -mlate-ldp-fusion

๐ŸŒธ Adapteva Epiphany Options

  • -mhalf-reg-file
  • -mprefer-short-insn-regs
  • -mbranch-cost=num
  • -mcmove
  • -mnops=num
  • -msoft-cmpsf
  • -msplit-lohi
  • -mpost-inc
  • -mpost-modify
  • -mstack-offset=num
  • -mround-nearest
  • -mlong-calls
  • -mshort-calls
  • -msmall16
  • -mfp-mode=mode
  • -mvect-double
  • -max-vect-align=num
  • -msplit-vecmove-early
  • -m1reg-reg

๐Ÿฆ‹ AMD GCN Options

  • -march=gpu
  • -mtune=gpu
  • -mstack-size=bytes

โœจ ARC Options

  • -mbarrel-shifter
  • -mjli-always
  • -mcpu=cpu
  • -mA6
  • -mARC600
  • -mA7
  • -mARC700
  • -mdpfp
  • -mdpfp-compact
  • -mdpfp-fast
  • -mno-dpfp-lrsr
  • -mea
  • -mno-mpy
  • -mmul32x16
  • -mmul64
  • -matomic
  • -mnorm
  • -mspfp
  • -mspfp-compact
  • -mspfp-fast
  • -msimd
  • -msoft-float
  • -mswap
  • -mcrc
  • -mdsp-packa
  • -mdvbf
  • -mlock
  • -mmac-d16
  • -mmac-24
  • -mrtsc
  • -mswape
  • -mtelephony
  • -mxy
  • -misize
  • -mannotate-align
  • -marclinux
  • -marclinux_prof
  • -mlong-calls
  • -mmedium-calls
  • -msdata
  • -mirq-ctrl-saved
  • -mrgf-banked-regs
  • -mlpc-width=width
  • -G num
  • -mvolatile-cache
  • -mtp-regno=regno
  • -malign-call
  • -mauto-modify-reg
  • -mbbit-peephole
  • -mno-brcc
  • -mcase-vector-pcrel
  • -mcompact-casesi
  • -mno-cond-exec
  • -mearly-cbranchsi
  • -mexpand-adddi
  • -mindexed-loads
  • -mlra
  • -mlra-priority-none
  • -mlra-priority-compact
  • -mlra-priority-noncompact
  • -mmillicode
  • -mmixed-code
  • -mq-class
  • -mRcq
  • -mRcw
  • -msize-level=level
  • -mtune=cpu
  • -mmultcost=num
  • -mcode-density-frame
  • -munalign-prob-threshold=probability
  • -mmpy-option=multo
  • -mdiv-rem
  • -mcode-density
  • -mll64
  • -mfpu=fpu
  • -mrf16
  • -mbranch-index

๐Ÿ’– ARM Options

  • -mapcs-frame
  • -mno-apcs-frame
  • -mabi=name
  • -mapcs-stack-check
  • -mno-apcs-stack-check
  • -mapcs-reentrant
  • -mno-apcs-reentrant
  • -mgeneral-regs-only
  • -msched-prolog
  • -mno-sched-prolog
  • -mlittle-endian
  • -mbig-endian
  • -mbe8
  • -mbe32
  • -mfloat-abi=name
  • -mfp16-format=name
  • -mthumb-interwork
  • -mno-thumb-interwork
  • -mcpu=name
  • -march=name
  • -mfpu=name
  • -mtune=name
  • -mprint-tune-info
  • -mstructure-size-boundary=n
  • -mabort-on-noreturn
  • -mlong-calls
  • -mno-long-calls
  • -msingle-pic-base
  • -mno-single-pic-base
  • -mpic-register=reg
  • -mnop-fun-dllimport
  • -mpoke-function-name
  • -mthumb
  • -marm
  • -mflip-thumb
  • -mtpcs-frame
  • -mtpcs-leaf-frame
  • -mcaller-super-interworking
  • -mcallee-super-interworking
  • -mtp=name
  • -mtls-dialect=dialect
  • -mword-relocations
  • -mfix-cortex-m3-ldrd
  • -mfix-cortex-a57-aes-1742098
  • -mfix-cortex-a72-aes-1655431
  • -munaligned-access
  • -mneon-for-64bits
  • -mslow-flash-data
  • -masm-syntax-unified
  • -mrestrict-it
  • -mverbose-cost-dump
  • -mpure-code
  • -mcmse
  • -mfix-cmse-cve-2021-35465
  • -mstack-protector-guard=guard
  • -mstack-protector-guard-offset=offset
  • -mfdpic
  • -mbranch-protection=none|standard|pac-ret[+leaf][+bti]|bti[+pac-ret[+leaf]]

๐ŸŽ€ AVR Options

  • -mmcu=mcu
  • -mabsdata
  • -maccumulate-args
  • -mbranch-cost=cost
  • -mfuse-add=level
  • -mcall-prologues
  • -mgas-isr-prologues
  • -mint8
  • -mflmap
  • -mdouble=bits
  • -mlong-double=bits
  • -mn_flash=size
  • -mno-interrupts
  • -mmain-is-OS_task
  • -mrelax
  • -mrmw
  • -mstrict-X
  • -mtiny-stack
  • -mrodata-in-ram
  • -mfract-convert-truncate
  • -mshort-calls
  • -mskip-bug
  • -nodevicelib
  • -nodevicespecs
  • -Waddr-space-convert
  • -Wmisspelled-isr

๐Ÿ’œ Blackfin Options

  • -mcpu=cpu[-sirevision]
  • -msim
  • -momit-leaf-frame-pointer
  • -mno-omit-leaf-frame-pointer
  • -mspecld-anomaly
  • -mno-specld-anomaly
  • -mcsync-anomaly
  • -mno-csync-anomaly
  • -mlow-64k
  • -mno-low64k
  • -mstack-check-l1
  • -mid-shared-library
  • -mno-id-shared-library
  • -mshared-library-id=n
  • -mleaf-id-shared-library
  • -mno-leaf-id-shared-library
  • -msep-data
  • -mno-sep-data
  • -mlong-calls
  • -mno-long-calls
  • -mfast-fp
  • -minline-plt
  • -mmulticore
  • -mcorea
  • -mcoreb
  • -msdram
  • -micplb

โญ C6X Options

  • -mbig-endian
  • -mlittle-endian
  • -march=cpu
  • -msim
  • -msdata=sdata-type

๐Ÿ“ CRIS Options

  • -mcpu=cpu
  • -march=cpu
  • -mtune=cpu
  • -mmax-stack-frame=n
  • -metrax4
  • -metrax100
  • -mpdebug
  • -mcc-init
  • -mno-side-effects
  • -mstack-align
  • -mdata-align
  • -mconst-align
  • -m32-bit
  • -m16-bit
  • -m8-bit
  • -mno-prologue-epilogue
  • -melf
  • -maout
  • -sim
  • -sim2
  • -mmul-bug-workaround
  • -mno-mul-bug-workaround

๐Ÿซถ C-SKY Options

  • -march=arch
  • -mcpu=cpu
  • -mbig-endian
  • -EB
  • -mlittle-endian
  • -EL
  • -mhard-float
  • -msoft-float
  • -mfpu=fpu
  • -mdouble-float
  • -mfdivdu
  • -mfloat-abi=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=n
  • -mcse-cc
  • -msched-prolog
  • -msim

๐ŸŽ Darwin Options

  • -all_load
  • -allowable_client
  • -arch
  • -arch_errors_fatal
  • -arch_only
  • -bind_at_load
  • -bundle
  • -bundle_loader
  • -client_name
  • -compatibility_version
  • -current_version
  • -dead_strip
  • -dependency-file
  • -dylib_file
  • -dylinker_install_name
  • -dynamic
  • -dynamiclib
  • -exported_symbols_list
  • -filelist
  • -flat_namespace
  • -force_cpusubtype_ALL
  • -force_flat_namespace
  • -headerpad_max_install_names
  • -iframework
  • -image_base
  • -init
  • -install_name
  • -keep_private_externs
  • -multi_module
  • -multiply_defined
  • -multiply_defined_unused
  • -noall_load
  • -no_dead_strip_inits_and_terms
  • -nodefaultrpaths
  • -nofixprebinding
  • -nomultidefs
  • -noprebind
  • -noseglinkedit
  • -pagezero_size
  • -prebind
  • -prebind_all_twolevel_modules
  • -private_bundle
  • -read_only_relocs
  • -sectalign
  • -sectobjectsymbols
  • -whyload
  • -seg1addr
  • -sectcreate
  • -sectobjectsymbols
  • -sectorder
  • -segaddr
  • -segs_read_only_addr
  • -segs_read_write_addr
  • -seg_addr_table
  • -seg_addr_table_filename
  • -seglinkedit
  • -segprot
  • -segs_read_only_addr
  • -segs_read_write_addr
  • -single_module
  • -static
  • -sub_library
  • -sub_umbrella
  • -twolevel_namespace
  • -umbrella
  • -undefined
  • -unexported_symbols_list
  • -weak_reference_mismatches
  • -whatsloaded
  • -F
  • -gused
  • -gfull
  • -mmacosx-version-min=version
  • -mkernel
  • -mone-byte-bool
bestie i need you to know that -sectobjectsymbols, -segs_read_only_addr and -segs_read_write_addr each show up twice in the source list. i'm not making the rules, i'm just the messenger ๐Ÿ’€ keeping every single one, in order, like a good girl.

๐Ÿ”ฅ DEC Alpha Options

  • -mno-fp-regs
  • -msoft-float
  • -mieee
  • -mieee-with-inexact
  • -mieee-conformant
  • -mfp-trap-mode=mode
  • -mfp-rounding-mode=mode
  • -mtrap-precision=mode
  • -mbuild-constants
  • -mcpu=cpu-type
  • -mtune=cpu-type
  • -mbwx
  • -mmax
  • -mfix
  • -mcix
  • -mfloat-vax
  • -mfloat-ieee
  • -mexplicit-relocs
  • -msmall-data
  • -mlarge-data
  • -msmall-text
  • -mlarge-text
  • -mmemory-latency=time

๐Ÿ eBPF Options

  • -mbig-endian
  • -mlittle-endian
  • -mframe-limit=bytes
  • -mxbpf
  • -mco-re
  • -mno-co-re
  • -mjmpext
  • -mjmp32
  • -malu32
  • -mv3-atomics
  • -mbswap
  • -msdiv
  • -msmov
  • -mcpu=version
  • -masm=dialect
  • -minline-memops-threshold=bytes

๐Ÿ’ซ FR30 Options

  • -msmall-model
  • -mno-lsim

๐ŸŒŸ FT32 Options

  • -msim
  • -mlra
  • -mnodiv
  • -mft32b
  • -mcompress
  • -mnopm

๐ŸŒˆ FRV Options

  • -mgpr-32
  • -mgpr-64
  • -mfpr-32
  • -mfpr-64
  • -mhard-float
  • -msoft-float
  • -malloc-cc
  • -mfixed-cc
  • -mdword
  • -mno-dword
  • -mdouble
  • -mno-double
  • -mmedia
  • -mno-media
  • -mmuladd
  • -mno-muladd
  • -mfdpic
  • -minline-plt
  • -mgprel-ro
  • -multilib-library-pic
  • -mlinked-fp
  • -mlong-calls
  • -malign-labels
  • -mlibrary-pic
  • -macc-4
  • -macc-8
  • -mpack
  • -mno-pack
  • -mno-eflags
  • -mcond-move
  • -mno-cond-move
  • -moptimize-membar
  • -mno-optimize-membar
  • -mscc
  • -mno-scc
  • -mcond-exec
  • -mno-cond-exec
  • -mvliw-branch
  • -mno-vliw-branch
  • -mmulti-cond-exec
  • -mno-multi-cond-exec
  • -mnested-cond-exec
  • -mno-nested-cond-exec
  • -mtomcat-stats
  • -mTLS
  • -mtls
  • -mcpu=cpu

๐Ÿง GNU/Linux Options

  • -mglibc
  • -muclibc
  • -mmusl
  • -mbionic
  • -mandroid
  • -tno-android-cc
  • -tno-android-ld

๐ŸŒธ H8/300 Options

  • -mrelax
  • -mh
  • -ms
  • -mn
  • -mexr
  • -mno-exr
  • -mint32
  • -malign-300

๐Ÿ‘‘ HPPA Options

  • -march=architecture-type
  • -matomic-libcalls
  • -mbig-switch
  • -mcaller-copies
  • -mdisable-fpregs
  • -mdisable-indexing
  • -mordered
  • -mfast-indirect-calls
  • -mgas
  • -mgnu-ld
  • -mhp-ld
  • -mfixed-range=register-range
  • -mcoherent-ldcw
  • -mjump-in-delay
  • -mlinker-opt
  • -mlong-calls
  • -mlong-load-store
  • -mno-atomic-libcalls
  • -mno-disable-fpregs
  • -mno-disable-indexing
  • -mno-fast-indirect-calls
  • -mno-gas
  • -mno-jump-in-delay
  • -mno-long-load-store
  • -mno-portable-runtime
  • -mno-soft-float
  • -mno-space-regs
  • -msoft-float
  • -mpa-risc-1-0
  • -mpa-risc-1-1
  • -mpa-risc-2-0
  • -mportable-runtime
  • -mschedule=cpu-type
  • -mspace-regs
  • -msoft-mult
  • -msio
  • -mwsio
  • -munix=unix-std
  • -nolibdld
  • -static
  • -threads

๐Ÿงš IA-64 Options

  • -mbig-endian
  • -mlittle-endian
  • -mgnu-as
  • -mgnu-ld
  • -mno-pic
  • -mvolatile-asm-stop
  • -mregister-names
  • -msdata
  • -mno-sdata
  • -mconstant-gp
  • -mauto-pic
  • -mfused-madd
  • -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=register-range
  • -mtls-size=tls-size
  • -mtune=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-prefer-non-data-spec-insns
  • -msched-prefer-non-control-spec-insns
  • -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=max-insns

๐Ÿฆ„ LM32 Options

  • -mbarrel-shift-enabled
  • -mdivide-enabled
  • -mmultiply-enabled
  • -msign-extend-enabled
  • -muser-enabled

๐Ÿฆ‹ LoongArch Options ๐Ÿฆ‹

okay bestie, LoongArch time โ€” it's giving very-now architecture energy, and here's every knob it's got:

  • -march=arch-type
  • -mtune=tune-type
  • -mabi=base-abi-type
  • -mfpu=fpu-type
  • -msimd=simd-type
  • -msoft-float
  • -msingle-float
  • -mdouble-float
  • -mlsx
  • -mno-lsx
  • -mlasx
  • -mno-lasx
  • -mbranch-cost=n
  • -mcheck-zero-division
  • -mno-check-zero-division
  • -mcond-move-int
  • -mno-cond-move-int
  • -mcond-move-float
  • -mno-cond-move-float
  • -memcpy
  • -mno-memcpy
  • -mstrict-align
  • -mno-strict-align
  • -mmax-inline-memcpy-size=n
  • -mexplicit-relocs=style
  • -mexplicit-relocs
  • -mno-explicit-relocs
  • -mdirect-extern-access
  • -mno-direct-extern-access
  • -mcmodel=code-model
  • -mrelax
  • -mpass-mrelax-to-as
  • -mrecip
  • -mrecip=opt
  • -mfrecipe
  • -mno-frecipe
  • -mdiv32
  • -mno-div32
  • -mlam-bh
  • -mno-lam-bh
  • -mlamcas
  • -mno-lamcas
  • -mld-seq-sa
  • -mno-ld-seq-sa
  • -mtls-dialect=opt

๐Ÿ’œ M32R/D Options ๐Ÿ’œ

  • -m32r2
  • -m32rx
  • -m32r
  • -mdebug
  • -malign-loops
  • -mno-align-loops
  • -missue-rate=number
  • -mbranch-cost=number
  • -mmodel=code-size-model-type
  • -msdata=sdata-type
  • -mno-flush-func
  • -mflush-func=name
  • -mno-flush-trap
  • -mflush-trap=number
  • -G num

๐Ÿ“ M32C Options ๐Ÿ“

  • -mcpu=cpu
  • -msim
  • -memregs=number

๐Ÿ”ฅ M680x0 Options ๐Ÿ”ฅ

the retro-motorola section, no cap, absolute legends:

  • -march=arch
  • -mcpu=cpu
  • -mtune=tune
  • -m68000
  • -m68020
  • -m68020-40
  • -m68020-60
  • -m68030
  • -m68040
  • -m68060
  • -mcpu32
  • -m5200
  • -m5206e
  • -m528x
  • -m5307
  • -m5407
  • -mcfv4e
  • -mbitfield
  • -mno-bitfield
  • -mc68000
  • -mc68020
  • -mnobitfield
  • -mrtd
  • -mno-rtd
  • -mdiv
  • -mno-div
  • -mshort
  • -mno-short
  • -mhard-float
  • -m68881
  • -msoft-float
  • -mpcrel
  • -malign-int
  • -mstrict-align
  • -msep-data
  • -mno-sep-data
  • -mshared-library-id=n
  • -mid-shared-library
  • -mno-id-shared-library
  • -mxgot
  • -mno-xgot
  • -mlong-jump-table-offsets

๐ŸŒธ MCore Options ๐ŸŒธ

  • -mhardlit
  • -mno-hardlit
  • -mdiv
  • -mno-div
  • -mrelax-immediates
  • -mno-relax-immediates
  • -mwide-bitfields
  • -mno-wide-bitfields
  • -m4byte-functions
  • -mno-4byte-functions
  • -mcallgraph-data
  • -mno-callgraph-data
  • -mslow-bytes
  • -mno-slow-bytes
  • -mno-lsim
  • -mlittle-endian
  • -mbig-endian
  • -m210
  • -m340
  • -mstack-increment

โœจ MicroBlaze Options โœจ

  • -msoft-float
  • -mhard-float
  • -msmall-divides
  • -mcpu=cpu
  • -mmemcpy
  • -mxl-soft-mul
  • -mxl-soft-div
  • -mxl-barrel-shift
  • -mxl-pattern-compare
  • -mxl-stack-check
  • -mxl-gp-opt
  • -mno-clearbss
  • -mxl-multiply-high
  • -mxl-float-convert
  • -mxl-float-sqrt
  • -mbig-endian
  • -mlittle-endian
  • -mxl-reorder
  • -mxl-mode-app-model
  • -mpic-data-is-text-relative

๐Ÿ‘‘ MIPS Options ๐Ÿ‘‘

the iconic one, the classic, the way it ate every SGI-era lunch ๐Ÿ’… buckle up, there's like a million:

  • -EL
  • -EB
  • -march=arch
  • -mtune=arch
  • -mips1
  • -mips2
  • -mips3
  • -mips4
  • -mips32
  • -mips32r2
  • -mips32r3
  • -mips32r5
  • -mips32r6
  • -mips64
  • -mips64r2
  • -mips64r3
  • -mips64r5
  • -mips64r6
  • -mips16
  • -mno-mips16
  • -mflip-mips16
  • -minterlink-compressed
  • -mno-interlink-compressed
  • -minterlink-mips16
  • -mno-interlink-mips16
  • -mabi=abi
  • -mabicalls
  • -mno-abicalls
  • -mshared
  • -mno-shared
  • -mplt
  • -mno-plt
  • -mxgot
  • -mno-xgot
  • -mgp32
  • -mgp64
  • -mfp32
  • -mfpxx
  • -mfp64
  • -mhard-float
  • -msoft-float
  • -mno-float
  • -msingle-float
  • -mdouble-float
  • -modd-spreg
  • -mno-odd-spreg
  • -mabs=mode
  • -mnan=encoding
  • -mdsp
  • -mno-dsp
  • -mdspr2
  • -mno-dspr2
  • -mmcu
  • -mmno-mcu
  • -meva
  • -mno-eva
  • -mvirt
  • -mno-virt
  • -mxpa
  • -mno-xpa
  • -mcrc
  • -mno-crc
  • -mginv
  • -mno-ginv
  • -mmicromips
  • -mno-micromips
  • -mmsa
  • -mno-msa
  • -mloongson-mmi
  • -mno-loongson-mmi
  • -mloongson-ext
  • -mno-loongson-ext
  • -mloongson-ext2
  • -mno-loongson-ext2
  • -mfpu=fpu-type
  • -msmartmips
  • -mno-smartmips
  • -mpaired-single
  • -mno-paired-single
  • -mdmx
  • -mno-mdmx
  • -mips3d
  • -mno-mips3d
  • -mmt
  • -mno-mt
  • -mllsc
  • -mno-llsc
  • -mlong64
  • -mlong32
  • -msym32
  • -mno-sym32
  • -Gnum
  • -mlocal-sdata
  • -mno-local-sdata
  • -mextern-sdata
  • -mno-extern-sdata
  • -mgpopt
  • -mno-gopt
  • -membedded-data
  • -mno-embedded-data
  • -muninit-const-in-rodata
  • -mno-uninit-const-in-rodata
  • -mcode-readable=setting
  • -msplit-addresses
  • -mno-split-addresses
  • -mexplicit-relocs
  • -mno-explicit-relocs
  • -mexplicit-relocs=release
  • -mcheck-zero-division
  • -mno-check-zero-division
  • -mdivide-traps
  • -mdivide-breaks
  • -mload-store-pairs
  • -mno-load-store-pairs
  • -mstrict-align
  • -mno-strict-align
  • -mno-unaligned-access
  • -munaligned-access
  • -mmemcpy
  • -mno-memcpy
  • -mlong-calls
  • -mno-long-calls
  • -mmad
  • -mno-mad
  • -mimadd
  • -mno-imadd
  • -mfused-madd
  • -mno-fused-madd
  • -nocpp
  • -mfix-24k
  • -mno-fix-24k
  • -mfix-r4000
  • -mno-fix-r4000
  • -mfix-r4400
  • -mno-fix-r4400
  • -mfix-r5900
  • -mno-fix-r5900
  • -mfix-r10000
  • -mno-fix-r10000
  • -mfix-rm7000
  • -mno-fix-rm7000
  • -mfix-vr4120
  • -mno-fix-vr4120
  • -mfix-vr4130
  • -mno-fix-vr4130
  • -mfix-sb1
  • -mno-fix-sb1
  • -mflush-func=func
  • -mno-flush-func
  • -mbranch-cost=num
  • -mbranch-likely
  • -mno-branch-likely
  • -mcompact-branches=policy
  • -mfp-exceptions
  • -mno-fp-exceptions
  • -mvr4130-align
  • -mno-vr4130-align
  • -msynci
  • -mno-synci
  • -mlxc1-sxc1
  • -mno-lxc1-sxc1
  • -mmadd4
  • -mno-madd4
  • -mrelax-pic-calls
  • -mno-relax-pic-calls
  • -mmcount-ra-address
  • -mframe-header-opt
  • -mno-frame-header-opt

๐Ÿงš MMIX Options ๐Ÿงš

  • -mlibfuncs
  • -mno-libfuncs
  • -mepsilon
  • -mno-epsilon
  • -mabi=gnu
  • -mabi=mmixware
  • -mzero-extend
  • -mknuthdiv
  • -mtoplevel-symbols
  • -melf
  • -mbranch-predict
  • -mno-branch-predict
  • -mbase-addresses
  • -mno-base-addresses
  • -msingle-exit
  • -mno-single-exit

๐ŸŒˆ MN10300 Options ๐ŸŒˆ

  • -mmult-bug
  • -mno-mult-bug
  • -mno-am33
  • -mam33
  • -mam33-2
  • -mam34
  • -mtune=cpu-type
  • -mreturn-pointer-on-d0
  • -mno-crt0
  • -mrelax
  • -mliw
  • -msetlb

๐Ÿ’ซ Moxie Options ๐Ÿ’ซ

short n sweet fr:

  • -meb
  • -mel
  • -mmul.x
  • -mno-crt0

๐ŸŽ€ MSP430 Options ๐ŸŽ€

  • -msim
  • -masm-hex
  • -mmcu=
  • -mcpu=
  • -mlarge
  • -msmall
  • -mrelax
  • -mwarn-mcu
  • -mcode-region=
  • -mdata-region=
  • -msilicon-errata=
  • -msilicon-errata-warn=
  • -mhwmult=
  • -minrt
  • -mtiny-printf
  • -mmax-inline-shift=

๐Ÿฆ‹ NDS32 Options ๐Ÿฆ‹

  • -mbig-endian
  • -mlittle-endian
  • -mreduced-regs
  • -mfull-regs
  • -mcmov
  • -mno-cmov
  • -mext-perf
  • -mno-ext-perf
  • -mext-perf2
  • -mno-ext-perf2
  • -mext-string
  • -mno-ext-string
  • -mv3push
  • -mno-v3push
  • -m16bit
  • -mno-16bit
  • -misr-vector-size=num
  • -mcache-block-size=num
  • -march=arch
  • -mcmodel=code-model
  • -mctor-dtor
  • -mrelax

๐ŸŒธ Nios II Options ๐ŸŒธ

  • -G num
  • -mgpopt=option
  • -mgpopt
  • -mno-gpopt
  • -mgprel-sec=regexp
  • -mr0rel-sec=regexp
  • -mel
  • -meb
  • -mno-bypass-cache
  • -mbypass-cache
  • -mno-cache-volatile
  • -mcache-volatile
  • -mno-fast-sw-div
  • -mfast-sw-div
  • -mhw-mul
  • -mno-hw-mul
  • -mhw-mulx
  • -mno-hw-mulx
  • -mno-hw-div
  • -mhw-div
  • -mcustom-insn=N
  • -mno-custom-insn
  • -mcustom-fpu-cfg=name
  • -mhal
  • -msmallc
  • -msys-crt0=name
  • -msys-lib=name
  • -march=arch
  • -mbmx
  • -mno-bmx
  • -mcdx
  • -mno-cdx

๐Ÿ’œ Nvidia PTX Options ๐Ÿ’œ

tiny list, big GPU energy:

  • -m64
  • -mmainkernel
  • -moptimize

๐Ÿ”ฅ OpenRISC Options ๐Ÿ”ฅ

  • -mboard=name
  • -mnewlib
  • -mhard-mul
  • -mhard-div
  • -msoft-mul
  • -msoft-div
  • -msoft-float
  • -mhard-float
  • -mdouble-float
  • -munordered-float
  • -mcmov
  • -mror
  • -mrori
  • -msext
  • -msfimm
  • -mshftimm
  • -mcmodel=code-model

๐Ÿ“ PDP-11 Options ๐Ÿ“

the actual fossil, and we respect her:

  • -mfpu
  • -msoft-float
  • -mac0
  • -mno-ac0
  • -m40
  • -m45
  • -m10
  • -mint32
  • -mno-int16
  • -mint16
  • -mno-int32
  • -msplit
  • -munix-asm
  • -mdec-asm
  • -mgnu-asm
  • -mlra

๐ŸŒˆ PowerPC Options ๐ŸŒˆ

See RS/6000 and PowerPC Options.

โœจ PRU Options โœจ

  • -mmcu=mcu
  • -minrt
  • -mno-relax
  • -mloop
  • -mabi=variant

๐Ÿ‘‘ RISC-V Options ๐Ÿ‘‘

the open-source girlboss of ISAs, obsessed with her tbh:

  • -mbranch-cost=N-instruction
  • -mplt
  • -mno-plt
  • -mabi=ABI-string
  • -mfdiv
  • -mno-fdiv
  • -mdiv
  • -mno-div
  • -misa-spec=ISA-spec-string
  • -march=ISA-string
  • -mtune=processor-string
  • -mpreferred-stack-boundary=num
  • -msmall-data-limit=N-bytes
  • -msave-restore
  • -mno-save-restore
  • -mshorten-memrefs
  • -mno-shorten-memrefs
  • -mstrict-align
  • -mno-strict-align
  • -mcmodel=medlow
  • -mcmodel=medany
  • -mexplicit-relocs
  • -mno-explicit-relocs
  • -mrelax
  • -mno-relax
  • -mriscv-attribute
  • -mno-riscv-attribute
  • -malign-data=type
  • -mbig-endian
  • -mlittle-endian
  • -mstack-protector-guard=guard
  • -mstack-protector-guard-reg=reg
  • -mstack-protector-guard-offset=offset
  • -mcsr-check
  • -mno-csr-check
  • -mmovcc
  • -mno-movcc
  • -minline-atomics
  • -mno-inline-atomics
  • -minline-strlen
  • -mno-inline-strlen
  • -minline-strcmp
  • -mno-inline-strcmp
  • -minline-strncmp
  • -mno-inline-strncmp
  • -mtls-dialect=desc
  • -mtls-dialect=trad

๐ŸŽ€ RL78 Options ๐ŸŽ€

  • -msim
  • -mmul=none
  • -mmul=g13
  • -mmul=g14
  • -mallregs
  • -mcpu=g10
  • -mcpu=g13
  • -mcpu=g14
  • -mg10
  • -mg13
  • -mg14
  • -m64bit-doubles
  • -m32bit-doubles
  • -msave-mduc-in-interrupts

๐Ÿฆ‹ RS/6000 and PowerPC Options ๐Ÿฆ‹

okay this one is enormous, bestie, brace yourself, she's the main character of embedded-and-HPC:

  • -mcpu=cpu-type
  • -mtune=cpu-type
  • -mcmodel=code-model
  • -mpowerpc64
  • -maltivec
  • -mno-altivec
  • -mpowerpc-gpopt
  • -mno-powerpc-gpopt
  • -mpowerpc-gfxopt
  • -mno-powerpc-gfxopt
  • -mmfcrf
  • -mno-mfcrf
  • -mpopcntb
  • -mno-popcntb
  • -mpopcntd
  • -mno-popcntd
  • -mfprnd
  • -mno-fprnd
  • -mcmpb
  • -mno-cmpb
  • -mhard-dfp
  • -mno-hard-dfp
  • -mfull-toc
  • -mminimal-toc
  • -mno-fp-in-toc
  • -mno-sum-in-toc
  • -m64
  • -m32
  • -mxl-compat
  • -mno-xl-compat
  • -mpe
  • -malign-power
  • -malign-natural
  • -msoft-float
  • -mhard-float
  • -mmultiple
  • -mno-multiple
  • -mupdate
  • -mno-update
  • -mavoid-indexed-addresses
  • -mno-avoid-indexed-addresses
  • -mfused-madd
  • -mno-fused-madd
  • -mbit-align
  • -mno-bit-align
  • -mstrict-align
  • -mno-strict-align
  • -mrelocatable
  • -mno-relocatable
  • -mrelocatable-lib
  • -mno-relocatable-lib
  • -mtoc
  • -mno-toc
  • -mlittle
  • -mlittle-endian
  • -mbig
  • -mbig-endian
  • -mdynamic-no-pic
  • -mswdiv
  • -msingle-pic-base
  • -mprioritize-restricted-insns=priority
  • -msched-costly-dep=dependence_type
  • -minsert-sched-nops=scheme
  • -mcall-aixdesc
  • -mcall-eabi
  • -mcall-freebsd
  • -mcall-linux
  • -mcall-netbsd
  • -mcall-openbsd
  • -mcall-sysv
  • -mcall-sysv-eabi
  • -mcall-sysv-noeabi
  • -mtraceback=traceback_type
  • -maix-struct-return
  • -msvr4-struct-return
  • -mabi=abi-type
  • -msecure-plt
  • -mbss-plt
  • -mlongcall
  • -mno-longcall
  • -mpltseq
  • -mno-pltseq
  • -mblock-move-inline-limit=num
  • -mblock-compare-inline-limit=num
  • -mblock-compare-inline-loop-limit=num
  • -mno-block-ops-unaligned-vsx
  • -mstring-compare-inline-limit=num
  • -misel
  • -mno-isel
  • -mvrsave
  • -mno-vrsave
  • -mmulhw
  • -mno-mulhw
  • -mdlmzb
  • -mno-dlmzb
  • -mprototype
  • -mno-prototype
  • -msim
  • -mmvme
  • -mads
  • -myellowknife
  • -memb
  • -msdata
  • -msdata=opt
  • -mreadonly-in-sdata
  • -mvxworks
  • -G num
  • -mrecip
  • -mrecip=opt
  • -mno-recip
  • -mrecip-precision
  • -mno-recip-precision
  • -mveclibabi=type
  • -mfriz
  • -mno-friz
  • -mpointers-to-nested-functions
  • -mno-pointers-to-nested-functions
  • -msave-toc-indirect
  • -mno-save-toc-indirect
  • -mpower8-fusion
  • -mno-mpower8-fusion
  • -mcrypto
  • -mno-crypto
  • -mhtm
  • -mno-htm
  • -mquad-memory
  • -mno-quad-memory
  • -mquad-memory-atomic
  • -mno-quad-memory-atomic
  • -mcompat-align-parm
  • -mno-compat-align-parm
  • -mfloat128
  • -mno-float128
  • -mfloat128-hardware
  • -mno-float128-hardware
  • -mgnu-attribute
  • -mno-gnu-attribute
  • -mstack-protector-guard=guard
  • -mstack-protector-guard-reg=reg
  • -mstack-protector-guard-offset=offset
  • -mprefixed
  • -mno-prefixed
  • -mpcrel
  • -mno-pcrel
  • -mmma
  • -mno-mmma
  • -mrop-protect
  • -mno-rop-protect
  • -mprivileged
  • -mno-privileged

๐Ÿ’ซ RX Options

Bestie, if you're cooking for an RX chip, these are the little dials you get to spin:

-m64bit-doubles -m32bit-doubles -fpu -nofpu -mcpu=
-mbig-endian-data -mlittle-endian-data -msmall-data -msim -mno-sim
-mas100-syntax -mno-as100-syntax -mrelax -mmax-constant-size=
-mint-register= -mpid -mallow-string-insns -mno-allow-string-insns
-mjsr -mno-warn-multiple-fast-interrupts -msave-acc-in-interrupts

(and yeah, -mcpu=, -mmax-constant-size= and -mint-register= are just sitting there with a trailing = and no value, that's literally how the page prints them, no cap ๐Ÿ™ˆ)


๐Ÿ’– S/390 and zSeries Options

Mainframe girlies, this is your section:

-mtune=cpu-type -march=cpu-type
-mhard-float -msoft-float -mhard-dfp -mno-hard-dfp
-mlong-double-64 -mlong-double-128 -mbackchain -mno-backchain
-mpacked-stack -mno-packed-stack -msmall-exec -mno-small-exec
-mmvcle -mno-mvcle -m64 -m31 -mdebug -mno-debug -mesa -mzarch
-mhtm -mvx -mzvector -mtpf-trace -mno-tpf-trace -mtpf-trace-skip
-mno-tpf-trace-skip -mfused-madd -mno-fused-madd -mwarn-framesize
-mwarn-dynamicstack -mstack-size -mstack-guard
-mhotpatch=halfwords,halfwords

๐ŸŽ€ SH Options

SuperH hive, rise up โœจ:

-m1 -m2 -m2e -m2a-nofpu -m2a-single-only -m2a-single
-m2a -m3 -m3e -m4-nofpu -m4-single-only -m4-single -m4
-m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al -mb -ml
-mdalign -mrelax -mbigtable -mfmovd -mrenesas -mno-renesas
-mnomacsave -mieee -mno-ieee -mbitops -misize
-minline-ic_invalidate -mpadstruct -mprefergot -musermode
-multcost=number -mdiv=strategy -mdivsi3_libfunc=name
-mfixed-range=register-range -maccumulate-outgoing-args
-matomic-model=atomic-model -mbranch-cost=num -mzdcbranch
-mno-zdcbranch -mcbranch-force-delay-slot -mfused-madd
-mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra
-mpretend-cmove -mtas

๐ŸŒธ Solaris 2 Options

Solaris besties, short and sweet:

-mclear-hwcap -mno-clear-hwcap -mimpure-text
-mno-impure-text -pthreads

๐Ÿฆ‹ SPARC Options

Okay SPARC is giving range, look at this list:

-mcpu=cpu-type -mtune=cpu-type -mcmodel=code-model
-mmemory-model=mem-model -m32 -m64 -mapp-regs -mno-app-regs
-mfaster-structs -mno-faster-structs -mflat -mno-flat -mfpu
-mno-fpu -mhard-float -msoft-float -mhard-quad-float
-msoft-quad-float -mstack-bias -mno-stack-bias -mstd-struct-return
-mno-std-struct-return -munaligned-doubles -mno-unaligned-doubles
-muser-mode -mno-user-mode -mv8plus -mno-v8plus -mvis -mno-vis
-mvis2 -mno-vis2 -mvis3 -mno-vis3 -mvis4 -mno-vis4 -mvis4b
-mno-vis4b -mcbcond -mno-cbcond -mfmaf -mno-fmaf -mfsmuld
-mno-fsmuld -mpopc -mno-popc -msubxc -mno-subxc -mfix-at697f
-mfix-ut699 -mfix-ut700 -mfix-gr712rc -mlra -mno-lra

๐ŸŒˆ System V Options

Tiny but mighty:

-Qy -Qn -YP,paths -Ym,dir

๐Ÿ“ V850 Options

-mlong-calls -mno-long-calls -mep -mno-ep
-mprolog-function -mno-prolog-function -mspace -mtda=n -msda=n
-mzda=n -mapp-regs -mno-app-regs -mdisable-callt
-mno-disable-callt -mv850e2v3 -mv850e2 -mv850e1 -mv850es -mv850e
-mv850 -mv850e3v5 -mloop -mrelax -mlong-jumps -msoft-float
-mhard-float -mgcc-abi -mrh850-abi -mbig-switch

๐Ÿ’œ VAX Options

Four flags, all iconic:

-mg -mgnu -munix -mlra

โญ Visium Options

-mdebug -msim -mfpu -mno-fpu -mhard-float
-msoft-float -mcpu=cpu-type -mtune=cpu-type -msv-mode -muser-mode

๐Ÿซถ VMS Options

-mvms-return-codes -mdebug-main=prefix -mmalloc64
-mpointer-size=size

๐Ÿ’… VxWorks Options

-mrtp -msmp -non-static -Bstatic -Bdynamic
-Xbind-lazy -Xbind-now

๐Ÿ”ฅ x86 Options

Okay this is the list, bestie. It's enormous. It's iconic. We're doing all of it, no skipping, no summarising, periodt. ๐Ÿ’€

-mtune=cpu-type -march=cpu-type
-mtune-ctrl=feature-list -mdump-tune-features -mno-default
-mfpmath=unit -masm=dialect -mno-fancy-math-387 -mno-fp-ret-in-387
-m80387 -mhard-float -msoft-float -mno-wide-multiply -mrtd
-malign-double -mpreferred-stack-boundary=num
-mincoming-stack-boundary=num -mcld -mcx16 -msahf -mmovbe
-mcrc32 -mmwait -mrecip -mrecip=opt -mvzeroupper -mprefer-avx128
-mprefer-vector-width=opt -mpartial-vector-fp-math -mmove-max=bits
-mstore-max=bits -mnoreturn-no-callee-saved-registers -mmmx -msse
-msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx -mavx2
-mavx512f -mavx512pf -mavx512er -mavx512cd -mavx512vl -mavx512bw
-mavx512dq -mavx512ifma -mavx512vbmi -msha -maes -mpclmul
-mfsgsbase -mrdrnd -mf16c -mfma -mpconfig -mwbnoinvd -mptwrite
-mprefetchwt1 -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 -mthreads -mgfni -mvaes
-mwaitpkg -mshstk -mmanual-endbr -mcet-switch -mforce-indirect-call
-mavx512vbmi2 -mavx512bf16 -menqcmd -mvpclmulqdq -mavx512bitalg
-mmovdiri -mmovdir64b -mavx512vpopcntdq -mavx5124fmaps
-mavx512vnni -mavx5124vnniw -mprfchw -mrdpid -mrdseed -msgx
-mavx512vp2intersect -mserialize -mtsxldtrk -mamx-tile -mamx-int8
-mamx-bf16 -muintr -mhreset -mavxvnni -mavx512fp16 -mavxifma
-mavxvnniint8 -mavxneconvert -mcmpccxadd -mamx-fp16 -mprefetchi
-mraoint -mamx-complex -mavxvnniint16 -msm3 -msha512 -msm4 -mapxf
-musermsr -mavx10.1 -mavx10.1-256 -mavx10.1-512 -mevex512 -mcldemote
-mms-bitfields -mno-align-stringops -minline-all-stringops
-minline-stringops-dynamically -mstringop-strategy=alg -mkl
-mwidekl -mmemcpy-strategy=strategy -mmemset-strategy=strategy
-mpush-args -maccumulate-outgoing-args -m128bit-long-double
-m96bit-long-double -mlong-double-64 -mlong-double-80
-mlong-double-128 -mregparm=num -msseregparm -mveclibabi=type
-mvect8-ret-in-mem -mpc32 -mpc64 -mpc80 -mdaz-ftz -mstackrealign
-momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs
-mcmodel=code-model -mabi=name -maddress-mode=mode -m32 -m64
-mx32 -m16 -miamcu -mlarge-data-threshold=num -msse2avx -mfentry
-mrecord-mcount -mnop-mcount -m8bit-idiv -minstrument-return=type
-mfentry-name=name -mfentry-section=name
-mavx256-split-unaligned-load -mavx256-split-unaligned-store
-malign-data=type -mstack-protector-guard=guard
-mstack-protector-guard-reg=reg
-mstack-protector-guard-offset=offset
-mstack-protector-guard-symbol=symbol -mgeneral-regs-only
-mcall-ms2sysv-xlogues -mrelax-cmpxchg-loop -mindirect-branch=choice
-mfunction-return=choice -mindirect-branch-register
-mharden-sls=choice -mindirect-branch-cs-prefix -mneeded
-mno-direct-extern-access -munroll-only-small-loops -mlam=choice

Whew. Slay. ๐Ÿ’…


๐Ÿงš x86 Windows Options

-mconsole -mcrtdll=library -mdll
-mnop-fun-dllimport -mthread -municode -mwin32 -mwindows
-fno-set-stack-executable

๐ŸŒธ Xstormy16 Options

One (1) flag. It's doing its best:

-msim

๐Ÿ’œ Xtensa Options

-mconst16 -mno-const16 -mfused-madd -mno-fused-madd
-mforce-no-pic -mserialize-volatile -mno-serialize-volatile
-mtext-section-literals -mno-text-section-literals -mauto-litpools
-mno-auto-litpools -mtarget-align -mno-target-align -mlongcalls
-mno-longcalls -mabi=abi-type -mextra-l32r-costs=cycles
-mstrict-align -mno-strict-align

๐Ÿ‘‘ zSeries Options

See S/390 and zSeries Options. That's the whole thing, bestie โ€” it's a redirect and honestly? Respect. ๐Ÿซถ


๐ŸŽ€ Options Controlling the Kind of Output ๐ŸŽ€

Okay so here's the tea on how compiling actually flows. Compilation can involve up to four stages, and they always go in this order:

  1. preprocessing
  2. compilation proper
  3. assembly
  4. linking

GCC can preprocess and compile 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 โ€” the ones just freshly compiled and the ones you handed it as input โ€” into one executable file. Chef's kiss. ๐Ÿ˜˜

For any given input file, the file name suffix determines what kind of compilation gets done, so let's vibe check every single one:

  • file.c โ€” C source code that must be preprocessed.
  • file.i โ€” C source code that should not be preprocessed.
  • file.ii โ€” C++ source code that should not be preprocessed.
  • file.m โ€” Objective-C source code. Heads up: you must link with the libobjc library to make an Objective-C program work.
  • file.mi โ€” Objective-C source code that should not be preprocessed.
  • file.mm, file.M โ€” Objective-C++ source code. Heads up: you must link with the libobjc library to make an Objective-C++ program work. And note that .M refers to a literal capital M.
  • file.mii โ€” Objective-C++ source code that should not be preprocessed.
  • 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 -fdump-ada-spec switch).
  • file.cc, file.cp, file.cxx, file.cpp, file.CPP, file.c++, file.C โ€” C++ source code that must be preprocessed. Note that in .cxx, the last two letters must both be literally x. Likewise, .C refers to a literal capital C.
  • file.mm, file.M โ€” Objective-C++ source code that must be preprocessed.
  • file.mii โ€” Objective-C++ source code that should not be preprocessed.
  • file.hh, file.H, file.hp, file.hxx, file.hpp, file.HPP, file.h++, file.tcc โ€” C++ header file to be turned into a precompiled header or Ada spec.
  • file.f, file.for, file.ftn, file.fi โ€” Fixed form Fortran source code that should not be preprocessed.
  • file.F, file.FOR, file.fpp, file.FPP, file.FTN โ€” Fixed form Fortran source code that must be preprocessed (with the traditional preprocessor).
  • file.f90, file.f95, file.f03, file.f08, file.fii โ€” Free form Fortran source code that should not be preprocessed.
  • file.F90, file.F95, file.F03, file.F08 โ€” Free form Fortran source code that must be preprocessed (with the traditional preprocessor).
  • file.go โ€” Go source code.
  • file.d โ€” D source code.
  • file.di โ€” D interface file.
  • file.dd โ€” D documentation code (Ddoc).
  • 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 specs.
  • file.adb โ€” Ada source code file containing a library unit body (a subprogram or package body). Such files are also called bodies.
  • file.s โ€” Assembler code.
  • file.S, file.sx โ€” Assembler code that must be preprocessed.
  • other โ€” An object file to be fed straight into linking. Any file name with no recognized suffix is treated this way.
Not me noticing file.mm / file.M and file.mii each show up twice in this list. That's not a typo on my end, bestie โ€” the page really does say it both ways. We report, we don't edit. ๐Ÿ™ˆ

And if you wanna be loud and proud about which language you're feeding in, you can specify the input language explicitly with the -x option:

  • -x language โ€” okay bestie, this is you explicitly saying what language the following input files are, instead of letting the compiler guess from the file name suffix. This option applies to all following input files until the next -x option. Possible values for language are:
c  c-header  cpp-output
c++  c++-header  c++-system-header c++-user-header c++-cpp-output
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
d
f77  f77-cpp-input  f95  f95-cpp-input
go
modula-2  modula-2-cpp-output
rust
lto
  • -x none โ€” turn off any specification of a language, so subsequent files are handled according to their file name suffixes, just like if -x had not been used at all. periodt.

If you only want some of the stages of compilation, you can use -x (or filename suffixes) to tell gcc where to start, and one of the options -c, -S, or -E to say where gcc is to stop. Heads up: some combinations โ€” for example, -x cpp-output -E โ€” instruct gcc to do nothing at all. ๐Ÿ’€

  • -c โ€” 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 .c, .i, .s, etc., with .o.

Unrecognized input files, not requiring compilation or assembly, are ignored.

  • -S โ€” 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 .c, .i, etc., with .s.

Input files that don't require compilation are ignored.

  • -E โ€” 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.

  • -o file โ€” place the primary output in 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 -o is not specified, the default is to put an executable file in a.out, the object file for source.suffix in source.o, its assembler file in source.s, a precompiled header file in source.suffix.gch, and all preprocessed C source on standard output.

Though -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.

gcc -c foo.c ...

will use foo.o as the primary output, and place aux outputs and dumps next to it, e.g., aux file foo.dwo for -gsplit-dwarf, and dump file foo.c.???r.final for -fdump-rtl-final.

If a non-linker output file is explicitly specified, aux and dump files by default take the same base name:

gcc -c foo.c -o dir/foobar.o ...

will name aux outputs dir/foobar.* and dump outputs dir/foobar.c.*.

A linker output will instead prefix aux and dump outputs:

gcc foo.c bar.c -o dir/foobar ...

will generally name aux outputs dir/foobar-foo.* and dir/foobar-bar.*, and dump outputs dir/foobar-foo.c.* and dir/foobar-bar.c.*.

The one exception to the above is when the executable shares the base name with the single input:

gcc foo.c -o dir/foo ...

in which case aux outputs are named dir/foo.* and dump outputs named dir/foo.c.*.

The location and the names of auxiliary and dump outputs can be adjusted by the options -dumpbase, -dumpbase-ext, -dumpdir, -save-temps=cwd, and -save-temps=obj.

  • -dumpbase 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:
gcc -save-temps -S foo.c

saves the (no longer) temporary preprocessed file in foo.i, and then compiles to the (implied) output file foo.s, whereas:

gcc -save-temps -dumpbase save-foo -c foo.c

preprocesses to in save-foo.i, compiles to save-foo.s (now an intermediate, thus auxiliary output), and then assembles to the (implied) output 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 -fdump-* options) with the input name suffix, and aux output files (those requested by other non-dump options, e.g. -save-temps, -gsplit-dwarf, -fcallgraph-info) without it.

Similar suffix differentiation of dump and aux outputs can be attained for explicitly-given -dumpbase basename.suf by also specifying -dumpbase-ext .suf.

If dumpbase is explicitly specified with any directory component, any dumppfx specification (e.g. -dumpdir or -save-temps=*) is ignored, and instead of appending to it, dumpbase fully overrides it:

gcc foo.c -c -o dir/foo.o -dumpbase alt/foo \
  -dumpdir pfx- -save-temps=cwd ...

creates auxiliary and dump outputs named alt/foo.*, disregarding dir/ in -o, the ./ prefix implied by -save-temps=cwd, and pfx- in -dumpdir.

When -dumpbase is specified in a command that compiles multiple inputs, or that compiles and then links, it may be combined with dumppfx, as specified under -dumpdir. Then, each input file is compiled using the combined dumppfx, and default values for dumpbase and auxdropsuf are computed for each input file:

gcc foo.c bar.c -c -dumpbase main ...

creates foo.o and bar.o as primary outputs, and avoids overwriting the auxiliary and dump outputs by using the dumpbase as a prefix, creating auxiliary and dump outputs named main-foo.* and main-bar.*.

An empty string specified as dumpbase avoids the influence of the output basename in the naming of auxiliary and dump outputs during compilation, computing default values :

gcc -c foo.c -o dir/foobar.o -dumpbase " ...

will name aux outputs dir/foo.* and dump outputs 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:

gcc foo.c bar.c -o dir/foobar -dumpbase " -flto ...

The compilation of the source files will name auxiliary outputs dir/foo.* and dir/bar.*, and dump outputs dir/foo.c.* and dir/bar.c.*. LTO recompilation during linking will use dir/foobar. as the prefix for dumps and auxiliary files.

  • -dumpbase-ext auxdropsuf โ€” when forming the name of an auxiliary (but not a dump) output file, drop trailing auxdropsuf from dumpbase before appending any suffixes. If not specified, this option defaults to the suffix of a default dumpbase, i.e., the suffix of the input file when -dumpbase is not present in the command line, or dumpbase is combined with dumppfx.
gcc foo.c -c -o dir/foo.o -dumpbase x-foo.c -dumpbase-ext .c ...

creates dir/foo.o as the main output, and generates auxiliary outputs in dir/x-foo.*, taking the location of the primary output, and dropping the .c suffix from the dumpbase. Dump outputs retain the suffix: dir/x-foo.c.*.

This option is disregarded if it does not match the suffix of a specified dumpbase, except as an alternative to the executable suffix when appending the linker output base name to dumppfx, as specified below:

gcc foo.c bar.c -o main.out -dumpbase-ext .out ...

creates main.out as the primary output, and avoids overwriting the auxiliary and dump outputs by using the executable name minus auxdropsuf as a prefix, creating auxiliary outputs named main-foo.* and main-bar.* and dump outputs named main-foo.c.* and main-bar.c.*.

  • -dumpdir dumppfx โ€” when forming the name of an auxiliary or dump output file, use dumppfx as a prefix:
gcc -dumpdir pfx- -c foo.c ...

creates foo.o as the primary output, and auxiliary outputs named pfx-foo.*, combining the given dumppfx with the default dumpbase derived from the default primary output, derived in turn from the input name. Dump outputs also take the input name suffix: pfx-foo.c.*.

If dumppfx is to be used as a directory name, it must end with a directory separator:

gcc -dumpdir dir/ -c foo.c -o obj/bar.o ...

creates obj/bar.o as the primary output, and auxiliary outputs named dir/bar.*, combining the given dumppfx with the default dumpbase derived from the primary output name. Dump outputs also take the input name suffix: dir/bar.c.*.

It defaults to the location of the output file, unless the output file is a special file like /dev/null. Options -save-temps=cwd and -save-temps=obj override this default, just like an explicit -dumpdir option. In case multiple such options are given, the last one prevails:

gcc -dumpdir pfx- -c foo.c -save-temps=obj ...

okay so picture this bestie: -save-temps=* overrides the dumppfx that the earlier -dumpdir option gave you, so you get foo.o as your main output, with auxiliary outputs named foo.*. And it literally does not matter that =obj is the default for -save-temps, nor that the output directory is implicitly the current directory. The dump outputs? Those get named foo.c.*. ๐Ÿ’…

Now when you're compiling from multiple input files, if -dumpbase is specified, then dumpbase โ€” minus an auxdropsuf suffix โ€” plus a dash get appended to (or they override, if containing any directory components) an explicit or defaulted dumppfx, so that each of the multiple compilations gets its own differently-named aux and dump outputs.

gcc foo.c bar.c -c -dumpdir dir/pfx- -dumpbase main ...

That outputs auxiliary dumps to dir/pfx-main-foo.* and dir/pfx-main-bar.*, appending dumpbase- to dumppfx. The dump outputs retain the input file suffix: dir/pfx-main-foo.c.* and dir/pfx-main-bar.c.*, respectively. Now contrast that with the single-input compilation:

gcc foo.c -c -dumpdir dir/pfx- -dumpbase main ...

...which, applying -dumpbase to a single source, does not compute and append a separate dumpbase per input file. Its auxiliary and dump outputs go in dir/pfx-main.*. periodt.

When you're compiling and then linking from multiple input files, a defaulted or explicitly specified dumppfx also undergoes that dumpbase- transformation from above (like the compilation of foo.c and bar.c above, but without -c). If neither -dumpdir nor -dumpbase are given, the linker output base name, minus auxdropsuf, if specified, or the executable suffix otherwise, plus a dash gets appended to the default dumppfx instead. But heads up โ€” note that unlike earlier cases of linking:

gcc foo.c bar.c -dumpdir dir/pfx- -o main ...

...this does not append the output name main to dumppfx, because -dumpdir is explicitly specified. The whole goal is that the explicitly-specified dumppfx may contain the specified output name as part of the prefix, if desired; only an explicitly-specified -dumpbase would be combined with it, so you 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 dumppfx as above if it does not share the base name with the single input file name. This has been covered in the single-input linking cases above, but not with an explicit -dumpdir that inhibits the combination, even if overridden by -save-temps=*:

gcc foo.c -dumpdir alt/pfx- -o dir/main.exe -save-temps=cwd ...

Here the auxiliary outputs are named foo.*, and dump outputs foo.c.*, in the current working directory as ultimately requested by -save-temps=cwd. ๐ŸŒธ

Summing it all up for an intuitive though slightly imprecise data flow: the primary output name gets broken into a directory part and a basename part; dumppfx is set to the former, unless overridden by -dumpdir or -save-temps=*, and dumpbase is set to the latter, unless overriden by -dumpbase. If there are multiple inputs or linking, this dumpbase may be combined with dumppfx and taken from each input file. Auxiliary output names for each input are formed by combining dumppfx, dumpbase minus suffix, and the auxiliary output suffix; dump output names are only different in that the suffix from dumpbase is retained. okay? iconic. ๐Ÿ‘‘

When it comes to auxiliary and dump outputs created during LTO recompilation, a combination of dumppfx and 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 -dumpdir option to lto-wrapper; being involved in linking, this program does not normally get any -dumpbase and -dumpbase-ext, and it ignores them.

When running sub-compilers, lto-wrapper appends LTO stage names to the received dumppfx, ensures it contains a directory component so that it overrides any -dumpdir, and passes that as -dumpbase to sub-compilers.


  • -v โ€” 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. it's giving receipts โœจ
  • -### โ€” Like -v, except the commands are not executed and arguments are quoted unless they contain only alphanumeric characters or "./-_". This is useful for shell scripts to capture the driver-generated command lines.
  • --help โ€” Print (on the standard output) a description of the command-line options understood by gcc. If the -v option is also specified, then --help is also passed on to the various processes invoked by gcc, so that they can display the command-line options they accept. And if the -Wextra option has also been specified (prior to the --help option), then command-line options that have no documentation associated with them are also displayed. bestie loves a full info dump ๐Ÿ’–
  • --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.
  • --help={class|[^]qualifier}[,...] โ€” 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:

  • optimizers โ€” Display all of the optimization options supported by the compiler.
  • warnings โ€” Display all of the options controlling warning messages produced by the compiler.
  • target โ€” Display target-specific options. Unlike the --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 --help= syntax.
  • params โ€” Display the values recognized by the --param option.
  • language โ€” Display the options supported for language, where 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 common class.
  • common โ€” Display the options that are common to all languages.

These are the supported qualifiers:

  • undocumented โ€” Display only those options that are undocumented.
  • joined โ€” Display options taking an argument that appears after an equal sign in the same continuous piece of text, such as: --help=target.
  • separate โ€” Display options taking an argument that appears as a separate word following the original option, such as: -o output-file.

So for example, to display all the undocumented target-specific switches supported by the compiler, use:

--help=target,undocumented

The sense of a qualifier can be inverted by prefixing it with the ^ 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:

--help=warnings,^joined,^undocumented

The argument to --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 target. For example, to display all the target-specific optimization options, use:

--help=target,optimizers

The --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 --help is also specified anywhere on the command line, then this takes precedence over any --help= option.

If the -Q option appears on the command line before the --help= option, then the descriptive text displayed by --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 --help= option is used).

Here is a truncated example from the ARM port of gcc:

% gcc -Q -mabi=2 --help=target -c
The following options are target specific:
-mabi=                                2
-mabort-on-noreturn                   [disabled]
-mapcs                                [disabled]

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 -O2 by using:

-Q -O2 --help=optimizers

Alternatively you can discover which binary optimizations are enabled by -O3 by using:

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
  • --version โ€” Display the version number and copyrights of the invoked GCC. the way that it just โœจ announces itself โœจ
  • -pass-exit-codes โ€” Normally the gcc program exits with the code of 1 if any phase of the compiler returns a non-success return code. If you specify -pass-exit-codes, the 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.
  • -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. ๐Ÿฆ‹
  • -specs=file โ€” Process file after the compiler reads in the standard specs file, in order to override the defaults which the gcc driver program uses when determining what switches to pass to cc1, cc1plus, as, ld, etc. More than one -specs=file can be specified on the command line, and they are processed in order, from left to right.
  • -wrapper โ€” Invoke all subcommands under a wrapper program. The name of the wrapper program and its parameters are passed as a comma separated list.
gcc -c t.c -wrapper gdb,--args

This invokes all subprograms of gcc under gdb --args, thus the invocation of cc1 is gdb --args cc1 .... not me wrapping everything in gdb like it's a lil gift ๐ŸŽ€

  • -ffile-prefix-map=old=new โ€” okay so when you're compiling files that live in directory old, bestie, every reference to them in the result of the compilation gets written down as if they actually lived in directory new instead. Specifying this one is literally equivalent to specifying all the individual -f*-prefix-map options at once. It's giving reproducible-builds-that-are-location-independent energy โœจ. Heads up tho: directories referenced by directives are not affected by these options. See also -fmacro-prefix-map, -fdebug-prefix-map, -fprofile-prefix-map and -fcanon-prefix-map ๐Ÿ’…
  • -fcanon-prefix-map โ€” so for the -f*-prefix-map options, normally the comparison of old prefix against the filename that would normally be referenced in the result of the compilation is done using textual comparison of the prefixes, or ignoring character case for case insensitive filesystems, and treating slashes and backslashes as equal on DOS based filesystems. The -fcanon-prefix-map makes those comparisons happen on canonicalized paths of old and the referenced filename instead. fancy fr fr ๐Ÿฆ‹
  • -fplugin=name.so โ€” loads the plugin code in file name.so, which is assumed to be a shared object that gets dlopen'd by the compiler. The base name of the shared object file is what identifies the plugin for argument parsing purposes (peep -fplugin-arg-name-key=value below ๐Ÿ‘€). Every plugin should define the callback functions specified in the Plugins API.
  • -fplugin-arg-name-key=value โ€” defines an argument called key with a value of value for the plugin called name. cute lil handshake ๐Ÿค
  • -fdump-ada-spec[-slim] โ€” for C and C++ source and include files, generates corresponding Ada specs. slay for the Ada girlies ๐Ÿ’œ
  • -fada-spec-parent=unit โ€” works together with -fdump-ada-spec[-slim] from above, and generates Ada specs as child units of parent unit.
  • -fdump-go-spec=file โ€” for input files in any language, generates corresponding Go declarations in file. This spits out Go const, type, var, and func declarations, which may be a genuinely useful way to start writing a Go interface to code that was written in some other language. main character crossover episode ๐Ÿน
  • @file โ€” reads command-line options from file. The options that get read are inserted in place of the original @file option. If file does not exist, or cannot be read, then the option will be treated literally, and not removed. Options inside file are separated by whitespace. A whitespace character may be included in an option by surrounding the entire option in either single or double quotes. Any character (including a backslash) may be included by prefixing the character to be included with a backslash. And plot twist: the file may itself contain additional @file options, and any such options will be processed recursively ๐Ÿ˜ญ it's giving inception

โœจ Compiling C++ Programs โœจ

C++ source files conventionally use one of the suffixes .C, .cc, .cpp, .CPP, .c++, .cp, or .cxx; C++ header files often use .hh, .hpp, .H, or (for shared template code) .tcc; and preprocessed C++ files use the suffix .ii. GCC recognizes files with these names and compiles them as C++ programs even if you call the compiler the same way as you would for compiling C programs (usually with the name gcc). the way it just knows ๐Ÿ˜Œ

However โ€” and this is the important part, bestie โ€” the use of gcc does not add the C++ library. g++ is a program that calls GCC and automatically specifies linking against the C++ library. It treats .c, .h and .i files as C++ source files instead of C source files unless -x is used. This program is also useful when precompiling a C header file with a .h extension for use in C++ compilations. On many systems, g++ is also installed with the name c++. two names, one icon ๐Ÿ’…

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. pick your fighter ๐ŸŒˆ


๐ŸŽ€ Options Controlling C 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:

  • -ansi โ€” in C mode, this is equivalent to -std=c90. In C++ mode, it is equivalent to -std=c++98.

This turns off certain features of GCC that are incompatible with ISO C90 (when compiling C code), or of standard C++ (when compiling C++ code), such as the asm and typeof keywords, and predefined macros such as unix and vax that identify the type of system you are using. It also enables the undesirable and rarely used ISO trigraph feature. For the C compiler, it disables recognition of C++ style // comments as well as the inline keyword. rip to your vibes if you liked those ๐Ÿ’€

The alternate keywords __asm__, __extension__, __inline__ and __typeof__ continue to work despite -ansi. You would not want to use them in an ISO C program, of course, but it is useful to put them in header files that might be included in compilations done with -ansi. Alternate predefined macros such as __unix__ and __vax__ are also available, with or without -ansi.

The -ansi option does not cause non-ISO programs to be rejected gratuitously. For that, -Wpedantic is required in addition to -ansi. no cap, you need both ๐Ÿซถ

The macro __STRICT_ANSI__ is predefined when the -ansi option is used. Some header files may notice this macro and refrain from declaring certain functions or defining certain macros that the ISO standard doesn't call for; this is to avoid interfering with any programs that might use these names for other things.

Functions that are normally built in but do not have semantics defined by ISO C (such as alloca and ffs) are not built-in functions when -ansi is used.

  • -std= โ€” determines the language standard. This option is currently only supported when compiling C or C++. periodt โœจ

The compiler can accept several base standards, such as c90 or c++98, and GNU dialects of those standards, such as gnu90 or 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, -std=c90 turns off certain features of GCC that are incompatible with ISO C90, such as the asm and typeof keywords, but not other GNU extensions that do not have a meaning in ISO C90, such as omitting the middle term of a ?: 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 -Wpedantic to identify which features are GNU extensions given that version of the standard. For example -std=gnu90 -Wpedantic warns about C++ style // comments, while -std=gnu99 -Wpedantic does not. ๐Ÿ’–

A value for this option must be provided; possible values are

  • c90, c89, iso9899:1990 โ€” supports all ISO C90 programs (certain GNU extensions that conflict with ISO C90 are disabled). Same as -ansi for C code.
  • iso9899:199409 โ€” ISO C90 as modified in amendment 1.
  • c99, c9x, iso9899:1999, 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 https://gcc.gnu.org/c99status.html for more information. The names c9x and iso9899:199x are deprecated.
  • c11, c1x, 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 c1x is deprecated.
  • c17, c18, iso9899:2017, 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 -std=c11) and a new value of __STDC_VERSION__, and so is supported to the same extent as C11.
  • c23, c2x, iso9899:2024 โ€” ISO C23, the 2023 revision of the ISO C standard (expected to be published in 2024). The support for this version is experimental and incomplete. The name c2x is deprecated.
  • gnu90, gnu89 โ€” GNU dialect of ISO C90 (including some C99 features).
  • gnu99, gnu9x โ€” GNU dialect of ISO C99. The name gnu9x is deprecated.
  • gnu11, gnu1x โ€” GNU dialect of ISO C11. The name gnu1x is deprecated.
  • gnu17, gnu18 โ€” GNU dialect of ISO C17. This is the default for C code ๐Ÿ‘‘
  • gnu23, gnu2x โ€” 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 gnu2x is deprecated.
  • c++98, c++03 โ€” the 1998 ISO C++ standard plus the 2003 technical corrigendum and some additional defect reports. Same as -ansi for C++ code.
  • gnu++98, gnu++03 โ€” GNU dialect of -std=c++98.
  • c++11, c++0x โ€” the 2011 ISO C++ standard plus amendments. The name c++0x is deprecated.
  • gnu++11, gnu++0x โ€” GNU dialect of -std=c++11. The name gnu++0x is deprecated.
  • c++14, c++1y โ€” the 2014 ISO C++ standard plus amendments. The name c++1y is deprecated.
  • gnu++14, gnu++1y โ€” GNU dialect of -std=c++14. The name gnu++1y is deprecated.
  • c++17, c++1z โ€” the 2017 ISO C++ standard plus amendments. The name c++1z is deprecated.
  • gnu++17, gnu++1z โ€” GNU dialect of -std=c++17. This is the default for C++ code. The name gnu++1z is deprecated.
  • c++20, c++2a โ€” the 2020 ISO C++ standard plus amendments. Support is experimental, and could change in incompatible ways in future releases. The name c++2a is deprecated.
  • gnu++20, gnu++2a โ€” GNU dialect of -std=c++20. Support is experimental, and could change in incompatible ways in future releases. The name gnu++2a is deprecated.
  • c++2b, c++23 โ€” bestie this is the next revision of the ISO C++ standard, planned for 2023. Support is highly experimental, and will almost certainly change in incompatible ways in future releases. So likeโ€ฆ vibe check before you ship it ๐Ÿ’€
  • gnu++2b, gnu++23 โ€” the GNU dialect of -std=c++2b. Support is highly experimental, and will almost certainly change in incompatible ways in future releases. Same warning, same energy ๐Ÿซถ
  • c++2c, c++26 โ€” 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. Yes we're already talking about 2026, she's planning ahead โœจ
  • gnu++2c, gnu++26 โ€” the GNU dialect of -std=c++2c. Support is highly experimental, and will almost certainly change in incompatible ways in future releases. No cap ๐ŸŽ€

  • -aux-info filename โ€” okay so this one outputs prototyped declarations to the filename you give it, for all functions declared and/or defined in a translation unit, header file ones included. And ngl? It's silently ignored in any language other than C. Like it justโ€ฆ doesn't happen ๐Ÿ™ˆ

Besides the declarations, the file also tells you, in comments, the origin of each declaration (source file and line), whether the declaration was implicit, prototyped or unprototyped (I, N for new or 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 (C or 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. So many little letters, she's thorough ๐Ÿ’…

  • -fno-asm โ€” do not recognize asm, inline or typeof as a keyword, so your code can use these words as identifiers. You can use the keywords __asm__, __inline__ and __typeof__ instead. In C, -ansi implies -fno-asm.

In C++, inline is a standard keyword and is not affected by this switch. You may want to use the -fno-gnu-keywords flag instead, which disables typeof but not asm and inline. In C99 mode (-std=c99 or -std=gnu99), this switch only affects the asm and typeof keywords, since inline is a standard keyword in ISO C99. In C23 mode (-std=c23 or -std=gnu23), this switch only affects the asm keyword, since typeof is a standard keyword in ISO C23. She's doing the math per-standard, iconic ๐Ÿงš

  • -fno-builtin
  • -fno-builtin-function โ€” don't recognize built-in functions that do not begin with __builtin_ as prefix.

GCC normally generates special code to handle certain built-in functions more efficiently; for instance, calls to alloca may become single instructions which adjust the stack directly, and calls to 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 -Wformat for bad calls to printf when printf is built in and strlen is known not to modify global memory. So it's giving optimized but also lowkey invisible, iykyk โœจ

With the -fno-builtin-function option only the built-in function function is disabled. function must not begin with __builtin_. If a function is named that is not built-in in this version of GCC, this option is ignored. There is no corresponding -fbuiltin-function option; if you wish to enable built-in functions selectively when using -fno-builtin or -ffreestanding, you may define macros such as:

#define abs(n)          __builtin_abs ((n))
#define strcpy(d, s)    __builtin_strcpy ((d), (s))
  • -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++. Sorry C++ girlies, not today ๐Ÿ’€
  • -ffreestanding โ€” assert that compilation targets a freestanding environment. This implies -fno-builtin. A freestanding environment is one in which the standard library may not exist, and program startup may not necessarily be at main. The most obvious example is an OS kernel. This is equivalent to -fno-hosted. Main character energy but make it no main ๐Ÿ‘‘
  • -fgimple โ€” enable parsing of function definitions marked with __GIMPLE. This is an experimental feature that allows unit testing of GIMPLE passes. Very niche, very cute ๐ŸŽ€
  • -fgnu-tm โ€” when the 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,

Note that the transactional memory feature is not supported with non-call exceptions (-fnon-call-exceptions). Bestie that sentence just ends, I'm not fixing it, I'm reporting it fr fr ๐Ÿ˜ญ

  • -fgnu89-inline โ€” the option -fgnu89-inline tells GCC to use the traditional GNU semantics for inline functions when in C99 mode.

Using this option is roughly equivalent to adding the gnu_inline function attribute to all inline functions.

The option -fno-gnu89-inline explicitly tells GCC to use the C99 semantics for inline when in C99 or gnu99 mode (i.e., it specifies the default behavior). This option is not supported in -std=c90 or -std=gnu90 mode.

The preprocessor macros __GNUC_GNU_INLINE__ and __GNUC_STDC_INLINE__ may be used to check which semantics are in effect for inline functions. Two little macros, your inline detective squad ๐Ÿ”

  • -fhosted โ€” assert that compilation targets a hosted environment. This implies -fbuiltin. A hosted environment is one in which the entire standard library is available, and in which main has a return type of int. Examples are nearly everything except a kernel. This is equivalent to -fno-freestanding. Basically the default girlie life ๐Ÿ’–
  • -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. Ma'am that's a red flag, please don't ๐Ÿšฉ
  • -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.

typedef int UOW;
struct ABC {
  UOW UOW;
};

Some cases of unnamed fields in structures and unions are only accepted with this option.

Note that this option is off for all targets except for x86 targets using ms-abi. Not me learning x86 has special privileges ๐Ÿ’…

  • -foffload=disable
  • -foffload=default
  • -foffload=target-list โ€” specify for which OpenMP and OpenACC offload targets code should be generated. The default behavior, equivalent to -foffload=default, is to generate code for all supported offload targets. The -foffload=disable form generates code only for the host fallback, while -foffload=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 -v to show the list of configured offload targets under OFFLOAD_TARGET_NAMES. Peep the list, bestie โœจ

  • -foffload-options=options
  • -foffload-options=target-triplet-list=options โ€” with -foffload-options=options, GCC passes the specified 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 -foffload-options=target-list=options form. The target-list is a comma-separated list in the same format as for the -foffload= option.

Typical command lines are

-foffload-options='-fno-math-errno -ffinite-math-only' -foffload-options=nvptx-none=-latomic
-foffload-options=amdgcn-amdhsa=-march=gfx906
  • -fopenacc โ€” enable handling of OpenACC directives #pragma acc in C/C++ and !$acc in free-form Fortran and !$acc, c$acc and *$acc in fixed-form Fortran. When -fopenacc is specified, the compiler generates accelerated code according to the OpenACC Application Programming Interface v2.6 <https://www.openacc.org>. This option implies -pthread, and thus is only supported on targets that have support for -pthread. Accelerated girlie behavior ๐Ÿ”ฅ
  • -fopenacc-dim=geom โ€” specify default compute dimensions for parallel offload regions that do not explicitly specify. The geom value is a triple of ':'-separated sizes, in order 'gang', 'worker' and, 'vector'. A size can be omitted, to use a target-specific default value. Pick your dimensions, queen ๐Ÿ‘‘
  • -fopenmp โ€” enable handling of OpenMP directives #pragma omp, [[omp::directive(...)]], [[omp::sequence(...)]] and [[omp::decl(...)]] in C/C++ and !$omp in Fortran. It additionally enables the conditional compilation sentinel !$ in Fortran. In fixed source form Fortran, the sentinels can also start with c or *. When -fopenmp is specified, the compiler generates parallel code according to the OpenMP Application Program Interface v4.5 <https://www.openmp.org>. This option implies -pthread, and thus is only supported on targets that have support for -pthread. -fopenmp implies -fopenmp-simd. Parallel processing, she ate that ๐ŸŒˆ
  • -fopenmp-simd โ€” enable handling of OpenMP's simd, declare simd, declare reduction, assume, ordered, scan and loop directive, and of combined or composite directives with simd as constituent with #pragma omp, [[omp::directive(...)]], [[omp::sequence(...)]] and [[omp::decl(...)]] in C/C++ and !$omp in Fortran. It additionally enables the conditional compilation sentinel !$ in Fortran. In fixed source form Fortran, the sentinels can also start with c or *. Other OpenMP directives are ignored. Unless -fopenmp is additionally specified, the loop region binds to the current task region, independent of the specified bind clause. Just the simd bits, nothing else, stay in your lane bestie ๐Ÿฆ‹
  • -fopenmp-target-simd-clone
  • -fopenmp-target-simd-clone=device-type โ€” so normally GCC makes SIMD clones for functions marked with the declare simd directive, right? But with this option on, it ALSO makes clones for functions marked with the OpenMP declare target directive, as long as they're the kind that can actually get vectorized. Bestie, the device-type can be none, host, nohost, or any, and those line up exactly with the keywords for the device_type clause of the declare target directive โ€” clones get generated for the intersection of the devices you specified. Oh and fyi: -fopenmp-target-simd-clone is the same thing as -fopenmp-target-simd-clone=any, and -fno-openmp-target-simd-clone is the same as -fopenmp-target-simd-clone=none. โœจ

At -O2 and higher (but not -Os or -Og) this optimization defaults to -fopenmp-target-simd-clone=nohost. Otherwise? Disabled by default. No cap. ๐Ÿ’…

  • -fpermitted-flt-eval-methods=style โ€” okay so ISO/IEC TS 18661-3 defines some new permissible values for FLT_EVAL_METHOD, and what they say is that operations and constants with a semantic type that's an interchange or extended format should be evaluated to the precision and range of that type. These new values are a superset of what C99/C11 allow, and C99/C11 doesn't even specify what the other positive values of FLT_EVAL_METHOD mean. Which means, and this is the tea โ˜•, code that conforms to C11 may not have been written expecting these new values to be possible at all.

-fpermitted-flt-eval-methods specifies whether the compiler should allow only the values of FLT_EVAL_METHOD specified in C99/C11, or the extended set of values specified in ISO/IEC TS 18661-3.

style is either c11 or ts-18661-3, whichever fits your vibe.

The default when you're in a standards compliant mode (-std=c11 or similar) is -fpermitted-flt-eval-methods=c11. The default when you're in a GNU dialect (-std=gnu11 or similar) is -fpermitted-flt-eval-methods=ts-18661-3. ๐ŸŽ€

The -fdeps-* options are used to extract structured dependency information for a source. What does that even mean? It means determining what resources provided by other source files will be required to compile the source, plus what resources the source itself provides. This info can be used to add required dependencies between compilation rules of dependent sources based on their contents, instead of requiring that information be reflected within the build tools as well. It's giving organized. ๐Ÿ—‚๏ธ

  • -fdeps-file=file โ€” where to write structured dependency information.
  • -fdeps-format=format โ€” the format to use for structured dependency information. p1689r5 is the only supported format right now. Heads up bestie: when this argument is specified, the output of -MF is stripped of some information (namely C++ modules) so that it doesn't use extended makefile syntax that most tools wouldn't understand anyway. ๐Ÿ™ˆ
  • -fdeps-target=file โ€” analogous to -MT but for structured dependency information. This indicates the target which will ultimately need any required resources and provide any resources extracted from the source that may be required by other sources.
  • -fplan9-extensions โ€” accept some non-standard constructs used in Plan 9 code.

This enables -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. And the catch: this is only supported for C, not C++. ๐Ÿ˜ญ

  • -fsigned-bitfields
  • -funsigned-bitfields
  • -fno-signed-bitfields
  • -fno-unsigned-bitfields โ€” these options control whether a bit-field is signed or unsigned when the declaration doesn't use either signed or unsigned. By default, such a bit-field is signed, because that's consistent: the basic integer types like int are signed types. Consistent queen behavior. ๐Ÿ‘‘
  • -fsigned-char โ€” let the type char be signed, like signed char.

Note that this is equivalent to -fno-unsigned-char, which is the negative form of -funsigned-char. Likewise, the option -fno-signed-char is equivalent to -funsigned-char. The way these flip around is so real. ๐Ÿฆ‹

  • -funsigned-char โ€” let the type char be unsigned, like unsigned char.

Every kind of machine has a default for what char should be. It's either like unsigned char by default or like signed char by default.

Ideally, a portable program should always use signed char or unsigned char when it depends on the signedness of an object. But so many programs were written to use plain char and expect it to be signed, or expect it to be unsigned, depending on the machines they were written for. This option, and its inverse, let you make such a program work with the opposite default. Slay, backwards compatibility. ๐Ÿ’–

The type char is always a distinct type from each of signed char or unsigned char, even though its behavior is always just like one of those two. It's literally its own thing.

  • -fstrict-flex-arrays (C and C++ only)
  • -fstrict-flex-arrays=level (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 level controls the level of strictness.

-fstrict-flex-arrays is equivalent to -fstrict-flex-arrays=3, which is the strictest: all trailing arrays of structures are treated as flexible array members.

The negative form -fno-strict-flex-arrays is equivalent to -fstrict-flex-arrays=0, which is the least strict. In this case, a trailing array is treated as a flexible array member only when it's declared as a flexible array member per C99 standard onwards.

The possible values of level are the same as for the strict_flex_array attribute.

You can control this behavior for a specific trailing array field of a structure by using the variable attribute strict_flex_array attribute.

Also, the -fstrict_flex_arrays option interacts with the -Wstrict-flex-arrays option. They're besties. ๐Ÿซถ

  • -fsso-struct=endianness โ€” set the default scalar storage order of structures and unions to the specified endianness. The accepted values are big-endian, little-endian, and native for the native endianness of the target (which is the default). And ngl, this option is not supported for C++.
โš ๏ธ Warning: the -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. Like, do not mix them. Fr fr. ๐Ÿ’€

๐ŸŒธ Options Controlling C++ Dialect ๐ŸŒธ

This section describes the command-line options that are only meaningful for C++ programs. But lowkey, 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 firstClass.C like this:

g++ -g -fstrict-enums -O -c firstClass.C

In this example, only -fstrict-enums is an option meant only for C++ programs; you can use the other options with any language supported by GCC. Iconic. โœจ

Some options for compiling C programs, such as -std, are also relevant for C++ programs.

Here's the list of options that are only for compiling C++ programs:

  • -fabi-version=n โ€” use version 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 get fixed. (Chaotic? A little. But that's just how it is.)

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, 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 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. 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 -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. (Not the accidental change bestie ๐Ÿ˜ญ)

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 __alignof__ to be distinct from that of 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 appeard in G++ 13, fixes manglings of lambdas that have additional context.

Version 19, which first appeard in G++ 14, fixes manglings of structured bindings to include ABI tags.

See also -Wabi. ๐Ÿ‘€

  • -fabi-compat-version=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 -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 -fabi-compat-version=2.

If this option is not provided but -Wabi=n is, that version is used for compatibility aliases. If this option is provided along with -Wabi (without the version), the version from this option is used for the warning.


  • -fno-access-control โ€” bestie, this one just turns off ALL the access checking. Itโ€™s mainly for working around bugs in the access control code. Use it when the compilerโ€™s being extra and you need a workaround, okay? ๐Ÿ’…
  • -faligned-new โ€” โœจ Enables support for C++17 new of types that require more alignment than void* ::operator new(std::size_t) provides. You can pass a numeric argument like -faligned-new=32 to specify how much alignment (in bytes) that function provides, but few users will need to override the default of alignof(std::max_align_t).

This flag is enabled by default for -std=c++17. ๐ŸŽ€

  • -fchar8_t
  • -fno-char8_t โ€” Enable support for char8_t as adopted for C++20. This includes the addition of a new 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 __cpp_char8_t and __cpp_lib_char8_t feature test macros.

This option enables functions to be overloaded for ordinary and UTF-8 strings:

int f(const char *);    // #1
int f(const char8_t *); // #2
int v1 = f("text");     // Calls #1
int v2 = f(u8"text");   // Calls #2

and introduces new signatures for user-defined literals:

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;

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 -fchar8_t is specified.

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
  • -fcheck-new โ€” Check that the pointer returned by operator new is non-null before attempting to modify the storage allocated. This check is normally unnecessary because the C++ standard specifies that operator new only returns 0 if it is declared throw(), in which case the compiler always checks the return value even without this option. In all other cases, when operator new has a non-empty exception specification, memory exhaustion is signalled by throwing std::bad_alloc. See also new (nothrow).
  • -fconcepts
  • -fconcepts-ts โ€” Enable support for the C++ Concepts feature for constraining template arguments. With -std=c++20 and above, Concepts are part of the language standard, so -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, can additionally be enabled by -fconcepts-ts. The option -fconcepts-ts was deprecated in GCC 14 and may be removed in GCC 15; users are expected to convert their code to C++20 concepts.

  • -fconstexpr-depth=n โ€” Set the maximum nested evaluation depth for C++11 constexpr functions to n. A limit is needed to detect endless recursion during constant expression evaluation. The minimum specified by the standard is 512.
  • -fconstexpr-cache-depth=n โ€” Set the maximum level of nested evaluation depth for C++11 constexpr functions that will be cached to 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. ๐Ÿ”ฅ
  • -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.
constexpr float inf = 1./0.; // OK with -fconstexpr-fp-except
  • -fconstexpr-loop-limit=n โ€” Set the maximum number of iterations for a loop in C++14 constexpr functions to n. A limit is needed to detect infinite loops during constant expression evaluation. The default is 262144 (1<<18).
  • -fconstexpr-ops-limit=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).
  • -fcontracts โ€” Enable experimental support for the C++ Contracts feature, as briefly added to and then removed from the C++20 working paper (N4820). The implementation also includes proposed enhancements from papers P1290, P1332, and P1429. This functionality is intended mostly for those interested in experimentation towards refining the feature to get it into shape for a future C++ standard.

On violation of a checked contract, the violation handler is called. Users can replace the violation handler by defining

void
handle_contract_violation (const std::experimental::contract_violation&);

There are different sets of additional flags that can be used together to specify which contracts will be checked and how, for N4820 contracts, P1332 contracts, or P1429 contracts; these sets cannot be used together.

  • -fcontract-mode=[on|off] โ€” Control whether any contracts have any semantics at all. Defaults to on.
  • -fcontract-assumption-mode=[on|off] โ€” [N4820] Control whether contracts with level axiom should have the assume semantic. Defaults to on.
  • -fcontract-build-level=[off|default|audit] โ€” [N4820] Specify which level of contracts to generate checks for. Defaults to default.
  • -fcontract-continuation-mode=[on|off] โ€” [N4820] Control whether to allow the program to continue executing after a contract violation. That is, do checked contracts have the maybe semantic described below rather than the never semantic. Defaults to off.
  • -fcontract-role=<name>:<default>,<audit>,<axiom> โ€” [P1332] Specify the concrete semantics for each contract level of a particular contract role.
  • -fcontract-semantic=[default|audit|axiom]:<semantic> โ€” [P1429] Specify the concrete semantic for a particular contract level.
  • -fcontract-strict-declarations=[on|off] โ€” Control whether to reject adding contracts to a function after its first declaration. Defaults to off.

The possible concrete semantics for that can be specified with -fcontract-role or -fcontract-semantic are:

  • "ignore" โ€” This contract has no effect.
  • "assume" โ€” This contract is treated like C++23 [[assume]].
  • "check_never_continue", "never", "abort" โ€” This contract is checked. If it fails, the violation handler is called. If the handler returns, std::terminate is called.
  • "check_maybe_continue", "maybe" โ€” This contract is checked. If it fails, the violation handler is called. If the handler returns, execution continues normally.
  • -fcoroutines โ€” Enable support for the C++ coroutines extension (experimental). ๐Ÿฆ‹
  • -fdiagnostics-all-candidates โ€” Permit the C++ front end to note all candidates during overload resolution failure, including when a deleted function is selected.
  • -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.

  • -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 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.
โš ๏ธ bestie, that last one is giving โ€œI know better than the standardโ€ energy. It violates the C++ standard and can cause undefined behavior at runtime if you throw an unexpected exception. Be careful! ๐Ÿ’€
  • -fextern-tls-init, -fno-extern-tls-init โ€” okay so the C++11 and OpenMP standards let thread_local and threadprivate variables have dynamic (runtime) initialization, right? And to make that work, every single use of such a variable has to go through a lil wrapper function that does the init if it needs doing ๐Ÿซถ. When the use and the definition live in the same translation unit, that overhead can just get optimized away, no biggie. But when the use is in a different translation unit?? ๐Ÿ’€ huge overhead, even if the variable literally doesn't need dynamic initialization at all. So if you the programmer can be 100% sure that no use of the variable in a non-defining TU needs to trigger dynamic init โ€” either because the variable is statically initialized, or because a use in the defining TU will run before any uses in another TU โ€” then bestie you can yeet that overhead with -fno-extern-tls-init. On targets that support symbol aliases, the default is -fextern-tls-init. On targets that don't support symbol aliases, the default is -fno-extern-tls-init.
  • -ffold-simple-inlines, -fno-fold-simple-inlines โ€” lets the C++ frontend fold calls to std::move, std::forward, std::addressof and std::as_const. And no, it's not the same as inlining โ€” unlike inlining, this means no debug information gets generated for those calls at all. Since these functions are rarely interesting to debug, this flag is enabled by default unless -fno-inline is active. periodt โœจ
  • -fno-gnu-keywords โ€” do NOT recognize typeof as a keyword, so your code can use that word as an identifier ๐Ÿ’…. You can use the keyword __typeof__ instead. This option is implied by the strict ISO C++ dialects: -ansi, -std=c++98, -std=c++11, etc.
  • -fno-immediate-escalation โ€” don't enable immediate function escalation, the thing where certain functions can get promoted to consteval, as specified in P2564R3. Like, for 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);
}

This compiles in C++20: f is an immediate-escalating function (because of the auto it's a function template, and it's declared constexpr) and id(t) is an immediate-escalating expression, so f gets promoted to consteval ๐Ÿ‘‘. Consequently, the call to id(t) is in an immediate context, so it doesn't have to produce a constant (that's literally the mechanism allowing consteval function composition, iykyk). BUT ๐Ÿ˜ญ with -fno-immediate-escalation, f is not promoted to consteval, and since the call to consteval function id(t) is not a constant expression, the compiler just rejects the code. This option is turned on by default; it is only effective in C++20 mode or later.

  • -fimplicit-constexpr โ€” makes inline functions implicitly constexpr, if they satisfy the requirements for a constexpr function ๐ŸŒธ. You can use this in C++14 mode or later. This can result in initialization changing from dynamic to static, plus other optimizations. slay.
  • -fno-implicit-templates โ€” never emit code for non-inline templates that get instantiated implicitly (i.e. by use); only emit code for explicit instantiations. And bestie, heads up ๐Ÿšจ: if you use this option you must take care to structure your code to include all the necessary explicit instantiations, otherwise you're getting undefined symbols at link time. not fun.
  • -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 ๐Ÿ’œ.
  • -fno-implement-inlines โ€” to save space, do not emit out-of-line copies of inline functions controlled by #pragma implementation. Warning though: this causes linker errors if those functions are not inlined everywhere they're called ๐Ÿ™ˆ.
  • -fmodules-ts, -fno-modules-ts โ€” enable support for C++20 modules ๐Ÿฆ‹. The -fno-modules-ts is usually not needed, since that's the default. And even though this is a C++20 feature, it is not currently implicitly enabled by selecting that standard version. ik, wild.
  • -fmodule-header, -fmodule-header=user, -fmodule-header=system โ€” compile a header file to create an importable header unit โœจ.
  • -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 โ€” no in-between, fr fr. (Such definitions outside of a named module remain implicitly inline, regardless.)
  • -fno-module-lazy โ€” disable lazy module importing and module mapper creation ๐Ÿ˜ด.
  • -fmodule-mapper=[hostname]:port[?ident], -fmodule-mapper=|program[?ident] args..., -fmodule-mapper==socket[?ident], -fmodule-mapper=<>[inout][?ident], -fmodule-mapper=<in>out[?ident], -fmodule-mapper=file[?ident] โ€” an oracle to query for module name to filename mappings ๐Ÿ”ฎ. If unspecified, the CXX_MODULE_MAPPER environment variable is used, and if that is unset, an in-process default is provided.
  • -fmodule-only โ€” only emit the Compiled Module Interface, inhibiting any object file. just the CMI, nothing else ๐Ÿ’–.
  • -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. we don't need the nagging here ๐ŸŽ€.
  • -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 -fabi-version=10 or lower is specified.
  • -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 -std=c++17.
  • -fno-nonansi-builtins โ€” disable built-in declarations of functions that are not mandated by ANSI/ISO C. These include ffs, alloca, _exit, index, bzero, conjf, and other related functions ๐Ÿซถ.
  • -fnothrow-opt โ€” treat a throw() exception specification as if it were a noexcept specification, to reduce or eliminate the text size overhead relative to a function with no exception specification. And get this: 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 terminate rather than unexpected. noted ๐Ÿ’€.
  • -fno-operator-names โ€” do not treat the operator name keywords and, bitand, bitor, compl, not, or and xor as synonyms as keywords.
  • -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 ๐Ÿ™ˆ.
  • -fno-pretty-templates โ€” so 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. void f(T) [with T = int] rather than void f(int)) so that it's clear which template is involved ๐ŸŒˆ. And 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. But if either of these behaviors makes it harder to understand the error message rather than easier, you can use -fno-pretty-templates to disable them. your call bestie ๐Ÿ’….
  • -fno-rtti โ€” disable generation of information about every class with virtual functions for use by the C++ run-time type identification features (dynamic_cast and 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 dynamic_cast operator can still be used for casts that do not require run-time type information, i.e. casts to void * or to unambiguous base classes. Mixing code compiled with -frtti with that compiled with -fno-rtti may not work ๐Ÿ˜ญ. For example, programs may fail to link if a class compiled with -fno-rtti is used as a base for a class compiled with -frtti.
  • -fsized-deallocation โ€” enable the built-in global declarations
void operator delete (void *, std::size_t) noexcept;
void operator delete[] (void *, std::size_t) noexcept;

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 -std=c++14 and above. The flag -Wsized-deallocation warns about places that might want to add a definition.

  • -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.
  • -fstrong-eval-order โ€” 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 ๐Ÿ”ฅ. Enabled by default with -std=c++17. -fstrong-eval-order=some enables just the ordering of member access and shift expressions, and is the default without -std=c++17.
  • *-ftemplate-backtrace-limit=n* โ€” set the maximum number of template instantiation notes for a single warning or error to n ๐Ÿ˜ญ. The default value is 10. (Because 10 notes is already a lot to read, bestie.)
  • -ftemplate-depth=n โ€” sets the max instantiation depth for template classes to n. bestie, why do we even need a ceiling? because endless recursion during template class instantiation is a real thing and we need to catch it ๐Ÿ˜ญ. ANSI/ISO C++ conforming programs must not rely on a maximum depth greater than 17 (this got changed to 1024 in C++11). the default value is 900, because sometimes the compiler runs out of stack space before it even hits 1024. so likeโ€ฆ 900 is the vibe. โœจ
  • -fno-threadsafe-statics โ€” do not emit the extra code that uses the routines specified in the C++ ABI for thread-safe initialization of local statics. you'd use this to shave a lil bit off the code size in code that doesn't need to be thread-safe. lowkey a niche flex but ok ๐ŸŽ€
  • -fuse-cxa-atexit โ€” registers destructors for objects with static storage duration with the __cxa_atexit function instead of the atexit function. this option is required for fully standards-compliant handling of static destructors, but heads up โ€” it only works if your C library supports __cxa_atexit. no support, no slay ๐Ÿ™ˆ
  • -fno-use-cxa-get-exception-ptr โ€” don't use the __cxa_get_exception_ptr runtime routine. this makes std::uncaught_exception incorrect ๐Ÿ˜ญ but it's necessary if the runtime routine isn't available. tradeoffs, bestie, tradeoffs.
  • -fvisibility-inlines-hidden โ€” this switch declares that the user is not attempting 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 __attribute__ ((visibility ("hidden"))) so that they don't appear in the export table of a DSO and don't require a PLT indirection when used within the DSO. turning this on can have a dramatic effect on load and link times of a DSO, because it massively reduces the size of the dynamic export table when the library makes heavy use of templates. it's giving glow-up for your link times fr fr ๐Ÿ”ฅ

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.

  • -fvisibility-ms-compat โ€” this flag attempts to use visibility settings to make GCC's C++ linkage model compatible with that of Microsoft Visual Studio. yes, that Microsoft Visual Studio ๐Ÿ‘€

the flag makes these changes to GCC's linkage model:

  1. it sets the default visibility to hidden, like -fvisibility=hidden.
  2. types, but not their members, are not hidden by default.
  3. 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.

in new code it's better to use -fvisibility=hidden and export those classes that are intended to be externally visible. unfortunately, it's 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. โš ๏ธ

  • -fno-weak โ€” do not use weak symbol support, even if it's provided by the linker. by default, G++ uses weak symbols if they're available. > this option exists only for testing and should not be used by end-users; it results in inferior code and has no benefits. it may be removed in a future release of G++. not me warning you twice ๐Ÿ’€
  • -fext-numeric-literals (C++ and Objective-C++ only) โ€” accept imaginary, fixed-point, or machine-defined literal number suffixes as GNU extensions. when this option is turned off, those suffixes are treated as C++11 user-defined literal numeric suffixes. it's on by default for all pre-C++11 dialects and all GNU dialects: -std=c++98, -std=gnu++98, -std=gnu++11, -std=gnu++14. it's off by default for ISO C++11 onwards (-std=c++11, ...). โœจ
  • -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.) ๐ŸŽ€
  • -flang-info-include-translate
  • -flang-info-include-translate-not
  • -flang-info-include-translate=header โ€” inform of include translation events. the first will note accepted include translations, the second will note declined include translations. the header form will inform of include translations relating to that specific header. if header is of the form "user" or <system> it will be resolved to a specific user or system header using the include path. ๐Ÿฆ‹
  • -flang-info-module-cmi
  • -flang-info-module-cmi=module โ€” inform of Compiled Module Interface pathnames. the first will note all read CMI pathnames. the module form will not reading a specific module's CMI. module may be a named module or a header-unit (the latter indicated by either being a pathname containing directory separators or enclosed in <> or "").
  • -stdlib=libstdc++,libc++ โ€” when G++ is configured to support this option, it allows specification of alternate C++ runtime libraries. two options are available: libstdc++ (the default, native C++ runtime for G++) and 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 -lstdc++ or -lc++ respectively, when a C++ runtime is required for linking. pick your fighter ๐Ÿ’…

in addition, these warning options have meanings only for C++ programs:

  • -Wabi-tag (C++ and Objective-C++ only) โ€” warn when a type with an ABI tag is used in a context that doesn't have that ABI tag. see C++ Attributes for more info about ABI tags. ๐Ÿท๏ธ
  • -Wcomma-subscript (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 ( ) is not deprecated. example:
void f(int *a, int b, int c) {
    a[b,c];     // deprecated in C++20, invalid in C++23
    a[(b,c)];   // OK
}

in C++23 it's 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 -Wno-comma-subscript.

enabled by default with -std=c++20 unless -Wno-deprecated, and with -std=c++23 regardless of -Wno-deprecated.

this warning is upgraded to an error by -pedantic-errors in C++23 mode or later. ๐Ÿ˜ณ
  • -Wctad-maybe-unsupported (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:
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>;
  • -Wctor-dtor-privacy (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. it's givingโ€ฆ locked out of your own house ๐Ÿ ๐Ÿ”’
  • -Wdangling-reference (C++ and Objective-C++ only) โ€” warn when a reference is bound to a temporary whose lifetime has ended. for example:
int n = 1;
const int& r = std::max(n - 1, n + 1); // r is dangling

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 r is dangling. ๐Ÿ˜ญ

this warning also detects dangling references in member initializer lists:

const int& f(const int& i) { return i; }
struct S {
  const int &r; // r is dangling
  S() : r(f(10)) { }
};

member functions are checked as well, but only their object argument:

struct S {
   const S& self () { return *this; }
};
const S& s = S().self(); // s is dangling

certain functions are safe in this respect, for example 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 #pragma:

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdangling-reference"
const T& foo (const T&) { ... }
#pragma GCC diagnostic pop

the #pragma can also surround the class; in that case, the warning will be disabled for all the member functions.

-Wdangling-reference also warns about code like

auto p = std::minmax(1, 2);

where std::minmax returns std::pair<const int&, const int&>, and both references dangle after the end of the full expression that contains the call to std::minmax. ๐Ÿ˜ญ like bestie the references are GONE the second that expression ends, do not touch them.

The warning does not warn for std::span-like classes. We consider classes of the form:

template<typename T>
struct Span {
  T* data_;
  std::size len_;
};

as std::span-like โ€” meaning: the class is a non-union class that has a pointer data member and a trivial destructor. โœจ That's the vibe check for "span-like", and those get a pass.

The warning can be disabled by using the gnu::no_dangling attribute. ๐ŸŽ€

This warning is enabled by -Wall.


  • -Wdelete-non-virtual-dtor (C++ and Objective-C++ only) โ€” Warn when delete is used to destroy an instance of a class that has virtual functions and a 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 -Wall.
  • -Wdeprecated-copy (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 -Wextra. With -Wdeprecated-copy-dtor, also deprecate if the class has a user-provided destructor.
  • -Wno-deprecated-enum-enum-conversion (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:
enum E1 { e };
enum E2 { f };
int k = f - e;

-Wdeprecated-enum-enum-conversion is enabled by default with -std=c++20. In pre-C++20 dialects, this warning can be enabled by -Wenum-conversion.

  • -Wno-deprecated-enum-float-conversion (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:
enum E1 { e };
enum E2 { f };
bool b = e <= 3.7;

-Wdeprecated-enum-float-conversion is enabled by default with -std=c++20. In pre-C++20 dialects, this warning can be enabled by -Wenum-conversion.

  • -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. ๐Ÿ”ฅ
  • -Wno-init-list-lifetime (C++ and Objective-C++ only) โ€” Do not warn about uses of std::initializer_list that are likely to result in dangling pointers. Since the underlying array for an 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:
    • If a function returns a temporary initializer_list, or a local initializer_list variable, the array's lifetime ends at the end of the return statement, so the value returned has a dangling pointer. ๐Ÿ’€
    • If a new-expression creates an initializer_list, the array only lives until the end of the enclosing full-expression, so the initializer_list in the heap has a dangling pointer.
    • When an 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 initializer_list variable has a dangling pointer.
// 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
  • When a list constructor stores the begin pointer from the initializer_list argument, this doesn't extend the lifetime of the array, so if a class variable is constructed from a temporary initializer_list, the pointer is left dangling by the end of the variable declaration statement. ๐Ÿ˜ญ
  • -Winvalid-constexpr โ€” Warn when a function never produces a constant expression. In C++20 and earlier, for every 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 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, -Winvalid-constexpr can be turned on, in which case it will be an ordinary warning. For example:

void f (int& i);
constexpr void
g (int& i)
{
  // Warns by default in C++20, in C++23 only with -Winvalid-constexpr.
  f(i);
}
  • -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. ๐Ÿซถ
  • -Wno-literal-suffix (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 <inttypes.h>. For example:
#define __STDC_FORMAT_MACROS
#include <inttypes.h>
#include <stdio.h>

int main() {
  int64_t i64 = 123;
  printf("My int64: %" PRId64"\n", i64);
}

In this case, 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.

  • -Wno-narrowing (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 -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 -Wnarrowing in C++98, warn when a narrowing conversion prohibited by C++11 occurs within { }, e.g.

int i = { 2.2 }; // error: narrowing from double to int

This flag is included in -Wall and -Wc++11-compat.

  • -Wnoexcept (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. throw() or noexcept) but is known by the compiler to never throw an exception. ๐Ÿ‘‘
  • -Wnoexcept-type (C++ and Objective-C++ only) โ€” Warn if the C++17 feature making noexcept part of a function type changes the mangled name of a symbol relative to C++14. Enabled by -Wabi and -Wc++17-compat.

As an example:

template <class T> void f(T t) { t(); };
void g() noexcept;
void h() { f(g); }

In C++14, f calls f<void(*)()>, but in C++17 it calls f<void(*)()noexcept>. ๐Ÿคฏ

  • -Wclass-memaccess (C++ and Objective-C++ only) โ€” Warn when the destination of a call to a raw memory function such as memset or 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 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. ๐ŸŽ€
std::string str = "abc";
memset (&str, 0, sizeof str);

The -Wclass-memaccess option is enabled by -Wall. Explicitly casting the pointer to the class object to void * or to a type that can be safely accessed by the raw memory function suppresses the warning.

  • -Wnon-virtual-dtor (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 -Weffc++ is specified. The -Wdelete-non-virtual-dtor option (enabled by -Wall) should be preferred because it warns about the unsafe cases without false positives. ๐Ÿ’…
  • -Wregister (C++ and Objective-C++ only) โ€” Warn on uses of the register storage class specifier, except when it is part of the GNU Explicit Register Variables extension. The use of the register keyword as storage class specifier has been deprecated in C++11 and removed in C++17. Enabled by default with -std=c++17. โญ
  • -Wreorder (C++ and Objective-C++ only) โ€” okay so bestie, this one yells at you when the order of your member initializers in the code doesn't match the order they actually get executed in. Because the compiler is gonna run them in declaration order whether you like it or not. Like, look at this mess:
struct A {
  int i;
  int j;
  A(): j (0), i (1) { }
};

The compiler rearranges the member initializers for i and j to match the declaration order of the members, and emits a warning to that effect. This warning is enabled by -Wall.

  • -Wno-pessimizing-move (C++ and Objective-C++ only) โ€” this one warns when a call to std::move is out here blocking copy elision. Rude, honestly. 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. Like:
struct T {
...
};
T fn()
{
  T t;
  ...
  return std::move (t);
}

But in this example, the std::move call prevents copy elision. ๐Ÿ’€

This warning is enabled by -Wall.

  • -Wno-redundant-move (C++ and Objective-C++ only) โ€” warns about redundant calls to std::move, meaning a move operation would have been performed even without the std::move call. It 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:
struct T {
...
};
T fn(T t)
{
  ...
  return std::move (t);
}

Here, the std::move call is redundant. Because G++ implements Core Issue 1579, another example is:

struct T { // convertible to U
...
};
struct U {
...
};
U fn()
{
  T t;
  ...
  return std::move (t);
}

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 -Wextra.

  • -Wrange-loop-construct (C++ and Objective-C++ only) โ€” this one calls out a C++ range-based for-loop that's making an unnecessary copy ๐Ÿซถ. This can happen when the range declaration is not a reference, but probably should be. For example:
struct S { char arr[128]; };
void fn () {
  S arr[5];
  for (const auto x : arr) { ... }
}

It does not warn when the type being copied is a trivially-copyable 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:

void fn() {
  int arr[10];
  for (const double &x : arr) { ... }
}

In the example above, in every iteration of the loop a temporary value of type double is created and destroyed, to which the reference const double & is bound. ๐Ÿ˜ญ

This warning is enabled by -Wall.

  • -Wredundant-tags (C++ and Objective-C++ only) โ€” warns 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:
struct foo;
struct foo *p;   // warn that keyword struct can be eliminated

On the other hand, in this example there is no warning:

struct foo;
void foo ();   // "hides" struct foo
void bar (struct foo&);  // no warning, keyword struct is necessary
  • -Wno-subobject-linkage (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. -Wsubobject-linkage is enabled by default.
  • -Weffc++ (C++ and Objective-C++ only) โ€” warns about violations of the following style guidelines from Scott Meyers' Effective C++ series of books ๐Ÿ“š:
    • Define a copy constructor and an assignment operator for classes with dynamically-allocated memory.
    • Prefer initialization to assignment in constructors.
    • Have operator= return a reference to *this.
    • Don't try to return a reference when you must return an object.
    • Distinguish between prefix and postfix forms of increment and decrement operators.
    • Never overload &&, ||, or ,.

This option also enables -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 grep -v to filter out those warnings.
  • -Wno-exceptions (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.
  • -Wstrict-null-sentinel (C++ and Objective-C++ only) โ€” warns about the use of an uncasted NULL as sentinel. When compiling only with GCC this is a valid sentinel, as NULL is defined to __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.
  • -Wno-non-template-friend (C++ and Objective-C++ only) โ€” disables 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 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.
  • -Wold-style-cast (C++ and Objective-C++ only) โ€” warns if an old-style (C-style) cast to a non-void type is used within a C++ program. The new-style casts (dynamic_cast, static_cast, reinterpret_cast, and const_cast) are less vulnerable to unintended effects and much easier to search for. glow up your casts bestie ๐Ÿ’…
  • -Woverloaded-virtual (C++ and Objective-C++ only)
  • -Woverloaded-virtual=n โ€” warns when a function declaration hides virtual functions from a base class. For example, in:
struct A {
  virtual void f();
};

struct B: public A {
  void f(int); // does not override
};

the A class version of f is hidden in B, and code like:

B* b;
b->f();

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 using A::f; to 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:

struct C {
  virtual void f();
  virtual void f(int);
};

struct D: public C {
  void f(int); // does override
}

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. -Woverloaded-virtual by itself selects level 2. Level 1 is included in -Wall. โœจ

  • -Wno-pmf-conversions (C++ and Objective-C++ only) โ€” disables the diagnostic for converting a bound pointer to member function to a plain pointer.
  • -Wsign-promo (C++ and Objective-C++ only) โ€” warns 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. the standard said "no" and that's that ๐Ÿคท
  • -Wtemplates (C++ and Objective-C++ only) โ€” warns 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.
  • -Wmismatched-new-delete (C++ and Objective-C++ only) โ€” warns for mismatches between calls to operator new or operator delete and the corresponding call to the allocation or deallocation function. This includes invocations of C++ operator delete with pointers returned from either mismatched forms of operator new, or from other functions that allocate objects for which the operator delete isn't a suitable deallocator, as well as calls to other deallocation functions with pointers returned from operator new for which the deallocation function isn't suitable.

For example, the delete expression in the function below is diagnosed because it doesn't match the array form of the new expression the pointer argument was returned from. Similarly, the call to free is also diagnosed. ๐Ÿšจ

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
   }

btw the sibling option -Wmismatched-dealloc is the one that clocks mismatches between allocation and deallocation functions that are not operator new and operator delete. different job, same energy ๐Ÿ’…

also: -Wmismatched-new-delete is riding along inside -Wall bestie, so it's on by default unless you tell it to chill.


  • -Wmismatched-tags (C++ and Objective-C++ only) โ€” okay so this one yells at you when you declare structs, classes, and class templates (plus their specializations) with a class-key that doesn't match the definition, or the first declaration if there's no definition at all. like, pick a lane, babe.

for example, the declaration of struct Object in the argument list of draw triggers the warning. to dodge it, either yeet the redundant class-key struct or swap it for class so it matches its definition:

class Object {
public:
  virtual ~Object () = 0;
};
void draw (struct Object*);

and like, to be clear: it is NOT wrong to declare a class with the class-key struct โ€” the example above proves it. the -Wmismatched-tags option is just here to help you achieve a consistent style of class declarations. and for code that's meant to be portable to Windows-based compilers, this warning helps prevent unresolved references caused by the difference in the mangling of symbols declared with different class-keys. you can run this option on its own or in conjunction with -Wredundant-tags. ๐ŸŽ€

  • -Wmultiple-inheritance (C++ and Objective-C++ only) โ€” warns when a class is defined with multiple direct base classes. some coding rules disallow multiple inheritance and this is how you enforce that rule, no cap. the warning is inactive inside a system header file, like the STL, so you can still use the STL. and you may also define classes that indirectly use multiple inheritance โ€” that's fine too. ๐Ÿฆ‹
  • -Wvirtual-inheritance โ€” warns when a class is defined with a virtual direct base class. again, some coding rules disallow multiple inheritance and this enforces it. warning is inactive inside a system header file such as the STL, so STL usage stays unbothered. and you may also define classes that indirectly use virtual inheritance. โœจ
  • -Wno-virtual-move-assign โ€” suppresses warnings about inheriting from a virtual base with a non-trivial C++11 move assignment operator. this is DANGEROUS, bestie, like genuinely: if the virtual base is reachable along more than one path, it gets 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. ๐Ÿ’€
  • -Wnamespaces โ€” warns when a namespace definition is opened. some coding rules disallow namespaces and this is how you enforce that rule. warning is inactive inside a system header file, such as the STL, so the STL stays usable. you may also use using directives and qualified names. ๐Ÿซถ
  • -Wno-template-id-cdtor (C++ and Objective-C++ only) โ€” disables the warning about using a simple-template-id as the declarator-id of a constructor or destructor, which became invalid in C++20 via DR 2237. for example:
template<typename T> struct S {
  S<T>(); // should be S();
  ~S<T>();  // should be ~S();
};

-Wtemplate-id-cdtor is enabled by default with -std=c++20; it is also enabled by -Wc++20-compat. ๐Ÿ’…

  • -Wno-terminate (C++ and Objective-C++ only) โ€” disables the warning about a throw-expression that will immediately result in a call to terminate. like, throwing straight into the void fr fr. ๐Ÿ˜ญ
  • -Wno-vexing-parse (C++ and Objective-C++ only) โ€” warns 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:
void f(double a) {
  int i();        // extern int i (void);
  int n(int(a));  // extern int n (int);
}

another example:

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);
}

the warning will suggest options for 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. ๐Ÿ‘‘

  • -Wno-class-conversion (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. so like, it's dead code, no need to scream about it. ๐Ÿ“
  • -Wvolatile (C++ and Objective-C++ only) โ€” warns about deprecated uses of the volatile qualifier. this includes postfix and prefix ++ and -- expressions of volatile-qualified types, using simple assignments where the left operand is a volatile-qualified non-class type for their value, compound assignments where the left operand is a volatile-qualified non-class type, volatile-qualified function return type, volatile-qualified parameter type, and structured bindings of a volatile-qualified type. this usage was deprecated in C++20.

enabled by default with -std=c++20. โœจ

  • -Wzero-as-null-pointer-constant (C++ and Objective-C++ only) โ€” warns when a literal 0 is used as a null pointer constant. this can be useful to facilitate the conversion to nullptr in C++11. like bestie, we have nullptr now, it's 2011, catch up ๐Ÿ’…
  • -Waligned-new โ€” warns about a new-expression of a type that requires greater alignment than alignof(std::max_align_t) but uses an allocation function without an explicit alignment parameter. this option is enabled by -Wall.

normally this only warns about global allocation functions, but -Waligned-new=all also warns about class member allocation functions. ๐ŸŒˆ

  • -Wno-placement-new
  • -Wplacement-new=n โ€” warns 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:
char buf [64];
new (buf) int[64];

this warning is enabled by default.

  • -Wplacement-new=1 โ€” this is the default warning level of -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 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:
struct S { int n, a[1]; };
S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
new (s->a)int [32]();
  • -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 a structure whose type is an array of a single element and whose size is less than the size of the object being constructed. so 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:
struct S { int n, a[]; };
S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
new (s->a)int [32]();
  • -Wcatch-value
  • -Wcatch-value=n (C++ and Objective-C++ only) โ€” warns about catch handlers that do not catch via reference. with -Wcatch-value=1 (or -Wcatch-value for short) warn about polymorphic class types that are caught by value. with -Wcatch-value=2 warn about all class types that are caught by value. with -Wcatch-value=3 warn about all types that are not caught by reference. -Wcatch-value is enabled by -Wall. ๐ŸŽ€
  • -Wconditionally-supported (C++ and Objective-C++ only) โ€” warns for conditionally-supported (C++11 [intro.defs]) constructs. iykyk. ๐Ÿฆ‹
  • -Wno-delete-incomplete (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. ๐Ÿ’€
  • -Wextra-semi (C++, Objective-C++ only) โ€” warns about redundant semicolons after in-class function definitions. extra semis are giving nothing, bestie, let them go. ๐Ÿ’…
  • -Wno-global-module (C++ and Objective-C++ only) โ€” disables the diagnostic for when the global module fragment of a module unit does not consist only of preprocessor directives. ๐ŸŒธ
  • -Wno-inaccessible-base (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 -Wextra option.
struct A { int a; };

struct B : A { };

struct C : B, A { };
  • -Wno-inherited-variadic-ctor โ€” suppresses 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. the ellipsis stays behind, it does not come with you ๐Ÿซถ
  • -Wno-invalid-offsetof (C++ and Objective-C++ only) โ€” suppresses warnings from applying the offsetof macro to a non-POD type. according to the 2014 ISO C++ standard, applying offsetof to a non-standard-layout type is undefined. in existing C++ implementations, however, 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 offsetof may be relaxed in a future version of the C++ standard. โญ

  • -Wsized-deallocation (C++ and Objective-C++ only) โ€” warns about a definition of an unsized deallocation function
void operator delete (void *) noexcept;
void operator delete[] (void *) noexcept;

without a definition of the corresponding sized deallocation function

void operator delete (void *, std::size_t) noexcept;
void operator delete[] (void *, std::size_t) noexcept;

or vice versa. enabled by -Wextra along with -fsized-deallocation. ๐Ÿ‘‘

  • -Wsuggest-final-types โ€” okay bestie, this one is a glow-up suggestion generator ๐Ÿ’… It warns about types with virtual methods where your code quality would be improved if the type were declared with the C++11 final specifier, or, if possible, declared in an anonymous namespace. Why do we care? Because that lets GCC more aggressively devirtualize the polymorphic calls โ€” speed, honey. This warning is more effective with link-time optimization, where the information about the class hierarchy graph is more complete. ๐Ÿ”ฅ
  • -Wsuggest-final-methods โ€” same energy, but for virtual methods: it warns where code quality would be improved if the method were declared with the C++11 final specifier, or, if possible, its type were declared in an anonymous namespace or with the final specifier. Also more effective with link-time optimization, where the information about the class hierarchy graph is more complete. And here's the pro strat: it is recommended to first consider suggestions of -Wsuggest-final-types and then rebuild with new annotations. Do it in that order, bestie, trust. โœจ
  • -Wsuggest-override โ€” warns about overriding virtual functions that are not marked with the override keyword. Just write override, it's free and it slays. ๐ŸŽ€
  • -Wno-conversion-null (C++ and Objective-C++ only) โ€” do not warn for conversions between NULL and non-pointer types. Heads up: -Wconversion-null is enabled by default, so this is you turning it off. ๐Ÿซถ

๐ŸŒˆ Options Controlling Objective-C and Objective-C++ Dialects ๐ŸŒˆ

NOTE: This manual does not describe the Objective-C and Objective-C++ languages themselves. We're doing flags only, bestie โ€” the language lore is a whole other fic.

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 some_class.m like this:

gcc -g -fgnu-runtime -O -c some_class.m

In this example, -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., -Wtraditional). Similarly, Objective-C++ compilations may use C++-specific options (e.g., -Wabi). Options stacking like outfits, we love to see it.

Here is a list of options that are only for compiling Objective-C and Objective-C++ programs:

  • -fconstant-string-class= class-name โ€” use class-name as the name of the class to instantiate for each literal string specified with the syntax @"...". The default class name is NXConstantString if the GNU runtime is being used, and NSConstantString if the NeXT runtime is being used (see below). On Darwin / macOS platforms, the -fconstant-cfstrings option, if also present, overrides the -fconstant-string-class setting and cause @"..." literals to be laid out as constant CoreFoundation strings. Note that -fconstant-cfstrings is an alias for the target-specific -mconstant-cfstrings equivalent. ๐Ÿฆ‹
  • -fgnu-runtime โ€” generate object code compatible with the standard GNU Objective-C runtime. This is the default for most types of systems, so it's giving "the usual."
  • -fnext-runtime โ€” generate output compatible with the NeXT runtime. This is the default for NeXT-based systems, including Darwin / macOS. The macro __NEXT_RUNTIME__ is predefined if (and only if) this option is used. Conditional queen. โญ
  • -fno-nil-receivers โ€” assume that all Objective-C message dispatches ([receiver message:arg]) in this translation unit ensure that the receiver is not 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. ๐Ÿซถ
  • -fobjc-abi-version= n โ€” use version 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. Pick your era, babe. ๐Ÿ’…
  • -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 - (id) .cxx_construct instance method which runs non-trivial default constructors on any such instance variables, in order, and then return self. Similarly, check if any instance variable is a C++ object with a non-trivial destructor, and if so, synthesize a special - (void) .cxx_destruct method which runs all such default destructors, in reverse order.

The - (id) .cxx_construct and - (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 - (id) .cxx_construct methods are invoked by the runtime immediately after a new object instance is allocated; the - (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 - (id) .cxx_construct and - (void) .cxx_destruct methods. So check your OS era before you come for me. ๐Ÿ™ˆ

  • -fobjc-direct-dispatch โ€” allow fast jumps to the message dispatcher. On Darwin this is accomplished via the comm page. Zoom zoom. ๐Ÿ”ฅ
  • -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 @try, @throw, @catch, @finally and @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). โš ๏ธ
  • -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. Your faves could never. ๐ŸŒธ
  • -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 -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. It's giving "does nothing but look cute." ๐Ÿ’€
  • -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. Retro compatibility era, iconic. ๐Ÿ‘‘
  • -freplace-objc-classes โ€” emit a special marker instructing ld(1) not to statically link in the resulting object file, and allow 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. ๐ŸŽ€
  • -fzero-link โ€” when compiling for the NeXT runtime, the compiler ordinarily replaces calls to objc_getClass("...") (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 -fzero-link flag suppresses this behavior and causes calls to objc_getClass("...") 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 objc_get_class("...") regardless of command-line options. Note the underscore difference, bestie, don't get got. ๐Ÿ˜ญ
  • -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 -fno-local-ivars flag disables this behavior thus avoiding variable shadowing issues. No more name collisions, we're healing. โœจ
  • -fivar-visibility=[public|protected|private|package] โ€” 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. ๐Ÿ’…
  • -gen-decls โ€” dump interface declarations for all classes seen in the source file to a file named sourcename.decl. Receipts, generated. ๐Ÿงš
  • -Wassign-intercept (Objective-C and Objective-C++ only) โ€” warn whenever an Objective-C assignment is being intercepted by the garbage collector. โš ๏ธ
  • -Wno-property-assign-default (Objective-C and Objective-C++ only) โ€” do not warn if a property for an Objective-C object has no assign semantics specified. ๐Ÿซถ
  • -Wno-protocol (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 -Wno-protocol option, then methods inherited from the superclass are considered to be implemented, and no warning is issued for them. Inherited counts as done, periodt. ๐ŸŒˆ
  • -Wobjc-root-class (Objective-C and Objective-C++ only) โ€” warn if a class interface lacks a superclass. Most classes will inherit from NSObject (or Object) for example. When declaring classes intended to be root classes, the warning can be suppressed by marking their interfaces with __attribute__((objc_root_class)). Root class energy is valid, just label it, babe. โญ
  • -Wselector (Objective-C and Objective-C++ only) โ€” bestie, this one calls out the compiler like "umm hello??" when it finds multiple methods of different types for the same selector during compilation. The check happens on the method list in the final stage of compilation, okay? And there's also a check for each selector that shows up in a @selector(...) expression where a corresponding method for that selector was found during compilation. But here's the tea: because these checks scan the method table only at the end of compilation, the warnings just... don't happen if the final stage never gets reached. Like if an error is found during compilation, or if you're using -fsyntax-only. So no final stage, no warnings, periodt. ๐Ÿ’…
  • -Wstrict-selector-match (Objective-C and Objective-C++ only) โ€” warns when multiple methods with differing argument and/or return types are found for a given selector, specifically when you're trying to send a message using this selector to a receiver of type id or Class. When this flag is off (which is the default behavior, jsyk), the compiler skips those warnings if any differences found are confined to types that share the same size and alignment. So like, same size, same alignment, same vibe โ€” no warning. ๐Ÿซถ
  • -Wundeclared-selector (Objective-C and Objective-C++ only) โ€” yells at you when a @selector(...) expression referring to an undeclared selector is found. A selector counts as undeclared if no method with that name has been declared before the @selector(...) expression โ€” either explicitly in an @interface or @protocol declaration, or implicitly in an @implementation section. And the way this option works? It always performs its checks as soon as a @selector(...) expression is found, whereas -Wselector only does its checks in the final stage of compilation. It also enforces that whole coding style convention that methods and selectors must be declared before being used. Iconic, honestly. ๐Ÿ‘‘
  • -print-objc-runtime-info โ€” generates a C header describing the largest structure that is passed by value, if any. That's it, that's the whole thing. ๐ŸŽ€

โœจ Options to Control Diagnostic Messages Formatting โœจ

So, historically, diagnostic messages have been formatted with zero regard for the output device's aspect (like its width, ...). Rude, honestly. But you can use the options below to control the formatting algorithm for diagnostic messages โ€” like how many characters per line, how often source location information gets reported. ๐Ÿ’–

Heads up though: some language front ends may not honor these options. Not everyone's invited to the party, I guess. ๐Ÿ˜ญ
  • -fmessage-length=n โ€” tries to format error messages so they fit on lines of about n characters. If n is zero, then no line-wrapping happens at all; 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 #error and #warning pre-processor directives, and the deprecated function/type/variable attribute. It does not, however, affect the pragma GCC warning and pragma GCC error pragmas. Those are doing their own thing. ๐Ÿ™ˆ
  • -fdiagnostics-plain-output โ€” requests that diagnostic output look as plain as possible, which is lowkey useful when you're running dejagnu or other utilities that need to parse diagnostics output and prefer it stay more stable over time. Right now, -fdiagnostics-plain-output is equivalent to the following options:
-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

And fr fr, 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. Future-proofing, bestie. ๐Ÿฆ‹

  • -fdiagnostics-show-location=once โ€” only meaningful in line-wrapping mode. Instructs the diagnostic messages reporter to emit source location information once โ€” so if 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 a prefix again and again and again on subsequent continuation lines. This is the default behavior. ๐Ÿ’…
  • -fdiagnostics-show-location=every-line โ€” only meaningful in line-wrapping mode. Instructs the diagnostic messages reporter to emit the same source location information (as a prefix) for physical lines that result from the process of breaking a message which is too long to fit on a single line. Every. Single. Line. ๐Ÿ˜ค
  • -fdiagnostics-color[=WHEN]
  • -fno-diagnostics-color โ€” use color in diagnostics! ๐ŸŒˆ WHEN is never, always, or auto. The default depends on how the compiler has been configured โ€” it can be any of the above WHEN options, or also never if the GCC_COLORS environment variable isn't present in the environment, and auto otherwise. auto makes GCC use color only when the standard error is a terminal, and when not executing in an emacs shell. The forms -fdiagnostics-color and -fno-diagnostics-color are aliases for -fdiagnostics-color=always and -fdiagnostics-color=never, respectively.

The colors are defined by the environment variable 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. (Go check 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 1 for bold, 4 for underline, 5 for blink, 7 for inverse, 39 for default foreground color, 30 to 37 for foreground colors, 90 to 97 for 16-color mode foreground colors, 38;5;0 to 38;5;255 for 88-color and 256-color modes foreground colors, 49 for default background color, 40 to 47 for background colors, 100 to 107 for 16-color mode background colors, and 48;5;0 to 48;5;255 for 88-color and 256-color modes background colors. ๐ŸŽจ

The default GCC_COLORS is

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

where 01;31 is bold red, 01;35 is bold magenta, 01;36 is bold cyan, 32 is green, 34 is blue, 01 is bold, and 31 is red. Setting GCC_COLORS to the empty string disables colors entirely. ๐Ÿ’€

Supported capabilities are as follows:

  • error= โ€” SGR substring for error: markers.
  • warning= โ€” SGR substring for warning: markers.
  • note= โ€” SGR substring for note: markers.
  • path= โ€” SGR substring for colorizing paths of control-flow events as printed via -fdiagnostics-path-format=, such as the identifiers of individual events and lines indicating interprocedural calls and returns.
  • range1= โ€” SGR substring for first additional range.
  • range2= โ€” SGR substring for second additional range.
  • locus= โ€” SGR substring for location information, file:line or file:line:column etc.
  • quote= โ€” SGR substring for information printed within quotes.
  • fnname= โ€” SGR substring for names of C++ functions.
  • targs= โ€” SGR substring for C++ function template parameter bindings.
  • fixit-insert= โ€” SGR substring for fix-it hints suggesting text to be inserted or replaced.
  • fixit-delete= โ€” SGR substring for fix-it hints suggesting text to be deleted.
  • diff-filename= โ€” SGR substring for filename headers within generated patches.
  • diff-hunk= โ€” SGR substring for the starts of hunks within generated patches.
  • diff-delete= โ€” SGR substring for deleted lines within generated patches.
  • diff-insert= โ€” SGR substring for inserted lines within generated patches.
  • type-diff= โ€” SGR substring for highlighting mismatching types within template arguments in the C++ frontend.
  • valid= โ€” SGR substring for highlighting valid elements within text art diagrams.
  • invalid= โ€” SGR substring for highlighting invalid elements within text art diagrams.
  • -fdiagnostics-urls[=WHEN] โ€” uses escape sequences to embed URLs in diagnostics! ๐Ÿ”— For example, when -fdiagnostics-show-option emits text showing the command-line option controlling a diagnostic, it embeds a URL for documentation of that option. Slay.

WHEN is never, always, or auto. 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, bestie. ๐Ÿ‘€

The default depends on how the compiler has been configured. It can be any of the above WHEN options.

GCC can also be configured (via the --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 auto if either GCC_URLS or TERM_URLS environment variables are present and non-empty in the environment of the compiler, or never if neither are.

However โ€” and this is the plot twist โ€” even with -fdiagnostics-urls=always the behavior is dependent on those environment variables: If GCC_URLS is set to empty or no, do not embed URLs in diagnostics. If set to st, URLs use ST escape sequences. If set to bel, the default, URLs use BEL escape sequences. Any other non-empty value enables the feature. If GCC_URLS is not set, use TERM_URLS as a fallback. Note: ST is an ANSI escape sequence, string terminator 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 -fdiagnostics-urls=always. ๐Ÿ’€

  • -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 -fno-diagnostics-show-option flag suppresses that behavior. Sometimes you just wanna be mysterious, yk? ๐Ÿ™ˆ
  • -fno-diagnostics-show-caret โ€” bestie, by default every diagnostic comes with the original source line AND a little caret ^ pointing at the column, like a tiny finger going it's right there ๐Ÿ’…. This option says no thanks, no caret, no source line. (Fun fact: that source line gets truncated to n characters if you passed -fmessage-length=n. And when the output is going to a terminal, the width gets capped at whatever the COLUMNS environment variable says โ€” or, if that's not set, at the terminal's actual width.) Slay, but quietly.
  • -fno-diagnostics-show-labels โ€” so when GCC prints source code (via -fdiagnostics-show-caret), diagnostics can label ranges of that source with relevant info โ€” like what type each expression actually is. Behold the vibe:
            printf ("foo %s bar", long_i + long_j);
                         ~^       ~~~~~~~~~~~~~~~
                          |              |
                          char *         long int

This option kills those labels (in the example above: the vertical bars and the "char *" and "long int" text). Gone. Not invited.

  • -fno-diagnostics-show-cwe โ€” diagnostic messages can optionally have an associated CWE ("https://cwe.mitre.org/index.html") identifier attached ๐ŸŽ€. GCC itself only provides that metadata for some of the -fanalyzer diagnostics. GCC plugins may also hand over diagnostics carrying that metadata. By default, if the info is there, it gets printed with the diagnostic. This option suppresses printing it. Mysterious metadata, begone.
  • -fno-diagnostics-show-rules โ€” diagnostics can also optionally have rules associated with them, like from a coding standard or a spec ๐Ÿ“œ. GCC itself does not do this for any of its diagnostics, but plugins might. By default, if that info exists, it's printed with the diagnostic. This option suppresses it. Not today, rulebook.
  • -fno-diagnostics-show-line-numbers โ€” when GCC prints source code (via -fdiagnostics-show-caret), there's normally a left margin showing line numbers. This option yeets that left margin entirely. No numbers, just vibes.
  • -fdiagnostics-minimum-margin-width=width โ€” controls the minimum width of that left margin printed by -fdiagnostics-show-line-numbers. It defaults to 6. Six. That's the number. Remember it.
  • -fdiagnostics-parseable-fixits โ€” emits fix-it hints in a machine-parseable format, perfect for IDEs to snack on ๐Ÿค–. For each fix-it, a line gets printed right after the relevant diagnostic, starting with the string "fix-it:". Like so:
        fix-it:"test.c":{45:3-45:21}:"gtk_widget_show_all"

The location is a half-open range, expressed as a count of bytes, starting at byte 1 for the initial column. So in that example, bytes 3 through 20 of line 45 of "test.c" are getting replaced with the given string:

        00000000011111111112222222222
        12345678901234567890123456789
          gtk_widget_showall (dlg);
          ^^^^^^^^^^^^^^^^^^
          gtk_widget_show_all

The filename and replacement string escape backslash as "\\", tab as "\t", newline as "\n", double quotes as "\"", and non-printable characters as octal (e.g. vertical tab as "\013").

An empty replacement string means the given range is to be removed. An empty range (e.g. "45:3-45:3") means the string is to be inserted at that position. Insertion rights, unlocked โœจ

  • -fdiagnostics-generate-patch โ€” prints fix-it hints to stderr in unified diff format, after all the diagnostics are printed. Example incoming:
        --- test.c
        +++ test.c
        @ -42,5 +42,5 @

         void show_cb(GtkDialog *dlg)
         {
        -  gtk_widget_showall(dlg);
        +  gtk_widget_show_all(dlg);
         }

The diff may or may not be colorized, following the exact same rules as for diagnostics (see -fdiagnostics-color). Patch era ๐Ÿ’–

  • -fdiagnostics-show-template-tree โ€” in the C++ frontend, when printing diagnostics about mismatching template types, like:
          could not convert 'std::map<int, std::vector<double> >()'
            from 'map<[...],vector<double>>' to 'map<[...],vector<float>>

the -fdiagnostics-show-template-tree flag enables printing a tree-like structure showing the common and differing parts of the types, like:

          map<
            [...],
            vector<
              [double != float]>>

The parts that differ are highlighted with color ("double" and "float" in this case). Tree branch realness ๐ŸŒธ

  • -fno-elide-type โ€” by default, when the C++ frontend prints diagnostics about mismatching template types, common parts of the types get printed as "[...]" to keep the error message simple. Like:
          could not convert 'std::map<int, std::vector<double> >()'
            from 'map<[...],vector<double>>' to 'map<[...],vector<float>>

Specifying the -fno-elide-type flag suppresses that behavior. This flag also affects the output of the -fdiagnostics-show-template-tree flag. No more [...] erasure, bestie.

  • -fdiagnostics-path-format=KIND โ€” specifies how to print paths of control-flow events for diagnostics that have such a path associated with them. ๐Ÿ›ค๏ธ

KIND is none, separate-events, or inline-events โ€” the default is inline-events.

none means: do not print diagnostic paths.

separate-events means: print a separate "note" diagnostic for each event within the diagnostic. Example:

        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

inline-events means: print the events "inline" within the source code. This view tries 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 get printed as:

          '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
            |

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. Stack frame lore ๐Ÿ“š

For example:

          '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)
  • -fdiagnostics-show-path-depths โ€” this one hands you extra info when printing control-flow paths tied to a diagnostic. Depth check โœจ

If this option is provided, the stack depth gets printed for each run of events within -fdiagnostics-path-format=inline-events. And if you pair it with -fdiagnostics-path-format=separate-events, then the stack depth and the function declaration get appended when printing each event.

This is intended for use by GCC developers and plugin developers when debugging diagnostics that report interprocedural control flow. Devs only, iykyk ๐Ÿ’…

  • -fno-show-column โ€” do not print column numbers in diagnostics. This may be necessary if the diagnostics are being scanned by a program that doesn't understand column numbers, such as dejagnu. Column-blind tools exist and we respect them.
  • -fdiagnostics-column-unit=UNIT โ€” picks the units for the column number. This affects traditional diagnostics (when -fno-show-column isn't in play), and also JSON format diagnostics if those are requested.

The default UNIT, display, counts the number of display columns occupied by each character. This can be bigger than the number of bytes needed to encode the character โ€” think tab characters โ€” or 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 needs two bytes; the character "SLIGHTLY SMILING FACE (U+1F642)" occupies two display columns, and its UTF-8 encoding needs four bytes. Unicode math, but make it cute ๐Ÿซถ

  • -fdiagnostics-column-unit=UNIT โ€” wait, this one's already been vibing, but its bestie is here: setting UNIT to byte makes the column number the raw byte count in all the cases, which is exactly what GCC did traditionally before version 11.1.0. Old-school behavior, no cap. ๐Ÿซถ
  • -fdiagnostics-column-origin=ORIGIN โ€” picks where column numbers start, bestie. Like, which column gets to be column one? The default 1 is traditional GCC behavior and also what the GNU style guide says. Some utilities lowkey do better with an origin of 0 though โ€” any non-negative value is fair game. โœจ
  • -fdiagnostics-escape-format=FORMAT โ€” okay so when GCC prints the pertinent source lines for a diagnostic, it normally just tries to print the source bytes directly. But some diagnostics are about encoding drama in the source file, like malformed UTF-8, or Unicode normalization issues. Those diagnostics get flagged so GCC will escape bytes that aren't printable ASCII when it prints their pertinent source lines. ๐Ÿ’…

This option controls how those bytes get escaped.

The default FORMAT, unicode, displays Unicode characters that aren't printable ASCII in the form <U+XXXX>, and bytes that don't correspond to a Unicode character validly-encoded in UTF-8 get shown as hexadecimal in the form <XX>.

For example, a source line containing the string 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 after will be printed for such a diagnostic as:

         before<U+03C0><BF>after

Setting FORMAT to bytes will display all non-printable-ASCII bytes in the form <XX>, thus showing the underlying encoding of non-ASCII Unicode characters. For the example above, the following will be printed:

         before<CF><80><BF>after
  • -fdiagnostics-text-art-charset=CHARSET โ€” some diagnostics can contain "text art" diagrams: visualizations created from text, intended to be viewed in a monospaced font. Iconic, honestly. ๐ŸŽ€

This option selects which characters should be used for printing such diagrams, if any. CHARSET is none, ascii, unicode, or emoji.

The none value suppresses the printing of such diagrams. The ascii value will ensure that such diagrams are pure ASCII ("ASCII art"). The unicode value will allow for conservative use of unicode drawing characters (such as box-drawing characters). The 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 emoji, except when the environment variable LANG is set to C, in which case the default is ascii.

  • -fdiagnostics-format=FORMAT โ€” picks a whole different format for printing diagnostics. FORMAT is text, sarif-stderr, sarif-file, json, json-stderr, or json-file.

The default is text.

The sarif-stderr and sarif-file formats both emit diagnostics in SARIF Version 2.1.0 format, either to stderr, or to a file named source.sarif, respectively.

The json format is a synonym for json-stderr. The json-stderr and json-file formats are identical, apart from where the JSON is emitted to โ€” with the former, the JSON is emitted to stderr, whereas with json-file it is written to source.gcc.json.

The emitted JSON consists of a top-level JSON array containing JSON objects representing the diagnostics.

Diagnostics can have child diagnostics. For example, this error and note:

         misleading-indentation.c:15:3: warning: this 'if' clause does not
           guard... [-Wmisleading-indentation]
            15 |   if (flag)
               |   ^~
         misleading-indentation.c:17:5: note: ...this statement, but the latter
           is misleadingly indented as if it were guarded by the 'if'
            17 |     y = 2;
               |     ^

might be printed in JSON form (after formatting) like this:

         [
             {
                 "kind": "warning",
                 "locations": [
                     {
                         "caret": {
                             "display-column": 3,
                             "byte-column": 3,
                             "column": 3,
                             "file": "misleading-indentation.c",
                             "line": 15
                         },
                         "finish": {
                             "display-column": 4,
                             "byte-column": 4,
                             "column": 4,
                             "file": "misleading-indentation.c",
                             "line": 15
                         }
                     }
                 ],
                 "message": "this \u2018if\u2019 clause does not guard...",
                 "option": "-Wmisleading-indentation",
                 "option_url": "https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html#index-Wmisleading-indentation",
                 "children": [
                     {
                         "kind": "note",
                         "locations": [
                             {
                                 "caret": {
                                     "display-column": 5,
                                     "byte-column": 5,
                                     "column": 5,
                                     "file": "misleading-indentation.c",
                                     "line": 17
                                 }
                             }
                         ],
                         "escape-source": false,
                         "message": "...this statement, but the latter is ..."
                     }
                 ]
                 "escape-source": false,
                 "column-origin": 1,
             }
         ]

where the "note" is a child of the "warning". ๐Ÿฆ‹

A diagnostic has a "kind". If this is "warning", then there's an "option" key describing the command-line option controlling the warning.

A diagnostic can contain zero or more locations. Each location has an optional "label" string and up to three positions within it: a "caret" position and optional "start" and "finish" positions. A position is described by a "file" name, a "line" number, and three numbers indicating a column position:

  • "display-column" counts display columns, accounting for tabs and multibyte characters.
  • "byte-column" counts raw bytes.
  • "column" is equal to one of the previous two, as dictated by the -fdiagnostics-column-unit option.

All three columns are relative to the origin specified by -fdiagnostics-column-origin, which is typically equal to 1 but may be set, for instance, to 0 for compatibility with other utilities that number columns from 0. The column origin is recorded in the JSON output in the "column-origin" tag. In the remaining examples below, the extra column number outputs have been omitted for brevity.

For example, this error:

         bad-binary-ops.c:64:23: error: invalid operands to binary + (have 'S' {aka
            'struct s'} and 'T' {aka 'struct t'})
            64 |   return callee_4a () + callee_4b ();
               |          ~~~~~~~~~~~~ ^ ~~~~~~~~~~~~
               |          |              |
               |          |              T {aka struct t}
               |          S {aka struct s}

has three locations. Its primary location is at the + token at column 23. It has two secondary locations, describing the left and right-hand sides of the expression, which have labels. It might be printed in JSON form as:

             {
                 "children": [],
                 "kind": "error",
                 "locations": [
                     {
                         "caret": {
                             "column": 23, "file": "bad-binary-ops.c", "line": 64
                         }
                     },
                     {
                         "caret": {
                             "column": 10, "file": "bad-binary-ops.c", "line": 64
                         },
                         "finish": {
                             "column": 21, "file": "bad-binary-ops.c", "line": 64
                         },
                         "label": "S {aka struct s}"
                     },
                     {
                         "caret": {
                             "column": 25, "file": "bad-binary-ops.c", "line": 64
                         },
                         "finish": {
                             "column": 36, "file": "bad-binary-ops.c", "line": 64
                         },
                         "label": "T {aka struct t}"
                     }
                 ],
                 "escape-source": false,
                 "message": "invalid operands to binary + ..."
             }

If a diagnostic contains fix-it hints, it has a "fixits" array, consisting of half-open intervals, similar to the output of -fdiagnostics-parseable-fixits. For example, this diagnostic with a replacement fix-it hint:

         demo.c:8:15: error: 'struct s' has no member named 'colour'; did you
           mean 'color'?
             8 |   return ptr->colour;
               |               ^~~~~~
               |               color

might be printed in JSON form as:

                       {
                           "children": [],
                           "fixits": [
                               {
                                   "next": {
                                       "column": 21,
                                       "file": "demo.c",
                                       "line": 8
                                   },
                                   "start": {
                                       "column": 15,
                                       "file": "demo.c",
                                       "line": 8
                                   },
                                   "string": "color"
                               }
                           ],
                           "kind": "error",
                           "locations": [
                               {
                                   "caret": {
                                       "column": 15,
                                       "file": "demo.c",
                                       "line": 8
                                   },
                                   "finish": {
                                       "column": 20,
                                       "file": "demo.c",
                                       "line": 8
                                   }
                               }
                           ],
                           "escape-source": false,
                           "message": "\u2018struct s\u2019 has no member named ..."
                       }

okay so where the fix-it hint suggests swapping out the text from "start" up to but NOT including "next" with the value of "string" ๐Ÿ’…. Deletions? they show up as an empty value for "string" ๐Ÿซฅ. Insertions? that's when "start" equals "next" โœจ.

If the diagnostic has a path of control-flow events attached to it, it's got a "path" array of objects, each one representing an event ๐Ÿฆ‹. Every event object has a "description" string, a "location" object, plus a "function" string and a "depth" number for representing interprocedural paths ๐Ÿ‘‘. The "function" is the current function at that event, and the "depth" is the stack depth relative to some baseline: the higher it is, the more frames are chillin' in the stack ๐Ÿฅž.

For example, the intraprocedural example shown for -fdiagnostics-path-format= might have this JSON for its path:

                       "path": [
                           {
                               "depth": 0,
                               "description": "when 'PyList_New' fails, returning NULL",
                               "function": "test",
                               "location": {
                                   "column": 10,
                                   "file": "test.c",
                                   "line": 25
                               }
                           },
                           {
                               "depth": 0,
                               "description": "when 'i < count'",
                               "function": "test",
                               "location": {
                                   "column": 3,
                                   "file": "test.c",
                                   "line": 27
                               }
                           },
                           {
                               "depth": 0,
                               "description": "when calling 'PyList_Append', passing NULL from (1) as argument 1",
                               "function": "test",
                               "location": {
                                   "column": 5,
                                   "file": "test.c",
                                   "line": 29
                               }
                           }
                       ]

Diagnostics also have a boolean attribute "escape-source", which hints at whether non-ASCII bytes should be escaped when printing the pertinent lines of source code ("true" for diagnostics involving source encoding issues) ๐ŸŒธ.

  • -fno-diagnostics-json-formatting โ€” so by default, whenever JSON gets emitted for diagnostics (via -fdiagnostics-format=sarif-stderr, -fdiagnostics-format=sarif-file, -fdiagnostics-format=json, -fdiagnostics-format=json-stderr, -fdiagnostics-format=json-file), GCC will sprinkle in newlines and indentation to visually emphasize the hierarchical structure of the JSON ๐ŸŽ€. Use -fno-diagnostics-json-formatting to suppress that whitespace. It must be passed before the option it is to affect. This is intended for compatibility with tools that don't expect the output to contain newlines, like the stuff emitted by older GCC releases ๐Ÿ™ˆ.

โœจ Options to Request or Suppress 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 don't enable specific warnings, they just control the kinds of diagnostics GCC produces ๐Ÿ’–:

  • -fsyntax-only โ€” check the code for syntax errors, but like... don't do anything beyond that. that's it, that's the whole vibe ๐Ÿซถ.
  • -fmax-errors=n โ€” caps the maximum number of error messages at n, and once you hit that, GCC just bails out instead of trying to keep processing the source code ๐Ÿ’€. If n is 0 (the default), there's no limit on the number of error messages produced. If -Wfatal-errors is also specified, then -Wfatal-errors takes precedence over this option ๐Ÿ‘‘.
  • -w โ€” inhibit ALL warning messages. like, every single one. gone. silenced. shhh ๐Ÿคซ.
  • -Werror โ€” make all warnings into errors ๐Ÿ˜ˆ.
  • -Werror= โ€” make the specified warning into an error. You append the specifier for the warning; for example -Werror=switch turns the warnings controlled by -Wswitch into errors โœจ. This switch also takes a negative form, so you can negate -Werror for specific warnings; for example -Wno-error=switch makes -Wswitch warnings not be errors, even when -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 -Werror= and -Wno-error= as described above. (Printing of the option in the warning message can be disabled using the -fno-diagnostics-show-option flag.) Also note: specifying -Werror=foo automatically implies -Wfoo ๐Ÿ”ฅ. However, -Wno-error=foo does not imply anything ๐Ÿซฅ.
  • -Wfatal-errors โ€” this one makes the compiler abort compilation on the first error that occurs, rather than trying to keep going and printing further error messages ๐Ÿ›‘.

You can request many specific warnings with options beginning with -W, for example -Wimplicit to request warnings on implicit declarations ๐ŸŒˆ. Each of these specific warning options also has a negative form beginning -Wno- to turn off warnings; for example -Wno-implicit ๐Ÿ’…. This manual lists only one of the two forms, whichever is not the default ๐Ÿ‘‘. For further language-specific options also refer to C++ Dialect Options and Objective-C and Objective-C++ Dialect Options. Additional warnings can be produced by enabling the static analyzer; ๐Ÿ”

Some options, such as -Wall and -Wextra, turn on other options, such as -Wunused, which may turn on further options, such as -Wunused-value ๐Ÿช†. 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 take effect as if they appeared at the end of the command-line ๐ŸŒธ.

When an unrecognized warning option is requested (e.g., -Wunknown-warning), GCC emits a diagnostic stating that the option is not recognized ๐Ÿ˜ญ. However, if the -Wno- form is used, the behavior is slightly different: no diagnostic is produced for -Wno-unknown-warning unless other diagnostics are being produced. This allows the use of new -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 -Wsuggest-final-types is more effective with link-time optimization, and some instances of other warnings may not be issued at all unless optimization is enabled ๐ŸŽ€. While optimization in general improves the efficacy of control and data flow sensitive warnings, in some cases it may also cause false positives ๐Ÿ’€.

  • -Wpedantic
  • -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 -std option used ๐Ÿ‘‘.

Valid ISO C and ISO C++ programs should compile properly with or without this option (though a rare few require -ansi or a -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 -pedantic-errors) ๐Ÿ’ฅ.

-Wpedantic does not cause warning messages for use of the alternate keywords whose names begin and end with __ ๐Ÿ™ˆ. This alternate format can also be used to disable warnings for non-ISO __intN types, i.e. __intN__ ๐Ÿงš. Pedantic warnings are also disabled in the expression that follows "__extension__" โœจ. However, only system header files should use these escape routes; application programs should avoid them ๐Ÿ˜ค.

Some warnings about non-conforming programs are controlled by options other than -Wpedantic; in many cases they are implied by -Wpedantic but can be disabled separately by their specific option, e.g. -Wpedantic -Wno-pointer-sign ๐Ÿ’….

Where the standard specified with -std represents a GNU extended dialect of C, such as gnu90 or gnu99, there is a corresponding base standard, the version of ISO C on which the GNU extended dialect is based ๐ŸŽ€. Warnings from -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.) ๐Ÿซ 

-pedantic-errors

okay so bestie, this one is the โœจstrictโœจ sibling of -Wpedantic. It throws an error whenever the base standard (peep -Wpedantic) says a diagnostic is required โ€” including some cases where there's undefined behavior at compile-time, plus some other cases that don't even stop you from compiling programs that are valid according to the standard. ๐Ÿซ 

Heads up: this is not the same thing as -Werror=pedantic. The latter is honestly lowkey not useful, because it only turns the diagnostics controlled by -Wpedantic into errors, whereas this option also messes with required diagnostics that are always enabled or that are controlled by options other than -Wpedantic. ๐Ÿ’…

So if you want those required diagnostics that are warnings by default to become errors, but you don't also wanna turn on the -Wpedantic diagnostics, you can do:

-pedantic-errors -Wno-pedantic

or, if you want them enabled but only as warnings:

-pedantic-errors -Wno-error=pedantic

Some required diagnostics are errors by default but can be downgraded to warnings using -fpermissive or their own specific warning option, like -Wno-error=narrowing. ๐ŸŽ€

And some diagnostics for non-ISO practices are controlled by specific warning options other than -Wpedantic, but are also made into errors by -pedantic-errors. For instance, bestie, this whole squad right here:

  • -Wattributes (for standard attributes)
  • -Wchanges-meaning (C++)
  • -Wcomma-subscript (C++23 or later)
  • -Wdeclaration-after-statement (C90 or earlier)
  • -Welaborated-enum-base (C++11 or later)
  • -Wimplicit-int (C99 or later)
  • -Wimplicit-function-declaration (C99 or later)
  • -Wincompatible-pointer-types
  • -Wint-conversion
  • -Wlong-long (C90 or earlier)
  • -Wmain
  • -Wnarrowing (C++11 or later)
  • -Wpointer-arith
  • -Wpointer-sign
  • -Wincompatible-pointer-types
  • -Wregister (C++17 or later)
  • -Wvla (C90 or earlier)
  • -Wwrite-strings (C++11 or later)

-fpermissive

Downgrade era. This one takes some required diagnostics about nonconformant code and drops them from errors down to warnings. So yeah, using -fpermissive lets some nonconforming code actually compile. ๐ŸŒˆ

Some C++ diagnostics are controlled only by this flag, but it also downgrades some C and C++ diagnostics that have their own flag:

  • -Wdeclaration-missing-parameter-type (C and Objective-C only)
  • -Wimplicit-function-declaration (C and Objective-C only)
  • -Wimplicit-int (C and Objective-C only)
  • -Wincompatible-pointer-types (C and Objective-C only)
  • -Wint-conversion (C and Objective-C only)
  • -Wnarrowing (C++ and Objective-C++ only)
  • -Wreturn-mismatch (C and Objective-C only)

And the tea: -fpermissive is the default for historic C language modes โ€” -std=c89, -std=gnu89, -std=c90, -std=gnu90. ๐Ÿซถ


-Wall

This turns on all the warnings about constructions that some users consider questionable, and that are easy to avoid (or easy to modify to prevent the warning) โ€” even in conjunction with macros. It also enables some language-specific warnings described over in C++ Dialect Options and Objective-C and Objective-C++ Dialect Options. ๐Ÿ’–

-Wall turns on the following warning flags:

  • -Waddress
  • -Waligned-new (C++ and Objective-C++ only)
  • -Warray-bounds=1 (only with -O2)
  • -Warray-compare
  • -Warray-parameter=2
  • -Wbool-compare
  • -Wbool-operation
  • -Wc++11-compat
  • -Wc++14-compat
  • -Wc++17compat
  • -Wc++20compat
  • -Wcatch-value (C++ and Objective-C++ only)
  • -Wchar-subscripts
  • -Wclass-memaccess (C++ and Objective-C++ only)
  • -Wcomment
  • -Wdangling-else
  • -Wdangling-pointer=2
  • -Wdelete-non-virtual-dtor (C++ and Objective-C++ only)
  • -Wduplicate-decl-specifier (C and Objective-C only)
  • -Wenum-compare (in C/ObjC; this is on by default in C++)
  • -Wenum-int-mismatch (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 (C and Objective-C only)
  • -Wimplicit-function-declaration (C and Objective-C only)
  • -Wimplicit-int (C and Objective-C only)
  • -Winfinite-recursion
  • -Winit-self (C++ and Objective-C++ only)
  • -Wint-in-bool-context
  • -Wlogical-not-parentheses
  • -Wmain (only for C/ObjC and unless -ffreestanding)
  • -Wmaybe-uninitialized
  • -Wmemset-elt-size
  • -Wmemset-transposed-args
  • -Wmisleading-indentation (only for C/C++)
  • -Wmismatched-dealloc
  • -Wmismatched-new-delete (C++ and Objective-C++ only)
  • -Wmissing-attributes
  • -Wmissing-braces (only for C/ObjC)
  • -Wmultistatement-macros
  • -Wnarrowing (C++ and Objective-C++ only)
  • -Wnonnull
  • -Wnonnull-compare
  • -Wopenmp-simd (C and C++ only)
  • -Woverloaded-virtual=1 (C++ and Objective-C++ only)
  • -Wpacked-not-aligned
  • -Wparentheses
  • -Wpessimizing-move (C++ and Objective-C++ only)
  • -Wpointer-sign (only for C/ObjC)
  • -Wrange-loop-construct (C++ and Objective-C++ only)
  • -Wreorder (C++ and Objective-C++ only)
  • -Wrestrict
  • -Wreturn-type
  • -Wself-move (C++ and Objective-C++ only)
  • -Wsequence-point
  • -Wsign-compare (C++ and Objective-C++ only)
  • -Wsizeof-array-div
  • -Wsizeof-pointer-div
  • -Wsizeof-pointer-memaccess
  • -Wstrict-aliasing
  • -Wstrict-overflow=1
  • -Wswitch
  • -Wtautological-compare
  • -Wtrigraphs
  • -Wuninitialized
  • -Wunknown-pragmas
  • -Wunused
  • -Wunused-but-set-variable
  • -Wunused-const-variable=1 (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

Notably, bestie: some warning flags are not implied by -Wall. Some of them warn about constructions that users generally don't consider questionable, but which occasionally you might wanna check for; others warn about constructions that are necessary or hard to avoid in some cases, and there's no simple way to modify the code to suppress the warning. Some of them are enabled by -Wextra but many of them must be enabled individually. ๐Ÿ’€


-Wextra

This one enables some extra warning flags that aren't enabled by -Wall. ๐Ÿฆ‹ (Fun fact: this option used to be called -W. The older name is still supported, but the newer name is more descriptive.)

  • -Wabsolute-value (only for C/ObjC)
  • -Walloc-size
  • -Wcalloc-transposed-args
  • -Wcast-function-type
  • -Wclobbered
  • -Wdeprecated-copy (C++ and Objective-C++ only)
  • -Wempty-body
  • -Wenum-conversion (only for C/ObjC)
  • -Wexpansion-to-defined
  • -Wignored-qualifiers (only for C/C++)
  • -Wimplicit-fallthrough=3
  • -Wmaybe-uninitialized
  • -Wmissing-field-initializers
  • -Wmissing-parameter-type (C/ObjC only)
  • -Wold-style-declaration (C/ObjC only)
  • -Woverride-init (C/ObjC only)
  • -Wredundant-move (C++ and Objective-C++ only)
  • -Wshift-negative-value (in C++11 to C++17 and in C99 and newer)
  • -Wsign-compare (C++ and Objective-C++ only)
  • -Wsized-deallocation (C++ and Objective-C++ only)
  • -Wstring-compare
  • -Wtype-limits
  • -Wuninitialized
  • -Wunused-parameter (only with -Wunused or -Wall)
  • -Wunused-but-set-parameter (only with -Wunused or -Wall)

The option -Wextra also prints warning messages for the following cases:

  • A pointer is compared against integer zero with "<", "<=", ">", or ">=".
  • (C++ only) An enumerator and a non-enumerator both appear in a conditional expression.
  • (C++ only) Ambiguous virtual bases.
  • (C++ only) Subscripting an array that has been declared "register".
  • (C++ only) Taking the address of a variable that has been declared "register".
  • (C++ only) A base class is not initialized in the copy constructor of a derived class.

-Wabi (C, Objective-C, C++ and Objective-C++ only)

Warn about code affected by ABI changes. That includes code that may not be compatible with the vendor-neutral C++ ABI as well as the psABI for the particular target. ๐Ÿ˜ญ

Since G++ now defaults to updating the ABI with each major release, normally -Wabi only warns about C++ ABI compatibility problems if there's a check added later in a release series for an ABI issue discovered since the initial release. -Wabi warns about more things if an older ABI version is selected (with -fabi-version=n). ๐ŸŒธ

-Wabi can also be used with an explicit version number to warn about C++ ABI compatibility with a particular -fabi-version level, e.g. -Wabi=2 to warn about changes relative to -fabi-version=2.

If an explicit version number is provided and -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 -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. (iconic chaotic energy, honestly.)

You should rewrite your code to avoid these warnings if you're concerned about the fact that code generated by G++ may not be binary compatible with code generated by other compilers. ๐Ÿ’…

Known incompatibilities in -fabi-version=2 (which was the default from GCC 3.4 to 4.9) include:

  • A template with a non-type template parameter of reference type was mangled incorrectly:
extern int N;
template <int &> struct S {};
void n (S<N>) {2}

This was fixed in -fabi-version=3.

  • SIMD vector types declared using "__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 -fabi-version=4.

  • "__attribute ((const))" and "noreturn" were mangled as type qualifiers, and "decltype" of a plain declaration was folded away.

These mangling issues were fixed in -fabi-version=5.

  • Scoped enumerators passed as arguments to a variadic function are promoted like unscoped enumerators, causing "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 "int".

Also, the ABI changed the mangling of template argument packs, "const_cast", "static_cast", prefix increment/decrement, and a class scope function used as a template argument.

These issues were corrected in -fabi-version=6.

  • Lambdas in default argument scope were mangled incorrectly, and the ABI changed the mangling of "nullptr_t".

These issues were corrected in -fabi-version=7.

  • When it was mangling a function type that had function-cv-qualifiers, the un-qualified function type was being treated as a substitution candidate and that was wrong. Fixed in -fabi-version=8, which is the default for GCC 5.1. ๐Ÿ’…
    • decltype(nullptr) lowkey had an alignment of 1, which meant unaligned accesses. But bestie, note that this did not affect the ABI of a function with a nullptr_t parameter, because parameters have a minimum alignment. Anyway โ€” fixed in -fabi-version=9, the default for GCC 5.2. โœจ
    • Target-specific attributes that affect the identity of a type โ€” like ia32 calling conventions on a function type (stdcall, regparm, etc.) โ€” were not affecting the mangled name, which led to name collisions when function pointers were used as template arguments. Not the vibe. Fixed in -fabi-version=10, the default for GCC 6.1. ๐Ÿซถ

This option also turns on warnings about psABI-related changes. The known psABI changes at this point include:

  • For SysV/x86-64, unions with long double members are passed in memory as specified in psABI. Prior to GCC 4.4, that was not the case. For example:
union U {
  long double ld;
  int i;
};

union U is now always passed in memory. Periodt.

โœจ -Wno-changes-meaning (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 you use it is ill-formed:

struct A;
struct B1 { A a; typedef A A; }; // warning, 'A' changes meaning
struct B2 { A a; struct A { }; }; // error, 'A' changes meaning

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 -Wno-changes-meaning. Alternately, the error case can be reduced to a warning with -Wno-error=changes-meaning or -fpermissive.

Both diagnostics are also suppressed by -fms-extensions. ๐Ÿ’œ

๐ŸŒธ -Wchar-subscripts ๐ŸŒธ

Warns if an array subscript has type char. This is a common cause of error, since programmers often forget that this type is signed on some machines. This warning is enabled by -Wall. ๐Ÿ˜ญ

๐Ÿ’€ -Wno-coverage-mismatch ๐Ÿ’€

Warns if feedback profiles do not match when you're using the -fprofile-use option. If a source file is changed between compiling with -fprofile-generate and with -fprofile-use, the files with the profile feedback can fail to match the source file and GCC can't use the profile feedback information. By default this warning is enabled and is treated as an error. -Wno-coverage-mismatch can be used to disable the warning, or -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. ๐Ÿšจ

๐ŸŽ€ -Wno-coverage-too-many-conditions ๐ŸŽ€

Warns if -fcondition-coverage is used and an expression has 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 gcov_type_unsigned. This warning is enabled by default.

๐Ÿฆ‹ -Wno-coverage-invalid-line-number ๐Ÿฆ‹

Warns in case a function ends earlier than it begins, due to an invalid linenum macros. The warning is emitted only with --coverage enabled.

By default, this warning is enabled and is treated as an error. -Wno-coverage-invalid-line-number can be used to disable the warning, or -Wno-error=coverage-invalid-line-number can be used to disable the error. ๐Ÿ’…

๐Ÿ“ -Wno-cpp (C, Objective-C, C++, Objective-C++ and Fortran only) ๐Ÿ“

Suppresses warning messages emitted by #warning directives. No cap.

๐Ÿ”ฅ -Wdouble-promotion (C, C++, Objective-C and Objective-C++ only) ๐Ÿ”ฅ

Gives a warning when a value of type float is implicitly promoted to double. CPUs with a 32-bit "single-precision" floating-point unit implement float in hardware, but emulate double in software. On such a machine, doing computations using double values is much more expensive because of the overhead required for software emulation. ๐Ÿ’ธ

It's easy to accidentally do computations with double, because floating-point literals are implicitly of type double. For example, in:

float area(float radius)
{
   return 3.14159 * radius * radius;
}

the compiler performs the entire computation with double, because the floating-point literal is a double. Sneaky fr fr.

โญ -Wduplicate-decl-specifier (C and Objective-C only) โญ

Warns if a declaration has duplicate const, volatile, restrict or _Atomic specifier. This warning is enabled by -Wall.

๐Ÿ‘‘ -Wformat / -Wformat=n ๐Ÿ‘‘

  • -Wformat
  • -Wformat=n

Checks calls to printf and 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, in the printf, scanf, strftime and 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 -ffreestanding or -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 -Wpedantic is used with -Wformat, warnings are given about format features not in the selected standard version (but not for strfmon formats, since those are not in any version of the C standard).

-Wformat=1 / -Wformat

Option -Wformat is equivalent to -Wformat=1, and -Wno-format is equivalent to -Wformat=0. Since -Wformat also checks for null format arguments for several functions, -Wformat also implies -Wnonnull. Some aspects of this level of format checking can be disabled by the options: -Wno-format-contains-nul, -Wno-format-extra-args, and -Wno-format-zero-length. -Wformat is enabled by -Wall. ๐Ÿ’–

-Wformat=2

Enables -Wformat plus additional format checks. Currently equivalent to -Wformat -Wformat-nonliteral -Wformat-security -Wformat-y2k.


๐Ÿฆ‹ -Wno-format-contains-nul ๐Ÿฆ‹

If -Wformat is specified, do not warn about format strings that contain NUL bytes.

๐Ÿ’œ -Wno-format-extra-args ๐Ÿ’œ

If -Wformat is specified, do not warn about excess arguments to a printf or scanf format function. The C standard specifies that such arguments are ignored.

Where the unused arguments lie between used arguments that are specified with $ operand number specifications, normally warnings are still given, since the implementation could not know what type to pass to va_arg to skip the unused arguments. However, in the case of 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. iykyk.

๐Ÿ’€ -Wformat-overflow / -Wformat-overflow=level ๐Ÿ’€

  • -Wformat-overflow
  • -Wformat-overflow=level

Warns about calls to formatted input/output functions such as sprintf and vsprintf that might overflow the destination buffer. When the exact number of bytes written by a format directive can't be determined at compile-time, it's estimated based on heuristics that depend on the 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. ๐Ÿ™ˆ

-Wformat-overflow / -Wformat-overflow=1

Level 1 of -Wformat-overflow enabled by -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 sprintf below is diagnosed because even with both a and b equal to zero, the terminating NUL character ('\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. ๐Ÿ˜ฌ

void f (int a, int b)
{
  char buf [13];
  sprintf (buf, "a = %i, b = %i\n", a, b);
}

-Wformat-overflow=2

Level 2 warns also about calls that might overflow the destination buffer given an argument of sufficient length or magnitude. At level 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. ๐Ÿ”ฅ

okay so at level 2, the call in the example above is again diagnosed, but this time because with a equal to a 32-bit INT_MIN the first %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, bestie. ๐Ÿซถ

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 a and b in the example above can be assumed to be within the precision of the short int type then using either the %hi format directive or casting the argument to short reduces the maximum required size of the buffer to 24 bytes. โœจ

void f (int a, int b)
{
  char buf [23];
  sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
}

-Wno-format-zero-length

If -Wformat is specified, do not warn about zero-length formats. The C standard specifies that zero-length formats are allowed. yes bestie, empty is a valid vibe here ๐Ÿ’…

-Wformat-nonliteral

If -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 va_list. ๐Ÿ‘€

-Wformat-security

If -Wformat is specified, also warn about uses of format functions that represent possible security problems. At present, this warns about calls to printf and scanf functions where the format string is not a string literal and there are no format arguments, as in printf (foo);. This may be a security hole if the format string came from untrusted input and contains %n. (This is currently a subset of what -Wformat-nonliteral warns about, but in future warnings may be added to -Wformat-security that are not included in -Wformat-nonliteral.) ๐Ÿšจ

-Wformat-signedness

If -Wformat is specified, also warn if the format string requires an unsigned argument and the argument is signed and vice versa. signed/unsigned drama, we love to see it

-Wformat-truncation

-Wformat-truncation=level

Warn about calls to formatted input/output functions such as snprintf and 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 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 -Wformat-overflow. ๐Ÿ˜ญ

  • -Wformat-truncation
  • -Wformat-truncation=1 โ€” Level 1 of -Wformat-truncation enabled by -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. lowkey chill about it
  • -Wformat-truncation=2 โ€” Level 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. highkey thorough

-Wformat-y2k

If -Wformat is specified, also warn about strftime formats that may yield only a two-digit year. y2k but make it a compiler warning ๐ŸŽ€

-Wnonnull

Warn about passing a null pointer for arguments marked as requiring a non-null value by the nonnull function attribute.

-Wnonnull is included in -Wall and -Wformat. It can be disabled with the -Wno-nonnull option. ๐Ÿฆ‹

-Wnonnull-compare

Warn when comparing an argument marked with the nonnull function attribute against null inside the function.

-Wnonnull-compare is included in -Wall. It can be disabled with the -Wno-nonnull-compare option.

-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 -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. bestie the precision is giving "it depends"

-Wnrvo (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. ๐Ÿ’€

std::vector<int> f()
{
  std::vector<int> v1, v2;
  // ...
  if (cond) return v1;
  else return v2; // warning: not eliding copy
}

-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. -Winfinite-recursion is included in -Wall. ๐Ÿ”

Compare with -Wanalyzer-infinite-recursion which provides a similar diagnostic, but is implemented in a different way (as part of -fanalyzer). same energy, different plumbing

-Winit-self (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 -Wuninitialized option.

For example, GCC warns about i being uninitialized in the following snippet only when -Winit-self has been specified:

int f()
{
  int i = i;
  return i;
}

This warning is enabled by -Wall in C++. โœจ

-Wno-implicit-int (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 -Wall. The error can be downgraded to a warning using -fpermissive (along with certain other errors), or for this error alone, with -Wno-error=implicit-int.

This warning is upgraded to an error by -pedantic-errors. pedantic-errors said "no ๐Ÿ’…"

-Wno-implicit-function-declaration (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 -Wall. The error can be downgraded to a warning using -fpermissive (along with certain other errors), or for this error alone, with -Wno-error=implicit-function-declaration.

This warning is upgraded to an error by -pedantic-errors.

-Wimplicit (C and Objective-C only)

Same as -Wimplicit-int and -Wimplicit-function-declaration. This warning is enabled by -Wall. ๐Ÿซถ

-Whardened

Warn when -fhardened did not enable an option from its set (for which see -fhardened). For instance, using -fhardened and -fstack-protector at the same time on the command line causes -Whardened to warn because -fstack-protector-strong will not be enabled by -fhardened. ๐Ÿ˜ญ

This warning is enabled by default and has effect only when -fhardened is enabled.

-Wimplicit-fallthrough

-Wimplicit-fallthrough is the same as -Wimplicit-fallthrough=3 and -Wno-implicit-fallthrough is the same as -Wimplicit-fallthrough=0. shortcut queen

-Wimplicit-fallthrough=n

Warn when a switch case falls through. For example:

switch (cond)
  {
  case 1:
    a = 1;
    break;
  case 2:
    a = 2;
  case 3:
    a = 3;
    break;
  }

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. -Wimplicit-fallthrough= also takes into account control flow statements, such as ifs, and only warns when appropriate. E.g.

switch (cond)
  {
  case 1:
    if (i > 3) {
      bar (5);
      break;
    } else if (i < 1) {
      bar (0);
    } else
      return;
  default:
    ...
  }

Since there are occasions where a switch case fall through is desirable, GCC provides an attribute, __attribute__ ((fallthrough)), that is to be used along with a null statement to suppress this warning that would normally occur:

switch (cond)
  {
  case 1:
    bar (0);
    __attribute__ ((fallthrough));
  default:
    ...
  }

C++17 provides a standard way to suppress the -Wimplicit-fallthrough warning using [[fallthrough]]; instead of the GNU attribute. In C++11 or C++14 users can use [[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 n specifies what kind of comments are accepted: ๐Ÿ‘‘

  • -Wimplicit-fallthrough=0 disables the warning altogether.
  • -Wimplicit-fallthrough=1 matches .* regular expression, any comment is used as fallthrough comment. anything goes, iconic
  • -Wimplicit-fallthrough=2 case insensitively matches .*falls?[ \t-]*thr(ough|u).* regular expression.
  • -Wimplicit-fallthrough=3 case sensitively matches one of the following regular expressions:

So the regex list for -Wimplicit-fallthrough=3 โ€” the one you'll meet basically every day โ€” is this whole vibe, bestie:

*<"-fallthrough">
*<"@fallthrough@">
*<"lint -fallthrough[ \t]*">
*<"[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?FALL(S | |-)?THR(OUGH|U)[
\t.!]*(-[^\n\r]*)?">
*<"[ \t.!]*(Else,? |Intentional(ly)? )?Fall((s |
|-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?">
*<"[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?fall(s |
|-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?">

And -Wimplicit-fallthrough=4 case sensitively matches one of these:

*<"-fallthrough">
*<"@fallthrough@">
*<"lint -fallthrough[ \t]*">
*<"[ \t]*FALLTHR(OUGH|U)[ \t]*">

And then there's -Wimplicit-fallthrough=5, which is the strictest of them all: it doesn't recognize any comments as fallthrough comments, only attributes disable the warning. No comments, no exceptions, periodt. ๐Ÿ’…

The comment needs to be followed after optional whitespace and other comments by "case" or "default" keywords or by a user label that precedes some "case" or "default" label.

switch (cond)
  {
  case 1:
    bar (0);
    /* FALLTHRU */
  default:
    ...
  }

The -Wimplicit-fallthrough=3 warning is enabled by -Wextra.

  • -Wno-if-not-aligned (C, C++, Objective-C and Objective-C++ only) โ€” controls whether the warnings triggered by the "warn_if_not_aligned" attribute get issued. These warnings are enabled by default. ๐ŸŽ€
  • -Wignored-qualifiers (C and C++ only) โ€” warns you if the return type of a function has a type qualifier like "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 "void". And heads up: ISO C prohibits qualified "void" return types on function definitions, so those return types always receive a warning even without this option. This warning is also enabled by -Wextra. โœจ
  • -Wno-ignored-attributes (C and C++ only) โ€” this one controls warnings when an attribute is ignored. It's different from the -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. ๐Ÿฆ‹
  • -Wmain โ€” warns if the type of "main" is suspicious. "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 -Wall or -Wpedantic. Also: this warning is upgraded to an error by -pedantic-errors. ๐Ÿ‘‘
  • -Wmisleading-indentation (C and C++ only) โ€” warns when the indentation of the code does not reflect the block structure. Specifically, a warning is issued for "if", "else", "while", and "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:

if (some_condition ())
  foo ();
  bar ();  /* Gotcha: this is not guarded by the "if".  */

In the case of mixed tabs and spaces, the warning uses the -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:

if (flagA)
  foo (0);
#if SOME_CONDITION_THAT_DOES_NOT_HOLD
  if (flagB)
#endif
  foo (1);

Also, the warning is not issued after a "#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 -Wall in C and C++. ๐Ÿ’–

  • -Wmissing-attributes โ€” warns 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 -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 "alloc_align", "alloc_size", "cold", "const", "hot", "leaf", "malloc", "nonnull", "noreturn", "nothrow", "pure", "returns_nonnull", and "returns_twice".

In C++, the warning is issued when an explicit specialization of a primary template declared with attribute "alloc_align", "alloc_size", "assume_aligned", "format", "format_arg", "malloc", or "nonnull" is declared without it. Attributes "deprecated", "error", and "warning" suppress the warning.. (yes bestie that double period is in the original, we don't fix it, we respect it ๐Ÿ’€)

You can use the "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.

-Wmissing-attributes is enabled by -Wall.

For example, since the declaration of the primary function template below makes use of both attribute "malloc" and "alloc_size" the declaration of the explicit specialization of the template is diagnosed because it is missing one of the attributes.

template <class T>
T* __attribute__ ((malloc, alloc_size (1)))
allocate (size_t);

template <>
void* __attribute__ ((malloc))   // missing alloc_size
allocate<void> (size_t);

๐Ÿซถ

  • -Wmissing-braces โ€” warns if an aggregate or union initializer is not fully bracketed. In the following example, the initializer for "a" is not fully bracketed, but that for "b" is fully bracketed.
int a[2][2] = { 0, 1, 2, 3 };
int b[2][2] = { { 0, 1 }, { 2, 3 } };

This warning is enabled by -Wall. ๐ŸŒธ

  • -Wmissing-include-dirs (C, C++, Objective-C, Objective-C++ and Fortran only) โ€” warns 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. ๐Ÿ‘€
  • -Wno-missing-profile โ€” this option controls warnings if feedback profiles are missing when using the -fprofile-use option. This option diagnoses those cases where a new function or a new file is added between compiling with -fprofile-generate and with -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. -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.

๐Ÿ˜ญ

  • -Wmismatched-dealloc โ€” warns 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 "malloc". Unless disabled by the -fno-builtin option the standard functions "calloc", "malloc", "realloc", and "free", as well as the corresponding forms of C++ "operator new" and "operator delete" are implicitly associated as matching allocators and deallocators. In the following example "mydealloc" is the deallocator for pointers returned from "myalloc".
void mydealloc (void*);

__attribute__ ((malloc (mydealloc, 1))) void*
myalloc (size_t);

void f (void)
{
  void *p = myalloc (32);
  // ...use p...
  free (p);   // warning: not a matching deallocator for myalloc
  mydealloc (p);   // ok
}

In C++, the related option -Wmismatched-new-delete diagnoses mismatches involving either "operator new" or "operator delete".

Option -Wmismatched-dealloc is included in -Wall. ๐ŸŽ€

  • -Wmultistatement-macros โ€” warns about unsafe multiple statement macros that appear to be guarded by a clause such as "if", "else", "for", "switch", or "while", in which only the first statement is actually guarded after the macro is expanded.

For example:

#define DOIT x++; y++
if (c)
  DOIT;

will increment "y" unconditionally, not just when "c" holds. The can usually be fixed by wrapping the macro in a do-while loop:

#define DOIT do { x++; y++; } while (0)
if (c)
  DOIT;

This warning is enabled by -Wall in C and C++. ๐Ÿ”ฅ

  • -Wparentheses โ€” warns 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 warns if a comparison like "x<=y<=z" appears; this is equivalent to "(x<=y ? 1 : 0) <= z", which is a different interpretation from that of ordinary mathematical notation.

Also warns for dangerous uses of the GNU extension to "?:" with omitted middle operand. When the condition in the "?": 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:

{
  // Declares a local variable called mymutex.
  std::unique_lock<std::mutex> (mymutex);
  // User meant std::unique_lock<std::mutex> lock (mymutex);
}

This warning is enabled by -Wall. ๐Ÿ’–

  • -Wno-self-move (C++ and Objective-C++ only) โ€” bestie this one snitches on you when a value gets moved to itself using std::move. And likeโ€ฆ such a std::move typically does absolutely nothing, so it's giving pointless ๐Ÿ’€
struct T {
...
};
void fn()
{
  T t;
  ...
  t = std::move (t);
}

This warning is enabled by -Wall.

  • -Wsequence-point โ€” warns about code that might have undefined semantics because it's breaking the sequence point rules from the C and C++ standards. ๐Ÿ˜ญ

So here's the tea: the C and C++ standards define the order in which expressions get evaluated in terms of sequence points, which are basically a partial ordering between the execution of parts of the program โ€” the stuff that runs before the sequence point, and the stuff that runs after it. These pop up after the evaluation of a full expression (one that isn't part of a bigger expression), after the evaluation of the first operand of a &&, ||, ? : or , (comma) operator, before a function is called (but after its arguments and the expression denoting the called function get evaluated), and in certain other places. Other than what the sequence point rules say, the order of evaluation of subexpressions of an expression is not specified. All these rules only describe a partial order, not a total order โ€” like, if two functions are called within one expression with no sequence point between them, the order they get called in is not specified. However, the standards committee 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 say: "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 a = a++;, a[n] = b[n++] and 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's been found pretty 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's 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 <https://gcc.gnu.org/readings.html>.

This warning is enabled by -Wall for C and C++.

  • -Wno-return-local-addr โ€” don't warn about returning a pointer (or in C++, a reference) to a variable that goes out of scope after the function returns. ๐Ÿซถ
  • -Wreturn-mismatch โ€” warns about return statements without an expression in functions that don't return void. Also warns about a return statement with an expression in a function whose return type is void, unless the expression type is also void. As a GNU extension, the latter case is accepted without a warning unless -Wpedantic is used.

Attempting to use the return value of a non-void function other than 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's treated as an error. It can be downgraded to a warning using -fpermissive (along with other warnings), or for just this warning, with -Wno-error=return-mismatch.

  • -Wreturn-type โ€” warns whenever a function is defined with a return type that defaults to int (unless -Wimplicit-int is active, which takes precedence). Also warns if execution may reach the end of the function body, or if the function doesn't contain any return statement at all. ๐Ÿ‘‘

Attempting to use the return value of a non-void function other than 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-void function other than 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 -Wall otherwise.

  • -Wno-shift-count-negative โ€” controls warnings if a shift count is negative. This warning is enabled by default.
  • -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.
  • -Wshift-negative-value โ€” warns if you left shift a negative value. This warning is enabled by -Wextra in C99 (and newer) and C++11 to C++17 modes.
  • -Wno-shift-overflow
  • -Wshift-overflow=n โ€” these options control warnings about left shift overflows. โœจ
    • -Wshift-overflow=1 โ€” this is the warning level of -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.
    • -Wshift-overflow=2 โ€” this warning level also warns about left-shifting 1 into the sign bit, unless C++14 mode (or newer) is active.
  • -Wswitch โ€” warns whenever a switch statement has an index of enumerated type and lacks a case for one or more of the named codes of that enumeration. (The presence of a default label prevents this warning.) case labels outside the enumeration range also provoke warnings when this option is used (even if there's a default label). This warning is enabled by -Wall.
  • -Wswitch-default โ€” warns whenever a switch statement doesn't have a default case.
  • -Wswitch-enum โ€” warns whenever a switch statement has an index of enumerated type and lacks a case for one or more of the named codes of that enumeration. case labels outside the enumeration range also provoke warnings when this option is used. The only difference between -Wswitch and this option is that this option gives a warning about an omitted enumeration code even if there's a default label. ๐Ÿ’…
  • -Wno-switch-bool โ€” don't warn when a switch statement has an index of boolean type and the case values are outside the range of a boolean type. It's possible to suppress this warning by casting the controlling expression to a type other than bool. For example:
switch ((int) (a == 4))
  {
  ...
  }

This warning is enabled by default for C and C++ programs.

  • -Wno-switch-outside-range โ€” this option controls warnings when a switch case has a value that's outside of its respective type range. This warning is enabled by default for C and C++ programs.
  • -Wno-switch-unreachable โ€” don't warn when a switch statement contains statements between the controlling expression and the first case label, which will never be executed. For example:
switch (cond)
  {
   i = 15;
  ...
   case 5:
  ...
  }

-Wswitch-unreachable does not warn if the statement between the controlling expression and the first case label is just a declaration:

switch (cond)
  {
   int i;
  ...
   case 5:
   i = 5;
  ...
  }

This warning is enabled by default for C and C++ programs.

  • -Wsync-nand (C and C++ only) โ€” warns when __sync_fetch_and_nand and __sync_nand_and_fetch built-in functions are used. These functions changed semantics in GCC 4.4. ๐Ÿ˜ญ
  • -Wtrivial-auto-var-init โ€” warns when -ftrivial-auto-var-init can't initialize the automatic variable. A common situation is an automatic variable that's declared between the controlling expression and the first case label of a switch statement.
  • -Wunused-but-set-parameter โ€” warns whenever a function parameter is assigned to, but otherwise unused (aside from its declaration).

To suppress this warning use the unused attribute.

This warning is also enabled by -Wunused together with -Wextra.

  • -Wunused-but-set-variable โ€” warns whenever a local variable is assigned to, but otherwise unused (aside from its declaration). This warning is enabled by -Wall.

To suppress this warning use the unused attribute.

This warning is also enabled by -Wunused, which is enabled by -Wall.

  • -Wunused-function โ€” warns whenever a static function is declared but not defined, or a non-inline static function is unused. This warning is enabled by -Wall.
  • -Wunused-label โ€” warns whenever a label is declared but not used. This warning is enabled by -Wall.

To suppress this warning use the unused attribute.

  • -Wunused-local-typedefs (C, Objective-C, C++ and Objective-C++ only) โ€” warns when a typedef locally defined in a function isn't used. This warning is enabled by -Wall.
  • -Wunused-parameter โ€” warns whenever a function parameter is unused aside from its declaration. This option is not enabled by -Wunused unless -Wextra is also specified.

To suppress this warning use the unused attribute.

  • -Wno-unused-result โ€” don't warn if a caller of a function marked with attribute warn_unused_result doesn't use its return value. The default is -Wunused-result. ๐Ÿฆ‹
  • -Wunused-variable โ€” bestie, this one yells at you whenever a local or static variable is just... sitting there, unused, existing only for its declaration and doing absolutely nothing else with its life. It also quietly turns on -Wunused-const-variable=1 for C, but not for C++. Enabled by -Wall.

Wanna shut it up? Slap the "unused" attribute on that variable and move on. ๐Ÿ’…

  • -Wunused-const-variable / -Wunused-const-variable=n โ€” warns when a constant static variable is out here being unused aside from its declaration. Same energy as above.

To suppress it, use the "unused" attribute. โœจ

  • -Wunused-const-variable=1 โ€” warns about unused static const variables defined in the main compilation unit, but not about static const variables declared in any header you included. This level is enabled by either -Wunused-variable or -Wunused for C, but not for C++. Also, a heads-up: in C this declares variable storage, but in C++ this is not an error since const variables take the place of "#define"s.
  • -Wunused-const-variable=2 โ€” this level also warns for unused constant static variables in headers (excluding system headers, thank god). It's equivalent to the short form -Wunused-const-variable. And you must explicitly request this level in both C and C++, because fr fr it might be hard to clean up all headers included. ๐Ÿ˜ญ
  • -Wunused-value โ€” warns whenever a statement computes a result that is explicitly not used. To suppress it, cast the unused expression to "void". This includes an expression-statement or the left-hand side of a comma expression that contains no side effects. Example time: an expression like "x[i,j]" causes a warning, while "x[(void)i,j]" does not. No cap. Enabled by -Wall.
  • -Wunused โ€” the whole squad of the above -Wunused options combined, except those documented as needing to be specified explicitly. ๐Ÿ‘‘

Wanna get a warning about an unused function parameter? You gotta either specify -Wextra -Wunused (and yes, -Wall implies -Wunused), or separately specify -Wunused-parameter and/or -Wunused-but-set-parameter.

Also important: -Wunused enables only -Wunused-const-variable=1 rather than -Wunused-const-variable, and only for C, not C++. Periodt.

  • -Wuse-after-free (C, Objective-C, C++ and Objective-C++ only) / -Wuse-after-free=n โ€” this one warns about uses of pointers to dynamically allocated objects that have been rendered indeterminate by a call to a deallocation function. It's enabled at all optimization levels but might yield different results with optimization than without. ๐ŸŒธ
    • -Wuse-after-free=1 โ€” at level 1, the warning only tries to diagnose unconditional uses of pointers made indeterminate by a deallocation call or a successful call to "realloc", regardless of whether or not the call actually reallocated memory. This includes double-"free" calls plus uses in arithmetic and relational expressions. Even though it's undefined, uses of indeterminate pointers in equality (or inequality) expressions are not diagnosed at this level.
    • -Wuse-after-free=2 โ€” at level 2, on top of unconditional uses, it also diagnoses conditional uses of pointers made indeterminate by a deallocation call. And just like at level 2 (yes, it says level 2), uses in equality (or inequality) expressions are not diagnosed. For example, the second call to "free" in the following function is diagnosed at this level:
        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
        }
  • -Wuse-after-free=3 โ€” at level 3, it also diagnoses uses of indeterminate pointers in equality expressions. All uses of indeterminate pointers are undefined, but equality tests sometimes appear after calls to "realloc" as an attempt to figure out whether the call relocated the object to a different address. They're diagnosed at a separate level to help gradually transition legacy code to safe alternatives. For example, the equality test in the function below is diagnosed at this level:
        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);
        }

To dodge the warning at this level, store offsets into allocated memory instead of pointers. That approach obviates needing to adjust the stored pointers after reallocation. ๐Ÿงš

  • -Wuse-after-free=2 is included in -Wall.
  • -Wuseless-cast (C, Objective-C, C++ and Objective-C++ only) โ€” warns when an expression is cast to its own type. Lowkey iconic. This warning does not occur when a class object is converted to a non-reference type, since that's a way to create a temporary:
        struct S { };
        void g (S&&);
        void f (S&& arg)
        {
          g (S(arg)); // make arg prvalue so that it can bind to S&&
        }
  • -Wuninitialized โ€” warns if an object with automatic or allocated storage duration is used without having been initialized. In C++, it also warns if a non-static reference or non-static "const" member appears in a class without constructors. ๐Ÿ’€

Plus, passing a pointer (or in C++, a reference) to an uninitialized object to a "const"-qualified argument of a built-in function known to read the object is also diagnosed by this warning. (-Wmaybe-uninitialized is issued for ordinary functions instead.)

Wanna warn about code that uses the uninitialized value of the variable in its own initializer? That's -Winit-self's whole job.

These warnings happen 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 "volatile". And because these warnings depend on optimization, the exact variables or elements you get warned about depend on the precise optimization options and version of GCC you're using.

Also note: there may be no warning about a variable that's 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. Sneaky.

In C++, this warning also warns about using uninitialized objects in member-initializer-lists. For example, GCC warns about "b" being uninitialized in this snippet:

        struct A {
          int a;
          int b;
          A() : a(b) { }
        };
  • -Wno-invalid-memory-model โ€” this option controls warnings for invocations of __atomic Builtins, __sync Builtins, and the C11 atomic generic functions with a memory consistency argument that's either invalid for the operation or outside the range of values of the "memory_order" enumeration. For example, since the "__atomic_store" and "__atomic_store_n" built-ins are only defined for the relaxed, release, and sequentially consistent memory orders, the following code is diagnosed:
        void store (int *i)
        {
          __atomic_store_n (i, 0, memory_order_consume);
        }

-Winvalid-memory-model is enabled by default. โœจ

  • -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's initialized, but there exist some other paths where the object is not initialized, the compiler emits a warning if it cannot prove the uninitialized paths aren't executed at run time. ๐Ÿฆ‹

Plus, passing a pointer (or in C++, a reference) to an uninitialized object to a "const"-qualified function argument is also diagnosed by this warning. (-Wuninitialized is issued for built-in functions known to read the object.) Annotating the function with attribute "access (none)" indicates that the argument isn't used to access the object, and avoids the warning.

These warnings are only possible in optimizing compilation, because otherwise GCC doesn't keep track of the state of variables.

They're made optional because GCC may not be able to determine when the code is correct in spite of appearing to have an error. Here's one example of how that can happen:

        {
          int x;
          switch (y)
            {
            case 1: x = 1;
              break;
            case 2: x = 4;
              break;
            case 3: x = 5;
            }
          foo (x);
        }

If the value of "y" is always 1, 2 or 3, then "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.

This option also warns when a non-volatile automatic variable might be changed by a call to "longjmp". The compiler sees only the calls to "setjmp". It cannot know where "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's in fact no problem, because "longjmp" can't actually 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 "noreturn".

This warning is enabled by -Wall or -Wextra.

  • -Wunknown-pragmas โ€” warns when a "#pragma" directive is encountered that GCC doesn't understand. And if this command-line option is used, warnings are even issued for unknown pragmas in system header files. That's not the case if the warnings are only enabled by the -Wall command-line option. ๐ŸŒˆ
  • -Wno-pragmas โ€” do not warn about misuses of pragmas, such as incorrect parameters, invalid syntax, or conflicts between pragmas. See also -Wunknown-pragmas.
  • -Wno-prio-ctor-dtor โ€” okay so bestie, this one says: don't warn when a priority from 0 to 100 gets used for a constructor or destructor. Because the constructor and destructor attributes let you hand a priority to that constructor/destructor to control the order it runs in โ€” either before "main" gets called or after it returns. ๐Ÿ’… But here's the tea: those priority values must be greater than 100, because the compiler reserves the 0--100 range for the implementation itself. So if you're using 0-100, that's a you problem, and GCC is like "not me warning about this."
  • -Wstrict-aliasing โ€” this one only does anything when -fstrict-aliasing is active, iykyk. It warns about code that might break the strict aliasing rules the compiler is using for optimization. Now, it does not catch every single case, but it does try to catch the more common pitfalls. It's included in -Wall. And it's equivalent to -Wstrict-aliasing=3. periodt. โœจ
  • -Wstrict-aliasing=n โ€” again, only active when -fstrict-aliasing is active. Warns about code that might break the strict aliasing rules the compiler uses for optimization. Higher levels = higher accuracy (so fewer false positives, slay). Higher levels also = more effort, kinda like how -O works. And remember, -Wstrict-aliasing is equivalent to -Wstrict-aliasing=3.
    • Level 1: most aggressive, quick, least accurate. Possibly useful when higher levels don't warn but -fstrict-aliasing still breaks the code, since 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 -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: *(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.
  • -Wstrict-overflow
  • -Wstrict-overflow=n โ€” this one's only active when signed overflow is undefined. It warns about cases where the compiler optimizes based on the assumption that signed overflow does not occur. Note that it does not warn about all cases where the code might overflow: it only warns about cases where the compiler implements some optimization. So this warning depends on the optimization level, bestie. ๐Ÿซถ

An optimization that assumes signed overflow does not occur is perfectly safe if the values of the variables involved are such that overflow never does, in fact, occur. Therefore this warning can easily give a false positive: a warning about code that is not actually a problem. To help focus on important issues, several warning levels are defined. No warnings are issued for the use of undefined signed overflow when estimating how many iterations a loop requires, in particular when determining whether a loop will be executed at all. ๐Ÿ˜ญ

  • -Wstrict-overflow=1 โ€” warn about cases that are both questionable and easy to avoid. For example the compiler simplifies x + 1 > x to 1. This level of -Wstrict-overflow is enabled by -Wall; higher levels are not, and must be explicitly requested.
  • -Wstrict-overflow=2 โ€” also warn about other cases where a comparison is simplified to a constant. For example: abs (x) >= 0. This can only be simplified when signed integer overflow is undefined, because abs (INT_MIN) overflows to INT_MIN, which is less than zero. -Wstrict-overflow (with no level) is the same as -Wstrict-overflow=2.
  • -Wstrict-overflow=3 โ€” also warn about other cases where a comparison is simplified. For example: x + 1 > 1 is simplified to x > 0.
  • -Wstrict-overflow=4 โ€” also warn about other simplifications not covered by the above cases. For example: (x * 10) / 5 is simplified to x * 2.
  • -Wstrict-overflow=5 โ€” also warn about cases where the compiler reduces the magnitude of a constant involved in a comparison. For example: x + 2 > y is simplified to x + 1 >= y. This is reported only at the highest warning level because this simplification applies to many comparisons, so this warning level gives a very large number of false positives. ๐Ÿ’€
  • -Wstring-compare โ€” warn for calls to strcmp and 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 strncmp). Such calls could be mistakes, bestie. ๐Ÿ™ˆ For example, the call to strcmp below is diagnosed because its result is necessarily non-zero irrespective of the contents of the array a.
extern char a[4];
void f (char *d)
{
  strcpy (d, "string");
  ...
  if (0 == strcmp (a, d))   // cannot be true
    puts ("a and d are the same");
}

-Wstring-compare is enabled by -Wextra.

  • -Wno-stringop-overflow
  • -Wstringop-overflow
  • -Wstringop-overflow=type โ€” warn for calls to string manipulation functions such as memcpy and strcpy that are determined to 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. The argument is meaningful only for functions that operate on character arrays but not for raw memory functions like memcpy which always make use of Object Size type-0. The option also warns for calls that specify a size in excess of the largest possible object or at most 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 __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. For example, the option issues a warning for the strcpy call below because it copies at least 5 characters (the string "blue" including the terminating NUL) into the buffer of size 4.
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
}

Option -Wstringop-overflow=2 is enabled by default. ๐Ÿ‘‘

  • -Wstringop-overflow
  • -Wstringop-overflow=1 โ€” the -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 _FORTIFY_SOURCE macro is defined to a non-zero value.
  • -Wstringop-overflow=2 โ€” the -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.
  • -Wstringop-overflow=3 โ€” the -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. ๐Ÿ˜ฌ
  • -Wstringop-overflow=4 โ€” the -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 -Wstringop-overflow=3 this setting of the option may result in warnings for benign code.
  • -Wno-stringop-overread โ€” warn for calls to string manipulation functions such as memchr, or strcpy that are determined to read past the end of the source sequence.

Option -Wstringop-overread is enabled by default. โœจ

  • -Wno-stringop-truncation โ€” do not warn for calls to bounded string manipulation functions such as strncat, strncpy, and stpncpy that may either truncate the copied string or leave the destination unchanged.

In the following example, the call to 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 bufsize - strlen (buf) - 1) as the bound. ๐ŸŽ€

void append (char *buf, size_t bufsize)
{
  strncat (buf, ".txt", 3);
}

As another iconic example, this next call to strncpy copies into d literally just the characters before that terminating NUL โ€” and then doesn't append the NUL at the end. Assuming the result of strncpy is necessarily a NUL-terminated string is a super common mistake (we've all been there bestie ๐Ÿ˜ญ), so the call gets diagnosed. If you're not expecting a NUL-terminated result, just call memcpy instead and dodge the warning entirely.

void copy (char *d, const char *s)
{
  strncpy (d, s, strlen (s));
}

And in this little guy, the call to strncpy uses the size of the destination buffer as the bound. If the source string's length is equal to or greater than that size, the copy won't be NUL-terminated. So yeah, also diagnosed. To avoid it, pass sizeof buf - 1 as the bound and set the last element of the buffer to NUL. ๐Ÿ’…

void copy (const char *s)
{
  char buf[80];
  strncpy (buf, s, sizeof buf);
  ...
}

But say you want a character array that stores a sequence of bytes with no terminating NUL โ€” that's valid, no cap. You can annotate that array with attribute nonstring to skip this warning. Heads up though: those arrays are not suitable arguments to functions that expect NUL-terminated strings. To catch accidental misuse of them, GCC issues warnings unless it can prove the use is safe. ๐Ÿ›ก๏ธ


โœจ -Wstrict-flex-arrays (C and C++ only) โœจ

Warns about improper usages of flexible array members, based on the level of the strict_flex_array (level) attribute attached to the trailing array field of a structure if it's available โ€” otherwise based on the level of the option -fstrict-flex-arrays=level. Note that -Wstrict-flex-arrays is only effective when level is greater than 0, fr fr.

  • When level=1, warnings are issued for a trailing array reference of a structure that has 2 or more elements if the trailing array is referenced as a flexible array member.
  • When level=2, on top of level=1, extra warnings are issued for a trailing one-element array reference of a structure if the array is referenced as a flexible array member.
  • When level=3, on top of level=2, even more 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 hits different when -ftree-vrp is active (that's the default for -O2 and above) โ€” but some warnings may still be diagnosed even without optimization. ๐Ÿ‘‘


๐ŸŒˆ -Wsuggest-attribute=[pure|const|noreturn|format|cold|malloc]returns_nonnull| ๐ŸŒˆ

Warns for cases where adding an attribute might be beneficial. The attributes currently supported are listed below, bestie:

  • -Wsuggest-attribute=pure
  • -Wsuggest-attribute=const
  • -Wsuggest-attribute=noreturn
  • -Wmissing-noreturn
  • -Wsuggest-attribute=malloc
  • -Wsuggest-attribute=returns_nonnull
  • -Wno-suggest-attribute=returns_nonnull

Warn about functions that might be candidates for attributes pure, const, noreturn, malloc or returns_nonnull. The compiler only warns for functions visible in other compilation units, or (for pure and const) if it can't prove the function returns normally. A function returns normally if it doesn't contain an infinite loop and doesn't return abnormally by throwing, calling abort, or trapping. This analysis requires the option -fipa-pure-const, which is enabled by default at -O and higher. Higher optimization levels improve how accurate the analysis is. ๐Ÿ“ˆ

  • -Wsuggest-attribute=format
  • -Wmissing-format-attribute

Warn about function pointers that might be candidates for format attributes. Lowkey note: these are only possible candidates, not absolute ones. GCC guesses that function pointers with format attributes used in assignment, initialization, parameter passing, or return statements should have a corresponding 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 should also have a format attribute to avoid the warning.

GCC also warns about function definitions that might be candidates for format attributes. Again, only possible candidates. GCC guesses that format attributes might be appropriate for any function that calls a function like vprintf or vscanf, but that might not always be the case, and some functions where format attributes would be appropriate may not get detected at all. ๐Ÿ™ˆ

  • -Wsuggest-attribute=cold

Warn about functions that might be candidates for the cold attribute. This is based on static detection and generally only warns about functions which always lead to a call to another cold function โ€” think wrappers of C++ throw, or fatal error reporting functions leading to abort.


๐Ÿ’œ -Walloc-size ๐Ÿ’œ

Warn about calls to allocation functions decorated with attribute alloc_size that specify insufficient size for the target type of the pointer the result is assigned to โ€” including calls to the built-in forms of the functions aligned_alloc, alloca, calloc, malloc, and realloc.


๐Ÿ’– -Walloc-zero ๐Ÿ’–

Warn about calls to allocation functions decorated with attribute alloc_size that specify zero bytes, including those to the built-in forms of the functions aligned_alloc, alloca, calloc, malloc, and realloc.

Because the behavior of these functions when called with a zero size differs among implementations (and, in the case of realloc, has been deprecated), relying on it may result in subtle portability bugs and should be avoided. ๐Ÿšจ

๐ŸŽ€ -Wcalloc-transposed-args ๐ŸŽ€

Warn about calls to allocation functions decorated with attribute alloc_size with two arguments, which use the sizeof operator as the earlier size argument and don't use it as the later size argument. This is a coding style warning, no cap.

The first argument to calloc is documented to be the number of elements in the array, while the second argument is the size of each element โ€” so calloc (n, sizeof (int)) is preferred over calloc (sizeof (int), n). If having sizeof in the earlier argument and not the latter is intentional, you can suppress the warning by using calloc (sizeof (struct S) + 0, n) or calloc (1 * sizeof (struct S), 4), or just use sizeof in the later argument as well. Slay. โœจ


๐Ÿฆ‹ -Walloc-size-larger-than=byte-size ๐Ÿฆ‹

Warn about calls to functions decorated with attribute 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 PTRDIFF_MAX on the target. -Walloc-size-larger-than=PTRDIFF_MAX is enabled by default.

Warnings controlled by this option can be disabled either by specifying a byte-size of SIZE_MAX or more, or by -Wno-alloc-size-larger-than.


๐ŸŒธ -Wno-alloc-size-larger-than ๐ŸŒธ

Disable -Walloc-size-larger-than= warnings. This option is equivalent to -Walloc-size-larger-than=SIZE_MAX or larger.


๐Ÿ”ฅ -Walloca ๐Ÿ”ฅ

This option warns on all uses of alloca in the source. All of them. Every single one. ๐Ÿ‘€


๐ŸŒˆ -Walloca-larger-than=byte-size ๐ŸŒˆ

This option warns on calls to alloca with an integer argument whose value is either zero, or that isn't bounded by a controlling predicate that limits its value to at most byte-size. It also warns for calls to 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 alloca could be:

void func (size_t n)
{
  void *p;
  if (n <= 1000)
    p = alloca (n);
  else
    p = malloc (n);
  f (p);
}

In the above example, passing -Walloca-larger-than=1000 would not issue a warning because the call to alloca is known to be at most 1000 bytes. But if -Walloca-larger-than=500 were passed, the compiler would emit a warning. Slippery slope fr.

Unbounded uses, on the other hand, are uses of alloca with no controlling predicate constraining its integer argument. Like this:

void func ()
{
  void *p = alloca (n);
  f (p);
}

If -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:

void func (signed int n)
{
  if (n < 500)
    {
      p = alloca (n);
      f (p);
    }
}

In the above example, n could be negative, causing a larger than expected argument to be implicitly cast into the alloca call. ๐Ÿ’€

This option also warns when alloca is used in a loop.

-Walloca-larger-than=PTRDIFF_MAX is enabled by default but is usually only effective when -ftree-vrp is active (default for -O2 and above).

See also -Wvla-larger-than=byte-size.


๐ŸŒŸ -Wno-alloca-larger-than ๐ŸŒŸ

Disable -Walloca-larger-than= warnings. This option is equivalent to -Walloca-larger-than=SIZE_MAX or larger.


๐Ÿ’… -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 -Wconversion, -Wfloat-conversion, and -Wsign-conversion.

void f (char c, int i)
{
  c = c + i; // warns with B<-Wconversion>
  c = c + 1; // only warns with B<-Warith-conversion>
}

โญ -Warray-bounds โญ

โญ -Warray-bounds=n โญ

Warn about out of bounds subscripts or offsets into arrays. This warning is enabled by -Wall. It's more effective when -ftree-vrp is active (the default for -O2 and above), but a subset of instances are issued even without optimization. ๐Ÿซถ

So like, bestie, by default the trailing array of a struct is treated as a flexible array member by -Warray-bounds or -Warray-bounds=n if it's declared as any of these:

  • a flexible array member per the C99 standard onwards โ€” that's []
  • a GCC zero-length array extension โ€” that's [0]
  • a one-element array โ€” that's [1]

And because of that, out-of-bounds subscripts or offsets into zero-length arrays or one-element arrays justโ€ฆ don't get warned about by default. Silent. Sneaky. Iconic but dangerous. ๐Ÿ’…

You can add -fstrict-flex-arrays or -fstrict-flex-arrays=level to control how this option treats the trailing array of a structure as a flexible array member:

  • when level<=1, no change to the default behavior.
  • when level=2, additional warnings will be issued for out of bounds subscripts or offsets into one-element arrays;
  • when level=3, in addition to level=2, additional warnings will be issued for out of bounds subscripts or offsets into zero-length arrays.
  • -Warray-bounds=1 โ€” this is the default warning level of -Warray-bounds and it's enabled by -Wall. The higher levels are not, and you have to explicitly request them. No auto-upgrade, bestie.
  • -Warray-bounds=2 โ€” this warning level also warns about the intermediate results of pointer arithmetic that may yield out of bounds values. Heads up tho: this level may give a larger number of false positives, and it is deactivated by default. ๐Ÿซ 

-Warray-compare ๐Ÿง

Warns about equality and relational comparisons between two operands of array type. This comparison was deprecated in C++20. For example:

        int arr1[5];
        int arr2[5];
        bool same = arr1 == arr2;

-Warray-compare is enabled by -Wall. Freebie warning, you're welcome. โœจ


-Warray-parameter / -Warray-parameter=n ๐Ÿ“

Warns about redeclarations of functions involving parameters of array or pointer types of inconsistent kinds or forms, and enables the detection of out-of-bounds accesses to such parameters by warnings such as -Warray-bounds.

So here's the tea: 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 -Warray-bounds or -Wstringop-overflow. At level 1, the warning diagnoses inconsistencies involving array parameters declared using the T[static N] form.

For example, the warning triggers for the second declaration of f because the first one with the keyword 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 f. Caught in 4K.

        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)
          ...
        }

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.

        void g (int*);
        void g (int[]);     // no warning
        void g (int[8]);    // warning (inconsistent array bound)

-Warray-parameter=2 is included in -Wall. And the -Wvla-parameter option triggers warnings for similar inconsistencies involving Variable Length Array arguments. VLAs stay messy, we been knew.

The short form of the option -Warray-parameter is equivalent to -Warray-parameter=2. The negative form -Wno-array-parameter is equivalent to -Warray-parameter=0. ๐Ÿ“


-Wattribute-alias=n / -Wno-attribute-alias ๐ŸŽญ

Warns about declarations using the alias and similar attributes whose target is incompatible with the type of the alias.

  • -Wattribute-alias=1 โ€” the default warning level of the -Wattribute-alias option diagnoses incompatibilities between the type of the alias declaration and that of its target. Such incompatibilities are typically indicative of bugs. Bugs. In MY code? It's more likely than you think. ๐Ÿ˜ญ
  • -Wattribute-alias=2 โ€” at this level -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 -Wmissing-attributes option, which controls diagnostics when the alias declaration is less restrictive than the target, rather than more restrictive.

Attributes considered include alloc_align, alloc_size, cold, const, hot, leaf, malloc, nonnull, noreturn, nothrow, pure, returns_nonnull, and returns_twice. That's the whole roster, no subs. ๐Ÿ‘‘

-Wattribute-alias is equivalent to -Wattribute-alias=1. This is the default. You can disable these warnings with either -Wno-attribute-alias or -Wattribute-alias=0.


-Wbidi-chars=[none|unpaired|any|ucn] ๐Ÿชž

Warns 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. That's literally a jumpscare. ๐Ÿ’€

There are three levels of warning supported by GCC. The default is -Wbidi-chars=unpaired, which warns about improperly terminated bidi contexts. -Wbidi-chars=none turns the warning off. -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 -Wbidi-chars=unpaired,ucn or -Wbidi-chars=any,ucn. Using -Wbidi-chars=ucn is valid, and is equivalent to -Wbidi-chars=unpaired,ucn, if no previous -Wbidi-chars=any was specified. Order matters, bestie, keep track. ๐ŸŽ€


-Wbool-compare โš–๏ธ

Warns about boolean expression compared with an integer value different from true/false. For instance, the following comparison is always false:

        int n = 5;
        ...
        if ((n > 1) == 2) { ... }

This warning is enabled by -Wall. Always false? Girl, that's not a condition, that's a vibe. ๐Ÿ™ˆ


-Wbool-operation ๐Ÿ”

Warns 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 -Wall. โœจ


-Wduplicated-branches ๐Ÿชž

Warns when an if-else has identical branches. This warning detects cases like

        if (p != NULL)
          return 0;
        else
          return 0;

It doesn't warn when both branches contain just a null statement. This warning also warn for conditional operators:

          int i = x ? *p : *p;

Same branch twice? That's not a choice, that's a bit. ๐Ÿ’…


-Wduplicated-cond ๐Ÿ”‚

Warns about duplicated conditions in an if-else-if chain. For instance, warn for the following code:

        if (p->q != NULL) { ... }
        else if (p->q != NULL) { ... }

Bestie you already asked that. It's the same question. ๐Ÿ˜ญ


-Wframe-address ๐Ÿชœ

Warns when the __builtin_frame_address or __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 -Wall. Crash the program?? Not the crashout arc. ๐Ÿ’€


-Wno-discarded-qualifiers (C and Objective-C only) ๐Ÿท๏ธ

Do not warn if type qualifiers on pointers are being discarded. Typically, the compiler warns if a const char * variable is passed to a function that takes a char * parameter. This option can be used to suppress such a warning. You're allowed to be messy on purpose, bestie.


-Wno-discarded-array-qualifiers (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 const int (*)[] variable is passed to a function that takes a int (*)[] parameter. This option can be used to suppress such a warning.


-Wno-incompatible-pointer-types (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 -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 -fpermissive (along with certain other errors), or for this error alone, with -Wno-error=incompatible-pointer-types.

This warning is upgraded to an error by -pedantic-errors. Pedantic mode does NOT play. Periodt. ๐ŸŽ€


-Wno-int-conversion (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 -Wno-int-to-pointer-cast and -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 -fpermissive (along with certain other errors), or for this error alone, with -Wno-error=int-conversion.

This warning is upgraded to an error by -pedantic-errors. ๐Ÿ’…


-Wzero-length-bounds 0๏ธโƒฃ

Warns 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. Undefined behavior, bestie. We do not stan.

For example, the first two stores in function bad are diagnosed because the array elements overlap the subsequent members b and c. The third store is diagnosed by -Warray-bounds because it is beyond the bounds of the enclosing object.

        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
                   }

And bestie, just so you know: -Wzero-length-bounds is enabled by -Warray-bounds. ๐Ÿ’–

  • -Wno-div-by-zero โ€” Don't warn about integer division by zero when it's known at compile time. Floating-point division by zero? That's not warned about, because it can be a totally legit way to get infinities and NaNs. โœจ
  • -Wsystem-headers โ€” Print warning messages for stuff found in system header files. Normally warnings from system headers are suppressed, because the assumption is they usually don't indicate real problems and would only make 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. But heads up: using -Wall together with this option does not warn about unknown pragmas in system headersโ€”for that, -Wunknown-pragmas must also be used. ๐Ÿ’…
  • -Wtautological-compare โ€” Warn if a self-comparison always evaluates to true or false. This warning catches various mistakes like:
                   int i = 1;
                   ...
                   if (i > i) { ... }

It also warns about bitwise comparisons that always evaluate to true or false, for instance:

                   if ((a & 16) == 10) { ... }

which will always be false. This warning is enabled by -Wall. ๐Ÿ‘‘

  • -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's made up of data only and thus requires no special treatment. But for most targets, it's made up of code and thus requires the stack to be made executable in order for the program to work properly. ๐Ÿ˜ญ
  • -Wfloat-equal โ€” Warn if floating-point values are used in equality comparisons. The idea behind this is that sometimes it's convenient (for the programmer) to consider floating-point values as approximations to infinitely precise real numbers. If you're 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. ๐Ÿฆ‹
  • -Wtraditional (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. Here's the whole vibe check:
    • 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.
    • In traditional C, some preprocessor directives did not exist. Traditional preprocessors only considered a line to be a directive if the # appeared in column 1 on the line. Therefore -Wtraditional warns about directives that traditional C understands but ignores because the # does not appear as the first character on the line. It also suggests you hide directives like "#pragma" not understood by traditional C by indenting them. Some traditional implementations do not recognize "#elif", so this option suggests avoiding it altogether.
    • A function-like macro that appears without arguments.
    • The unary plus operator.
    • The U integer constant suffix, or the F or L floating-point constant suffixes. (Traditional C does support the L suffix on integer constants.) Note, these suffixes appear in macros defined in the system headers of most modern systems, e.g. the _MIN/_MAX macros in "<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.
    • A function declared external in one block and then used after the end of the block.
    • A "switch" statement has an operand of type "long".
    • A non-"static" function declaration follows a "static" one. This construct is not accepted by some traditional C compilers.
    • 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.
    • Usage of ISO string concatenation is detected.
    • Initialization of automatic aggregates.
    • Identifier conflicts with labels. Traditional C lacks a separate namespace for labels.
    • 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. "__STDC__" to avoid missing initializer warnings and relies on default initialization to zero in the traditional C case.
    • 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 -Wtraditional-conversion.
    • Use of ISO C style function definitions. This warning intentionally is 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, "PARAMS" and "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.
  • -Wtraditional-conversion (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. ๐Ÿ”ฅ
  • -Wdeclaration-after-statement (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. This warning is upgraded to an error by -pedantic-errors. ๐Ÿ˜ญ
  • -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 -Wno-shadow=local and -Wno-shadow=compatible-local are ignored when -Wshadow is used. Same as -Wshadow=global. ๐Ÿ’…
  • -Wno-shadow-ivar (Objective-C only) โ€” Do not warn whenever a local variable shadows an instance variable in an Objective-C method. ๐Ÿ™ˆ
  • -Wshadow=global โ€” Warn for any shadowing. Same as -Wshadow. ๐Ÿ‘‘
  • -Wshadow=local โ€” Warn when a local variable shadows another local variable or parameter. โœจ
  • -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 -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:
                   for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
                   {
                     for (int i = 0; i < N; ++i)
                     {
                       ...
                     }
                     ...
                   }

Since the two variable "i" in the example above have incompatible types, enabling only -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 -Wshadow=local can possibly reduce the number of warnings triggered by intentional shadowing. Note that this also means that shadowing "const char *i" by "char *i" does not emit a warning. This warning is also enabled by -Wshadow=local. ๐ŸŽ€

  • -Wlarger-than=byte-size โ€” Warn whenever an object is defined whose size exceeds byte-size. -Wlarger-than=PTRDIFF_MAX is enabled by default. Warnings controlled by the option can be disabled either by specifying byte-size of SIZE_MAX or more or by -Wno-larger-than. Also warn for calls to bounded functions such as "memchr" or "strnlen" that specify a bound greater than the largest possible object, which is PTRDIFF_MAX bytes by default. These warnings can only be disabled by -Wno-larger-than. ๐Ÿ”ฅ
  • -Wno-larger-than โ€” Disable -Wlarger-than= warnings. The option is equivalent to -Wlarger-than=SIZE_MAX or larger. ๐Ÿ’€
  • -Wframe-larger-than=byte-size โ€” bestie, this one clocks your function frames ๐Ÿ‘€ if a frame gets bigger than byte-size, it warns you. BUT โš ๏ธ the math it does to figure out the stack frame size is approximate and not conservative โ€” so the real requirements might be somewhat greater than byte-size even if you don't get a warning. And plot twist: any space allocated via alloca, variable-length arrays, or related constructs is not included by the compiler when deciding whether to warn you. -Wframe-larger-than=PTRDIFF_MAX is enabled by default. You can turn these warnings off either by specifying a byte-size of SIZE_MAX or more, or with -Wno-frame-larger-than.
  • -Wno-frame-larger-than โ€” turns off the -Wframe-larger-than= warnings. It's the exact same energy as -Wframe-larger-than=SIZE_MAX or larger. no cap ๐Ÿ’…
  • -Wfree-nonheap-object โ€” warns when you try to deallocate something that either wasn't allocated on the heap, or you're using a pointer that wasn't returned from a prior call to the corresponding allocation function. Like, for example: since stpcpy returns a pointer to the terminating nul character and not to the beginning of the object, that free call down there gets diagnosed:
void f (char *p)
{
  p = stpcpy (p, "abc");
  // ...
  free (p);   // warning
}

-Wfree-nonheap-object is included in -Wall. ๐Ÿซถ

  • -Wstack-usage=byte-size โ€” warns if a function's stack usage might exceed byte-size. The computation here is conservative (opposite vibe from the frame one, iykyk). Any space allocated via alloca, variable-length arrays, or related constructs is included by the compiler when determining whether to warn you.

The message matches the output of -fstack-usage.

  • If the stack usage is fully static but exceeds the specified amount, it's:
warning: stack usage is 1120 bytes
  • If the stack usage is (partly) dynamic but bounded, it's:
warning: stack usage might be 1648 bytes
  • If the stack usage is (partly) dynamic and not bounded, it's:
warning: stack usage might be unbounded

-Wstack-usage=PTRDIFF_MAX is enabled by default. You can disable these warnings either by specifying a byte-size of SIZE_MAX or more, or with -Wno-stack-usage.

  • -Wno-stack-usage โ€” disables the -Wstack-usage= warnings. Equivalent to -Wstack-usage=SIZE_MAX or larger. โœจ
  • -Wunsafe-loop-optimizations โ€” warns if the loop can't be optimized because the compiler can't assume anything about the bounds of the loop indices. With -funsafe-loop-optimizations, it warns if the compiler does make such assumptions. the way that... ๐Ÿ’€
  • -Wno-pedantic-ms-format (MinGW targets only) โ€” when you use this together with -Wformat and -pedantic without GNU extensions, it disables the warnings about non-ISO printf / scanf format width specifiers I32, I64, and I used on Windows targets, which depend on the MS runtime.
  • -Wpointer-arith โ€” warns about anything that depends on the "size of" a function type or of void. GNU C assigns these types a size of 1, for convenience in calculations with void * pointers and pointers to functions. In C++, it also warns when an arithmetic operation involves NULL. This warning is also enabled by -Wpedantic.
Heads up bestie: this warning is upgraded to an error by -pedantic-errors. ๐Ÿ˜ญ
  • -Wno-pointer-compare โ€” does not warn if a pointer is compared with a zero character constant. That usually means the pointer was meant to be dereferenced. For example:
const char *p = foo ();
if (p == '\0')
  return 42;

Note that the code above is invalid in C++11. ๐Ÿšจ

This warning is enabled by default.

  • -Wno-tsan โ€” disables warnings about unsupported features in ThreadSanitizer.

ThreadSanitizer does not support std::atomic_thread_fence and can report false positives. ๐Ÿ™ˆ

  • -Wtype-limits โ€” warns if a comparison is always true or always false due to the limited range of the data type, but does not warn for constant expressions. For example, warn if an unsigned variable is compared against zero with < or >=. This warning is also enabled by -Wextra.
  • -Wabsolute-value (C and Objective-C only) โ€” warns for calls to standard functions that compute the absolute value of an argument when a more appropriate standard function is available. For example, calling abs(3.14) triggers the warning because the appropriate function to call to compute the absolute value of a double argument is 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's also enabled by -Wextra.
  • -Wcomment
  • -Wcomments โ€” warns whenever a comment-start sequence /* appears in a /* comment, or whenever a backslash-newline appears in a // comment. This warning is enabled by -Wall. ๐ŸŒธ
  • -Wtrigraphs โ€” warns if any trigraphs are encountered that might change the meaning of the program. Trigraphs within comments are not warned about, except those that would form escaped newlines.

This option is implied by -Wall. If -Wall is not given, this option is still enabled unless trigraphs are enabled. To get trigraph conversion without warnings, but get the other -Wall warnings, use -trigraphs -Wall -Wno-trigraphs.

  • -Wundef โ€” warns if an undefined identifier is evaluated in an #if directive. Such identifiers are replaced with zero.
  • -Wexpansion-to-defined โ€” warns whenever defined is encountered in the expansion of a macro (including the case where the macro is expanded by an #if directive). Such usage is not portable. This warning is also enabled by -Wpedantic and -Wextra.
  • -Wunused-macros โ€” warns about macros defined in the main file that are unused. A macro is used if it is expanded or tested for existence at least once. The preprocessor also warns if the macro has not been used at the time it is redefined or undefined.

Built-in macros, macros defined on the command line, and macros defined in include files are not warned about.

Note ๐Ÿ“: if a macro is actually used, but only used in skipped conditional blocks, then the preprocessor reports it as unused. To avoid the warning in such a case, you might improve the scope of the macro's definition by, for example, moving it into the first skipped block. Alternatively, you could provide a dummy use with something like:
#if defined the_macro_causing_the_warning
#endif
  • -Wno-endif-labels โ€” does not warn whenever an #else or an #endif are followed by text. This sometimes happens in older programs with code of the form
#if FOO
...
#else FOO
...
#endif FOO

The second and third FOO should be in comments. This warning is on by default.

  • -Wbad-function-cast (C and Objective-C only) โ€” warns 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. ๐Ÿ’€
  • -Wc90-c99-compat (C and Objective-C only) โ€” warns about features not present in ISO C90, but present in ISO C99. For instance, warn about use of variable length arrays, long long type, 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 __extension__.
  • -Wc99-c11-compat (C and Objective-C only) โ€” warns about features not present in ISO C99, but present in ISO C11. For instance, warn about use of anonymous structures and unions, _Atomic type qualifier, _Thread_local storage-class specifier, _Alignas specifier, Alignof operator, _Generic keyword, and so on. This option is independent of the standards mode. Warnings are disabled in the expression that follows __extension__.
  • -Wc11-c23-compat (C and Objective-C only)
  • -Wc11-c2x-compat (C and Objective-C only) โ€” warns about features not present in ISO C11, but present in ISO C23. For instance, warn about omitting the string in _Static_assert, use of [[]] 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 __extension__. The name -Wc11-c2x-compat is deprecated. ๐Ÿ‘‘

When not compiling in C23 mode, these warnings are upgraded to errors by -pedantic-errors.

  • -Wc++-compat (C and Objective-C only) โ€” warns about ISO C constructs that are outside of the common subset of ISO C and ISO C++, e.g. request for implicit conversion from void * to a pointer to non-void type.
  • -Wc++11-compat (C++ and Objective-C++ only) โ€” warns 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 -Wnarrowing and is enabled by -Wall.
  • -Wc++14-compat (C++ and Objective-C++ only) โ€” warns about C++ constructs whose meaning differs between ISO C++ 2011 and ISO C++ 2014. This warning is enabled by -Wall.
  • -Wc++17-compat (C++ and Objective-C++ only) โ€” warns about C++ constructs whose meaning differs between ISO C++ 2014 and ISO C++ 2017. This warning is enabled by -Wall.
  • -Wc++20-compat (C++ and Objective-C++ only) โ€” warns about C++ constructs whose meaning differs between ISO C++ 2017 and ISO C++ 2020. This warning is enabled by -Wall.
  • -Wno-c++11-extensions (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 -Wpedantic is used.
  • -Wno-c++14-extensions (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 -Wpedantic is used.
  • -Wno-c++17-extensions (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 -Wpedantic is used.
  • -Wno-c++20-extensions (C++ and Objective-C++ only) โ€” bestie, this one says don't yell at me about C++20 constructs when I'm compiling with an older C++ standard. And lowkey even if you don't pass it, some C++20 constructs only get diagnosed when you're using -Wpedantic anyway. So it's giving "chill, I know what I'm doing" ๐Ÿ’…
  • -Wno-c++23-extensions (C++ and Objective-C++ only) โ€” same energy, but for C++23 constructs in code being compiled with an older C++ standard. And fr fr, even without this option, some C++23 constructs are only diagnosed if -Wpedantic is in the mix. โœจ
  • -Wno-c++26-extensions (C++ and Objective-C++ only) โ€” and the trilogy concludes: no warnings about C++26 constructs when you're compiling against an older C++ standard. Again, some C++26 constructs only get diagnosed under -Wpedantic, option or no option. ๐Ÿฆ‹
  • -Wcast-qual โ€” okay so this one goes off whenever a pointer gets cast in a way that strips a type qualifier off the target type. Like, if a const char * gets cast to a plain old char *? Yeah, that's a warning, bestie. ๐Ÿ˜ญ

It also warns when a cast introduces a type qualifier in an unsafe way. Example: casting char ** to const char ** is unsafe, and here's literally why:

/* 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';
  • -Wcast-align โ€” warn whenever a pointer cast makes the required alignment of the target go โฌ†๏ธ up. Classic case: a char * getting cast to an int * on machines where ints can only be accessed at two- or four-byte boundaries. Alignment is not a vibe, it's a rule. ๐Ÿ™ˆ
  • -Wcast-align=strict โ€” the exact same warning (pointer cast raises required alignment of the target, e.g. char * โ†’ int *) but regardless of the target machine. No "well, this machine is fine" passes. Strict is strict, periodt. ๐Ÿ‘‘
  • -Wcast-function-type โ€” warn when a function pointer gets cast to an incompatible function pointer. The deets: in a cast involving function types with a variable argument list, only the types of the 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 int vs. long on ILP32 targets. Likewise type qualifiers are ignored. The function type void (*) (void) is special and matches everything, which you can use to suppress this warning. In a cast involving pointer-to-member types, this warning fires whenever the type cast is changing the pointer-to-member type. And heads up โ€” this warning is enabled by -Wextra. ๐Ÿ”ฅ
  • -Wcast-user-defined โ€” warn when a cast to reference type doesn't involve a user-defined conversion that the programmer might have expected to be called. Like:
struct A { operator const int&(); } a;
auto r = (int&)a; // warning

This warning is enabled by default. So it's just there, watching. ๐Ÿ‘€

  • -Wwrite-strings โ€” okay so in C, this gives string constants the type const char[length], which means copying the address of one into a non-const char * pointer produces a warning. These warnings help you find code at compile time that can try to write into a string constant โ€” but only if you've been super careful about using const in declarations and prototypes. Otherwise it's just a nuisance, and that's literally why -Wall doesn't request these warnings. ๐Ÿ’€

In C++, it warns about the deprecated conversion from string literals to char *. This warning is enabled by default for C++ programs.

Also: this warning is upgraded to an error by -pedantic-errors in C++11 mode or later. Not a drill. ๐Ÿšจ

  • -Wclobbered โ€” warn about variables that might get changed by longjmp or vfork. Also enabled by -Wextra. Those variables really said "I'm in danger" ๐Ÿ˜ญ
  • -Wno-complain-wrong-lang โ€” by default, language front ends complain when a command-line option is valid but not applicable to that front end. You can turn that off with -Wno-complain-wrong-lang, which is mostly useful when you're invoking a single compiler driver for multiple source files written in different languages. For example:
$ g++ -fno-rtti a.cc b.f90

The driver g++ invokes the C++ front end to compile a.cc and the Fortran front end to compile b.f90. That latter front end diagnoses f951: Warning: command-line option '-fno-rtti' is valid for C++/D/ObjC++ but not for Fortran, which may be disabled with -Wno-complain-wrong-lang. Snitchy little front end, honestly. ๐Ÿ™ˆ

  • -Wcompare-distinct-pointer-types (C and Objective-C only) โ€” warn if pointers of distinct types are compared without a cast. Enabled by default. Don't compare apples to int *, bestie. ๐Ÿ“
  • -Wconversion โ€” warn for implicit conversions that may alter a value. This includes:
    • conversions between real and integer, like abs (x) when x is double
    • conversions between signed and unsigned, like unsigned ui = -1
    • conversions to smaller types, like sqrtf (M_PI)

It does not warn for explicit casts like abs ((int) x) and ui = (unsigned) -1, or if the value isn't changed by the conversion โ€” like in abs (2.0). Warnings about conversions between signed and unsigned integers can be disabled by using -Wno-sign-conversion.

For C++, it also warns for confusing overload resolution for user-defined conversions, and conversions that never use a type conversion operator: conversions to 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 -Wsign-conversion is explicitly enabled.

And one more: warnings about conversion from arithmetic on a small type back to that type are only given with -Warith-conversion. ๐ŸŒธ

  • -Wdangling-else โ€” warn about constructions where there might be confusion about which if statement an else branch belongs to. Here's an example of such a case:
{
  if (a)
    if (b)
      foo ();
  else
    bar ();
}

In C/C++, every else branch belongs to the innermost possible if statement โ€” which in this example is if (b). That is often not what the programmer expected, as the indentation in the above example illustrates. When there's potential for this confusion, GCC issues a warning when this flag is specified. To eliminate the warning, add explicit braces around the innermost if statement so there's no way the else can belong to the enclosing if. The resulting code looks like this:

{
  if (a)
    {
      if (b)
        foo ();
      else
        bar ();
    }
}

This warning is enabled by -Wparentheses. ๐ŸŽ€

  • -Wdangling-pointer
  • -Wdangling-pointer=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. On top of that, it warns about storing the address of such objects in escaped pointers. The warning is enabled at all optimization levels, but it may yield different results with optimization than without. ๐Ÿ‘‘
    • -Wdangling-pointer=1 โ€” at level 1, the warning diagnoses only unconditional uses of dangling pointers.
    • -Wdangling-pointer=2 โ€” at level 2, in addition to unconditional uses, the warning also diagnoses conditional uses of dangling pointers.

The short form -Wdangling-pointer is equivalent to -Wdangling-pointer=2, while -Wno-dangling-pointer and -Wdangling-pointer=0 have the same effect of disabling the warnings. And -Wdangling-pointer=2 is included in -Wall. โœจ

This example triggers the warning at level 1 โ€” the address of the unnamed temporary is unconditionally referenced outside of its scope:

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;
}

In the following function, the store of the address of the local variable x in the escaped pointer *p triggers the warning at level 1:

void g (int **p)
{
  int x = 7;
  // warning: storing the address of local variable 'x' in '*p'
  *p = &x;
}

In this example, the array a is out of scope when the pointer s is used. Since the code that sets s is conditional, the warning triggers at level 2:

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);
}
  • -Wdate-time โ€” warn when the macros __TIME__, __DATE__ or __TIMESTAMP__ are encountered, because they might prevent bit-wise-identical reproducible compilations. Not the reproducible-build girlies' fav ๐Ÿ˜ญ
  • -Wempty-body โ€” warn if an empty body occurs in an if, else or do while statement. Also enabled by -Wextra. An empty body said absolutely nothing and that was the problem ๐Ÿ’€
  • -Wno-endif-labels โ€” do not warn about stray tokens after #else and #endif. Live your truth, leave your little notes there. ๐Ÿซถ
  • -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 -Wall. Comparing two different enums is giving "these are not the same thing bestie" ๐Ÿ’…
  • -Wenum-conversion โ€” warn when a value of enumerated type is implicitly converted to a different enumerated type. This warning is enabled by -Wextra in C. ๐ŸŒˆ
  • -Wenum-int-mismatch (C and Objective-C only) โ€” warn about mismatches between an enumerated type and an integer type in declarations. For example:
enum E { l = -1, z = 0, g = 1 };
int foo(void);
enum E foo(void);

In C, an enumerated type is compatible with 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 -Wall and -Wc++-compat. ๐Ÿ”ฅ

  • -Wjump-misses-init (C, Objective-C only) โ€” okay bestie, so this one yells at you when a goto or a switch jumps forward across a variable's initialization, or jumps backward to a label after that variable already got initialized. It only cares about variables that get initialized at the moment they're declared, bestie, so if you declared it then assigned it later, this warning is not the one. Also it's literally only a thing for C and Objective-C โ€” in C++ this kinda branch is just an error, no warning, no mercy, periodt. ๐Ÿ’…

This one is bundled up inside -Wc++-compat, and you can turn it off with -Wno-jump-misses-init. slay.

  • -Wsign-compare โ€” warns you when a comparison between a signed value and an unsigned value could give you a wrong answer, specifically when that signed value gets converted to unsigned and just. ruins everything. In C++, -Wall turns this on too. In C, -Wextra is the one that turns it on. ๐ŸŒธ
  • -Wsign-conversion โ€” warns about implicit conversions that might flip the sign of an integer value, like assigning a signed integer expression into an unsigned integer variable. An explicit cast silences it, no cap. In C, this option also gets enabled by -Wconversion.
  • -Wflex-array-member-not-at-end (C and C++ only) โ€” warns when a struct that has a C99 flexible array member as its last field is itself not sitting at the end of another struct. It's giving "this layout is not what you think it is." For example, it warns about:
struct flex  { int length; char data[]; };
struct mid_flex { int m; struct flex flex_data; int n; };

๐Ÿ˜ญ iconic problem honestly.

  • -Wfloat-conversion โ€” warns about implicit conversions that reduce the precision of a real value. That includes real โ†’ integer, and higher-precision real โ†’ lower-precision real. Also gets enabled by -Wconversion. ๐Ÿฆ‹
  • -Wno-scalar-storage-order โ€” do not warn on suspicious constructs involving reverse scalar storage order. simple as that bestie.
  • -Wsizeof-array-div โ€” warns about dividing two sizeof operators when the first one is applied to an array and the divisor isn't equal to the size of the array's element. Because in that case the computation is NOT gonna give you the number of elements in the array, which is like, almost definitely what you wanted. It warns about stuff like:
int fn ()
{
  int arr[10];
  return sizeof (arr) / sizeof (short);
}

Enabled by -Wall. ๐Ÿ’œ

  • -Wsizeof-pointer-div โ€” warns for suspicious divisions of two sizeof expressions that divide the pointer size by the element size โ€” which is literally the classic way to compute array size but does NOT work out when you're holding a pointer. It warns about e.g. sizeof (ptr) / sizeof (ptr[0]) when ptr is not an array but a pointer. Enabled by -Wall. ๐Ÿ”ฅ
  • -Wsizeof-pointer-memaccess โ€” warns for suspicious length parameters handed to certain string and memory built-in functions when the argument uses sizeof. Like it triggers on memset (ptr, 0, sizeof (ptr)); when ptr is a pointer, not an array โ€” and it even suggests a possible fix. Also flags stuff like memcpy (&foo, ptr, sizeof (&foo));.

It ALSO warns about calls to bounded string copy functions like strncat or strncpy that pass a sizeof expression of the source array as the bound. Look at this โ€” the strncat call passes the size of the source string as the bound, which is almost certainly a mistake, so the call gets diagnosed:

void make_file (const char *name)
{
  char path[PATH_MAX];
  strncpy (path, name, sizeof path - 1);
  strncat (path, ".text", sizeof ".text");
  ...
}

This option is enabled by -Wall. โœจ

  • -Wno-sizeof-array-argument โ€” do not warn when the sizeof operator is applied to a parameter that's declared as an array in a function definition. This warning is enabled by default for C and C++ programs. ๐ŸŒˆ
  • -Wmemset-elt-size โ€” warns for suspicious calls to the memset built-in when 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. Translation: you forgot to multiply by the element size, bestie. ๐Ÿ’€ Enabled by -Wall.
  • -Wmemset-transposed-args โ€” warns for suspicious memset calls where the second argument isn't zero and the third argument is zero. Like memset (buf, sizeof buf, 0) gets diagnosed, because you clearly meant memset (buf, 0, sizeof buf) and just. swapped them. ๐Ÿ™ˆ

Important detail though: the diagnostic only fires if that third argument is a literal zero. If it's an expression that folds to zero, or a cast of zero to some type, then it's way less likely the args got transposed, so no warning. Enabled by -Wall.

  • -Waddress โ€” warns about suspicious uses of address expressions. These include comparing the address of a function or a declared object to the null pointer constant, like:
void f (void);
void g (void)
{
  if (!f)   // warning: expression evaluates to false
    abort ();
}

comparisons of a pointer to a string literal, like:

void f (const char *x)
{
  if (x == "abc")   // warning: expression evaluates to false
    puts ("equal");
}

and tests of the results of pointer addition or subtraction for equality to null, like:

void f (const int *p, int i)
{
  return p + i == NULL;
}

Such uses typically mean a programmer goofed: the address of most functions and objects necessarily evaluates to true (the exception is weak symbols), so using one in a conditional might mean you dropped parentheses in a function call or dropped a dereference in an array expression. The object-pointer subset of the warning can be silenced by casting the pointer operand to an integer type like intptr_t or uintptr_t. Comparisons against string literals give you unspecified behavior and aren't portable, and honestly they just scream "I meant to call strcmp." The warning is suppressed if the suspicious expression came from macro expansion. Enabled by -Wall. ๐Ÿ‘‘

  • -Wno-address-of-packed-member โ€” do not warn when the address of a packed member of a struct or union is taken, which usually results in an unaligned pointer value. This is enabled by default. ๐ŸŽ€
  • -Wlogical-op โ€” warns about suspicious uses of logical operators in expressions. This includes using logical operators where a bit-wise operator was probably expected. It also warns when both operands of a logical operator are literally the same:
extern int a;
if (a < 0 && a < 0) { ... }

bestie. that's the same thing twice. ๐Ÿ’…

  • -Wlogical-not-parentheses โ€” warns about a logical not used on the left-hand-side operand of a comparison. It does NOT warn if the right operand is considered a boolean expression. Its whole purpose is catching suspicious code like:
int a;
...
if (!a > 1) { ... }

You can suppress the warning by wrapping the LHS in parentheses:

if ((!a) > 1) { ... }

Enabled by -Wall. ๐ŸŒธ

  • -Waggregate-return โ€” warns if any functions that return structures or unions get defined or called. (And in languages where you can return an array, that also gets a warning.) ๐Ÿฆ‹
  • -Wno-aggressive-loop-optimizations โ€” warns if, in a loop with a constant number of iterations, the compiler detects undefined behavior in some statement during one or more of those iterations. ๐Ÿ˜ญ
  • -Wno-attributes โ€” do not warn if an unexpected __attribute__ is used, like unrecognized attributes, function attributes slapped onto variables, etc. This does NOT stop errors for incorrect use of supported attributes, so don't get it twisted.

Warnings about ill-formed uses of standard attributes get upgraded to errors by -pedantic-errors.

Also โ€” using -Wno-attributes=, you can suppress warnings about unknown scoped attributes (in C++11 and C23). For example, -Wno-attributes=vendor::attr disables the warning about this declaration:

[[vendor::attr]] void f();

And you can disable warnings about all attributes in a namespace with -Wno-attributes=vendor::, which prevents warnings about both of these:

[[vendor::safe]] void f();
[[vendor::unsafe]] void f2();

Note that -Wno-attributes= does not imply -Wno-attributes. periodt. ๐Ÿ’œ

  • -Wno-builtin-declaration-mismatch โ€” warns 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 doesn't include a prototype is called with arguments whose promoted types don't match what the function expects. When -Wextra is specified, it ALSO warns when a built-in function that takes arguments is declared without a prototype. The -Wbuiltin-declaration-mismatch warning is enabled by default. To dodge the warning, include the appropriate header so the prototypes of built-in functions come into scope. โœจ

For example, the memset call below gets diagnosed because the function expects a value of type size_t as its argument but the type of 32 is int. With -Wextra, the declaration of the function gets diagnosed too:

extern void* memset ();
void f (void *d)
{
  memset (d, '\0', 32);
}

๐Ÿ’€

  • -Wno-builtin-macro-redefined โ€” do not warn if certain built-in macros are redefined. This suppresses warnings for redefinition of __TIMESTAMP__, __TIME__, __DATE__, __FILE__, and __BASE_FILE__. ๐ŸŒˆ
  • -Wstrict-prototypes (C and Objective-C only) โ€” warns if a function is declared or defined without specifying the argument types. (An old-style function definition is permitted without a warning if it's preceded by a declaration that specifies the argument types.) ๐Ÿ‘‘
  • -Wold-style-declaration (C and Objective-C only) โ€” warns you when you're doing obsolescent stuff in a declaration, per the C Standard. Like bestie, if your storage-class specifiers such as static are not the very first thing in a declaration, you're getting a warning. Also switched on by -Wextra. ๐Ÿ‘‘
  • -Wold-style-definition (C and Objective-C only) โ€” screams at you if you used an old-style function definition. It warns even if there's a previous prototype chilling there already. Lowkey important: a definition using () is not counted as old-style in C23 mode, because in that case it's equivalent to (void) โ€” but for older standards it totally is old-style. ๐Ÿ™ˆ
  • -Wmissing-parameter-type (C and Objective-C only) โ€” a function parameter got declared with no type specifier in K&R-style functions:
void foo(bar) { }

This warning is also enabled by -Wextra.

  • -Wno-declaration-missing-parameter-type (C and Objective-C only) โ€” do not warn if a function declaration has a parameter name with no type. Heads up though: those declarations don't give you a function prototype and they block most type checking in function calls. ๐Ÿ˜ญ

This warning is enabled by default. In C99 and later dialects of C, it's treated as an error. That error can be downgraded to a warning with -fpermissive (along with certain other errors), or for this error alone with -Wno-error=declaration-missing-parameter-type.

This warning is upgraded to an error by -pedantic-errors.

  • -Wmissing-prototypes (C and Objective-C only) โ€” warns if a global function is defined with no previous prototype declaration. It fires even if the definition itself provides a prototype. Use this to sniff out global functions that don't have a matching prototype declaration in a header file. Not valid for C++, bestie โ€” because in C++ all function declarations provide prototypes, and a non-matching declaration just declares an overload rather than conflicting with an earlier declaration. For C++ missing declarations, use -Wmissing-declarations.
  • -Wmissing-variable-declarations (C and Objective-C only) โ€” warns if a global variable is defined without a previous declaration. Use it to catch global variables that don't have a matching extern declaration in a header file. ๐ŸŽ€
  • -Wmissing-declarations โ€” warns if a global function is defined without a previous declaration, even when the definition itself gives you a prototype. Use this to find global functions that aren't declared in header files. In C, no warnings for functions with previous non-prototype declarations โ€” use -Wmissing-prototypes for those. In C++, no warnings for function templates, inline functions, or functions in anonymous namespaces. โœจ
  • -Wmissing-field-initializers โ€” warns when a structure's initializer is missing some fields. Example: this code triggers it because x.h is implicitly zero:
struct s { int f, g, h; };
struct s x = { 3, 4 };

In C this option does not warn about designated initializers, so this modification doesn't trigger anything:

struct s { int f, g, h; };
struct s x = { .f = 3, .g = 4 };

And in C it also doesn't warn about the universal zero initializer { 0 }:

struct s { int f, g, h; };
struct s x = { 0 };

Same energy in C++: this option does not warn about the empty { } initializer, like:

struct s { int f, g, h; };
s x = { };

This warning is included in -Wextra. Want the other -Wextra warnings without this one? Use -Wextra -Wno-missing-field-initializers. ๐Ÿ’…

  • -Wno-missing-requires โ€” by default, the compiler warns about a concept-id showing up as a C++20 simple-requirement:
bool satisfied = requires { C<T> };

Here satisfied will be true if C<T> is a valid expression, which it is for all T. Presumably you meant to write:

bool satisfied = requires { requires C<T> };

so satisfied is only true if concept C is satisfied for type T. This warning can be disabled with -Wno-missing-requires. ๐Ÿฆ‹

  • -Wno-missing-template-keyword โ€” the member access tokens ., -> and :: must be followed by the template keyword if the parent object is dependent and the member being named is a template.
template <class X>
void DoStuff (X x)
{
  x.template DoSomeOtherStuff<X>(); // Good.
  x.DoMoreStuff<X>(); // Warning, x is dependent.
}

In rare cases you can get false positives. To silence it, wrap the expression in parentheses. For example, this next bit is treated as a template, even where m and N are integers:

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.
}

This warning can be disabled with -Wno-missing-template-keyword.

  • -Wno-multichar โ€” do not warn if a multicharacter constant ('FOOF') is used. Usually these are a typo in your code, because they have implementation-defined values and should not be used in portable code. ๐Ÿ’€
  • -Wnormalized=[none|id|nfc|nfkc] โ€” in ISO C and ISO C++, two identifiers are different if they're different sequences of characters. But sometimes, when characters outside the basic ASCII set are used, you can end up with two different character sequences that look identical. To avoid confusion, the ISO 10646 standard lays out normalization rules that, when applied, make two look-alike sequences turn into the same sequence. GCC can warn you if you're using identifiers that haven't been normalized โ€” this option controls that warning. ๐ŸŒˆ

There are four levels of warning GCC supports. The default is -Wnormalized=nfc, which warns about any identifier not in the ISO 10646 "C" normalized form, NFC. NFC is the recommended form for most uses. It's equivalent to -Wnormalized.

Unfortunately, some characters allowed in identifiers by ISO C and ISO C++ โ€” when turned into NFC โ€” are not allowed in identifiers. Like, there's genuinely no way to use these symbols in portable ISO C or C++ and have all your identifiers in NFC. -Wnormalized=id suppresses the warning for these characters. The hope is that future versions of the standards involved will fix this, which is why this option is not the default.

You can switch the warning off for all characters by writing -Wnormalized=none or -Wno-normalized. Only do this if you're 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 after formatting has been applied. For instance "\u207F", "SUPERSCRIPT LATIN SMALL LETTER N", displays just like a regular n that's been placed in a superscript. ISO 10646 defines the NFKC normalization scheme to convert all of these into a standard form too, and GCC warns if your code isn't in NFKC when you use -Wnormalized=nfkc. This warning is comparable to warning about every identifier containing the letter O because it might be confused with the digit 0 โ€” so it's not the default, but it can be useful as a local coding convention if the programming environment can't be fixed to display these characters distinctly.

  • -Wno-attribute-warning โ€” do not warn about usage of functions declared with the warning attribute. By default this warning is enabled. -Wno-attribute-warning can be used to disable the warning, or -Wno-error=attribute-warning can be used to disable the error when compiled with the -Werror flag. ๐Ÿซถ
  • -Wno-deprecated โ€” do not warn about usage of deprecated features.
  • -Wno-deprecated-declarations โ€” do not warn about uses of functions, variables, and types marked as deprecated via the deprecated attribute.
  • -Wno-overflow โ€” do not warn about compile-time overflow in constant expressions.
  • -Wno-odr โ€” warn about One Definition Rule violations during link-time optimization. Enabled by default.
  • -Wopenacc-parallelism โ€” warns about potentially suboptimal choices related to OpenACC parallelism.
  • -Wno-openmp โ€” warns about suspicious OpenMP code.
  • -Wopenmp-simd โ€” warns if the vectorizer cost model overrides the OpenMP simd directive you set. The -fsimd-cost-model=unlimited option can be used to relax the cost model. โญ
  • -Woverride-init (C and Objective-C only) โ€” warns if an initialized field without side effects gets overridden when you're using designated initializers.

This warning is included in -Wextra. Want the other -Wextra warnings without this one? Use -Wextra -Wno-override-init.

  • -Wno-override-init-side-effects (C and Objective-C only) โ€” do not warn if an initialized field with side effects is overridden when using designated initializers. This warning is enabled by default.
  • -Wpacked โ€” warns if a structure is given the packed attribute, but that packed attribute has zero effect on the layout or size of the structure. Such structures may end up mis-aligned for basically no benefit. For instance, here the variable f.x in struct bar is misaligned even though struct bar doesn't itself have the packed attribute:
struct foo {
  int x;
  char a, b, c, d;
} __attribute__((packed));
struct bar {
  char z;
  struct foo f;
};
  • -Wnopacked-bitfield-compat โ€” the 4.1, 4.2 and 4.3 series of GCC ignore the packed attribute on bit-fields of type char. This got fixed in GCC 4.4, but the change can lead to differences in the structure layout. GCC lets you know when the offset of such a field has changed in GCC 4.4. For example there's no longer a 4-bit padding between field a and b in this structure:
struct foo
{
  char a:4;
  char b:8;
} __attribute__ ((packed));

This warning is enabled by default. Use -Wno-packed-bitfield-compat to disable this warning.

  • -Wpacked-not-aligned (C, C++, Objective-C and Objective-C++ only) โ€” warns you when a struct field that has explicitly specified alignment sitting inside a packed struct or union ends up misaligned. Like, bestie, you asked for aligned(8) and then packed the whole thing, so of course it's crooked. For example, a warning gets issued on struct S, something like warning: alignment 1 of 'struct S' is less than 8, in this code:
struct __attribute__ ((aligned (8))) S8 { char a[8]; };
struct __attribute__ ((packed)) S {
  struct S8 s8;
};

This warning is enabled by -Wall. ๐Ÿ‘‘

  • -Wpadded โ€” warns if padding gets baked into a structure, whether it's there to align one element or to align the whole structure. And honestly? Sometimes when this happens you can rearrange the fields of the structure to shrink the padding and make the whole thing smaller. So it's giving helpful, not just judgy. ๐Ÿ’…
  • -Wredundant-decls โ€” warns if literally anything is declared more than once in the same scope. Even in the cases where declaring it twice is valid and changes absolutely nothing. Redundant? yes. Illegal? no. Still gonna tell you. ๐Ÿ™ˆ
  • -Wrestrict โ€” warns when an object referenced by a restrict-qualified parameter (or, in C++, a __restrict-qualified parameter) gets aliased by another argument, or when copies between such objects overlap. So here's the vibe: the call to the strcpy function below is trying to truncate the string by replacing its initial characters with the last four. But because the call writes the terminating NUL into a[4], the copies overlap and the call gets diagnosed. ๐Ÿ˜ญ
void foo (void)
{
  char a[] = "abcd1234";
  strcpy (a, a + 4);
  ...
}

The -Wrestrict option catches some instances of simple overlap even with no optimization at all, but it works best at -O2 and above. It is included in -Wall.

  • -Wnested-externs (C and Objective-C only) โ€” warns if an extern declaration shows up inside a function. Why is it in there. Get it out. ๐Ÿ’€
  • -Winline โ€” warns if a function that's declared as inline cannot actually be inlined. Even with this option on, the compiler does not warn about failures to inline functions declared in system headers. Not our problem, not our drama.

The compiler uses a whole variety of heuristics to decide whether or not to inline a function. For example, it takes into account the size of the function being inlined and the amount of inlining that has already been done in the current function. So seemingly insignificant changes in the source program can cause the warnings produced by -Winline to appear or disappear. Iconic chaotic behaviour, honestly.

  • -Winterference-size โ€” warns about use of C++17 std::hardware_destructive_interference_size without specifying its value with --param destructive-interference-size. Also warns about questionable values for that option. ๐Ÿšฉ

This variable is intended to be used for controlling class layout, to avoid false sharing in concurrent code:

struct independent_fields {
  alignas(std::hardware_destructive_interference_size)
    std::atomic<int> one;
  alignas(std::hardware_destructive_interference_size)
    std::atomic<int> two;
};

Here one and 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, --param destructive-interference-size and --param constructive-interference-size are set based on the current -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 -mtune (or -mcpu). No mixing, bestie, that's the rule. ๐Ÿ’–

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. Alternatively, you can force a particular value with --param.

If you are confident that your use of the variable does not affect ABI outside a single build of your project, you can turn off the warning with -Wno-interference-size.

  • -Wint-in-bool-context โ€” warns for suspicious use of integer values where boolean values are expected. Like conditional expressions (?:) using non-boolean integer constants in boolean context, like if (a <= b ? 2 : 3). Or left shifting of signed integers in boolean context, like for (a = 0; 1 << a; a++);. Same energy for all kinds of multiplications regardless of the data type. This warning is enabled by -Wall. ๐Ÿซถ
  • -Wno-int-to-pointer-cast โ€” suppresses 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. Wint-to-pointer-cast is enabled by default.
  • -Wno-pointer-to-int-cast (C and Objective-C only) โ€” suppresses warnings from casts from a pointer to an integer type of a different size.
  • -Winvalid-pch โ€” warns if a precompiled header is found in the search path but cannot be used. Found it, can't use it. It's giving ghosted. ๐ŸŒธ
  • -Winvalid-utf8 โ€” warns if an invalid UTF-8 character is found. This warning is on by default for C++23 if -finput-charset=UTF-8 is used and turned into error with -pedantic-errors.
  • -Wno-unicode โ€” don't diagnose invalid forms of delimited or named escape sequences which are treated as separate tokens. Wunicode is enabled by default.
  • -Wlong-long โ€” warns if the long long type is used. This is enabled by either -Wpedantic or -Wtraditional in ISO C90 and C++98 modes. To inhibit the warning messages, use -Wno-long-long.

This warning is upgraded to an error by -pedantic-errors. Not a drill, fr fr.

  • -Wvariadic-macros โ€” warns 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 -Wpedantic or -Wtraditional. To inhibit the warning messages, use -Wno-variadic-macros.
  • -Wno-varargs โ€” do not warn upon questionable usage of the macros used to handle variable arguments like va_start. These warnings are enabled by default.
  • -Wvector-operation-performance โ€” warns if a vector operation is not implemented via SIMD capabilities of the architecture. Mainly useful for performance tuning. A vector operation can be implemented piecewise, which means the scalar operation is performed on every vector element; in parallel, which means the vector operation is implemented using scalars of wider type, which normally is more performance efficient; and as a single scalar, which means the vector fits into a scalar type. Three flavours, all valid, some faster. โœจ
  • -Wvla โ€” warns if a variable-length array is used in the code. -Wno-vla prevents the -Wpedantic warning of the variable-length array.

This warning is upgraded to an error by -pedantic-errors.

  • -Wvla-larger-than=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 byte-size bytes. This is similar to how -Walloca-larger-than=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. Sneaky little optimizer. ๐Ÿ™ˆ

-Wvla-larger-than=PTRDIFF_MAX is enabled by default but is typically only effective when -ftree-vrp is active (default for -O2 and above).

See also -Walloca-larger-than=byte-size.

  • -Wno-vla-larger-than โ€” disables -Wvla-larger-than= warnings. The option is equivalent to -Wvla-larger-than=SIZE_MAX or larger.
  • -Wvla-parameter โ€” warns about redeclarations of functions involving arguments of Variable Length Array types of inconsistent kinds or forms, and enables the detection of out-of-bounds accesses to such parameters by warnings such as -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 f while the second one specifies that the array argument must have at least n elements. In addition, calling f with the associated VLA bound parameter in excess of the actual VLA bound triggers a warning as well.

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);
  ...
}

-Wvla-parameter is included in -Wall. The -Warray-parameter option triggers warnings for similar problems involving ordinary array arguments.

  • -Wvolatile-register-var โ€” warns 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. So like, the vibe is "I said volatile so it's safe" and the compiler is like "no bestie". This warning is enabled by -Wall.
  • -Wno-xor-used-as-pow (C, C++, Objective-C and Objective-C++ only) โ€” disables warnings about uses of ^, 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++, ^ means exclusive or, whereas in some other languages (e.g. TeX and some versions of BASIC) it means exponentiation. Different language, different lore. iykyk.

This warning can be silenced by converting one of the operands to hexadecimal as well as by compiling with -Wno-xor-used-as-pow.

  • -Wdisabled-optimization โ€” warns 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. It's not you, it's the complexity budget. ๐Ÿ’€
  • -Wpointer-sign (C and Objective-C only) โ€” warns when you pass a pointer argument or do an assignment where the signedness doesn't match. ngl this one is C/Objective-C exclusive, bestie. It's implied by -Wall and by -Wpedantic, and you can turn it off with -Wno-pointer-sign.
Heads up: -pedantic-errors upgrades this warning to a full-on error. ๐Ÿ’€
  • -Wstack-protector โ€” only does anything when -fstack-protector is active. When it is, it warns about functions that aren't protected against stack smashing. ๐Ÿ›ก๏ธ
  • -Woverlength-strings โ€” warns about string constants that are longer than the "minimum maximum" length the C standard specifies. Modern compilers generally let you go way past the standard's minimum limit, but if your program needs to be very portable you should not be out here using longer strings. โœจ

The limit applies after string constant concatenation, and it does not count the trailing NUL. In C90 the limit was 509 characters; in C99 it got raised to 4095. C++98 doesn't specify a normative minimum maximum, so we do not diagnose overlength strings in C++. Periodt.

This option is implied by -Wpedantic, and you can disable it with -Wno-overlength-strings.

  • -Wunsuffixed-float-constants (C and Objective-C only) โ€” issues a warning for any floating constant that has no suffix. When you use it together with -Wsystem-headers it also warns about such constants inside system header files. This is genuinely useful when you're prepping code to use with the "FLOAT_CONST_DECIMAL64" pragma from the decimal floating-point extension to C99. ๐Ÿ“
  • -Wno-lto-type-mismatch โ€” during link-time optimization, don't warn about type mismatches in global declarations coming from different compilation units. Requires -flto to be enabled. It's enabled by default.
  • -Wno-designated-init (C and Objective-C only) โ€” suppresses warnings when a positional initializer is used to initialize a structure that's been marked with the "designated_init" attribute.

๐Ÿ”ฎ Options That Control Static Analysis ๐Ÿ”ฎ

  • -fanalyzer โ€” turns on a static analysis of program flow that hunts for "interesting" interprocedural paths through your code, and issues warnings for the problems it finds along them. ๐Ÿ”

This analysis is much more expensive than other GCC warnings. Like, dramatically.

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's a bug-finding tool, not a tool for proving your program is correct. No cap.

In this release, the analyzer is only suitable for use on C code.

Enabling this option effectively enables the following warnings:

-Wanalyzer-allocation-size -Wanalyzer-deref-before-check
-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-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-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. ๐Ÿ™ˆ
  • -Wanalyzer-symbol-too-complex โ€” if -fanalyzer is enabled, the analyzer uses various heuristics to try to track the state of memory, but sufficiently complicated code can defeat them.

By default, the analysis silently stops tracking values of expressions once they exceed the threshold defined by --param analyzer-max-svalue-depth=value, and falls back to an imprecise representation for those expressions. The -Wanalyzer-symbol-too-complex option warns you when this happens. ๐Ÿ“ฃ

  • -Wanalyzer-too-complex โ€” if -fanalyzer is enabled, the analyzer uses various heuristics to try to explore the control flow and data flow in the program, but sufficiently complicated code can defeat them too.

By default, the analysis silently stops if the code is too complicated for the analyzer to fully explore and it hits an internal limit. The -Wanalyzer-too-complex option warns you when this happens. ๐Ÿ’…

  • -Wno-analyzer-allocation-size โ€” this warning requires -fanalyzer, which enables it; to disable it, use -Wno-analyzer-allocation-size.

This diagnostic warns for paths through the code where a pointer to a buffer gets assigned to point at a buffer whose size is not a multiple of sizeof (*pointer).

See CWE-131: Incorrect Calculation of Buffer Size ("https://cwe.mitre.org/data/definitions/131.html").

  • -Wno-analyzer-deref-before-check โ€” this warning requires -fanalyzer, which enables it; use -Wno-analyzer-deref-before-check to disable it.

This diagnostic warns for paths through the code where a pointer is checked for "NULL" after it has already been dereferenced, which suggests the pointer could have been NULL. Cases like that suggest the NULL check is either redundant, or it needs to be moved to before the pointer is dereferenced. ๐Ÿซ 

This diagnostic also considers values passed to a function argument marked with "__attribute__((nonnull))" as requiring a non-NULL value, and thus it will complain if such values are checked for "NULL" after returning from such a function call.

This diagnostic is unlikely to be reported when any level of optimization is enabled, because GCC's optimization logic will typically consider such NULL checks redundant and optimize them away before the analyzer ever "sees" them. So optimization should be disabled when you're trying to trigger this diagnostic.

  • -Wno-analyzer-double-fclose โ€” this warning requires -fanalyzer, which enables it; use -Wno-analyzer-double-fclose to disable it.

This diagnostic warns for paths through the code where a "FILE *" can have fclose called on it more than once. ๐Ÿ˜ญ

See CWE-1341: Multiple Releases of Same Resource or Handle ("https://cwe.mitre.org/data/definitions/1341.html").

  • -Wno-analyzer-double-free โ€” this warning requires -fanalyzer, which enables it; use -Wno-analyzer-double-free to disable it.

This diagnostic warns for paths through the code where a pointer can have a deallocator called on it more than once โ€” either free, or a deallocator referenced by attribute "malloc".

See CWE-415: Double Free ("https://cwe.mitre.org/data/definitions/415.html").

  • -Wno-analyzer-exposure-through-output-file โ€” this warning requires -fanalyzer, which enables it; use -Wno-analyzer-exposure-through-output-file to disable it.

This diagnostic warns for paths through the code where a security-sensitive value gets written to an output file (like, writing a password into a log file). ๐Ÿ™ˆ

See CWE-532: Information Exposure Through Log Files ("https://cwe.mitre.org/data/definitions/532.html").

  • -Wanalyzer-exposure-through-uninit-copy โ€” this warning requires both -fanalyzer and the use of a plugin to specify a function that copies across a "trust boundary". Use -Wno-analyzer-exposure-through-uninit-copy to disable it.

This diagnostic warns for "infoleaks" โ€” paths through the code where uninitialized values are copied across a security boundary (like code within an OS kernel that copies a partially-initialized struct on the stack to user space). ๐Ÿ’€

See CWE-200: Exposure of Sensitive Information to an Unauthorized Actor ("https://cwe.mitre.org/data/definitions/200.html").

  • -Wno-analyzer-fd-access-mode-mismatch โ€” this warning requires -fanalyzer, which enables it; use -Wno-analyzer-fd-access-mode-mismatch to disable it.

This diagnostic warns for paths through code where a read on a write-only file descriptor is attempted, or the other way round.

This diagnostic also warns for code paths where a function with attribute "fd_arg_read (N)" is called with a file descriptor opened with O_WRONLY at referenced argument "N", or a function with attribute "fd_arg_write (N)" is called with a file descriptor opened with O_RDONLY at referenced argument N. ๐ŸŒธ

  • -Wno-analyzer-fd-double-close โ€” this warning requires -fanalyzer, which enables it; use -Wno-analyzer-fd-double-close to disable it.

This diagnostic warns for paths through code where a file descriptor can be closed more than once.

See CWE-1341: Multiple Releases of Same Resource or Handle ("https://cwe.mitre.org/data/definitions/1341.html").

  • -Wno-analyzer-fd-leak โ€” this warning requires -fanalyzer, which enables it; use -Wno-analyzer-fd-leak to disable it.

This diagnostic warns for paths through code where an open file descriptor is leaked.

See CWE-775: Missing Release of File Descriptor or Handle after Effective Lifetime ("https://cwe.mitre.org/data/definitions/775.html").

  • -Wno-analyzer-fd-phase-mismatch โ€” this warning requires -fanalyzer, which enables it; use -Wno-analyzer-fd-phase-mismatch to disable it.

This diagnostic warns for paths through code where an operation is attempted in the wrong phase of a file descriptor's lifetime. For example, it'll warn on attempts to call accept on a stream socket that hasn't yet had listen successfully called on it. ๐Ÿฆ‹

See CWE-666: Operation on Resource in Wrong Phase of Lifetime ("https://cwe.mitre.org/data/definitions/666.html").

  • -Wno-analyzer-fd-type-mismatch โ€” okay bestie, this one needs -fanalyzer to even turn on, and it's the analyzer that enables it, so if you wanna shut it up you use -Wno-analyzer-fd-type-mismatch. ๐Ÿ’…

This diagnostic is the one that clocks paths through your code where you're doing an operation on the wrong type of file descriptor. Like, it will warn when you're out here trying to do socket operations on a file descriptor you got from open, or when you're attempting a stream socket operation on a datagram socket. Wrong vibe entirely, and the analyzer WILL call it out. ๐Ÿ˜ญ

  • -Wno-analyzer-fd-use-after-close โ€” requires -fanalyzer, which enables it; hit it with -Wno-analyzer-fd-use-after-close to disable.

This one warns for paths through code where a read or write gets called on a closed file descriptor. Rude. ๐Ÿ™ˆ

It also warns for paths where a function with attribute fd_arg (N) or fd_arg_read (N) or fd_arg_write (N) gets called with a closed file descriptor at referenced argument N.

  • -Wno-analyzer-fd-use-without-check โ€” requires -fanalyzer, which enables it; -Wno-analyzer-fd-use-without-check disables it.

This diagnostic warns for paths through code where a file descriptor is used without being checked for validity. No vibe check, no mercy. โœจ

It also warns for paths where a function with attribute fd_arg (N) or fd_arg_read (N) or fd_arg_write (N) is called with a file descriptor, at referenced argument N, without being checked for validity.

  • -Wno-analyzer-file-leak โ€” requires -fanalyzer, which enables it; -Wno-analyzer-file-leak turns it off.

This one warns for paths through the code where a <stdio.h> FILE * stream object is leaked. It's giving "forgot to close the door on your way out" energy. ๐Ÿšช

See CWE-775: Missing Release of File Descriptor or Handle after Effective Lifetime (https://cwe.mitre.org/data/definitions/775.html).

  • -Wno-analyzer-free-of-non-heap โ€” requires -fanalyzer, which enables it; -Wno-analyzer-free-of-non-heap disables it.

This diagnostic warns for paths through the code where free is called on a non-heap pointer (e.g. an on-stack buffer, or a global). Ma'am, that is NOT yours to free. ๐Ÿ’€

See CWE-590: Free of Memory not on the Heap (https://cwe.mitre.org/data/definitions/590.html).

  • -Wno-analyzer-imprecise-fp-arithmetic โ€” requires -fanalyzer, which enables it; -Wno-analyzer-imprecise-fp-arithmetic disables it.

This diagnostic warns for paths through the code where floating-point arithmetic is used in locations where precise computation is needed. At the moment, it only warns on use of floating-point operands inside the calculation of an allocation size. Math girlies stay winning, but only with integers here. ๐ŸŽ€

  • -Wno-analyzer-infinite-loop โ€” requires -fanalyzer, which enables it; -Wno-analyzer-infinite-loop disables it.

This diagnostic warns for paths through the code which appear to lead to an infinite loop. We've all been there emotionally. ๐ŸŒ€

Specifically, the analyzer will issue this warning when it "sees" a loop in which:

  • no externally-visible work could be being done within the loop
  • there is no way to escape from the loop
  • the analyzer is sufficiently confident about the program state throughout the loop to know that the above are true

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:

          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;
               }
            }

The analyzer will complain for the above case because if opcode ever matches none of the cases, the switch will follow the implicit default case, making the body of the loop be a no-op with cpu_state.pc unchanged, and thus using the same value of opcode on all subseqent iterations, leading to an infinite loop.

See CWE-835: Loop with Unreachable Exit Condition ('Infinite Loop') (https://cwe.mitre.org/data/definitions/835.html).

  • -Wno-analyzer-infinite-recursion โ€” requires -fanalyzer, which enables it; -Wno-analyzer-infinite-recursion disables it.

This diagnostic warns for paths through the code which appear to lead to infinite recursion. It's the function calling itself forever and ever, no thoughts head empty. ๐Ÿ”

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 convered to iteration by the optimizer before the analyzer "sees" them. Hence optimization should be disabled when attempting to trigger this diagnostic.

Compare with -Winfinite-recursion, which provides a similar diagnostic, but is implemented in a different way.

See CWE-674: Uncontrolled Recursion (https://cwe.mitre.org/data/definitions/674.html).

  • -Wno-analyzer-jump-through-null โ€” requires -fanalyzer, which enables it; -Wno-analyzer-jump-through-null disables it.

This diagnostic warns for paths through the code where a NULL function pointer is called. There is nothing there. Nobody is home. Do not call them. ๐Ÿ˜ญ

  • -Wno-analyzer-malloc-leak โ€” requires -fanalyzer, which enables it; -Wno-analyzer-malloc-leak disables it.

This diagnostic warns for paths through the code where a pointer allocated via an allocator is leaked: either malloc, or a function marked with attribute malloc. The memory is just out there, unbothered, unclaimed, unserfed. ๐ŸŒธ

See CWE-401: Missing Release of Memory after Effective Lifetime (https://cwe.mitre.org/data/definitions/401.html).

  • -Wno-analyzer-mismatching-deallocation โ€” requires -fanalyzer, which enables it; -Wno-analyzer-mismatching-deallocation disables it.

This diagnostic warns for paths through the code where 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 free, scalar delete and vector delete[], and those marked as allocator/deallocator pairs using attribute malloc. It's giving "you cannot return that, it's from a different store." ๐Ÿ›๏ธ

See CWE-762: Mismatched Memory Management Routines (https://cwe.mitre.org/data/definitions/762.html).

  • -Wno-analyzer-out-of-bounds โ€” requires -fanalyzer, which enables it; -Wno-analyzer-out-of-bounds disables it.

This diagnostic warns for paths through the code where 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. Boundaries exist for a reason, bestie. ๐Ÿšง

See CWE-119: Improper Restriction of Operations within the Bounds of a Memory Buffer (https://cwe.mitre.org/data/definitions/119.html).

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 -fdiagnostics-text-art-charset=none. A whole little diagram, she's an artist, she's an icon. ๐ŸŽจ

  • -Wno-analyzer-overlapping-buffers โ€” requires -fanalyzer, which enables it; -Wno-analyzer-overlapping-buffers disables it.

This diagnostic warns for paths through the code where overlapping buffers are passed to an API for which the behavior on such buffers is undefined. Sharing is not always caring. ๐Ÿ˜ฌ

Specifically, the diagnostic occurs on calls to the following functions

  • "memcpy"
  • "strcat"
  • "strcpy"

for cases where the buffers are known to overlap.

  • -Wno-analyzer-possible-null-argument โ€” requires -fanalyzer, which enables it; -Wno-analyzer-possible-null-argument disables it.

This diagnostic warns for paths through the code where a possibly-NULL value is passed to a function argument marked with __attribute__((nonnull)) as requiring a non-NULL value. The function said no NULLs and you said "well, maybe." โœ‹

See CWE-690: Unchecked Return Value to NULL Pointer Dereference (https://cwe.mitre.org/data/definitions/690.html).

  • -Wno-analyzer-possible-null-dereference โ€” requires -fanalyzer, which enables it; -Wno-analyzer-possible-null-dereference disables it.

This diagnostic warns for paths through the code where a possibly-NULL value is dereferenced. Possibly. Maybe. Potentially. And the analyzer is watching. ๐Ÿ‘€

See CWE-690: Unchecked Return Value to NULL Pointer Dereference (https://cwe.mitre.org/data/definitions/690.html).

  • -Wno-analyzer-null-argument โ€” requires -fanalyzer, which enables it; -Wno-analyzer-null-argument disables it.

This diagnostic warns for paths through the code where a value known to be NULL is passed to a function argument marked with __attribute__((nonnull)) as requiring a non-NULL value. Not "possibly", bestie. Known. Certain. Absolutely. ๐Ÿ’€

See CWE-476: NULL Pointer Dereference (https://cwe.mitre.org/data/definitions/476.html).

  • -Wno-analyzer-null-dereference โ€” requires -fanalyzer, which enables it; -Wno-analyzer-null-dereference disables it.

This diagnostic warns for paths through the code where a value known to be NULL is dereferenced. There is nothing at that address. You are knocking on a door that does not exist. ๐Ÿšช๐Ÿ’€

See CWE-476: NULL Pointer Dereference (https://cwe.mitre.org/data/definitions/476.html).

  • -Wno-analyzer-putenv-of-auto-var โ€” requires -fanalyzer, which enables it; -Wno-analyzer-putenv-of-auto-var disables it.

This diagnostic warns for paths through the code in which a call to putenv is passed a pointer to an automatic variable or an on-stack buffer. Bestie, that buffer is literally about to evaporate ๐Ÿ˜ญ

See POS34-C. Do not call putenv() with a pointer to an automatic variable as the argument (https://wiki.sei.cmu.edu/confluence/x/6NYxBQ).

  • -Wno-analyzer-shift-count-negative โ€” this one needs -fanalyzer, which is what turns it on in the first place; use -Wno-analyzer-shift-count-negative to turn it back off.

It warns about paths through the code where somebody tries to shift by a negative count. It's the analyzer-flavored cousin of the -Wshift-count-negative diagnostic that lives in the C/C++ front ends โ€” except this one is built on analyzing interprocedural paths instead of just parsing the syntax tree. Real talk though: the analyzer doesn't prioritize hunting these paths down, so you're more likely to get false negatives here than with the other warnings. ๐Ÿซ 

  • -Wno-analyzer-shift-count-overflow โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-shift-count-overflow to disable it.

Warns about paths where a shift is attempted with a count that's greater than or equal to the precision of the operand's type. Same deal as -Wshift-count-overflow in the C/C++ front ends, but again, it's built on interprocedural path analysis rather than merely parsing the syntax tree. And yeah โ€” the analyzer doesn't prioritize detecting these either, so false negatives are more likely compared to the other warnings. ๐Ÿ™ˆ

  • -Wno-analyzer-stale-setjmp-buffer โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-stale-setjmp-buffer to disable it.

Warns about paths where longjmp gets called to rewind to a jmp_buf that relates to a setjmp call in a function that has already returned. ๐Ÿ’€

Here's the tea: when setjmp is called on a jmp_buf to record a rewind location, it records the stack frame. That stack frame becomes invalid the moment the function containing the setjmp call returns. Trying to rewind to it via longjmp means you're referencing a stack frame that does not exist anymore, and that's very likely gonna crash (or worse). Not cute. Not the vibe.

  • -Wno-analyzer-tainted-allocation-size โ€” needs -fanalyzer which enables it; use -Wno-analyzer-tainted-allocation-size to disable it.

Warns about paths where a value that could be under an attacker's control gets used as the size of an allocation without being sanitized. Which means an attacker could inject an excessively large allocation and potentially cause a denial of service attack. Sabotage, basically.

See CWE-789: Memory Allocation with Excessive Size Value (https://cwe.mitre.org/data/definitions/789.html).

  • -Wno-analyzer-tainted-assertion โ€” needs -fanalyzer which enables it; use -Wno-analyzer-tainted-assertion to disable it.

Warns about paths where a value that could be under an attacker's control is used as part of a condition without being sanitized first, and that condition guards a call to a function marked with attribute noreturn (like the function __builtin_unreachable). Functions like that typically mean the program is terminating abnormally โ€” assertion failure handlers, that kind of thing. Example time:

assert (some_tainted_value < SOME_LIMIT);

In cases like this:

  • when assertion-checking is enabled: an attacker could trigger a denial of service by injecting an assertion failure
  • when assertion-checking is disabled, like by defining NDEBUG: an attacker could inject data that subverts the process, since it presumably violates a precondition that the code is assuming. Yikes.

Also important, bestie: when assertion-checking is disabled, the assertions are typically removed by the preprocessor before the analyzer even gets a chance to "see" them โ€” so this diagnostic can only generate warnings on builds where assertion-checking is enabled.

For the purpose of this warning, any function marked with attribute noreturn counts as a possible assertion failure handler, __builtin_unreachable included. Heads up though: 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 CWE-617: Reachable Assertion (https://cwe.mitre.org/data/definitions/617.html).

This warning can also report problematic constructions like

switch (some_tainted_value) {
case 0:
  /* [...etc; various valid cases omitted...] */
  break;

default:
  __builtin_unreachable (); /* BUG: attacker can trigger this  */
}

even though, strictly speaking, the above isn't an assertion failure at all. Plot twist.

  • -Wno-analyzer-tainted-array-index โ€” needs -fanalyzer which enables it; use -Wno-analyzer-tainted-array-index to disable it.

Warns about paths where a value that could be under an attacker's control gets used as the index of an array access without being sanitized โ€” so an attacker could inject an out-of-bounds access. ๐Ÿ‘‘

See CWE-129: Improper Validation of Array Index (https://cwe.mitre.org/data/definitions/129.html).

  • -Wno-analyzer-tainted-divisor โ€” needs -fanalyzer which enables it; use -Wno-analyzer-tainted-divisor to disable it.

Warns about paths where a value that could be under an attacker's control gets used as the divisor in a division or modulus operation without being sanitized, so an attacker could inject a division-by-zero. Math crimes!!

See CWE-369: Divide By Zero (https://cwe.mitre.org/data/definitions/369.html).

  • -Wno-analyzer-tainted-offset โ€” needs -fanalyzer which enables it; use -Wno-analyzer-tainted-offset to disable it.

Warns about paths where a value that could be under an attacker's control gets used as a pointer offset without being sanitized, so an attacker could inject an out-of-bounds access. ๐Ÿ’…

See CWE-823: Use of Out-of-range Pointer Offset (https://cwe.mitre.org/data/definitions/823.html).

  • -Wno-analyzer-tainted-size โ€” needs -fanalyzer which enables it; use -Wno-analyzer-tainted-size to disable it.

Warns about paths where a value that could be under an attacker's control gets used as the size of an operation such as memset without being sanitized, so an attacker could inject an out-of-bounds access. Same energy, different function.

See CWE-129: Improper Validation of Array Index (https://cwe.mitre.org/data/definitions/129.html).

  • -Wno-analyzer-undefined-behavior-strtok โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-undefined-behavior-strtok to disable it.

Warns about paths where a call is made to strtok with undefined behavior. ๐Ÿ˜ญ

Specifically: passing NULL as the first parameter for the initial call to strtok within a process has undefined behavior. That's it. That's the whole thing. Don't do it.

  • -Wno-analyzer-unsafe-call-within-signal-handler โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-unsafe-call-within-signal-handler to disable it.

Warns about paths where a function that's known to be async-signal-unsafe (like fprintf) gets called from a signal handler. ๐Ÿšฉ

See CWE-479: Signal Handler Use of a Non-reentrant Function (https://cwe.mitre.org/data/definitions/479.html).

  • -Wno-analyzer-use-after-free โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-use-after-free to disable it.

Warns about paths where a pointer is used after a deallocator was called on it โ€” either free, or a deallocator referenced by attribute malloc. You freed it, bestie. It's gone. Let it go.

See CWE-416: Use After Free (https://cwe.mitre.org/data/definitions/416.html).

  • -Wno-analyzer-use-of-pointer-in-stale-stack-frame โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-use-of-pointer-in-stale-stack-frame to disable it.

Warns about paths where a pointer is dereferenced that points to a variable sitting in a stale stack frame. ๐Ÿ’€

  • -Wno-analyzer-va-arg-type-mismatch โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-va-arg-type-mismatch to disable it.

Warns about interprocedural paths where the analyzer catches an attempt to use va_arg to extract a value that was passed to a variadic call โ€” but using a type that does not match the type of the expression that was passed to the call. Type mismatch girlies, this one's for you.

See CWE-686: Function Call With Incorrect Argument Type (https://cwe.mitre.org/data/definitions/686.html).

  • -Wno-analyzer-va-list-exhausted โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-va-list-exhausted to disable it.

Warns about interprocedural paths where the analyzer catches an attempt to use va_arg to access the next value passed to a variadic call, except all the values in the va_list have already been consumed. ๐Ÿฝ๏ธ Nothing left on the plate, babe.

See CWE-685: Function Call With Incorrect Number of Arguments (https://cwe.mitre.org/data/definitions/685.html).

  • -Wno-analyzer-va-list-leak โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-va-list-leak to disable it.

Warns about interprocedural paths where the analyzer catches that va_start or va_copy was called on a va_list without a corresponding call to va_end. ๐Ÿซ 

  • -Wno-analyzer-va-list-use-after-va-end โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-va-list-use-after-va-end to disable it.

Warns about interprocedural paths where the analyzer catches an attempt to use a va_list after va_end has been called on it. va_list. ๐Ÿ’…

  • -Wno-analyzer-write-to-const โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-write-to-const to disable it.

...and yeah, this diagnostic? it warns about paths through the code where the analyzer spots an attempt to write through a pointer to a const object. but โ€” and this is the tea โ€” the analyzer does not prioritize detecting these paths, so false negatives are more likely here than with its other warnings. so like, don't get comfy just bc it stayed quiet bestie ๐Ÿ’€


  • -Wno-analyzer-write-to-string-literal โ€” this warning needs -fanalyzer to even be on (that's what enables it); use -Wno-analyzer-write-to-string-literal to turn it back off.

it warns about paths through the code where the analyzer catches an attempt to write through a pointer to a string literal. and again, the analyzer does not prioritize finding these paths, so false negatives are more likely relative to other warnings. ๐Ÿ™ˆ

  • -Wno-analyzer-use-of-uninitialized-value โ€” requires -fanalyzer, which is what enables it; use -Wno-analyzer-use-of-uninitialized-value to disable it.

this one warns about paths through the code where an uninitialized value gets used. ngl that's just asking for chaos ๐Ÿซ 

See CWE-457: Use of Uninitialized Variable (https://cwe.mitre.org/data/definitions/457.html).


๐Ÿง  what the analyzer just knows (hardcoded knowledge)

the analyzer has hardcoded knowledge about the behavior of these memory-management functions:

  • "alloca"
  • The built-in functions "__builtin_alloc", "__builtin_alloc_with_align", "__builtin_calloc", "__builtin_free", "__builtin_malloc", "__builtin_memcpy", "__builtin_memcpy_chk", "__builtin_memset", "__builtin_memset_chk", "__builtin_realloc", "__builtin_stack_restore", and "__builtin_stack_save"
  • "calloc"
  • "free"
  • "malloc"
  • "memset"
  • "operator delete"
  • "operator delete []"
  • "operator new"
  • "operator new []"
  • "realloc"
  • "strdup"
  • "strndup"

of these functions for working with file descriptors:

  • "open"
  • "close"
  • "creat"
  • "dup", "dup2" and "dup3"
  • "isatty"
  • "pipe", and "pipe2"
  • "read"
  • "write"
  • "socket", "bind", "listen", "accept", and "connect"

of these functions for working with "<stdio.h>" streams:

  • The built-in functions "__builtin_fprintf", "__builtin_fprintf_unlocked", "__builtin_fputc", "__builtin_fputc_unlocked", "__builtin_fputs", "__builtin_fputs_unlocked", "__builtin_fwrite", "__builtin_fwrite_unlocked", "__builtin_printf", "__builtin_printf_unlocked", "__builtin_putc", "__builtin_putchar", "__builtin_putchar_unlocked", "__builtin_putc_unlocked", "__builtin_puts", "__builtin_puts_unlocked", "__builtin_vfprintf", and "__builtin_vprintf"
  • "fopen"
  • "fclose"
  • "ferror"
  • "fgets"
  • "fgets_unlocked"
  • "fileno"
  • "fread"
  • "getc"
  • "getchar"
  • "fprintf"
  • "printf"
  • "fwrite"

and of these functions:

  • The built-in functions "__builtin_expect", "__builtin_expect_with_probability", "__builtin_strchr", "__builtin_strcpy", "__builtin_strcpy_chk", "__builtin_strlen", "__builtin_va_copy", and "__builtin_va_start"
  • The GNU extensions "error" and "error_at_line"
  • "getpass"
  • "longjmp"
  • "putenv"
  • "setjmp"
  • "siglongjmp"
  • "signal"
  • "sigsetjmp"
  • "strcat"
  • "strchr"
  • "strlen"

plus, various functions with an "__analyzer_" prefix have special meaning to the analyzer โ€” those are described in the GCC Internals manual. iykyk ๐Ÿ“–โœจ


๐ŸŽ›๏ธ the params that actually matter here

pertinent parameters for controlling the exploration are:

  • --param analyzer-bb-explosion-factor=value
  • --param analyzer-max-enodes-per-program-point=value
  • --param analyzer-max-recursion-depth=value
  • --param analyzer-min-snodes-for-call-summary=value

โš™๏ธ options that control the analyzer

  • -fanalyzer-call-summaries โ€” simplifies interprocedural analysis by computing the effect of certain calls instead of exploring every single path through the function from callsite to each possible return. it's giving "shortcut, but make it smart" ๐Ÿ’…

if it's enabled, call summaries are only used for functions that have more than one call site, and that are sufficiently complicated (as per --param analyzer-min-snodes-for-call-summary=value).

  • -fanalyzer-checker=name โ€” restricts the analyzer to run just the checker called name, and enables it. one checker, no entourage. ๐Ÿ‘‘
  • -fanalyzer-debug-text-art-headings โ€” this one is for analyzer developers. if it's enabled, the analyzer adds extra annotations to any diagrams it generates. ๐ŸŽจ
  • -fno-analyzer-feasibility โ€” this option is intended for analyzer developers.

by default the analyzer verifies that there's a feasible control flow path for every diagnostic it emits โ€” meaning the conditions that hold aren't mutually exclusive. diagnostics where no feasible path can be found get rejected. you can suppress that filtering with -fno-analyzer-feasibility, for debugging issues in this code.

  • -fanalyzer-fine-grained โ€” this option is intended for analyzer developers.

internally the analyzer builds an "exploded graph" that combines control flow graphs with data flow information.

by default, an edge in this graph can contain the effects of a run of multiple statements within a basic block. with -fanalyzer-fine-grained, every single statement gets its own edge. so demure, so mindful โœจ

  • -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. it's literally counting the clones ๐Ÿ’€
  • -fanalyzer-show-events-in-system-headers โ€” by default the analyzer emits simplified diagnostic paths by hiding events fully located within a system header. with -fanalyzer-show-events-in-system-headers, those events are no longer suppressed. nothing stays hidden bestie ๐Ÿ™ˆ
  • -fno-analyzer-state-merge โ€” this option is intended for analyzer developers.

by default the analyzer tries to simplify analysis by merging sufficiently similar states at each program point as it builds its "exploded graph". with -fno-analyzer-state-merge that merging can be suppressed, for debugging state-handling issues.

  • -fno-analyzer-state-purge โ€” this option is intended for analyzer developers.

by default the analyzer tries to simplify analysis by purging aspects of state at a program point that look like they're no longer relevant โ€” e.g. the values of locals that aren't accessed later in the function and which aren't relevant to leak analysis.

with -fno-analyzer-state-purge this purging of state can be suppressed, for debugging state-handling issues.

  • -fno-analyzer-suppress-followups โ€” this option is intended for analyzer developers.

by default the analyzer stops exploring an execution path after hitting certain diagnostics, so it doesn't potentially issue a cascade of follow-up diagnostics.

the diagnostics that terminate analysis along a path are:

  • -Wanalyzer-null-argument
  • -Wanalyzer-null-dereference
  • -Wanalyzer-use-after-free
  • -Wanalyzer-use-of-pointer-in-stale-stack-frame
  • -Wanalyzer-use-of-uninitialized-value

with -fno-analyzer-suppress-followups the analyzer keeps exploring those paths even after such diagnostics โ€” which can be helpful for debugging issues in the analyzer, or for microbenchmarks for detecting undefined behavior.

  • -fanalyzer-transitivity โ€” enables transitivity of constraints within the analyzer. transitive queen ๐Ÿ‘‘
  • -fno-analyzer-undo-inlining โ€” this option is intended for analyzer developers.

-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 already happened, which leads 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 -fno-analyzer-undo-inlining this attempt to reconstruct the original frame information can be disabled, which may help when debugging issues in the analyzer.

  • -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. yapping mode: activated ๐Ÿ—ฃ๏ธ
  • -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.
  • -fanalyzer-verbosity=level โ€” this option controls the complexity of the control flow paths that get emitted for analyzer diagnostics.

the level can be one of:

  • 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-"free" diagnostic, both calls to "free" will be shown.
  • 1 โ€” as per the previous level, but also shows events for the entry to each function.
  • 2 โ€” as per the previous level, but also shows 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.

  • 3 โ€” as per the previous level, but shows all control flow events, not just the significant ones.
  • 4 โ€” this level is intended for analyzer developers; it adds various other events intended for debugging the analyzer.
  • -fdump-analyzer โ€” dumps internal details about what the analyzer is doing to file.analyzer.txt. -fdump-analyzer-stderr overrides this option. ๐Ÿ“„
  • -fdump-analyzer-stderr โ€” dumps internal details about what the analyzer is doing to stderr. this option overrides -fdump-analyzer.
  • -fdump-analyzer-callgraph โ€” dumps a representation of the call graph suitable for viewing with GraphViz to file.callgraph.dot. ๐ŸŒ
  • -fdump-analyzer-exploded-graph โ€” dumps a representation of the "exploded graph" suitable for viewing with GraphViz to file.eg.dot. nodes are color-coded based on state-machine states to emphasize state changes. aesthetic and informative ๐Ÿ’…
  • -fdump-analyzer-exploded-nodes โ€” emits diagnostics showing where nodes in the "exploded graph" are in relation to the program source.
  • -fdump-analyzer-exploded-nodes-2 โ€” dumps a textual representation of the "exploded graph" to file.eg.txt.
  • -fdump-analyzer-exploded-nodes-3 โ€” dumps a text version of the "exploded graph" into one whole file per node, named file.eg-id.txt. and bestieโ€ฆ that's a LOT of files. like, so many. brace yourself. ๐Ÿ’€
  • -fdump-analyzer-exploded-paths โ€” dumps a text version of the "exploded path" for each diagnostic into file.idx.kind.epath.txt.
  • -fdump-analyzer-feasibility โ€” spills the analyzer's internal tea about its search for feasible paths ๐Ÿซ– into filenames shaped like file.*.fg.dot, file.*.tg.dot, and file.*.fpath.txt, all formatted so you can peek at them in GraphViz.
  • -fdump-analyzer-infinite-loop โ€” dumps internal deets about the analyzer's hunt for infinite loops ๐ŸŒ€, GraphViz-viewable, into filenames like file.*.infinite-loop.dot.
  • -fdump-analyzer-json โ€” dumps a compressed JSON version of the analyzer's internals into file.analyzer.json.gz. ngl the exact format is subject to change, so don't get too attached. ๐Ÿ™ˆ
  • -fdump-analyzer-state-purge โ€” same energy as -fdump-analyzer-supergraph, dumps a GraphViz-ready representation of the "supergraph", but it annotates the graph with what state gets purged at each node. lands in file.state-purge.dot.
  • -fdump-analyzer-supergraph โ€” dumps representations of the "supergraph" (GraphViz-friendly โœจ) into file.supergraph.dot and file.supergraph-eg.dot. these show every control flow graph in the program, plus the interprocedural edges for calls and returns. the second dump has annotations showing nodes in the "exploded graph" and the diagnostics attached to them.
  • -fdump-analyzer-untracked โ€” emits custom warnings with internal details, literally just for analyzer developers. it's giving insider info only. ๐Ÿ‘‘

๐ŸŒธ Options for Debugging Your Program ๐ŸŒธ

okay so, to tell GCC to emit extra info for a debugger, in like almost all cases you just add -g to your other options. periodt. some debug formats can co-exist (think DWARF and CTF ๐Ÿ’ž) when you explicitly enable each one by adding its own command line option to your other options.

GCC lets you use -g with -O. the shortcuts optimized code takes can occasionally be surprising: some variables you declared may not exist at all ๐Ÿ˜ญ; flow of control may briefly move somewhere 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 got moved out of loops. nevertheless, it IS possible to debug optimized output. so it's actually reasonable to use the optimizer for programs that might have bugs. slay.

if you're not using some other optimization option, consider using -Og with -g. fr fr โ€” with no -O option at all, some compiler passes that collect info useful for debugging don't run at all, so -Og may give you a better debugging experience. ๐Ÿ’…

  • -g โ€” produces 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, -g enables use of extra debugging info that only GDB can use. this extra info 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 -gvms (see below).

  • -ggdb โ€” produces debugging information for use by GDB. this means using the most expressive format available (DWARF, stabs, or the native format if neither of those are supported), including GDB extensions if at all possible. iconic.
  • -gdwarf, -gdwarf-version โ€” produces debugging information in DWARF format (if that is supported). version can 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 -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 -fno-dwarf2-cfi-asm retain a reference to DWARF Version 2 in their names, but they apply to all currently-supported versions of DWARF.

  • -gbtf โ€” requests 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 debug formats are enabled explicitly via their respective command line options. ๐Ÿฆ‹
  • -gctf, -gctflevel โ€” requests CTF debug information and uses level to specify how much CTF debug info should be produced. if -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 debug formats are enabled explicitly via their respective command line options.

  • Level 0 produces no CTF debug information at all. so -gctf0 negates -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.
  • -gvms โ€” produces debugging information in Alpha/VMS debug format (if that is supported). this is the format used by DEBUG on Alpha/VMS systems.
  • -gcodeview โ€” produces debugging information in CodeView debug format (if that is supported). this is the format used by Microsoft Visual C++ on Windows. ๐Ÿ’ป
  • -glevel, -ggdblevel, -gvmslevel โ€” request debugging information and also use level to specify how much information. the default level is 2.
    • Level 0 produces no debug information at all. so -g0 negates -g.
    • Level 1 produces minimal information, enough for making backtraces in parts of the program 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 3 includes extra information, such as all the macro definitions present in the program. some debuggers support macro expansion when you use -g3.

if you use multiple -g options, with or without level numbers, the last such option is the one that is effective. periodt.

-gdwarf does not accept a concatenated debug level, to avoid confusion with -gdwarf-level. instead use an additional -glevel option to change the debug level for DWARF.

  • -fno-eliminate-unused-debug-symbols โ€” by default, no debug information is produced for symbols that aren't actually used. use this option if you want debug information for all symbols.
  • -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. โš ๏ธ only use this with debuggers that can't handle the way GCC normally emits debugging info for classes, because using this option increases the size of debugging information by as much as a factor of two. that's a big yikes.
  • -fno-merge-debug-strings โ€” tells the linker to not merge together strings in the debugging information that are identical in different object files. merging isn't supported by all assemblers or linkers. merging decreases the size of the debug info in the output file at the cost of increasing link processing time. merging is enabled by default.
  • -fdebug-prefix-map=old=new โ€” when compiling files residing in directory old, record debugging information describing them as if the files resided in directory new instead. this can replace a build-time path with an install-time path in the debug info. it can also change an absolute path to a relative path by using . for 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 -ffile-prefix-map and -fcanon-prefix-map.
  • -fvar-tracking โ€” runs the 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 info). ๐Ÿ’–

it's enabled by default when compiling with optimization (-Os, -O, -O2, ...), debugging information (-g) and the debug info format supports it.

  • -fvar-tracking-assignments โ€” annotates assignments to user variables early in the compilation and attempts to carry the annotations over throughout the compilation all the way to the end, trying to improve debug info while optimizing. using -gdwarf-4 along with it is recommended. โœจ

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 -fvar-tracking, except when selective scheduling is enabled.

  • -gsplit-dwarf โ€” if DWARF debugging information is enabled, separate as much debugging info as possible into a separate output file with the extension .dwo. this option lets the build system avoid linking files with debug information. to be useful, this option requires a debugger capable of reading .dwo files.
  • -gdwarf32, -gdwarf64 โ€” if DWARF debugging information is enabled, -gdwarf32 selects the 32-bit DWARF format and -gdwarf64 selects the 64-bit DWARF format. the default is target specific, on most targets it's -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. ๐Ÿซถ
  • -gdescribe-dies โ€” adds description attributes to some DWARF DIEs that have no name attribute, such as artificial variables, external references and call site parameter DIEs.
  • -gpubnames โ€” generates DWARF .debug_pubnames and .debug_pubtypes sections. ๐ŸŒˆ
  • -ggnu-pubnames โ€” bestie this one makes .debug_pubnames and .debug_pubtypes sections in a format that can be converted into a GDB index โœจ. It's only useful with a linker that can produce GDB index version 7, so like, only then. Periodt.
  • -fdebug-types-section โ€” when you're using DWARF Version 4 or higher, type DIEs can be put into their own .debug_types section instead of being part of .debug_info ๐ŸŽ€. It's more efficient to put them in a separate comdat section since the linker can then remove duplicates. But โ€” and this is the tea โ€” not all DWARF consumers support .debug_types sections yet, and on some objects .debug_types produces larger instead of smaller debugging information. Not me getting betrayed by an optimization ๐Ÿ’€.
  • -grecord-gcc-switches, -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 -frecord-gcc-switches for another way of storing compiler options into the object file.
  • -gstrict-dwarf โ€” disallow using extensions of later DWARF standard version than selected with -gdwarf-version ๐Ÿ™ˆ. On most targets, using non-conflicting DWARF extensions from later standard versions is allowed.
  • -gno-strict-dwarf โ€” allow using extensions of later DWARF standard version than selected with -gdwarf-version. Slay, freedom โœจ.
  • -gas-loc-support โ€” this tells the compiler that the assembler supports .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. Iconic behavior honestly.

This option will be enabled by default if, at GCC configure time, the assembler was found to support such directives.

  • -gno-as-loc-support โ€” force GCC to generate DWARF2+ line number tables internally, if DWARF2+ line number tables are to be generated. Okay, control freak, we respect it ๐Ÿ’œ.
  • -gas-locview-support โ€” inform the compiler that the assembler supports "view" assignment and reset assertion checking in .loc directives ๐Ÿ‘‘

This option will be enabled by default if, at GCC configure time, the assembler was found to support them.

  • -gno-as-locview-support โ€” force GCC to assign view numbers internally, if -gvariable-location-views are explicitly requested.
  • -gcolumn-info, -gno-column-info โ€” emit location column information into DWARF debugging information, rather than just file and line ๐ŸŒธ. This option is enabled by default.
  • -gstatement-frontiers, -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 is_stmt markers in the line number table ๐Ÿฆ‹. This is enabled by default when compiling with optimization (-Os, -O1, -O2, ...), and outputting DWARF 2 debug information at the normal level.
  • -gvariable-location-views, -gvariable-location-views=incompat5, -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 will cause 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. It's giving "works on your machine either way, bestie" ๐Ÿซถ.

This is enabled by default when outputting DWARF 2 debug information at the normal level, as long as there is assembler support, -fvar-tracking-assignments is enabled and -gstrict-dwarf is not. When assembler support is not available, this may still be enabled, but it will force GCC to output internal line number tables, and if -ginternal-reset-location-views is not enabled, that will most certainly lead to silently mismatching location views ๐Ÿ˜ญ. (Silently! The audacity.)

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 -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 ๐Ÿ’€. So like, do not casually reach for this one.

  • -ginternal-reset-location-views, -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 insn 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 will flag any such error as a "view number mismatch". This is only enabled on ports that define a reliable estimation function.
  • -ginline-points, -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.
  • -gz[=type] โ€” produce compressed debug sections in DWARF format, if that is supported ๐ŸŽ€. If type is not given, the default type depends on the capabilities of the assembler and linker used. type may be one of none (don't compress debug sections), or zlib (use zlib 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, -gz is silently ignored when producing object files ๐Ÿ‘€.
  • -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 -femit-struct-debug-reduced for a less aggressive option. See -femit-struct-debug-detailed for more detailed control.

This option works only with DWARF debug output.

  • -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 -femit-struct-debug-baseonly for a more aggressive option. See -femit-struct-debug-detailed for more detailed control.

This option works only with DWARF debug output.

  • -femit-struct-debug-detailed[=spec-list] โ€” 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 -femit-struct-debug-reduced and -femit-struct-debug-baseonly, which serves for most needs.

A specification has the syntax

[dir:|ind:][ord:|gen:](any|sys|base|none)

The optional first word limits the specification to structs that are used directly (dir:) or used indirectly (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 struct one direct; struct two * indirect;.

The optional second word limits the specification to ordinary structs (ord:) or generic structs (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 -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 none and any have the normal meaning. The value 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 foo.c, debug information is generated for types declared in that file and foo.h, but not other header files. The value sys means those types satisfying base or declared in system or compiler headers.

You may need to experiment to determine the best settings for your application, fr fr ๐Ÿงš.

The default is -femit-struct-debug-detailed=all.

This option works only with DWARF debug output.

  • -fno-dwarf2-cfi-asm โ€” emit DWARF unwind info as compiler generated .eh_frame section instead of using GAS .cfi_* directives ๐Ÿ’….
  • -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 ๐Ÿ’€.

โœจ Options That Control Optimization โœจ

These options control various sorts of optimizations ๐Ÿ”ฅ.

okay so bestie, real talk about what the compiler is actually doing to your code, because this is the part where it stops being a translator and starts being a โœจwhole entire stylistโœจ for your binary.

When you pass no optimization option at all, the compiler's whole goal is just to keep compilation cheap and make debugging do the thing you expect. Statements stay 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. It's giving "what you wrote is what you get" ๐Ÿซถ.

Flip on optimization flags though and it's a whole different vibe โ€” the compiler starts attempting to improve performance and/or code size, but the price is compilation time and possibly the ability to debug the program. ๐Ÿ˜ญ tradeoffs, always.

It does all this based on the knowledge it has of the program. And here's a cute little trick: compiling multiple files at once to a single output file mode lets the compiler use information gained from all of the files when compiling each of them. it's giving group project but everyone actually participates ๐Ÿ’….

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 -O0, or if an -O level isn't set on the command line โ€” even if you specify individual optimization flags. Same energy with -Og: it suppresses many optimization passes too.

And depending on the target and how GCC was configured, a slightly different set of optimizations may be enabled at each -O level than the ones listed here. Wanna know the exact set for real? Invoke GCC with -Q --help=optimizers and it'll spill everything. iykyk ๐Ÿ”ฅ


๐Ÿ’– the -O levels ๐Ÿ’–

  • -O, -O1 โ€” Optimize. Optimizing compilation takes somewhat more time, and a lot more memory for a large function.

With -O, the compiler tries to reduce code size and execution time, without performing any optimizations that take a great deal of compilation time.

-O turns on the following optimization flags:

-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 -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
  • -O2 โ€” Optimize even more. GCC performs nearly all supported optimizations that don't involve a space-speed tradeoff. Compared to -O, this option increases both compilation time and the performance of the generated code.

-O2 turns on all optimization flags specified by -O1. It also turns on the following optimization flags:

-falign-functions  -falign-jumps -falign-labels  -falign-loops
-fcaller-saves -fcode-hoisting -fcrossjumping -fcse-follow-jumps
-fcse-skip-blocks -fdelete-null-pointer-checks -fdevirtualize
-fdevirtualize-speculatively -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-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 -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 -fgcse about invoking -O2 on programs that use computed gotos. ๐Ÿ‘€
  • -O3 โ€” Optimize yet more. -O3 turns on all optimizations specified by -O2 and also turns on the following optimization flags:
-fgcse-after-reload -fipa-cp-clone -floop-interchange
-floop-unroll-and-jam -fpeel-loops -fpredictive-commoning
-fsplit-loops -fsplit-paths -ftree-loop-distribution
-ftree-partial-pre -funswitch-loops -fvect-cost-model=dynamic
-fversion-loops-for-strides
  • -O0 โ€” Reduce compilation time and make debugging produce the expected results. This is the default. no thoughts, just vibes ๐Ÿ“
  • -Os โ€” Optimize for size. -Os enables all -O2 optimizations except those that often increase code size:
-falign-functions  -falign-jumps -falign-labels  -falign-loops
-fprefetch-loop-arrays  -freorder-blocks-algorithm=stc

It also enables -finline-functions, causes the compiler to tune for code size rather than execution speed, and performs further optimizations designed to reduce code size. smol but mighty ๐Ÿงš

  • -Ofast โ€” Disregard strict standards compliance. -Ofast enables all -O3 optimizations. It also enables optimizations that are not valid for all standard-compliant programs. It turns on -ffast-math, -fallow-store-data-races and the Fortran-specific -fstack-arrays, unless -fmax-stack-var-size is specified, and -fno-protect-parens. It turns off -fsemantic-interposition. living dangerously, love that for you ๐Ÿ’€
  • -Og โ€” Optimize debugging experience. -Og should be the optimization level of choice for the standard edit-compile-debug cycle, offering a reasonable level of optimization while maintaining fast compilation and a good debugging experience. It's a better choice than -O0 for producing debuggable code, because some compiler passes that collect debug information are disabled at -O0.

Like -O0, -Og completely disables a number of optimization passes so that individual options controlling them have no effect. Otherwise -Og enables all -O1 optimization flags except for those that may interfere with debugging:

-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
  • -Oz โ€” Optimize aggressively for size rather than speed. This may increase the number of instructions executed if those instructions require fewer bytes to encode. -Oz behaves similarly to -Os including enabling most -O2 optimizations.
If you use multiple -O options, with or without level numbers, the last such option is the one that is effective. last one wins, periodt ๐Ÿ‘‘

โœจ the -f flags section โœจ

Options of the form -fflag specify machine-independent flags. Most flags have both positive and negative forms; the negative form of -ffoo is -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 no- or adding it. easy math bestie ๐ŸŽ€

The following options control specific optimizations. They're either activated by -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.

  • -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 -O1 and higher, -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. bulk pop, iconic ๐ŸŒˆ
  • -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 -O1, -O2, -O3, -Os.

  • -ffp-contract=style โ€” -ffp-contract=off disables floating-point expression contraction. -ffp-contract=fast enables floating-point expression contraction such as forming of fused multiply-add operations if the target has native support for them. -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 -ffp-contract=off for C in a standards compliant mode (-std=c11 or similar), -ffp-contract=fast otherwise.

  • -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. free real estate ๐Ÿ’…

On some targets this flag has no effect, because the standard calling sequence always uses a frame pointer, so it can't be omitted.

Note that -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 -O1 and higher.

  • -foptimize-sibling-calls โ€” Optimize sibling and tail recursive calls.

Enabled at levels -O2, -O3, -Os.

  • -foptimize-strlen โ€” Optimize various standard C string functions (e.g. strlen, strchr or strcpy) and their _FORTIFY_SOURCE counterparts into faster alternatives.

Enabled at levels -O2, -O3.

  • -finline-stringops[=fn] โ€” Expand memory and string operations (for now, only memset) inline, even when the length is variable or big enough as to require looping. This is most useful along with -ffreestanding and -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.

  • -fno-inline โ€” Do not expand any functions inline apart from those marked with the always_inline attribute. This is the default when not optimizing.

Single functions can be exempted from inlining by marking them with the noinline attribute. not me, not today ๐Ÿ™ˆ

  • -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 -O2, -O3, -Os.

and that's the energy for this chunk bestie, more coming so don't go anywhere ๐Ÿ’œ

  • -findirect-inlining โ€” this one inlines the indirect calls that turn out to be known at compile time, all thanks to inlining that already happened earlier ๐Ÿ’ซ. Lowkey it does nothing unless inlining itself is switched on by -finline-functions or -finline-small-functions. no cap.

It's enabled at levels -O2, -O3, -Os.

  • -finline-functions โ€” bestie, this considers every single function for inlining, even the ones that never said inline in their whole life ๐Ÿซถ. The compiler heuristically decides which functions are actually worth integrating like that.

If all calls to a given function get integrated, and the function is declared static, then normally it just... doesn't get output as assembler code in its own right. bye girl ๐Ÿ’….

Enabled at levels -O2, -O3, -Os. Also enabled by -fprofile-use and -fauto-profile.

  • -finline-functions-called-once โ€” consider all static functions that get called exactly once for inlining into their caller, even if they're not marked inline โœจ. If a call to a given function gets integrated, then the function is not output as assembler code in its own right.

Enabled at levels -O1, -O2, -O3 and -Os, but not -Og.

  • -fearly-inlining โ€” inline functions marked by always_inline, plus functions whose body seems smaller than the function call overhead, early โ€” before -fprofile-generate instrumentation and the real inlining pass even happen ๐ŸŒธ. Doing it this way makes profiling significantly cheaper and usually makes inlining faster on programs with big long chains of nested wrapper functions. it's giving efficiency.

Enabled by default.

  • -fipa-sra โ€” perform interprocedural scalar replacement of aggregates, removal of unused parameters, and replacement of parameters passed by reference with parameters passed by value ๐Ÿงš. so much cleanup, obsessed.

Enabled at levels -O2, -O3 and -Os.

  • -finline-limit=n โ€” by default GCC limits the size of functions that can be inlined, and this flag gives you coarse control over that limit ๐Ÿ‘‘. n is the size of functions that can be inlined, measured in number of pseudo instructions.

Inlining is actually controlled by a bunch of parameters, which you can specify individually with --param name=value. The -finline-limit=n option sets some of these parameters like this:

  • max-inline-insns-single โ€” is set to n/2.
  • max-inline-insns-auto โ€” is set to n/2.

See below for documentation of the individual parameters controlling inlining and for the defaults of these parameters ๐Ÿ‘€.

Note: there may be no value of -finline-limit that results in default behavior. like, none. it's giving "you can't go home again" ๐Ÿ˜ญ.
Note: "pseudo instruction" here means an abstract measurement of a 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 another. so don't come for me if the number vibes differently next version ๐Ÿ’€.
  • -fno-keep-inline-dllexport โ€” this is a more fine-grained version of -fkeep-inline-functions, and it applies only to functions declared using the dllexport attribute or declspec. specific queen ๐ŸŽ€.
  • -fkeep-inline-functions โ€” in C, emit static functions that are declared inline into the object file, even if the function got inlined into all of its callers ๐Ÿซถ. This switch does not affect functions using the extern inline extension in GNU C90. In C++, emit any and all inline functions into the object file.
  • -fkeep-static-functions โ€” emit static functions into the object file, even if the function is never used. keeping it for the plot โœจ.
  • -fkeep-static-consts โ€” emit variables declared 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 whether a variable is referenced, regardless of whether or not optimization is turned on, use the -fno-keep-static-consts option.

  • -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 -fno-merge-constants to inhibit this behavior.

Enabled at levels -O1, -O2, -O3, -Os.

  • -fmerge-all-constants โ€” attempt to merge identical constants and identical variables ๐Ÿ”ฅ.

This option implies -fmerge-constants. On top of -fmerge-constants, it 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 ๐Ÿ˜ฌ. it's giving "breaking the rules, knowingly".

  • -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. slay.
  • -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 -fmodulo-sched enabled.
  • -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 -fno-branch-count-reg option doesn't remove the decrement and branch instructions from the generated instruction stream introduced by other optimization passes. she's just declining to add more, not cleaning up everyone else's mess ๐Ÿ˜ญ.

The default is -fbranch-count-reg at -O1 and higher, except for -Og.

  • -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. iykyk.

The default is -ffunction-cse.

  • -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 -fzero-initialized-in-bss.

  • -fthread-jumps โ€” perform optimizations that check whether 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. main character redirect energy.

Enabled at levels -O1, -O2, -O3, -Os.

  • -fsplit-wide-types โ€” when using a type that occupies multiple registers, such as 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 -O1, -O2, -O3, -Os.

  • -fsplit-wide-types-early โ€” fully split wide types early, instead of very late ๐Ÿ’ซ. This option has no effect unless -fsplit-wide-types is turned on.

This is the default on some targets.

  • -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 if statement with an else clause, CSE follows the jump when the condition tested is false.

Enabled at levels -O2, -O3, -Os.

  • -fcse-skip-blocks โ€” this is similar to -fcse-follow-jumps, but it causes CSE to follow jumps that conditionally skip over blocks ๐Ÿฆ‹. When CSE encounters a simple if statement with no else clause, -fcse-skip-blocks causes CSE to follow the jump around the body of the if.

Enabled at levels -O2, -O3, -Os.

  • -frerun-cse-after-loop โ€” re-run common subexpression elimination after loop optimizations are performed ๐Ÿ”. she's doing it again, and honestly? iconic.

Enabled at levels -O2, -O3, -Os.

  • -fgcse โ€” perform a global common subexpression elimination pass ๐Ÿ’…. This pass also performs global constant and copy propagation.
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 -fno-gcse to the command line.

Enabled at levels -O2, -O3, -Os.

  • -fgcse-lm โ€” when -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. chef's kiss.

Enabled by default when -fgcse is enabled.

  • -fgcse-sm โ€” when -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 -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. so you have to ask for it specifically, bestie.

  • -fgcse-las โ€” when -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.

  • -fgcse-after-reload โ€” when -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. tidying up the mess fr fr.

Enabled by -O3, -fprofile-use and -fauto-profile.

  • -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.
  • -funconstrained-commons โ€” bestie, heads up: this tells the compiler that variables declared in common blocks (like, e.g., Fortran ones) might get overridden later with longer trailing arrays. Which means it blocks certain optimizations that would otherwise depend on knowing the array bounds. So like, it's a "we can't be sure, so don't get cocky" flag. ๐Ÿ’…
  • -fcrossjumping โ€” does the cross-jumping transformation, which unifies equivalent code and saves code size. Now, does the result actually run faster? Honestly, maybe, maybe not โ€” it may or may not perform better than without cross-jumping. It's giving "smaller but who knows" energy. ๐Ÿฆ‹
    • Enabled at levels -O2, -O3, -Os.
  • -fauto-inc-dec โ€” combines increments or decrements of addresses with memory accesses. But wait: this pass is always skipped on architectures that don't have instructions to support it. No instruction, no vibe.
    • Enabled by default at -O1 and higher on architectures that support this. โœจ
  • -fdce โ€” performs dead code elimination (DCE) on RTL.
    • Enabled by default at -O1 and higher. ๐Ÿ”ฅ
  • -fdse โ€” performs dead store elimination (DSE) on RTL.
    • Enabled by default at -O1 and higher. ๐Ÿ”ฅ
  • -fif-conversion โ€” attempts to transform conditional jumps into branch-less equivalents. This includes use of conditional moves, min, max, set flags and abs instructions, plus some tricks doable by standard arithmetics. The use of conditional execution on chips where it's available is controlled by -fif-conversion2.
    • Enabled at levels -O1, -O2, -O3, -Os, but not with -Og.
  • -fif-conversion2 โ€” uses conditional execution (where available) to transform conditional jumps into branch-less equivalents. Same fam, different flavour.
    • Enabled at levels -O1, -O2, -O3, -Os, but not with -Og.
  • -fdeclone-ctor-dtor โ€” okay so 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 literally means two copies of the function. ๐Ÿ˜ญ With this option, the base and complete variants get changed into thunks that call a common implementation. Iconic, honestly.
    • Enabled by -Os. ๐Ÿ’–
  • -fdelete-null-pointer-checks โ€” assumes 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. On top of that, 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 if a pointer is checked after it's already been dereferenced, it cannot be null. ๐Ÿ•ต๏ธโ€โ™€๏ธ
Bestie, WARNING: in some environments this assumption is not true. Use -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 Nios II ELF, it defaults to off. On AVR and MSP430, this option is completely disabled.

Passes that use the dataflow information are enabled independently at different optimization levels.

  • -fdevirtualize โ€” attempts to convert calls to virtual functions into direct calls. This happens both within a procedure and interprocedurally as part of indirect inlining (-findirect-inlining) and interprocedural constant propagation (-fipa-cp).
    • Enabled at levels -O2, -O3, -Os. โœจ
  • -fdevirtualize-speculatively โ€” attempts to convert calls to virtual functions into speculative direct calls. Based on the analysis of the type inheritance graph, it determines for a given call the set of likely targets. If the set is small โ€” preferably of size 1 โ€” it changes the call into a conditional deciding between direct and indirect calls. These speculative calls enable more optimizations, like inlining. And when they seem useless after further optimization, they get converted back into their original form. It's giving "we tried, we un-tried" energy and I respect it. ๐Ÿ’…
  • -fdevirtualize-at-ltrans โ€” streams 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. (trade-off alert ๐Ÿซถ)
  • -fexpensive-optimizations โ€” performs a number of minor optimizations that are relatively expensive. Yes, that's the actual name, they said the quiet part out loud.
    • Enabled at levels -O2, -O3, -Os.
  • -free โ€” attempts 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 -O2, -O3, -Os.
  • -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 takes 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 -flifetime-dse=1. The default behavior can be explicitly selected with -flifetime-dse=2. And -flifetime-dse=0 is equivalent to -fno-lifetime-dse. ๐ŸŒˆ

  • -flive-range-shrinkage โ€” attempts to decrease register pressure through register live range shrinkage. This is helpful for fast processors with small or moderate size register sets. ๐Ÿงš
  • -fira-algorithm=algorithm โ€” use the specified coloring algorithm for the integrated register allocator. The algorithm argument can be priority, which specifies Chow's priority coloring, or 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. ๐Ÿ‘‘
  • -fira-region=region โ€” use specified regions for the integrated register allocator. The region argument should be one of the following:
    • all โ€” use all loops as register allocation regions. This can give the best results for machines with a small and/or irregular register set.
    • 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 (-O, -O2, ...).
    • one โ€” use all functions as a single region. This typically results in the smallest code size, and is enabled by default for -Os or -O0.
  • -fira-hoist-pressure โ€” uses 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 -Os for all targets.
  • -fira-loop-pressure โ€” uses 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 -O3 for some targets.
  • -fno-ira-share-save-slots โ€” disables 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. ๐Ÿ’€
  • -fno-ira-share-spill-slots โ€” disables 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. ๐Ÿ’€
  • -flra-remat โ€” enables 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 -O2, -O3, -Os.
  • -fdelayed-branch โ€” if supported for the target machine, attempts to reorder instructions to exploit instruction slots available after delayed branch instructions. ๐ŸŒธ
    • Enabled at levels -O1, -O2, -O3, -Os, but not at -Og.
  • -fschedule-insns โ€” if supported for the target machine, attempts 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. โœจ
    • Enabled at levels -O2, -O3.
  • -fschedule-insns2 โ€” similar to -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 -O2, -O3, -Os.
  • -fno-sched-interblock โ€” disables instruction scheduling across basic blocks, which is normally enabled when scheduling before register allocation, i.e. with -fschedule-insns or at -O2 or higher. ๐Ÿ™ˆ
  • -fno-sched-spec โ€” disables speculative motion of non-load instructions, which is normally enabled when scheduling before register allocation, i.e. with -fschedule-insns or at -O2 or higher. ๐Ÿ™ˆ
  • -fsched-pressure โ€” enables register pressure sensitive insn scheduling before register allocation. This only makes sense when scheduling before register allocation is enabled, i.e. with -fschedule-insns or at -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. ๐ŸŽ€
  • -fsched-spec-load โ€” allows speculative motion of some load instructions. This only makes sense when scheduling before register allocation, i.e. with -fschedule-insns or at -O2 or higher.
  • -fsched-spec-load-dangerous โ€” allows speculative motion of more load instructions. This only makes sense when scheduling before register allocation, i.e. with -fschedule-insns or at -O2 or higher. And yeah bestie, it's literally called "dangerous" โ€” the name is not a vibe, it's a warning. ๐Ÿ’…
  • -fsched-stalled-insns, -fsched-stalled-insns=n โ€” okay so this one sets how many insns (if any, bestie) get to be moved prematurely out of the queue of stalled insns and into the ready list during the second scheduling pass. ๐Ÿ’…
    • -fno-sched-stalled-insns means literally zero insns get moved prematurely.
    • -fsched-stalled-insns=0 means there is no limit on how many queued insns can be moved prematurely.
    • -fsched-stalled-insns with no value at all is the same thing as -fsched-stalled-insns=1.
  • -fsched-stalled-insns-dep, -fsched-stalled-insns-dep=n โ€” this one defines how many insn groups (cycles) get examined for a dependency on a stalled insn that's a candidate for premature removal from the queue of stalled insns. ๐ŸŒ€
    • Heads up: this only does anything during the second scheduling pass, and only if -fsched-stalled-insns is in play.
    • -fno-sched-stalled-insns-dep is equivalent to -fsched-stalled-insns-dep=0.
    • -fsched-stalled-insns-dep without a value is equivalent to -fsched-stalled-insns-dep=1.
  • -fsched2-use-superblocks โ€” when you're scheduling after register allocation, this uses superblock scheduling, which lets motion happen across basic block boundaries and that gives you faster schedules. โœจ
    • > Bestie, fair warning: this option is experimental, because not all machine descriptions used by GCC model the CPU closely enough to avoid unreliable results from the algorithm. ๐Ÿ‘€
    • It only makes sense when scheduling happens after register allocation, i.e. with -fschedule-insns2 or at -O2 or higher.
  • -fsched-group-heuristic โ€” turns on the group heuristic in the scheduler. It favors the instruction that belongs to a schedule group. On by default whenever scheduling is on, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐ŸŽ€
  • -fsched-critical-path-heuristic โ€” turns on the critical-path heuristic. It favors instructions on the critical path. On by default whenever scheduling is on, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐Ÿ”ฅ
  • -fsched-spec-insn-heuristic โ€” turns on the speculative instruction heuristic. It favors speculative instructions with greater dependency weakness. On by default whenever scheduling is on, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐Ÿ’ซ
  • -fsched-rank-heuristic โ€” turns on the rank heuristic. It favors the instruction belonging to a basic block with greater size or frequency. On by default whenever scheduling is on, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐Ÿ‘‘
  • -fsched-last-insn-heuristic โ€” turns on the last-instruction heuristic. It favors the instruction that's less dependent on the last instruction scheduled. On by default whenever scheduling is on, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐ŸŒธ
  • -fsched-dep-count-heuristic โ€” turns on the dependent-count heuristic. It favors the instruction that has more instructions depending on it. On by default whenever scheduling is on, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐Ÿฆ‹
  • -freschedule-modulo-scheduled-loops โ€” so modulo scheduling gets performed before traditional scheduling. If a loop is modulo scheduled, later scheduling passes may change its schedule, and this option is how you control that behavior. ๐ŸŽฏ
  • -fselective-scheduling โ€” schedule instructions using the selective scheduling algorithm. Selective scheduling runs instead of the first scheduler pass. ๐ŸŒˆ
  • -fselective-scheduling2 โ€” schedule instructions using the selective scheduling algorithm, but this time it runs instead of the second scheduler pass. โญ
  • -fsel-sched-pipelining โ€” enables software pipelining of innermost loops during selective scheduling. Ngl, this option has no effect unless one of -fselective-scheduling or -fselective-scheduling2 is turned on. ๐Ÿšซ
  • -fsel-sched-pipelining-outer-loops โ€” when pipelining loops during selective scheduling, this also pipelines outer loops. Same deal: no effect unless -fsel-sched-pipelining is turned on. ๐Ÿ’œ
  • -fsemantic-interposition โ€” some object formats, like ELF, allow interposing of symbols by the dynamic linker. What that means is that for symbols exported from the DSO, the compiler can't perform interprocedural propagation, inlining and other optimizations, because it has to anticipate 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 terms of code quality.
    • With -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's never allowed for interposition to change semantics) and for symbols explicitly declared weak. ๐Ÿ™ˆ
  • -fshrink-wrap โ€” emit function prologues only before the parts of the function that actually need them, instead of at the top of the function. This flag is enabled by default at -O and higher. ๐Ÿซถ
  • -fshrink-wrap-separate โ€” shrink-wrap separate parts of the prologue and epilogue separately, so those parts are only executed when needed. This option is on by default, but it has no effect unless -fshrink-wrap is also turned on and the target supports it. โœ‚๏ธ
  • -fcaller-saves โ€” enables allocation of values to registers that get clobbered by function calls, by emitting extra instructions to save and restore the registers around such calls. That allocation only happens 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 -O2, -O3, -Os.
  • -fcombine-stack-adjustments โ€” tracks stack adjustments (pushes and pops) and stack memory references, then tries to find ways to combine them. Enabled by default at -O1 and higher. ๐Ÿงฉ
  • -fipa-ra โ€” use caller save registers for allocation if those registers aren't used by any called function. In that case it's not necessary to save and restore them around calls. This is only possible if the called functions are part of the same compilation unit as the current function and they're compiled before it. ๐Ÿ”
    • Enabled at levels -O2, -O3, -Os, however the option is disabled if the generated code will be instrumented for profiling (-p, or -pg) or if the callee's register usage can't be known exactly โ€” which happens on targets that don't expose prologues and epilogues in RTL.
  • -fconserve-stack โ€” attempt to minimize stack usage. The compiler tries to use less stack space, even if that makes the program slower. This option implies setting the large-stack-frame parameter to 100 and the large-stack-frame-growth parameter to 400. ๐Ÿ“‰
  • -ftree-reassoc โ€” perform reassociation on trees. This flag is enabled by default at -O1 and higher. ๐ŸŒณ
  • -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 -O2 and higher. ๐Ÿš€
  • -ftree-pre โ€” perform partial redundancy elimination (PRE) on trees. This flag is enabled by default at -O2 and -O3. ๐Ÿ“
  • -ftree-partial-pre โ€” make partial redundancy elimination (PRE) more aggressive. This flag is enabled by default at -O3. ๐Ÿ’ฅ
  • -ftree-forwprop โ€” perform forward propagation on trees. This flag is enabled by default at -O1 and higher. โžก๏ธ
  • -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 -O1 and higher. ๐Ÿง 
  • -ftree-phiprop โ€” perform hoisting of loads from conditional pointers on trees. This pass is enabled by default at -O1 and higher. ๐ŸŽˆ
  • -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 -O2 and higher. ๐ŸŽช
  • -ftree-copy-prop โ€” perform copy propagation on trees. This pass eliminates unnecessary copy operations. This flag is enabled by default at -O1 and higher. ๐Ÿ“‹
  • -fipa-pure-const โ€” discover which functions are pure or constant. Enabled by default at -O1 and higher. ๐Ÿ’Ž
  • -fipa-reference โ€” discover which static variables do not escape the compilation unit. Enabled by default at -O1 and higher. ๐Ÿ”’
  • -fipa-reference-addressable โ€” discover read-only, write-only and non-addressable static variables. Enabled by default at -O1 and higher. ๐Ÿ”Ž
  • -fipa-stack-alignment โ€” reduce stack alignment on call sites if possible. Enabled by default. ๐Ÿ“
  • -fipa-pta โ€” perform interprocedural pointer analysis and interprocedural modification and reference analysis. > Heads up bestie: this option can cause excessive memory and compile-time usage on large compilation units. It is not enabled by default at any optimization level. ๐Ÿ’€
  • -fipa-profile โ€” perform interprocedural profile propagation. The functions called only from cold functions are marked as cold. Also, functions executed once โ€” such as cold, 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 -O1 and higher. โ„๏ธ
  • -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 -O1 and higher. ๐ŸŒŸ
  • -fipa-cp โ€” interprocedural constant propagation, bestie ๐Ÿ’– It peeks at the whole program to figure out when the values you're passing into functions are actually constants, and then optimizes around that knowledge. If your app is out here passing constants into functions, this can be a substantial glow-up for performance. Enabled by default at -O2, -Os and -O3, and it's also switched on by -fprofile-use and -fauto-profile. โœจ
  • -fipa-cp-clone โ€” function cloning that makes interprocedural constant propagation even stronger ๐Ÿ’… When it's on, IPA-CP goes ahead and clones a function when an externally visible function can be called with constant arguments. Heads up though: because this can create multiple copies of functions, it may significantly increase code size (see --param ipa-cp-unit-growth=value). Enabled by default at -O3, and also enabled by -fprofile-use and -fauto-profile.
  • -fipa-bit-cp โ€” when enabled, does interprocedural bitwise constant propagation ๐ŸŽ€ Enabled by default at -O2 and by -fprofile-use and -fauto-profile. It requires that -fipa-cp is enabled. No -fipa-cp, no bit-cp, periodt.
  • -fipa-vrp โ€” when enabled, does interprocedural propagation of value ranges ๐ŸŒธ Enabled by default at -O2. And yeah, it requires that -fipa-cp is enabled too.
  • -fipa-icf โ€” Identical Code Folding for functions and read-only variables ๐Ÿฆ‹ It reduces code size, and it may disturb unwind stacks by replacing a function with an equivalent one that has a different name. (Yeah, dramatic, we know.) The optimization works more effectively with link-time optimization enabled.

Even though the behavior is similar to the Gold Linker's ICF optimization, GCC ICF works on different levels and so the optimizations are not the same โ€” there are equivalences that are found only by GCC, and equivalences found only by Gold. Both ate, just differently ๐Ÿ’…

Enabled by default at -O2 and -Os.

  • -flive-patching=level โ€” controls GCC's optimizations so the output is suitable for live-patching ๐Ÿ‘‘

Okay so here's the tea: if the compiler's optimization uses a function's body, or info extracted from its body, to optimize or change another function, that other function is called an impacted function of the former. And if a function gets patched, its impacted functions should be patched too. Fr fr.

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 you enable, the larger the number of impacted functions for each function. So in order to control the number of impacted functions and more easily compute the list of impacted functions, IPA optimizations can be partially enabled at two different levels.

The level argument should be one of the following:

inline-clone

Only enables 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 they need to be patched as well. ๐Ÿ˜ญ

-flive-patching=inline-clone disables the following optimization flags: -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

inline-only-static

Only enables 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 -flive-patching=inline-clone disables, -flive-patching=inline-only-static disables the following additional optimization flags: -fipa-cp-clone -fipa-sra -fpartial-inlining -fipa-cp

When -flive-patching is specified without any value, the default value is inline-clone.

This flag is disabled by default.

Note that -flive-patching is not supported with link-time optimization (-flto). Like, don't even try it bestie ๐Ÿ™ˆ
  • -fisolate-erroneous-paths-dereference โ€” detects paths that trigger erroneous or undefined behavior due to dereferencing a null pointer ๐Ÿ’€ It isolates those paths from the main control flow and turns the statement with erroneous or undefined behavior into a trap. Enabled by default at -O2 and higher, and it depends on -fdelete-null-pointer-checks also being enabled.
  • -fisolate-erroneous-paths-attribute โ€” detects paths that trigger erroneous or undefined behavior due to a null value being used in a way that's forbidden by a returns_nonnull or nonnull attribute ๐Ÿ”ฅ It isolates those paths from the main control flow and turns the statement with erroneous or undefined behavior into a trap. This is not currently enabled, but may be enabled by -O2 in the future.
  • -ftree-sink โ€” performs forward store motion on trees ๐ŸŒˆ Enabled by default at -O1 and higher.
  • -ftree-bit-ccp โ€” performs sparse conditional bit constant propagation on trees and propagates pointer alignment information โœจ This pass only operates on local scalar variables and is enabled by default at -O1 and higher, except for -Og. It requires that -ftree-ccp is enabled.
  • -ftree-ccp โ€” performs sparse conditional constant propagation (CCP) on trees ๐Ÿ’œ This pass only operates on local scalar variables and is enabled by default at -O1 and higher.
  • -fssa-backprop โ€” propagates 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. Enabled by default at -O1 and higher.
  • -fssa-phiopt โ€” performs pattern matching on SSA PHI nodes to optimize conditional code ๐ŸŒธ This pass is enabled by default at -O1 and higher, except for -Og.
  • -ftree-switch-conversion โ€” performs conversion of simple initializations in a switch to initializations from a scalar array ๐Ÿฆ‹ Enabled by default at -O2 and higher.
  • -ftree-tail-merge โ€” looks for identical code sequences, and when it finds them, replaces one with a jump to the other ๐Ÿ‘‘ This optimization is known as tail merging or cross jumping. Enabled by default at -O2 and higher. The compilation time in this pass can be limited using max-tail-merge-comparisons parameter and max-tail-merge-iterations parameter.
  • -ftree-dce โ€” performs dead code elimination (DCE) on trees โœจ Enabled by default at -O1 and higher.
  • -ftree-builtin-call-dce โ€” performs conditional dead code elimination (DCE) for calls to built-in functions that may set errno but are otherwise free of side effects ๐Ÿ’– Enabled by default at -O2 and higher if -Os is not also specified.
  • -ffinite-loops โ€” assumes 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, and it's not considering eventual endless looping as such a side-effect.

This option is enabled by default at -O2 for C++ with -std=c++11 or higher.

  • -ftree-dominator-opts โ€” performs 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). Enabled by default at -O1 and higher.
  • -ftree-dse โ€” performs dead store elimination (DSE) on trees ๐ŸŒˆ A dead store is a store into a memory location that's later overwritten by another store without any intervening loads. In that case, the earlier store can be deleted. Enabled by default at -O1 and higher.
  • -ftree-ch โ€” performs loop header copying on trees ๐ŸŽ€ This is beneficial since it increases the effectiveness of code motion optimizations. It also saves one jump. Enabled by default at -O1 and higher. It is not enabled for -Os, since it usually increases code size.
  • -ftree-loop-optimize โ€” performs loop optimizations on trees ๐ŸŒธ Enabled by default at -O1 and higher.
  • -ftree-loop-linear, -floop-strip-mine, -floop-block โ€” perform loop nest optimizations ๐Ÿฆ‹ Same as -floop-nest-optimize. To use this code transformation, GCC has to be configured with --with-isl to enable the Graphite loop transformation infrastructure.
  • -fgraphite-identity โ€” enables the identity transformation for graphite โœจ For every SCoP we generate the polyhedral representation and transform it back to gimple. Using -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.
  • -floop-nest-optimize โ€” enables 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 ๐Ÿ’€ (so, like, tread carefully bestie).
  • -floop-parallelize-all โ€” uses the Graphite data dependence analysis to identify loops that can be parallelized ๐Ÿ”ฅ It parallelizes all the loops that can be analyzed to not contain loop carried dependences, without checking that it's profitable to parallelize the loops. Not me checking the vibe and just sending it ๐Ÿ’…
  • -ftree-coalesce-vars โ€” while transforming the program out of the SSA representation, it attempts 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 -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.
  • -ftree-loop-if-convert โ€” bestie, this one tries to turn conditional jumps in the innermost loops into branch-less equivalents โœจ. The whole goal? Strip control-flow out of those innermost loops so the vectorization pass has an easier time handling them ๐Ÿ’…. It's on by default whenever vectorization is enabled, periodt.
  • -ftree-loop-distribution โ€” does loop distribution ๐ŸŒ€. This flag can level up cache performance on big loop bodies and lets further loop optimizations happen, like parallelization or vectorization. For example, this loop
        DO I = 1, N
          A(I) = B(I) + C
          D(I) = E(I) * F
        ENDDO

gets transformed into

        DO I = 1, N
           A(I) = B(I) + C
        ENDDO
        DO I = 1, N
           D(I) = E(I) * F
        ENDDO

This flag is enabled by default at -O3. It's also enabled by -fprofile-use and -fauto-profile ๐Ÿ”ฅ.

  • -ftree-loop-distribute-patterns โ€” loop distribution, but make it library-call coded ๐Ÿ‘‘. It distributes patterns that can be code generated with calls to a library. This flag is enabled by default at -O2 and higher, and by -fprofile-use and -fauto-profile.

This pass distributes the initialization loops and generates a call to memset zero. For example, the loop

        DO I = 1, N
          A(I) = 0
          B(I) = A(I) + I
        ENDDO

is transformed to

        DO I = 1, N
           A(I) = 0
        ENDDO
        DO I = 1, N
           B(I) = A(I) + I
        ENDDO

and the initialization loop is transformed into a call to memset zero. it's giving optimized ๐Ÿ’–

  • -floop-interchange โ€” performs 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
        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];

is transformed to

        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];

This flag is enabled by default at -O3. It is also enabled by -fprofile-use and -fauto-profile โœจ.

  • -floop-unroll-and-jam โ€” applies 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 -O3. It is also enabled by -fprofile-use and -fauto-profile.
  • -ftree-loop-im โ€” performs loop invariant motion on trees ๐ŸŒธ. This pass moves only invariants that are hard to handle at RTL level โ€” think function calls, operations that expand to nontrivial sequences of insns. With -funswitch-loops it also moves operands of conditions that are invariant out of the loop, so we can use just trivial invariantness analysis in loop unswitching. The pass also includes store motion.
  • -ftree-loop-ivcanon โ€” creates a canonical counter for the number of iterations in loops where figuring out the iteration count needs complicated analysis ๐Ÿ˜ญ. Later optimizations then may determine the number easily. Useful especially in connection with unrolling, iykyk ๐Ÿ’….
  • -ftree-scev-cprop โ€” performs 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, then uses of the final value get replaced by such a computation โ€” provided it's sufficiently cheap. This reduces data dependencies and may allow further simplifications. Enabled by default at -O1 and higher.
  • -fivopts โ€” performs induction variable optimizations on trees: strength reduction, induction variable merging and induction variable elimination ๐ŸŒˆ.
  • -ftree-parallelize-loops=n โ€” parallelize loops, bestie!! i.e., split their iteration space to run in n threads ๐Ÿงš. This is only possible for loops whose iterations are independent and can be arbitrarily reordered. Heads up: 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 -pthread, and thus is only supported on targets that have support for -pthread.
  • -ftree-pta โ€” performs function-local points-to analysis on trees ๐Ÿ”. This flag is enabled by default at -O1 and higher, except for -Og.
  • -ftree-sra โ€” performs 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 -O1 and higher, except for -Og.
  • -fstore-merging โ€” merging of narrow stores to consecutive memory addresses ๐ŸŽ€. This pass merges contiguous stores of immediate values narrower than a word into fewer wider stores, which reduces the number of instructions. Enabled by default at -O2 and higher as well as -Os.
  • -ftree-ter โ€” performs 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, which results in better RTL generation. Enabled by default at -O1 and higher.
  • -ftree-slsr โ€” performs straight-line strength reduction on trees ๐Ÿ’ช. This recognizes related expressions involving multiplications and replaces them by less expensive calculations when possible. Enabled by default at -O1 and higher.
  • -ftree-vectorize โ€” performs vectorization on trees โœจ. This flag enables -ftree-loop-vectorize and -ftree-slp-vectorize if they're not explicitly specified.
  • -ftree-loop-vectorize โ€” performs loop vectorization on trees ๐Ÿ”ฅ. This flag is enabled by default at -O2 and by -ftree-vectorize, -fprofile-use, and -fauto-profile.
  • -ftree-slp-vectorize โ€” performs basic block vectorization on trees ๐Ÿ‘‘. This flag is enabled by default at -O2 and by -ftree-vectorize, -fprofile-use, and -fauto-profile.
  • -ftrivial-auto-var-init=choice โ€” initialize automatic variables with either a pattern or with zeroes ๐Ÿ›ก๏ธ, which increases the security and predictability of a program by preventing uninitialized memory disclosure and use. Okay but listen: GCC still considers an automatic variable that doesn't have an explicit initializer as uninitialized. -Wuninitialized and -Wanalyzer-use-of-uninitialized-value will still report warning messages on such automatic variables, and the compiler will perform optimization as if the variable were uninitialized ๐Ÿ˜ค. With this option, GCC will also initialize any padding of automatic variables that have structure or union types to zeroes. However, the current implementation cannot initialize automatic variables that are declared between the controlling expression and the first case of a switch statement. Use -Wtrivial-auto-var-init to report all such cases.

The three values of choice are:

  • uninitialized โ€” doesn't initialize any automatic variables. This is C and C++'s default ๐Ÿ’….
  • 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 a byte-repeatable pattern with byte "0xFE". The values used for pattern initialization might be changed in the future ๐Ÿ‘€.
  • zero โ€” initialize automatic variables with zeroes.

The default is uninitialized.

Note that the initializer values, whether zero or 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 hardbool. For example, a variable that uses 8 bits to represent (biased) quantities in the "range 160..400" will be initialized with the bit patterns 0x00 or 0xFE, depending on 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 hardbool variable that uses say "0X5A" and 0xA5 for "false" and "true", respectively, will trap with either choice of trivial initializer, i.e., zero initialization will not convert to the representation for "false", even if it would for a "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 "false" (zero), even when pattern is requested ๐Ÿคฏ.

You can control this behavior for a specific variable by using the variable attribute "uninitialized" โœจ.

  • -fvect-cost-model=model โ€” alter the cost model used for vectorization ๐Ÿ’ธ. The model argument should be one of unlimited, dynamic, cheap or very-cheap.
    • With the unlimited model the vectorized code-path is assumed to be profitable.
    • With the 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 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 dynamic model.
    • The very-cheap model only allows vectorization if the vector code would entirely replace the scalar code that is being vectorized. For example, if each iteration of a vectorized loop would only be able to handle exactly four iterations of the scalar loop, the very-cheap model would only allow vectorization if the scalar iteration count is known to be a multiple of four.

The default cost model depends on other optimization flags and is either dynamic or cheap ๐Ÿฆ‹.

  • -fsimd-cost-model=model โ€” bestie, this changes the cost model used when GCC vectorizes loops that are marked with the OpenMP simd directive. โœจ The model argument needs to be one of unlimited, dynamic, cheap. Every one of those values means the same thing it means over in -fvect-cost-model, and if you don't say anything here, whatever cost model you set with -fvect-cost-model is the one that gets used. ๐Ÿ’…
  • -ftree-vrp โ€” this does Value Range Propagation on trees. ๐ŸŒˆ It's giving constant propagation's cooler cousin: instead of propagating values, it propagates ranges of values. That lets the optimizers yeet unnecessary range checks, like array bound checks and null pointer checks. It's on by default at -O2 and higher. ๐Ÿซถ One lil caveat: null pointer check elimination only happens if -fdelete-null-pointer-checks is enabled. ๐Ÿ‘‘
  • -fsplit-paths โ€” splits the paths that lead to loop backedges. ๐Ÿฆ‹ This can level up dead code elimination and common subexpression elimination. Enabled by default at -O3 and above. โœจ
  • -fsplit-ivs-in-unroller โ€” this one lets GCC express the values of induction variables in later iterations of an unrolled loop using the value from the first iteration. ๐Ÿ”ฅ It breaks up those long dependency chains, which makes the scheduling passes way more efficient. slay.

A combo of -fweb and CSE is often enough to get the same effect. However, that's not reliable when the loop body is more complicated than a single basic block. ๐Ÿ˜ญ And it doesn't work at all on some architectures because of restrictions in the CSE pass.

This optimization is enabled by default. ๐Ÿ’–

  • -fvariable-expansion-in-unroller โ€” with this one, the compiler makes multiple copies of some local variables while unrolling a loop, which can result in superior code. ๐Ÿ‘‘

This optimization is enabled by default for PowerPC targets, but disabled by default everywhere else. ๐ŸŽ€

  • -fpartial-inlining โ€” inline parts of functions. ๐ŸŒธ Heads up though: this only has any effect when inlining itself is turned on, via the -finline-functions or -finline-small-functions options.

Enabled at levels -O2, -O3, -Os. ๐Ÿ’…

  • -fpredictive-commoning โ€” performs predictive commoning optimization, i.e., reusing computations (especially memory loads and stores) that were already performed in previous iterations of loops. ๐Ÿฆ‹

This option is enabled at level -O3. It's also enabled by -fprofile-use and -fauto-profile. โœจ

  • -fprefetch-loop-arrays โ€” if the target machine supports it, this generates instructions to prefetch memory so loops that access large arrays perform better. ๐Ÿ”ฅ

Fair warning, bestie: this option may generate better or worse code. ๐Ÿ˜ญ Results are highly dependent on the structure of the loops within your source code.

Disabled at level -Os. ๐Ÿ™ˆ

  • -fno-printf-return-value โ€” do not substitute constants for the known return value of formatted output functions like sprintf, snprintf, vsprintf, and vsnprintf (but not printf of fprintf). ๐ŸŽ€ This transformation lets GCC optimize or even eliminate branches based on the known return value of those functions when they're 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 -fprintf-return-value is in effect, both the branch and the body of the if statement (but not the call to snprint) can be optimized away when i is a 32-bit or smaller integer, because the return value is guaranteed to be at most 8. ๐Ÿ’…
char buf[9];
if (snprintf (buf, "%08x", i) >= sizeof buf)
  ...

The -fprintf-return-value option relies on other optimizations and yields its best results with -O2 and above. It works in tandem with the -Wformat-overflow and -Wformat-truncation options. The -fprintf-return-value option is enabled by default. ๐ŸŒŸ

  • -fno-peephole
  • -fno-peephole2 โ€” disable any machine-specific peephole optimizations. ๐Ÿ‘€ The difference between -fno-peephole and -fno-peephole2 is in how they're implemented in the compiler; some targets use one, some use the other, and a few use both.

-fpeephole is enabled by default. -fpeephole2 is enabled at levels -O2, -O3, -Os. โœจ

  • -fno-guess-branch-probability โ€” don't guess branch probabilities using heuristics. ๐Ÿšซ

GCC uses heuristics to guess branch probabilities when profiling feedback (-fprofile-arcs) hasn't given it any. These heuristics are based on the control flow graph. If some branch probabilities are specified by __builtin_expect, then the heuristics are used to guess branch probabilities for the rest of the control flow graph, taking the __builtin_expect info into account. ๐Ÿงš The interactions between the heuristics and __builtin_expect can be complex, and in some cases it may be useful to disable the heuristics so the effects of __builtin_expect are easier to understand.

It's also possible to specify the expected probability of the expression with the __builtin_expect_with_probability built-in function. ๐Ÿ’–

The default is -fguess-branch-probability at levels -O, -O2, -O3, -Os. ๐ŸŽ€

  • -freorder-blocks โ€” reorder basic blocks in the compiled function so there are fewer taken branches and better code locality. โœจ

Enabled at levels -O1, -O2, -O3, -Os. ๐Ÿ’…

  • -freorder-blocks-algorithm=algorithm โ€” use the specified algorithm for basic block reordering. The algorithm argument can be simple, which does not increase code size (except sometimes due to secondary effects like alignment), or stc, the "software trace cache" algorithm, which tries to put all the often-executed code together, minimizing the number of branches executed by making extra copies of code. ๐Ÿ”ฅ

The default is simple at levels -O1, -Os, and stc at levels -O2, -O3. ๐ŸŒธ

  • -freorder-blocks-and-partition โ€” on top of reordering basic blocks in the compiled function to reduce the number of taken branches, this partitions hot and cold basic blocks into separate sections of the assembly and .o files, to improve paging and cache locality performance. ๐Ÿ’…

This optimization is automatically turned off when exception handling or unwind tables are in play (on targets using setjump/longjump or a target-specific scheme), for linkonce sections, for functions with a user-defined section attribute, and on any architecture that doesn't support named sections. ๐Ÿšซ When -fsplit-stack is used, this option isn't enabled by default (to avoid linker errors), but it may be enabled explicitly (if you're using a working linker).

Enabled for x86 at levels -O2, -O3, -Os. โœจ

  • -freorder-functions โ€” reorder functions in the object file to improve code locality. ๐ŸŒˆ This is implemented by using special subsections .text.hot for the most frequently executed functions and .text.unlikely for the unlikely-to-execute ones. The reordering is done by the linker, so the object file format must support named sections and the linker must place them in a reasonable way. ๐Ÿ‘‘

This option isn't effective unless you either provide profile feedback (see -fprofile-arcs for details) or manually annotate functions with hot or cold attributes. ๐Ÿ˜ญ

Enabled at levels -O2, -O3, -Os. ๐Ÿ’–

  • -fstrict-aliasing โ€” lets the compiler assume the strictest aliasing rules that apply to the language being compiled. ๐Ÿ”ฅ For C (and C++), this activates optimizations based on the type of expressions. In particular, an object of one type is assumed never to live at the same address as an object of a different type, unless the types are almost the same. For example, an unsigned int can alias an int, but not a void* or a double. A character type may alias any other type. ๐ŸŒŸ

Pay special attention to code like this, bestie:

union a_union {
  int i;
  double d;
};

int f() {
  union a_union t;
  t.d = 3.0;
  return t.i;
}

The practice of reading from a different union member than the one most recently written to (called "type-punning") is common. ๐Ÿซถ Even with -fstrict-aliasing, type-punning is allowed, provided the memory is accessed through the union type. So, the code above works as expected. However, this code might not:

int f() {
  union a_union t;
  int* ip;
  t.d = 3.0;
  ip = &t.i;
  return *ip;
}

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.: ๐Ÿ’€

int f() {
  double d = 3.0;
  return ((union a_union *) &d)->i;
}

The -fstrict-aliasing option is enabled at levels -O2, -O3, -Os. ๐Ÿ’…

  • -fipa-strict-aliasing โ€” controls whether the rules of -fstrict-aliasing get applied across function boundaries. โœจ Note that if multiple functions get inlined into a single function, the memory accesses are no longer considered to be crossing a function boundary. ๐Ÿฆ‹

The -fipa-strict-aliasing option is enabled by default and is effective only in combination with -fstrict-aliasing. ๐Ÿ‘‘

  • -falign-functions
  • -falign-functions=n
  • -falign-functions=n:m
  • -falign-functions=n:m:n2
  • -falign-functions=n:m:n2:m2 โ€” align the start of functions to the next power-of-two greater than or equal to n, skipping up to m-1 bytes. ๐ŸŒธ This ensures that at least the first m bytes of the function can be fetched by the CPU without crossing an 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 -fmin-function-alignment.

If m is not specified, it defaults to n. ๐Ÿ’…

Examples: -falign-functions=32 aligns functions to the next 32-byte boundary, -falign-functions=24 aligns to the next 32-byte boundary only if this can be done by skipping 23 bytes or less, and -falign-functions=32:7 aligns to the next 32-byte boundary only if this can be done by skipping 6 bytes or less. ๐Ÿ”ฅ

That second pair of n2:m2 values lets you specify a secondary alignment: -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 it aligns to the next 32-byte boundary if this can be done by skipping 2 bytes or less. ๐ŸŽ€ If m2 is not specified, it defaults to n2. โœจ

Some assemblers lowkey only support this flag when n is a power of two โ€” and in that case, bestie, it just gets rounded up. ๐Ÿ’…

-fno-align-functions and -falign-functions=1 are literally equivalent, and they mean functions are not aligned. Periodt.

If n isn't specified or it's zero, use a machine-dependent default. The maximum allowed n option value is 65536. No cap on the vibes though. โœจ

Enabled at levels -O2, -O3.

  • -flimit-function-alignment โ€” if this is on, the compiler tries to avoid unnecessarily overaligning functions. It attempts to instruct the assembler to align by the amount specified by -falign-functions, but not to skip more bytes than the size of the function. It's giving "align, but know your limits" energy. ๐ŸŽ€
  • -falign-labels
  • -falign-labels=n
  • -falign-labels=n:m
  • -falign-labels=n:m:n2
  • -falign-labels=n:m:n2:m2 โ€” align all branch targets to a power-of-two boundary. ๐Ÿฆ‹

Parameters of this option are analogous to the -falign-functions option. -fno-align-labels and -falign-labels=1 are equivalent and mean that labels are not aligned.

If -falign-loops or -falign-jumps are applicable and are greater than this value, then their values are used instead.

If n is not specified or is zero, use a machine-dependent default which is very likely to be 1, meaning no alignment. The maximum allowed n option value is 65536.

Enabled at levels -O2, -O3.

  • -falign-loops
  • -falign-loops=n
  • -falign-loops=n:m
  • -falign-loops=n:m:n2
  • -falign-loops=n:m:n2: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 -falign-labels is greater than this value, then its value is used instead.

Parameters of this option are analogous to the -falign-functions option. -fno-align-loops and -falign-loops=1 are equivalent and mean that loops are not aligned. The maximum allowed n option value is 65536.

If n is not specified or is zero, use a machine-dependent default.

Enabled at levels -O2, -O3.

  • -falign-jumps
  • -falign-jumps=n
  • -falign-jumps=n:m
  • -falign-jumps=n:m:n2
  • -falign-jumps=n:m:n2: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 -falign-labels is greater than this value, then its value is used instead.

Parameters of this option are analogous to the -falign-functions option. -fno-align-jumps and -falign-jumps=1 are equivalent and mean that loops are not aligned.

If n is not specified or is zero, use a machine-dependent default. The maximum allowed n option value is 65536.

Enabled at levels -O2, -O3.

  • -fmin-function-alignment โ€” specify minimal alignment of functions to the next power-of-two greater than or equal to n. Unlike -falign-functions this alignment is applied also to all functions (even those considered cold). The alignment is also not affected by -flimit-function-alignment. It's giving "no one gets left behind" fr fr. ๐Ÿ’–
  • -fno-allocation-dce โ€” do not remove unused C++ allocations in dead code elimination. Not me keeping the dead allocations around... ๐Ÿ™ˆ
  • -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 -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 -Ofast.

โš ๏ธ Okay so heads up bestie: this one is literally about data races. The manpage says it may introduce new ones. Read the whole thing before you turn it on. ๐Ÿ’€
  • -funit-at-a-time โ€” this option is left for compatibility reasons. -funit-at-a-time has no effect, while -fno-unit-at-a-time implies -fno-toplevel-reorder and -fno-section-anchors.

Enabled by default.

  • -fno-toplevel-reorder โ€” do not reorder top-level functions, variables, and 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. ๐Ÿ‘‘

-ftoplevel-reorder is the default at -O1 and higher, and also at -O0 if -fsection-anchors is explicitly requested. Additionally -fno-toplevel-reorder implies -fno-section-anchors.

  • -funreachable-traps โ€” with this option, the compiler turns calls to __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 -fsanitize=unreachable -fsanitize-trap=unreachable, but does not affect the values of those options. If -fsanitize=unreachable is enabled, that option takes priority over this one.

This option is enabled by default at -O0 and -Og.

  • -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 -funroll-loops.

  • -fwhole-program โ€” assume that the current compilation unit represents the whole program being compiled. All public functions and variables with the exception of main and those merged by attribute externally_visible become static functions and in effect are optimized more aggressively by interprocedural optimizers. Main character exception, obviously. ๐Ÿ‘‘

With -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 -flto -flinker-output=nolto-rel).

  • -flto[=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, -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:

gcc -c -O2 -flto foo.c
gcc -c -O2 -flto bar.c
gcc -o myprog -flto -O2 foo.o bar.o

The first two invocations to GCC save a bytecode representation of GIMPLE into special ELF sections inside foo.o and bar.o. The final invocation reads the GIMPLE bytecode from foo.o and bar.o, merges the two files into a single internal image, and compiles the result as usual. Since both foo.o and 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 bar.o into functions in foo.o and vice-versa. It's giving "two files, one vibe". ๐Ÿฆ‹

Another (simpler) way to enable link-time optimization is:

gcc -o myprog -flto -O2 foo.c bar.c

The above generates bytecode for foo.c and bar.c, merges them together into a single GIMPLE representation and optimizes them as usual to produce 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 -flto command-line option. You can always override the automatic decision to do link-time optimization by passing -fno-lto to the link command.

To make whole program optimization effective, it is necessary to make certain whole program 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 -fuse-linker-plugin) passes information to the compiler about used and externally visible symbols. When the linker plugin is not available, -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 -flto without -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 -ffat-lto-objects). This means that object files with LTO information can be linked as normal object files; if -fno-lto is passed to the linker, no interprocedural optimizations are applied. Note that when -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.

Okay so if you're at link time and you don't pass an optimization level like -O, GCC just goes "bestie, I'll use whatever the highest -O level was that got used when compiling the object files" โœจ. But here's the tea: passing an optimization level only at link time and not at compile time is basically pointless, for two reasons. One, compiling without optimization suppresses the compiler passes that gather the info you'd need to actually optimize well at link time. Two, some early optimization passes can only run at compile time โ€” never at link time. So like, it's giving nothing. ๐Ÿ’€

There are a few code generation flags GCC preserves when it's generating bytecodes, because they're needed during the final link. Currently these options and their settings get taken from the first object file that explicitly specifies them: -fcommon, -fexceptions, -fnon-call-exceptions, -fgnu-tm, plus all the -m target flags.

The following options โ€” -fPIC, -fpic, -fpie and -fPIE โ€” get combined according to this scheme, no cap:

-fPIC + -fpic = -fpic
-fPIC + -fno-pic = -fno-pic
-fpic/-fPIC + (no option) = (no option)
-fPIC + -fPIE = -fPIE
-fpic + -fPIE = -fpie
-fPIC/-fpic + -fpie = -fpie

Certain ABI-changing flags have to match across every compilation unit, periodt. If you try to override that at link time with a conflicting value, the override just gets ignored. This includes options like -freg-struct-return and -fpcc-struct-return.

Other options โ€” like -ffp-contract, -fno-strict-overflow, -fwrapv, -fno-trapv or -fno-strict-aliasing โ€” get passed through to the link stage and merged conservatively for conflicting translation units. Specifically, -fno-strict-overflow, -fwrapv and -fno-trapv take precedence; and for example -ffp-contract=off takes precedence over -ffp-contract=fast. These ones you can override at link time. ๐Ÿซถ

Diagnostic options like -Wstringop-overflow also get passed through to the link stage, and their setting matches the compile-step's setting at function granularity. Heads up: this only actually matters for diagnostics emitted during optimization. And also โ€” code transforms like inlining can make warnings turn on or off for regions of code that don't match the compile-time setting. ๐Ÿ™ˆ

When you need to pass options to the assembler via -Wa or -Xassembler, make sure you either compile those translation units with -fno-lto, or consistently use the same assembler options on all of them. Or alternatively, you can just specify the assembler options at LTO link time. ๐Ÿ’…

To get debug info generation you need to supply -g at compile time. If any of the input files at link time were built with debug info generation enabled, then the link enables debug info generation too. But fancy debug info settings like the dwarf level -gdwarf-5 have to be explicitly repeated on the linker command line โ€” and mixing different settings across different translation units is discouraged, so like, don't. ๐Ÿ˜ญ

If LTO runs into objects with C linkage declared with incompatible types in separate translation units that are being linked together (which is undefined behavior according to ISO C99 6.2.7), a non-fatal diagnostic may get issued. The behavior is still undefined at run time though โ€” the diagnostic is not a fix, bestie. Similar diagnostics may be raised for other languages too.


Another iconic feature of LTO: you can apply interprocedural optimizations on files written in different languages. Obsessed, honestly:

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

Notice that the final link is done with g++ to pull in the C++ runtime libraries, and -lgfortran is added to get the Fortran runtime libraries. In general, when you're mixing languages in LTO mode, use the same link command options you'd use when mixing languages in a regular (non-LTO) compilation. ๐ŸŒˆ

If object files containing GIMPLE bytecode are stored in a library archive โ€” say libfoo.a โ€” you can extract and use them in an LTO link if you're using a linker with plugin support. To create static libraries suitable for LTO, use gcc-ar and gcc-ranlib instead of ar and ranlib; to show the symbols of object files with GIMPLE bytecode, use gcc-nm. Those commands require that ar, ranlib and nm have been compiled with plugin support. At link time, use the flag -fuse-linker-plugin to make sure the library actually participates in the LTO optimization process:

gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo

With the linker plugin enabled, the linker extracts the needed GIMPLE files from libfoo.a and passes them on to the running GCC so they become part of the aggregated GIMPLE image that gets optimized. โœจ

If you're not using a linker with plugin support, and/or you don't enable the linker plugin, then the objects inside 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 -flto -ffat-lto-objects. ๐ŸŽ€

Link-time optimizations do not require the whole program to be present to operate. If the program doesn't need any symbols exported, you can combine -flto and -fwhole-program to let the interprocedural optimizers use more aggressive assumptions, which may lead to improved optimization opportunities. You do not need -fwhole-program when the linker plugin is active (see -fuse-linker-plugin).

The current implementation of LTO makes no attempt to generate bytecode that's portable between different types of hosts. The bytecode files are versioned and there's a strict version check, so bytecode files generated in one version of GCC do not work with an older or newer version of GCC. It's giving exclusive. ๐Ÿ’€

Link-time optimization does not work well with generation of debugging information on systems other than those using a combination of ELF and DWARF. Just so you know. ๐Ÿ˜ญ

If you specify the optional n, the optimization and code generation done at link time is executed in parallel using n parallel jobs, by utilizing an installed make program. The environment variable MAKE may be used to override the program used. Slay.

You can also specify -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 + to the command recipe in the parent Makefile for this to work. This option likely only works if MAKE is GNU make. Even without the option value, GCC tries to automatically detect a running GNU make's job server. ๐Ÿ

Use -flto=auto to use GNU make's job server if it's available, or otherwise fall back to autodetecting the number of CPU threads present in your system.

-flto-partition=alg ๐Ÿ‘‘

Specify the partitioning algorithm used by the link-time optimizer. The value is either 1to1, to specify a partitioning mirroring the original source files, or balanced, to specify partitioning into equally sized chunks (whenever possible), or max, to create a new partition for every symbol where possible. Specifying none as an algorithm disables partitioning and streaming completely. The default value is balanced. While 1to1 can be used as a workaround for various code ordering issues, the max partitioning is intended for internal testing only โ€” don't be out here using it in prod, bestie. ๐Ÿ™ˆ The value one specifies that exactly one partition should be used, while the value none bypasses partitioning and executes the link-time optimization step directly from the WPA phase.

-flto-compression-level=n ๐Ÿ—œ๏ธ

This option specifies the level of compression used for intermediate language written to LTO object files, and it's only meaningful in conjunction with LTO mode (-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 get clamped to either the minimum or maximum of the supported values. If the option isn't given, a default balanced compression setting is used.

-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 -fwhole-program. See -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). โœจ

-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 -flto and is ignored at link time.

-fno-fat-lto-objects improves compilation time over plain LTO, but it requires the complete toolchain to be aware of LTO. It requires a linker with linker plugin support for basic functionality. Additionally, nm, ar and ranlib need to support linker plugins to allow a full-featured build environment (capable of building static libraries etc). GCC provides the gcc-ar, gcc-nm, 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 a plugin auto-load mechanism. Installing the linker plugin into $libdir/bfd-plugins has the same effect as usage of the command wrappers (gcc-ar, gcc-nm and gcc-ranlib).

The default is -fno-fat-lto-objects on targets with linker plugin support.

  • -fcompare-elim โ€” so after register allocation and post-register allocation instruction splitting, GCC goes looking for arithmetic instructions that compute processor flags the same way a comparison operation would, based on that arithmetic. If it can, it โœจeliminatesโœจ the explicit comparison operation. This pass only applies to certain targets that can't explicitly represent the comparison operation before register allocation is complete. Enabled at levels -O1, -O2, -O3, -Os.
  • -ffold-mem-offsets, -fno-fold-mem-offsets โ€” try to eliminate add instructions by folding them into memory loads/stores. Enabled at levels -O2, -O3.
  • -fcprop-registers โ€” after register allocation and post-register allocation instruction splitting, run a copy-propagation pass to try to reduce scheduling dependencies and, every once in a while, straight up eliminate the copy. Enabled at levels -O1, -O2, -O3, -Os.
  • -fprofile-correction โ€” bestie. Profiles collected from an instrumented binary for multi-threaded programs can be inconsistent because some counter updates just get missed, it's giving race condition energy ๐Ÿ’€. When you specify this option, GCC uses heuristics to correct or smooth out those inconsistencies. By default, GCC emits an error message when it detects an inconsistent profile. This option is enabled by -fauto-profile.
  • -fprofile-partial-training โ€” with -fprofile-use, every portion of a program that didn't get executed during the train run is optimized aggressively for size rather than speed. And sometimes it's just not practical to train all the possible hot paths in a program (say the program has functions specific to a given hardware and your training didn't cover all the hardware configurations the program actually runs on ๐Ÿ™ˆ). With -fprofile-partial-training, profile feedback gets ignored for all functions not executed during the train run, which leads them to be optimized as if they were compiled without profile feedback at all. This leads to better performance when the train run isn't representative โ€” but also leads to significantly bigger code. Tradeoffs, babes.
  • -fprofile-use, -fprofile-use=path โ€” enable profile feedback-directed optimizations, plus the following optimizations, many of which are generally profitable only with profile feedback available:
-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. That's the whole prerequisite, no skipping ๐Ÿ‘‘

By default, GCC emits an error message if the feedback profiles don't match the source code. You can turn that error into a warning by using -Wno-error=coverage-mismatch. Note this may result in poorly optimized code ๐Ÿ˜ญ. Also, by default, GCC emits a warning message if the feedback profiles don't exist at all (see -Wmissing-profile).

If path is specified, GCC looks at path to find the profile feedback data files. See -fprofile-dir.

  • -fauto-profile, -fauto-profile=path โ€” enable sampling-based feedback-directed optimizations, plus the following optimizations, many of which are generally profitable only with profile feedback available:
-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

path is the name of a file containing AutoFDO profile information. If it's omitted, it defaults to fbdata.afdo in the current directory.

Producing an AutoFDO profile data file requires running your program with the perf utility on a supported GNU/Linux target system. For more info, see https://perf.wiki.kernel.org/.

E.g.

perf record -e br_inst_retired:near_taken -b -o perf.data \
    -- your_program

Then use the create_gcov tool to convert the raw profile data into a format GCC can actually use. You also have to supply the unstripped binary for your program to this tool. See https://github.com/google/autofdo.

E.g.

create_gcov --binary=your_program.unstripped --profile=perf.data \
    --gcov=profile.afdo

The following options control compiler behavior regarding floating-point arithmetic. These options trade off between speed and correctness. And heads up โ€” all of them must be specifically enabled. No freebies here, you gotta ask nicely.

  • -ffloat-store โ€” don't store floating-point variables in registers, and inhibit other options that might change whether a floating-point value gets taken from a register or from memory.

This option prevents undesirable excess precision on machines like the 68000, where the floating registers (of the 68881) keep more precision than a double is supposed to have. Same situation on the x86 architecture, fr fr. For most programs, the excess precision does only good, but a few programs rely on the precise definition of IEEE floating point. Use -ffloat-store for those programs โ€” after modifying them to store all pertinent intermediate computations into variables. Yes, that part's on you.

  • -fexcess-precision=style โ€” this option lets you control excess precision even further on machines where floating-point operations happen in a format with more precision or range than the IEEE standard and interchange floating-point types.

By default, -fexcess-precision=fast is in effect; this means 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 -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 -ffloat-store only affects assignments). This option is enabled by default for C or C++ if a strict conformance option such as -std=c99 or -std=c++17 is used. -ffast-math enables -fexcess-precision=fast by default regardless of whether a strict conformance option is used. If -fexcess-precision=16 is specified, constants and the results of expressions with types _Float16 and __bf16 are computed without excess precision.

Heads up bestie: -fexcess-precision=standard is not implemented for languages other than C or C++. On the x86, it has no effect if -mfpmath=sse or -mfpmath=sse+387 is specified; in the former case, IEEE semantics apply without excess precision, and in the latter, rounding is unpredictable. ๐Ÿ’€
  • -ffast-math โ€” sets the options -fno-math-errno, -funsafe-math-optimizations, -ffinite-math-only, -fno-rounding-math, -fno-signaling-nans, -fcx-limited-range and -fexcess-precision=fast.

This option causes the preprocessor macro __FAST_MATH__ to be defined. Iconic.

This option is not turned on by any -O option besides -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 don't require the guarantees of these specifications. Your call, your vibe ๐Ÿฆ‹.

  • -fno-math-errno โ€” don't set errno after calling math functions that are executed with a single instruction, e.g. sqrt. A program that relies on IEEE exceptions for math error handling may want to use this flag for speed while keeping IEEE arithmetic compatibility.

This option is not turned on by any -O option, 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 don't require the guarantees of these specifications.

The default is -fmath-errno.

On Darwin systems, the math library never sets errno. So there's literally no reason for the compiler to consider the possibility that it might, and -fno-math-errno is the default there. Slay, Darwin.

  • -funsafe-math-optimizations โ€” allow optimizations for floating-point arithmetic that (a) assume 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 -O option, 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 don't require the guarantees of these specifications. Enables -fno-signed-zeros, -fno-trapping-math, -fassociative-math and -freciprocal-math.

The default is -fno-unsafe-math-optimizations.

  • -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 (x + 2**52) - 2**52). It may also reorder floating-point comparisons and thus may not be used when ordered comparisons are required. This option requires that both -fno-signed-zeros and -fno-trapping-math be in effect. Moreover, it doesn't make much sense with -frounding-math. For Fortran the option is automatically enabled when both -fno-signed-zeros and -fno-trapping-math are in effect.

The default is -fno-associative-math.

  • -freciprocal-math โ€” allow the reciprocal of a value to be used instead of dividing by the value, if this enables optimizations. For example x / y can be replaced with x * (1/y), which is useful if (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 -fno-reciprocal-math.

  • -ffinite-math-only โ€” okay so this one lets GCC do FP math optimizations that assume your arguments and your results are never NaNs and never ยฑInfs. The catch? No -O option turns this on, because it can straight up produce incorrect output for programs that need math functions to follow IEEE or ISO rules/specifications to the letter. If your program doesn't need those guarantees though? Faster code, bestie. โœจ

The default is -fno-finite-math-only.

  • -fno-signed-zeros โ€” this one allows optimizations for floating-point arithmetic that ignore the signedness of zero. IEEE arithmetic is very much a "we care about this" situation: it specifies distinct behavior for +0.0 and -0.0, which then forbids simplifying expressions like x+0.0 or 0.0*x (yes, even with -ffinite-math-only). Turning this on implies the sign of a zero result isn't significant.

The default is -fsigned-zeros.

  • -fno-trapping-math โ€” compile code assuming floating-point operations cannot generate user-visible traps. Which traps, you ask? Division by zero, overflow, underflow, inexact result and invalid operation. ๐Ÿ’€ This option requires that -fno-signaling-nans be in effect. Setting it may allow faster code if you're relying on "non-stop" IEEE arithmetic, for example.

This option should never be turned on by any -O option, 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 -ftrapping-math.

Future versions of GCC may provide finer control of this setting using C99's FENV_ACCESS pragma. This command-line option will be used along with -frounding-math to specify the default state for FENV_ACCESS.

  • -frounding-math โ€” disables transformations and optimizations that assume default floating-point rounding behavior. And what's "default", exactly? Round-to-zero for all floating point to integer conversions, and round-to-nearest for all other arithmetic truncations. Specify this for programs that change the FP rounding mode dynamically, or that might be executed with a non-default rounding mode. It 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 -fno-rounding-math.

Heads up babes, 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 FENV_ACCESS pragma. This command-line option will be used along with -ftrapping-math to specify the default state for FENV_ACCESS.
  • -fsignaling-nans โ€” compile code assuming that IEEE signaling NaNs may generate user-visible traps during floating-point operations. Setting this disables optimizations that may change the number of exceptions visible with signaling NaNs. It also implies -ftrapping-math.

This option causes the preprocessor macro __SUPPORT_SNAN__ to be defined. ๐ŸŽ€

The default is -fno-signaling-nans.

Also experimental, bestie โ€” it does not currently guarantee to disable all GCC optimizations that affect signaling NaN behavior.
  • -fno-fp-int-builtin-inexact โ€” do not allow the built-in functions ceil, floor, round and trunc, and their float and 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 -ffp-int-builtin-inexact, allowing the exception to be raised, unless C23 or a later C standard is selected. This option does nothing unless -ftrapping-math is in effect.

Even if -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. ๐Ÿ˜ญ

  • -fsingle-precision-constant โ€” treat floating-point constants as single precision instead of implicitly converting them to double-precision constants. That's it, that's the whole vibe.
  • -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 NaN + I*NaN, with an attempt to rescue the situation in that case. The default is -fno-cx-limited-range, but is enabled by -ffast-math.

This option controls the default setting of the ISO C99 CX_LIMITED_RANGE pragma. Nevertheless, the option applies to all languages. ๐Ÿ‘‘

  • -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 NaN + I*NaN, with an attempt to rescue the situation in that case.

The default is -fno-cx-fortran-rules.


The following options control optimizations that may improve performance, but are not enabled by any -O options. This section includes experimental options that may produce broken code. ๐Ÿ˜ณ Yeah. Read that twice. Proceed with caution, gorgeous.

  • -fbranch-probabilities โ€” so after running a program compiled with -fprofile-arcs, you can compile it a second time</u> using -fbranch-probabilities, to improve optimizations based on the number of times each branch was taken. When a program compiled with -fprofile-arcs exits, it saves arc execution counts to a file called sourcename.gcda for each source file. The info in that 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 -fprofile-arcs.

With -fbranch-probabilities, GCC puts a REG_BR_PROB note on each JUMP_INSN and CALL_INSN. These can be used to improve optimization. Currently, they are only used in one place: in reorg.cc, instead of guessing which path a branch is most likely to take, the REG_BR_PROB values are used to exactly determine which path is taken more often. ๐Ÿ”ฅ

Enabled by -fprofile-use and -fauto-profile.

  • -fprofile-values โ€” if combined with -fprofile-arcs, it adds code so that some data about values of expressions in the program is gathered.

With -fbranch-probabilities, it reads back the data gathered from profiling values of expressions for usage in optimizations.

Enabled by -fprofile-generate, -fprofile-use, and -fauto-profile.

  • -fprofile-reorder-functions โ€” function reordering based on profile instrumentation collects first time of execution of a function and orders these functions in ascending order. Sorting, but make it a glow-up. โœจ

Enabled with -fprofile-use.

  • -fvpt โ€” if combined with -fprofile-arcs, this option instructs the compiler to add code to gather information about values of expressions.

With -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. iykyk.

Enabled with -fprofile-use and -fauto-profile.

  • -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 -funroll-loops.

  • -fschedule-fusion โ€” performs a target dependent pass over the instruction stream to schedule instructions of same type together, because the target machine can execute them more efficiently if they are adjacent to each other in the instruction flow. Besties who sit together, slay together. ๐Ÿซถ

Enabled at levels -O2, -O3, -Os.

  • -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. Teamwork makes the dream work. ๐ŸŒˆ

Enabled by -fprofile-use and -fauto-profile.

  • -funroll-loops โ€” unroll loops whose number of iterations can be determined at compile time or upon entry to the loop. -funroll-loops implies -frerun-cse-after-loop, -fweb and -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. No promises, babe.

Enabled by -fprofile-use and -fauto-profile.

  • -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. ๐Ÿ˜ฌ -funroll-all-loops implies the same options as -funroll-loops.
  • -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). Peeling, but for loops, not for your skincare routine. ๐Ÿ“

Enabled by -O3, -fprofile-use, and -fauto-profile.

  • -fmove-loop-invariants โ€” enables the loop invariant motion pass in the RTL loop optimizer. Enabled at level -O1 and higher, except for -Og.
  • -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, -ftree-loop-im has to be enabled as well. Enabled at level -O1 and higher, except for -Og.
  • -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. Divide and conquer, literally. ๐Ÿ’…

Enabled by -fprofile-use and -fauto-profile.

  • -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). Basically yeeting the decision out of the loop so it stops asking every single time. ๐Ÿ‘‘

Enabled by -fprofile-use and -fauto-profile.

  • -fversion-loops-for-strides โ€” bestie, if a loop is striding through an array with a variable stride, this makes a whole second version of the loop that just assumes the stride is 1. Iconic behaviour, honestly. Like, watch this:
for (int i = 0; i < n; ++i)
  x[i * stride] = ...;

and then it becomes:

if (stride == 1)
  for (int i = 0; i < n; ++i)
    x[i] = ...;
else
  for (int i = 0; i < n; ++i)
    x[i * stride] = ...;

This is particularly useful for assumed-shape arrays in Fortran, where (for example) it lets the compiler vectorize way better assuming contiguous accesses. This flag is enabled by default at -O3. It's also enabled by -fprofile-use and -fauto-profile.

  • -ffunction-sections
  • -fdata-sections

Put 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. (Two flags, one slay.)

Use these on systems where the linker can do 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, ngl.

Together with a linker garbage collection (linker --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 though.

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.
  • -fstdarg-opt โ€” optimizes the prologue of variadic argument functions with respect to usage of those arguments. Little prologue glow-up ๐Ÿ’…
  • -fsection-anchors โ€” tries to reduce the number of symbolic address calculations by using shared "anchor" symbols to address nearby objects. This transformation can help reduce the number of GOT entries and GOT accesses on some targets.

For example, the implementation of the following function foo:

static int a, b, c;
int foo (void) { return a + b + c; }

usually calculates the addresses of all three variables, but if you compile it with -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):

int foo (void)
{
  register int *xr = &x;
  return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
}

Not all targets support this option.

  • -fzero-call-used-regs=choice โ€” zeroes call-used registers at function return to increase program security, either by mitigating Return-Oriented Programming (ROP) attacks or by preventing information leakage through registers. Security girl summer ๐Ÿ”ฅ

The possible values of choice are the same as for the zero_call_used_regs attribute. The default is skip.

You can control this behavior for a specific function by using the function attribute zero_call_used_regs.


  • --param name=value โ€” okay so in some places, GCC uses various constants to control how much optimization gets done. For example, GCC does not inline functions that contain more than a certain number of instructions. You can control some of these constants on the command line using the --param option.
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. (fr fr, don't get attached)

In order to get the minimal, maximal and default values of a parameter, use the --help=param -Q options.

In each case, the value is an integer. The following choices of name are recognized for all targets:

predictable-branch-outcome

When branch is predicted to be taken with probability lower than this threshold (in percent), then it is considered well predictable.

max-rtl-if-conversion-insns

RTL if-conversion tries to remove conditional branches around a block and replace them with conditionally executed instructions. This parameter gives the maximum number of instructions in a block which should be considered for if-conversion. The compiler will also use other heuristics to decide whether if-conversion is likely to be profitable.

max-rtl-if-conversion-predictable-cost

RTL if-conversion will try to remove conditional branches around a block and replace them with conditionally executed instructions. These parameters give the maximum permissible cost for the sequence that would be generated by if-conversion depending on whether the branch is statically determined to be predictable or not. The units for this parameter are the same as those for the GCC internal seq_cost metric. The compiler will try to provide a reasonable default for this parameter using the BRANCH_COST target macro.

max-crossjump-edges

The maximum number of incoming edges to consider for cross-jumping. The algorithm used by -fcrossjumping is O(N^2) in the number of edges incoming to each block. Increasing values mean more aggressive optimization, making the compilation time increase with probably small improvement in executable size.

min-crossjump-insns

The minimum number of instructions that must be matched at the end of two blocks before cross-jumping is performed on them. This value is ignored in the case where all instructions in the block being cross-jumped from are matched.

max-grow-copy-bb-insns

The maximum code size expansion factor when copying basic blocks instead of jumping. The expansion is relative to a jump instruction.

max-goto-duplication-insns

The maximum number of instructions to duplicate to a block that jumps to a computed goto. To avoid O(N^2) behavior in a number of passes, GCC factors computed gotos early in the compilation process, and unfactors them as late as possible. Only computed jumps at the end of a basic blocks with no more than max-goto-duplication-insns are unfactored.

The maximum number of instructions to consider when looking for an instruction to fill a delay slot. If more than this arbitrary number of instructions are searched, the time savings from filling the delay slot are minimal, so stop searching. Increasing values mean more aggressive optimization, making the compilation time increase with probably small improvement in execution time.

When trying to fill delay slots, the maximum number of instructions to consider when searching for a block with valid live register information. Increasing this arbitrarily chosen value means more aggressive optimization, increasing the compilation time. This parameter should be removed when the delay slot code is rewritten to maintain the control-flow graph.

max-gcse-memory

The approximate maximum amount of memory in kB that can be allocated in order to perform the global common subexpression elimination optimization. If more memory than specified is required, the optimization is not done.

max-gcse-insertion-ratio

If the ratio of expression insertions to deletions is larger than this value for any expression, then RTL PRE inserts or removes the expression and thus leaves partially redundant computations in the instruction stream.

max-pending-list-length

The maximum number of pending dependencies scheduling allows before flushing the current state and starting over. Large functions with few branches or calls can create excessively large lists which needlessly consume memory and resources.

max-modulo-backtrack-attempts

The maximum number of backtrack attempts the scheduler should make when modulo scheduling a loop. Larger values can exponentially increase compilation time.

max-inline-functions-called-once-loop-depth

Maximal loop depth of a call considered by inline heuristics that tries to inline all functions called once.

max-inline-functions-called-once-insns

Maximal estimated size of functions produced while inlining functions called once.

max-inline-insns-single

Several parameters control the tree inliner used in GCC. This number sets the maximum number of instructions (counted in GCC's internal representation) in a single function that the tree inliner considers for inlining. This only affects functions declared inline and methods implemented in a class declaration (C++).

max-inline-insns-auto

When you use -finline-functions (included in -O3), a lot of functions that would otherwise not be considered for inlining by the compiler are investigated. To those functions, a different (more restrictive) limit compared to functions declared inline can be applied (--param max-inline-insns-auto).

max-inline-insns-small

This is bound applied to calls which are considered relevant with -finline-small-functions.

max-inline-insns-size

This is bound applied to calls which are optimized for size. Small growth may be desirable to anticipate optimization opportunities exposed by inlining.

uninlined-function-insns

Number of instructions accounted by inliner for function overhead such as function prologue and epilogue.

uninlined-function-time

Extra time accounted by inliner for function overhead such as time needed to execute function prologue and epilogue.

  • inline-heuristics-hint-percent โ€” the scale (in percents) that gets applied to inline-insns-single, inline-insns-single-O2 and inline-insns-auto when the inline heuristics are hinting that inlining is very profitable (like, it'll unlock later optimizations, bestie). ๐Ÿ’…
  • uninlined-thunk-insns, uninlined-thunk-time โ€” literally the same energy as --param uninlined-function-insns and --param uninlined-function-time, except it's applied to function thunks. ๐Ÿซถ
  • inline-min-speedup โ€” when the estimated performance improvement of caller + callee runtime goes over this threshold (in percent), the function can be inlined no matter what, ignoring the limit on --param max-inline-insns-single and --param max-inline-insns-auto. it just gets to do it. iconic.
  • large-function-insns โ€” the limit that says what counts as a really large function. for functions bigger than this limit after inlining, inlining is constrained by --param large-function-growth. this parameter is mainly there to avoid absolutely unhinged compilation times caused by the non-linear algorithms the back end uses. ๐Ÿ˜ญ
  • large-function-growth โ€” specifies the maximal growth of a large function caused by inlining, in percents. for example, a parameter value of 100 limits large function growth to 2.0 times the original size. no cap.
  • large-unit-insns โ€” the limit that says what counts as a large translation unit. growth caused by inlining of units bigger than this limit is limited by --param inline-unit-growth. for small units this might be too tight. for example, think of a unit made of function A that's inline and B that just calls A three times. if B is small relative to A, the growth of the unit is 300% and yet that inlining is very sane. but for very large units made of small inlineable functions, the overall unit growth limit is needed to avoid exponential explosion of code size. so for smaller units, the size gets bumped up to --param large-unit-insns before --param inline-unit-growth is applied. periodt.
  • lazy-modules โ€” maximum number of concurrently open C++ module files when lazy loading.
  • inline-unit-growth โ€” specifies the maximal overall growth of the compilation unit caused by inlining. for example, parameter value 20 limits unit growth to 1.2 times the original size. cold functions (either marked cold via an attribute or by profile feedback) are not accounted into the unit size. ๐Ÿ’€
  • ipa-cp-unit-growth โ€” specifies the maximal overall growth of the compilation unit caused by interprocedural constant propagation. for example, parameter value 10 limits unit growth to 1.1 times the original size.
  • ipa-cp-large-unit-insns โ€” the size of translation unit that the IPA-CP pass considers large.
  • large-stack-frame โ€” the limit that says what counts as a large stack frame. while inlining, the algorithm is trying to not grow past this limit too much.
  • large-stack-frame-growth โ€” specifies the maximal growth of large stack frames caused by inlining, in percents. for example, parameter value 1000 limits large stack frame growth to 11 times the original size. ๐Ÿ”ฅ
  • max-inline-insns-recursive, max-inline-insns-recursive-auto โ€” specifies the maximum number of instructions an out-of-line copy of a self-recursive inline function can grow into by doing recursive inlining.

--param max-inline-insns-recursive applies to functions declared inline. for functions not declared inline, recursive inlining only happens when -finline-functions (which is included in -O3) is enabled; --param max-inline-insns-recursive-auto applies instead. slay.

  • max-inline-recursive-depth, max-inline-recursive-depth-auto โ€” specifies the maximum recursion depth used for recursive inlining.

--param max-inline-recursive-depth applies to functions declared inline. for functions not declared inline, recursive inlining only happens when -finline-functions (which is included in -O3) is enabled; --param max-inline-recursive-depth-auto applies instead.

  • min-inline-recursive-probability โ€” recursive inlining is only profitable for functions that have deep recursion on average, and it can actually hurt functions with little recursion depth by increasing the prologue size or the complexity of the function body for the other optimizers. ๐Ÿ™ˆ

when profile feedback is available (see -fprofile-generate), the actual recursion depth can be guessed from the probability that the function recurses via a given call expression. this parameter limits inlining to only those call expressions whose probability exceeds the given threshold (in percents).

  • early-inlining-insns โ€” specify the growth the early inliner is allowed to make. in effect it increases the amount of inlining for code that has a large abstraction penalty.
  • max-early-inliner-iterations โ€” the limit on iterations of the early inliner. this basically bounds the number of nested indirect calls the early inliner can resolve. deeper chains are still handled by late inlining.
  • comdat-sharing-probability โ€” the probability (in percent) that a C++ inline function with comdat visibility is shared across multiple compilation units.
  • modref-max-bases, modref-max-refs, modref-max-accesses โ€” specifies the maximal number of base pointers, references and accesses stored for a single function by mod/ref analysis.
  • modref-max-tests โ€” specifies the maxmal number of tests the alias oracle can perform to disambiguate memory locations using the mod/ref information. this parameter ought to be bigger than --param modref-max-bases and --param modref-max-refs.
  • modref-max-depth โ€” specifies the maximum depth of the DFS walk used by modref escape analysis. setting it to 0 disables the analysis completely. ๐Ÿ’€
  • modref-max-escape-points โ€” specifies the maximum number of escape points tracked by modref per SSA-name.
  • modref-max-adjustments โ€” specifies the maximum number the access range is enlarged during modref dataflow analysis.
  • profile-func-internal-id โ€” a parameter to control whether to use the function internal id in profile database lookup. if the value is 0, the compiler uses an id that's based on function assembler name and filename, which makes old profile data more tolerant to source changes such as function reordering etc.
  • min-vect-loop-bound โ€” the minimum number of iterations under which loops are not vectorized when -ftree-vectorize is used. the number of iterations after vectorization needs to be greater than the value specified by this option to allow vectorization.
  • gcse-cost-distance-ratio โ€” scaling factor in the calculation of the maximum distance an expression can be moved by GCSE optimizations. this is currently supported only in the code hoisting pass. the bigger the ratio, the more aggressive code hoisting is with simple expressions, i.e. the expressions that have cost less than gcse-unrestricted-cost. specifying 0 disables hoisting of simple expressions.
  • gcse-unrestricted-cost โ€” cost, roughly measured as the cost of a single typical machine instruction, at which GCSE optimizations do not constrain the distance an expression can travel. this is currently supported only in the code hoisting pass. the lesser the cost, the more aggressive code hoisting is. specifying 0 allows all expressions to travel unrestricted distances. โœจ
  • max-hoist-depth โ€” the depth of search in the dominator tree for expressions to hoist. this is used to avoid quadratic behavior in the hoisting algorithm. the value 0 doesn't limit the search, but may slow down compilation of huge functions.
  • max-tail-merge-comparisons โ€” the maximum amount of similar bbs to compare a bb with. this is used to avoid quadratic behavior in tree tail merging.
  • max-tail-merge-iterations โ€” the maximum amount of iterations of the pass over the function. this is used to limit compilation time in tree tail merging.
  • store-merging-allow-unaligned โ€” allow the store merging pass to introduce unaligned stores if it's legal to do so.
  • max-stores-to-merge โ€” the maximum number of stores to attempt to merge into wider stores in the store merging pass.
  • max-store-chains-to-track โ€” the maximum number of store chains to track at the same time in the attempt to merge them into wider stores in the store merging pass.
  • max-stores-to-track โ€” the maximum number of stores to track at the same time in the attemt to to merge them into wider stores in the store merging pass.
  • max-unrolled-insns โ€” the maximum number of instructions a loop may have to be unrolled. if a loop is unrolled, this parameter also determines how many times the loop code is unrolled.
  • max-average-unrolled-insns โ€” the maximum number of instructions, biased by the probabilities of their execution, that a loop may have to be unrolled. if a loop is unrolled, this parameter also determines how many times the loop code is unrolled.
  • max-unroll-times โ€” the maximum number of unrollings of a single loop.
  • max-peeled-insns โ€” the maximum number of instructions a loop may have to be peeled. if a loop is peeled, this parameter also determines how many times the loop code is peeled.
  • max-peel-times โ€” the maximum number of peelings of a single loop.
  • max-peel-branches โ€” the maximum number of branches on the hot path through the peeled sequence.
  • max-completely-peeled-insns โ€” the maximum number of insns of a completely peeled loop.
  • max-completely-peel-times โ€” the maximum number of iterations of a loop to be suitable for complete peeling.
  • max-completely-peel-loop-nest-depth โ€” the maximum depth of a loop nest suitable for complete peeling.
  • max-unswitch-insns โ€” the maximum number of insns of an unswitched loop.
  • max-unswitch-depth โ€” the maximum depth of a loop nest to be unswitched. ๐Ÿฆ‹

lim-expensive

The minimum cost of an expensive expression in the loop invariant motion. ๐Ÿ’ธ


min-loop-cond-split-prob

When FDO profile information is available, min-loop-cond-split-prob specifies minimum threshold for probability of semi-invariant condition statement to trigger loop split.


iv-consider-all-candidates-bound

Bound on number of candidates for induction variables, below which all candidates are considered for each use in induction variable optimizations. If there are more candidates than this, only the most relevant ones are considered to avoid quadratic time complexity. ๐ŸŒ€


iv-max-considered-uses

The induction variable optimizations give up on loops that contain more induction variable uses.


iv-always-prune-cand-set-bound

If the number of candidates in the set is smaller than this value, always try to remove unnecessary ivs from the set when adding a new one.


avg-loop-niter

Average number of iterations of a loop.


dse-max-object-size

Maximum size (in bytes) of objects tracked bytewise by dead store elimination. Larger values may result in larger compilation times.


dse-max-alias-queries-per-store

Maximum number of queries into the alias oracle per store. Larger values result in larger compilation times and may result in more removed dead stores. ๐Ÿ—‘๏ธ


scev-max-expr-size

Bound on size of expressions used in the scalar evolutions analyzer. Large expressions slow the analyzer. ๐ŸŒ


scev-max-expr-complexity

Bound on the complexity of the expressions in the scalar evolutions analyzer. Complex expressions slow the analyzer.


max-tree-if-conversion-phi-args

Maximum number of arguments in a PHI supported by TREE if conversion unless the loop is marked with simd pragma.


vect-max-layout-candidates

The maximum number of possible vector layouts (such as permutations) to consider when optimizing to-be-vectorized code.


vect-max-version-for-alignment-checks

The maximum number of run-time checks that can be performed when doing loop versioning for alignment in the vectorizer.


vect-max-version-for-alias-checks

The maximum number of run-time checks that can be performed when doing loop versioning for alias in the vectorizer.


vect-max-peeling-for-alignment

The maximum number of loop peels to enhance access alignment for vectorizer. Value -1 means no limit.


max-iterations-to-track

The maximum number of iterations of a loop the brute-force algorithm for analysis of the number of iterations of the loop tries to evaluate.


hot-bb-count-fraction

The denominator n of fraction 1/n of the maximal execution count of a basic block in the entire program that a basic block needs to at least have in order to be considered hot. The default is 10000, which means that a basic block is considered hot if its execution count is greater than 1/10000 of the maximal execution count. 0 means that it is never considered hot. Used in non-LTO mode. ๐Ÿ”ฅ


hot-bb-count-ws-permille

The number of most executed permilles, ranging from 0 to 1000, of the profiled execution of the entire program to which the execution count of a basic block must be part of in order to be considered hot. The default is 990, which means that a basic block is considered hot if its execution count contributes to the upper 990 permilles, or 99.0%, of the profiled execution of the entire program. 0 means that it is never considered hot. Used in LTO mode.


hot-bb-frequency-fraction

The denominator n of fraction 1/n of the execution frequency of the entry block of a function that a basic block of this function needs to at least have in order to be considered hot. The default is 1000, which means that a basic block is considered hot in a function if it is executed more frequently than 1/1000 of the frequency of the entry block of the function. 0 means that it is never considered hot.


unlikely-bb-count-fraction

The denominator n of fraction 1/n of the number of profiled runs of the entire program below which the execution count of a basic block must be in order for the basic block to be considered unlikely executed. The default is 20, which means that a basic block is considered unlikely executed if it is executed in fewer than 1/20, or 5%, of the runs of the program. 0 means that it is always considered unlikely executed. ๐Ÿ˜ฌ


max-predicted-iterations

The maximum number of loop iterations we predict statically. This is useful in cases where a function contains a single loop with known bound and another loop with unknown bound. The known number of iterations is predicted correctly, while the unknown number of iterations average to roughly 10. This means that the loop without bounds appears artificially cold relative to the other one. ๐Ÿฅถ


builtin-expect-probability

Control the probability of the expression having the specified value. This parameter takes a percentage (i.e. 0 ... 100) as input.


builtin-string-cmp-inline-length

The maximum length of a constant string for a builtin string cmp call eligible for inlining.


align-threshold

Select fraction of the maximal frequency of executions of a basic block in a function to align the basic block.


align-loop-iterations

A loop expected to iterate at least the selected number of iterations is aligned.


tracer-dynamic-coverage, tracer-dynamic-coverage-feedback

This value is used to limit superblock formation once the given percentage of executed instructions is covered. This limits unnecessary code size expansion.

The tracer-dynamic-coverage-feedback parameter is used only when profile feedback is available. The real profiles (as opposed to statically estimated ones) are much less balanced allowing the threshold to be larger value. ๐ŸŽข


tracer-max-code-growth

Stop tail duplication once code growth has reached given percentage. This is a rather artificial limit, as most of the duplicates are eliminated later in cross jumping, so it may be set to much higher values than is the desired code growth.


tracer-min-branch-ratio

Stop reverse growth when the reverse probability of best edge is less than this threshold (in percent).


tracer-min-branch-probability, tracer-min-branch-probability-feedback

Stop forward growth if the best edge has probability lower than this threshold.

Similarly to tracer-dynamic-coverage two parameters are provided. tracer-min-branch-probability-feedback is used for compilation with profile feedback and tracer-min-branch-probability compilation without. The value for compilation with profile feedback needs to be more conservative (higher) in order to make tracer effective.


stack-clash-protection-guard-size

Specify the size of the operating system provided stack guard as 2 raised to num bytes. Higher values may reduce the number of explicit probes, but a value larger than the operating system provided guard will leave code vulnerable to stack clash style attacks. ๐Ÿ›ก๏ธ

Bestie, that last bit is the important bit. Bigger than the OS guard = vulnerable. Do not do it.

stack-clash-protection-probe-interval

Stack clash protection involves probing stack space as it is allocated. This param controls the maximum distance between probes into the stack as 2 raised to num bytes. Higher values may reduce the number of explicit probes, but a value larger than the operating system provided guard will leave code vulnerable to stack clash style attacks. ๐Ÿ’€


max-cse-path-length

The maximum number of basic blocks on path that CSE considers.


max-cse-insns

The maximum number of instructions CSE processes before flushing.


ggc-min-expand

GCC uses a garbage collector to manage its own memory allocation. This parameter specifies the minimum percentage by which the garbage collector's heap should be allowed to expand between collections. Tuning this may improve compilation speed; it has no effect on code generation. ๐Ÿšฎ

The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when RAM >= 1GB. If getrlimit is available, the notion of "RAM" is the smallest of actual RAM and RLIMIT_DATA or RLIMIT_AS. If GCC is not able to calculate RAM on a particular platform, the lower bound of 30% is used. Setting this parameter and ggc-min-heapsize to zero causes a full collection to occur at every opportunity. This is extremely slow, but can be useful for debugging. ๐Ÿข


ggc-min-heapsize

Minimum size of the garbage collector's heap before it begins bothering to collect garbage. The first collection occurs after the heap expands by ggc-min-expand% beyond ggc-min-heapsize. Again, tuning this may improve compilation speed, and has no effect on code generation.

The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but with a lower bound of 4096 (four megabytes) and an upper bound of 131072 (128 megabytes). If GCC is not able to calculate RAM on a particular platform, the lower bound is used. Setting this parameter very large effectively disables garbage collection. Setting this parameter and ggc-min-expand to zero causes a full collection to occur at every opportunity. โœจ


max-reload-search-insns

The maximum number of instruction reload should look backward for equivalent register. Increasing values mean more aggressive optimization, making the compilation time increase with probably slightly better performance. โšก

  • max-cselib-memory-locations โ€” the max number of memory locations cselib is allowed to keep track of, bestie. Crank it up and the compiler gets more aggressive with optimizations, so compile time goes ๐Ÿ“ˆ but performance probably gets a lil better. Trade-offs, you know? ๐Ÿ’…
  • max-sched-ready-insns โ€” how many instructions that are ready to be issued the scheduler will actually consider at any one moment during the first scheduling pass. Bigger number = more thorough searching, which means longer compile time for probably barely any benefit. Not the glow-up you're hoping for. ๐Ÿ™ˆ
  • max-sched-region-blocks โ€” the max number of blocks in a region that get considered for interblock scheduling.
  • max-pipeline-region-blocks โ€” the max number of blocks in a region considered for pipelining in the selective scheduler.
  • max-sched-region-insns โ€” the max number of insns in a region that get considered for interblock scheduling.
  • max-pipeline-region-insns โ€” the max number of insns in a region considered for pipelining in the selective scheduler.
  • min-spec-prob โ€” the minimum probability (in percents) of reaching a source block for interblock speculative scheduling.
  • max-sched-extend-regions-iters โ€” the max number of iterations through CFG to extend regions. Set it to 0 and region extensions are fully disabled, periodt.
  • max-sched-insn-conflict-delay โ€” the max conflict delay for an insn to even be considered for speculative motion.
  • sched-spec-prob-cutoff โ€” the minimal probability of speculation success (in percents), so that speculative insns actually get scheduled.
  • sched-state-edge-prob-cutoff โ€” the minimum probability an edge has to have for the scheduler to save its state across it.
  • sched-mem-true-dep-cost โ€” the minimal distance (in CPU cycles) between a store and a load targeting the same memory locations.
  • selsched-max-lookahead โ€” the max size of the lookahead window of selective scheduling. It's basically the depth of search for available instructions. ๐Ÿ‘€
  • selsched-max-sched-times โ€” the max number of times an instruction gets scheduled during selective scheduling. This is the limit on how many iterations the instruction may be pipelined through.
  • selsched-insns-to-rename โ€” the max number of best instructions in the ready list that get considered for renaming in the selective scheduler.
  • sms-min-sc โ€” the minimum value of stage count that the swing modulo scheduler generates.
  • max-last-value-rtl โ€” the max size, measured as number of RTLs, that can be recorded in an expression in combiner for a pseudo register as the last known value of that register.
  • max-combine-insns โ€” the max number of instructions the RTL combiner tries to combine. That's it, that's the whole vibe. โœจ
  • integer-share-limit โ€” small integer constants can share a data structure, which cuts the compiler's memory usage and speeds it up ๐Ÿƒโ€โ™€๏ธ๐Ÿ’จ. This sets the maximum value of a shared integer constant.
  • ssp-buffer-size โ€” the minimum size of buffers (i.e. arrays) that receive stack smashing protection when -fstack-protector is used.
  • min-size-for-stack-sharing โ€” the minimum size of variables that take part in stack slot sharing when not optimizing.
  • max-jump-thread-duplication-stmts โ€” the maximum number of statements allowed in a block that needs to be duplicated when threading jumps.
  • max-jump-thread-paths โ€” the max number of paths to consider when hunting for jump threading opportunities. When arriving at a block, incoming edges only get considered if the number of paths to be searched so far multiplied by the number of incoming edges does not exhaust the specified maximum number of paths to consider. Math girlie behavior fr fr. ๐Ÿงฎ
  • max-fields-for-field-sensitive โ€” the maximum number of fields in a structure treated in a field sensitive manner during pointer analysis.
  • prefetch-latency โ€” an estimate of the average number of instructions executed before a prefetch finishes. The distance prefetched ahead is proportional to this constant. Bumping this number up may also lead to less streams being prefetched (peep simultaneous-prefetches).
  • simultaneous-prefetches โ€” the maximum number of prefetches that can run at the same time.
  • l1-cache-line-size โ€” the size of a cache line in the L1 data cache, in bytes.
  • l1-cache-size โ€” the size of the L1 data cache, in kilobytes.
  • l2-cache-size โ€” the size of the L2 data cache, in kilobytes.
  • prefetch-dynamic-strides โ€” whether the loop array prefetch pass should issue software prefetch hints for strides that are non-constant. In some cases this may be beneficial, though the fact that the stride is non-constant may make it hard to predict when there's a clear benefit to issuing these hints.

Set to 1 if the prefetch hints should be issued for non-constant strides. Set to 0 if prefetch hints should be issued only for strides that are known to be constant and below prefetch-minimum-stride.

  • prefetch-minimum-stride โ€” the minimum constant stride, in bytes, to start using prefetch hints for. If the stride is less than this threshold, prefetch hints will not be issued.

This setting is useful for processors that have hardware prefetchers, since there may be conflicts between the hardware prefetchers and the software prefetchers. If the hardware prefetchers have a maximum stride they can handle, that value should be used here to improve the use of software prefetchers.

A value of -1 means we don't have a threshold and therefore prefetch hints can be issued for any constant stride.

This setting is only useful for strides that are known and constant.

  • destructive-interference-size, constructive-interference-size โ€” these are the values for the C++17 variables std::hardware_destructive_interference_size and std::hardware_constructive_interference_size. The destructive interference size is the minimum recommended offset between two independent concurrently-accessed objects; the constructive interference size is the maximum recommended size of contiguous memory accessed together. Typically both will be the size of an L1 cache line for the target, in bytes. For a generic target covering a range of L1 cache line sizes, typically the constructive interference size will be the small end of the range and the destructive size will be the large end.

The destructive interference size is intended to be used for layout, and thus has ABI impact. ๐Ÿšจ The default value is not expected to be stable, and on some targets varies with -mtune, so using this variable in a context where ABI stability matters โ€” like the public interface of a library โ€” is strongly discouraged; if it is used in that context, users can stabilize the value using this option.

The constructive interference size is less sensitive, since it's typically only used in a static_assert to make sure a type fits within a cache line.

See also -Winterference-size.

  • loop-interchange-max-num-stmts โ€” the maximum number of stmts in a loop to be interchanged.
  • loop-interchange-stride-ratio โ€” the minimum ratio between the stride of two loops for interchange to be profitable.
  • min-insn-to-prefetch-ratio โ€” the minimum ratio between the number of instructions and the number of prefetches to enable prefetching in a loop.
  • prefetch-min-insn-to-mem-ratio โ€” the minimum ratio between the number of instructions and the number of memory references to enable prefetching in a loop.
  • use-canonical-types โ€” whether the compiler should use the "canonical" type system. This should always be 1, which uses a more efficient internal mechanism for comparing types in C++ and Objective-C++. But โ€” plot twist โ€” if bugs in the canonical type system are causing compilation failures, set this value to 0 to disable canonical types. ๐Ÿฉน
  • switch-conversion-max-branch-ratio โ€” switch initialization conversion refuses to create arrays that are bigger than switch-conversion-max-branch-ratio times the number of branches in the switch.
  • max-partial-antic-length โ€” the maximum length of the partial antic set computed during the tree partial redundancy elimination optimization (-ftree-pre) when optimizing at -O3 and above. For some sorts of source code the enhanced partial redundancy elimination optimization can run away, consuming all of the memory available on the host machine ๐Ÿ˜ญ. This parameter sets a limit on the length of the sets that are computed, which prevents that runaway behavior. Setting a value of 0 for this parameter allows an unlimited set length (so like, don't, unless you're feeling chaotic).
  • rpo-vn-max-loop-depth โ€” the maximum loop depth that is value-numbered optimistically. When the limit hits, the innermost rpo-vn-max-loop-depth loops and the outermost loop in the loop nest are value-numbered optimistically and the remaining ones not.
  • sccvn-max-alias-queries-per-access โ€” the maximum number of alias-oracle queries we perform when looking for redundancies for loads and stores. If this limit is hit the search is aborted and the load or store is not considered redundant. The number of queries is algorithmically limited to the number of stores on all paths from the load to the function entry.
  • ira-max-loops-num โ€” IRA uses regional register allocation by default. If a function contains more loops than the number given by this parameter, only at most the given number of the most frequently-executed loops form regions for regional register allocation. ๐Ÿ‘‘
  • ira-max-conflict-table-size โ€” okay so IRA has this whole sophisticated algorithm for squishing the conflict table down, but bestie, for truly huge functions that table can STILL eat absurd amounts of memory ๐Ÿ˜ญ. So if a function's conflict table could be bigger than the size in MB you give this parameter, the register allocator just nopes out and switches to a faster, simpler, lower-quality algorithm that doesn't need to build a pseudo-register conflict table at all. Tradeoff queen ๐Ÿ’…
  • ira-loop-reserved-regs โ€” IRA can be used to get a more accurate read on register pressure in loops, which feeds into decisions about moving loop invariants (peep -O3). This parameter says how many available registers get reserved for other purposes. Default is the best value found from numerous experiments โ€” scientists were sciencing ๐Ÿงช
  • ira-consider-dup-in-all-alts โ€” Makes IRA care heavily about matching constraints (that's a duplicated operand number, iykyk) across all available alternatives for a preferred register class. Set it to zero and IRA only respects the matching constraint when it shows up in the only available alternative with an appropriate register class. Otherwise, IRA checks all available alternatives for the preferred register class even if it already found a choice with an appropriate register class, and respects the qualified matching constraint it found. Obsessed with thoroughness fr ๐Ÿ’–
  • ira-simple-lra-insn-threshold โ€” Approximates the function's insn count in 1K units that triggers simple local RA.
  • lra-inheritance-ebb-probability-cutoff โ€” LRA tries to reuse values it already reloaded into registers in subsequent insns, and this little glow-up is called inheritance โœจ. EBB is the region where it does this. This parameter sets the minimal fall-through edge probability, in percentage, needed to add a BB to the inheritance EBB in LRA. The default was picked from numerous runs of SPEC2000 on x86-64, no cap.
  • loop-invariant-max-bbs-in-loop โ€” Loop invariant motion can get very expensive โ€” both in compile time and in compile-time memory โ€” when loops are huge. Any loop with more basic blocks than this parameter simply won't get loop invariant motion optimization done on it. Sorry bestie, too big ๐Ÿซถ
  • loop-max-datarefs-for-datadeps โ€” Building data dependencies is expensive for very large loops, so this parameter caps how many data references inside loops get considered for data dependence analysis. Those large loops just don't get handled by the optimizations that use loop data dependencies.
  • max-vartrack-size โ€” Sets the maximum number of hash table slots to use during variable tracking dataflow analysis of any function. If you blow past this limit with variable tracking at assignments enabled, the analysis for that function gets retried without it, after all debug insns are removed from the function. And if you blow past it even without debug insns? Var tracking analysis is completely disabled for that function ๐Ÿ’€. Setting this parameter to zero makes it unlimited.
  • max-vartrack-expr-depth โ€” Sets the maximum number of recursion levels when trying to map variable names or debug temporaries to value expressions. It's literally trading compilation time for more complete debug info. Set it too low and value expressions that ARE available and could be represented in debug info might just end up unused ๐Ÿ˜ญ; set it higher and the compiler may find more complex debug expressions, but compile time and memory use may grow.
  • max-debug-marker-count โ€” Sets a threshold on the number of debug markers (e.g. begin stmt markers) to avoid a complexity explosion at inlining or when expanding to RTL. If a function has more of these gimple stmts than the limit you set, those stmts get dropped from the inlined copy of a function, and from its RTL expansion.
  • min-nondebug-insn-uid โ€” Uses uids starting at this parameter for nondebug insns. The range below the parameter is reserved exclusively for debug insns created by -fvar-tracking-assignments, but debug insns may still get (non-overlapping) uids above it if that reserved range gets exhausted ๐Ÿ‘‘
  • ipa-sra-deref-prob-threshold โ€” IPA-SRA only replaces a pointer known not to be NULL with one or more new parameters when the probability (in percent, relative to function entry) of it being dereferenced is higher than this parameter.
  • ipa-sra-ptr-growth-factor โ€” IPA-SRA only replaces a pointer to an aggregate with one or more new parameters when their cumulative size is less than or equal to ipa-sra-ptr-growth-factor times the size of the original pointer parameter.
  • ipa-sra-ptrwrap-growth-factor โ€” The additional maximum allowed growth of the total size of new parameters that ipa-sra replaces a pointer to an aggregate with, if it points to a local variable that the caller only writes to and passes as an argument to other functions.
  • ipa-sra-max-replacements โ€” The maximum pieces of an aggregate that IPA-SRA tracks. As a consequence, it's also the maximum number of replacements of a formal parameter.
  • sra-max-scalarization-size-Ospeed, sra-max-scalarization-size-Osize โ€” The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to replace scalar parts of aggregates with uses of independent scalar variables. These parameters control the maximum size, in storage units, of an aggregate considered for replacement when compiling for speed (sra-max-scalarization-size-Ospeed) or for size (sra-max-scalarization-size-Osize), respectively. Two moods, two numbers ๐Ÿ’…
  • sra-max-propagations โ€” The maximum number of artificial accesses that Scalar Replacement of Aggregates (SRA) will track, per one local variable, to facilitate copy propagation.
  • tm-max-aggregate-size โ€” When making copies of thread-local variables in a transaction, this parameter specifies the size in bytes after which variables get saved with the logging functions as opposed to save/restore code sequence pairs. This option only applies when using -fgnu-tm.
  • graphite-max-nb-scop-params โ€” To avoid exponential effects in the Graphite loop transforms, the number of parameters in a Static Control Part (SCoP) is bounded. A value of zero lifts that bound entirely ๐Ÿฆ‹. A variable whose value is unknown at compilation time and defined outside a SCoP is a parameter of the SCoP.
  • hardcfr-max-blocks โ€” Disables -fharden-control-flow-redundancy for functions with a larger number of blocks than the value you specify. Zero removes any limit.
  • hardcfr-max-inline-blocks โ€” Forces -fharden-control-flow-redundancy to use out-of-line checking for functions with a larger number of basic blocks than the value you specify.
  • loop-block-tile-size โ€” Loop blocking or strip mining transforms, enabled with -floop-block or -floop-strip-mine, strip mine each loop in the loop nest by a given number of iterations. The strip length can be changed using the loop-block-tile-size parameter.
  • ipa-jump-function-lookups โ€” Specifies the number of statements visited during jump function offset discovery.
  • ipa-cp-value-list-size โ€” IPA-CP tries to track all possible values and types passed to a function's parameter so it can propagate them and do devirtualization. ipa-cp-value-list-size is the maximum number of values and types it stores per one formal parameter of a function.
  • ipa-cp-eval-threshold โ€” IPA-CP calculates its own score of cloning profitability heuristics and performs those cloning opportunities whose scores exceed ipa-cp-eval-threshold.
  • ipa-cp-max-recursive-depth โ€” Maximum depth of recursive cloning for a self-recursive function.
  • ipa-cp-min-recursive-probability โ€” Recursive cloning happens only when the probability of the call being executed exceeds the parameter.
  • ipa-cp-profile-count-base โ€” When using the -fprofile-use option, IPA-CP will consider the measured execution count of a call graph edge at this percentage position in their histogram as the basis for its heuristics calculation.
  • ipa-cp-recursive-freq-factor โ€” The number of times interprocedural copy propagation expects recursive functions to call themselves.
  • ipa-cp-recursion-penalty โ€” The percentage penalty recursive functions receive when they're evaluated for cloning.
  • ipa-cp-single-call-penalty โ€” The percentage penalty that functions containing a single call to another function receive when they're evaluated for cloning.
  • ipa-max-agg-items โ€” IPA-CP is also capable of propagating a number of scalar values passed in an aggregate. ipa-max-agg-items controls the maximum number of such values per one parameter.
  • ipa-cp-loop-hint-bonus โ€” When IPA-CP determines that a cloning candidate would make the number of iterations of a loop known, it adds a bonus of ipa-cp-loop-hint-bonus to the profitability score of that candidate. Main character bonus energy fr ๐Ÿ”ฅ
  • ipa-max-loop-predicates โ€” The maximum number of different predicates IPA will use to describe when loops in a function have known properties.
  • ipa-max-aa-steps โ€” During its analysis of function bodies, IPA-CP employs alias analysis to track values pointed to by function parameters. So it doesn't spend forever analyzing huge functions, it gives up and considers all memory clobbered after examining ipa-max-aa-steps statements that modify memory. Respect the timeout bestie โณ
  • ipa-max-switch-predicate-bounds โ€” The maximal number of boundary endpoints of case ranges of a switch statement. For a switch that exceeds this limit, IPA-CP will not construct a cloning cost predicate โ€” which is what's used to estimate cloning benefit โ€” for the default case of the switch statement.

okay bestie we're still deep in the --param vault, so let's keep scrolling ๐Ÿ’…โœจ

  • ipa-max-param-expr-ops โ€” so IPA-CP will look at a conditional statement that references some function parameter to estimate the benefit of cloning it for a certain constant value. BUT if the number of operations in a parameter expression goes over ipa-max-param-expr-ops, that expression gets labeled as a complicated one and IPA analysis just... won't touch it. ๐Ÿ™ˆ
  • lto-partitions โ€” sets the number of partitions you want produced during WHOPR compilation. Important vibe check: that number should be bigger than the number of CPUs you're compiling with.
  • lto-min-partition โ€” the size of the minimal partition for WHOPR, measured in estimated instructions. It exists so tiny little programs don't get shredded into a zillion partitions and waste everyone's time. ๐Ÿ’€
  • lto-max-partition โ€” size of the max partition for WHOPR (again, in estimated instructions), giving an upper bound on how big any single partition can get. Meant to be used only with balanced partitioning, bestie. ๐ŸŽ€
  • lto-max-streaming-parallelism โ€” the max number of parallel processes used for LTO streaming. that's it, that's the whole thing. ๐Ÿ‘‘
  • cxx-max-namespaces-for-diagnostic-help โ€” the max number of namespaces GCC will consult for suggestions when C++ name lookup fails for an identifier. it's giving helpful friend energy ๐Ÿซถ
  • sink-frequency-threshold โ€” the maximum relative execution frequency (in percents) of the target block compared to a statement's original block, which is what allows a statement to be sunk. Bigger numbers = more aggressive sinking. And a small positive adjustment gets applied for statements with memory operands, because those are even more profitable to sink. ๐Ÿ’…
  • max-stores-to-sink โ€” the maximum number of conditional store pairs that can be sunk. Set it to 0 if either vectorization (-ftree-vectorize) or if-conversion (-ftree-loop-if-convert) is disabled.
  • case-values-threshold โ€” the smallest number of different values for which a jump-table beats a tree of conditional branches. If the value is 0, GCC uses the default for the machine. โœจ
  • jump-table-max-growth-ratio-for-size โ€” the max code size growth ratio (in percent) when expanding into a jump table. This one is used when you're optimizing for size.
  • jump-table-max-growth-ratio-for-speed โ€” same deal, max code size growth ratio (in percent) when expanding into a jump table, except this parameter is the one used when optimizing for speed. ๐ŸŽ๏ธ
  • tree-reassoc-width โ€” sets the maximum number of instructions executed in parallel in a reassociated tree. If it has a non zero value, this parameter overrides the target dependent heuristics used by default.
  • sched-pressure-algorithm โ€” pick between the two available implementations of -fsched-pressure. Algorithm 1 is the original implementation and is the more likely one to stop instructions from being reordered. Algorithm 2 was designed as a compromise between the relatively conservative approach of algorithm 1 and the rather aggressive approach of the default scheduler. It leans way more heavily on having a regular register file and accurate register pressure classes. For more details, go peek at haifa-sched.cc in the GCC sources. ๐Ÿ‘€

The default choice depends on the target.

  • max-slsr-cand-scan โ€” the maximum number of existing candidates considered when seeking a basis for a new straight-line strength reduction candidate.
  • asan-globals โ€” turns on buffer overflow detection for global objects. This kind of protection is enabled by default if you're using the -fsanitize=address option. To turn global objects protection off, use --param asan-globals=0.
  • asan-stack โ€” turns on buffer overflow detection for stack objects. Enabled by default when using -fsanitize=address. To disable stack protection use the --param asan-stack=0 option.
  • asan-instrument-reads โ€” turns on buffer overflow detection for memory reads. Enabled by default when using -fsanitize=address. To disable memory reads protection, use --param asan-instrument-reads=0.
  • asan-instrument-writes โ€” turns on buffer overflow detection for memory writes. Enabled by default when using -fsanitize=address. To disable memory writes protection, use the --param asan-instrument-writes=0 option.
  • asan-memintrin โ€” turns on detection for built-in functions. Enabled by default when using -fsanitize=address. To disable built-in functions protection, use --param asan-memintrin=0.
  • asan-use-after-return โ€” turns on detection of use-after-return. Enabled by default when using the -fsanitize=address option. To disable it, use --param asan-use-after-return=0.
Heads up bestie: by default the check is disabled at run time. To enable it, add "detect_stack_use_after_return=1" to the environment variable ASAN_OPTIONS. ๐Ÿšจ
  • asan-instrumentation-with-call-threshold โ€” if the number of memory accesses in a function being instrumented is greater than or equal to this number, GCC uses callbacks instead of inline checks. E.g. to disable inline code, use --param asan-instrumentation-with-call-threshold=0.
  • asan-kernel-mem-intrinsic-prefix โ€” if nonzero, prefix calls to "memcpy", "memset" and "memmove" with __asan_ or __hwasan_ for -fsanitize=kernel-address or -fsanitize=kernel-hwaddress, respectively. ๐ŸŒˆ
  • hwasan-instrument-stack โ€” enables hwasan instrumentation of statically sized stack-allocated variables. This kind of instrumentation is enabled by default when using -fsanitize=hwaddress and disabled by default when using -fsanitize=kernel-hwaddress. To disable stack instrumentation, use --param hwasan-instrument-stack=0, and to enable it use --param hwasan-instrument-stack=1.
  • hwasan-random-frame-tag โ€” when using stack instrumentation, decides tags for stack variables with a deterministic sequence that begins at a random tag for each frame. With this parameter unset, tags get chosen using that same sequence but starting from 1. It's enabled by default for -fsanitize=hwaddress and unavailable for -fsanitize=kernel-hwaddress. To disable it, use --param hwasan-random-frame-tag=0. ๐ŸŽฒ
  • hwasan-instrument-allocas โ€” enables hwasan instrumentation of dynamically sized stack-allocated variables. Enabled by default when using -fsanitize=hwaddress and disabled by default when using -fsanitize=kernel-hwaddress. To disable instrumentation of such variables, use --param hwasan-instrument-allocas=0, and to enable it use --param hwasan-instrument-allocas=1.
  • hwasan-instrument-reads โ€” enables hwasan checks on memory reads. Instrumentation of reads is enabled by default for both -fsanitize=hwaddress and -fsanitize=kernel-hwaddress. To disable checking memory reads, use --param hwasan-instrument-reads=0.
  • hwasan-instrument-writes โ€” enables hwasan checks on memory writes. Instrumentation of writes is enabled by default for both -fsanitize=hwaddress and -fsanitize=kernel-hwaddress. To disable checking memory writes, use --param hwasan-instrument-writes=0.
  • hwasan-instrument-mem-intrinsics โ€” enables hwasan instrumentation of builtin functions. Instrumentation of these builtin functions is enabled by default for both -fsanitize=hwaddress and -fsanitize=kernel-hwaddress. To disable instrumentation of builtin functions, use --param hwasan-instrument-mem-intrinsics=0.
  • use-after-scope-direct-emission-threshold โ€” if the size of a local variable in bytes is smaller than or equal to this number, GCC directly poisons (or unpoisons) shadow memory instead of using run-time callbacks. ๐Ÿ’œ
  • tsan-distinguish-volatile โ€” emit special instrumentation for accesses to volatiles.
  • tsan-instrument-func-entry-exit โ€” emit instrumentation calls to __tsan_func_entry() and __tsan_func_exit().
  • max-fsm-thread-path-insns โ€” the maximum number of instructions to copy when duplicating blocks on a finite state automaton jump thread path.
  • threader-debug โ€” threader-debug=[none|all] enables verbose dumping of the threader solver.
  • parloops-chunk-size โ€” the chunk size of the omp schedule for loops parallelized by parloops.
  • parloops-schedule โ€” the schedule type of the omp schedule for loops parallelized by parloops: static, dynamic, guided, auto, runtime.
  • parloops-min-per-thread โ€” the minimum number of iterations per thread of an innermost parallelized loop for which the parallelized variant is preferred over the single threaded one. Slight plot twist: for a parallelized loop nest, the minimum number of iterations of the outermost loop per thread is two. ๐ŸŒธ
  • max-ssa-name-query-depth โ€” the maximum depth of recursion when querying properties of SSA names in things like fold routines. One level of recursion = following one use-def chain link. ๐Ÿ”—
  • max-speculative-devirt-maydefs โ€” the maximum number of may-defs analyzed when looking for a must-def that specifies the dynamic type of an object which invokes a virtual call we might be able to devirtualize speculatively.
  • ranger-debug โ€” specifies the type of debug output to be issued for ranges.
  • unroll-jam-min-percent โ€” the minimum percentage of memory references that must be optimized away for the unroll-and-jam transformation to count as profitable.
  • unroll-jam-max-unroll โ€” the maximum number of times the outer loop should be unrolled by the unroll-and-jam transformation.
  • max-rtl-if-conversion-unpredictable-cost โ€” the maximum permissible cost for the sequence that would be generated by the RTL if-conversion pass for a branch that's considered unpredictable. โญ
  • max-variable-expansions-in-unroller โ€” so if -fvariable-expansion-in-unroller is switched on, this caps how many times a single variable is allowed to get expanded while loop unrolling is happening. ๐Ÿ’ซ
  • partial-inlining-entry-probability โ€” the maximum probability of the entry BB of a split region (in percent, relative to the entry BB of the function) that makes partial inlining go ahead. yes it's as specific as it sounds.
  • max-tracked-strlens โ€” the most strings the strlen optimization pass will bother tracking string lengths for.
  • gcse-after-reload-partial-fraction โ€” the threshold ratio for doing partial redundancy elimination after reload. โœจ
  • gcse-after-reload-critical-fraction โ€” the threshold ratio of critical edges execution count that permits redundancy elimination after reload.
  • max-loop-header-insns โ€” the max number of insns in a loop header that the copy loop headers pass is allowed to duplicate.
  • vect-epilogues-nomask โ€” turns on loop epilogue vectorization using a smaller vector size.
  • vect-partial-vector-usage โ€” controls when the loop vectorizer thinks about using partial vector loads and stores instead of just giving up and falling back to scalar code. here's the tea: ๐Ÿซ–
    • 0 stops the vectorizer from ever using partial vector loads and stores.
    • 1 allows partial vector loads and stores if vectorization removes the need for the code to iterate.
    • 2 allows partial vector loads and stores in all loops.

lowkey important: this parameter only does anything on targets that support partial vector loads and stores. no cap.

  • vect-inner-loop-cost-factor โ€” the maximum factor the loop vectorizer applies to the cost of statements in an inner loop, relative to the loop being vectorized. the factor it actually applies is the max of the estimated number of iterations of the inner loop and this parameter. default is 50. ๐ŸŒธ
  • vect-induction-float โ€” enables loop vectorization of floating point inductions.
  • vrp-sparse-threshold โ€” max number of basic blocks before VRP switches to using a sparse bitmap cache.
  • vrp-switch-limit โ€” max number of outgoing edges in a switch before VRP refuses to process it. periodt.
  • vrp-vector-threshold โ€” max number of basic blocks for VRP to use a basic cache vector.
  • avoid-fma-max-bits โ€” maximum number of bits for which we avoid creating FMAs.
  • fully-pipelined-fma โ€” whether the target fully pipelines FMA instructions. if it's non-zero, reassociation considers the benefit of parallelizing the FMA's multiplication part and its addition part, assuming FMUL and FMA use the same units that can also do FADD.
  • sms-loop-average-count-threshold โ€” a threshold on the average loop count that the swing modulo scheduler considers.
  • sms-dfa-history โ€” the number of cycles the swing modulo scheduler looks at when checking conflicts using DFA.
  • graphite-allow-codegen-errors โ€” whether codegen errors should be ICEs when -fchecking is on. ๐Ÿ˜ญ
  • sms-max-ii-factor โ€” a factor for tuning the upper bound that the swing modulo scheduler uses when scheduling a loop.
  • lra-max-considered-reload-pseudos โ€” the max number of reload pseudos considered while spilling a non-reload pseudo.
  • max-pow-sqrt-depth โ€” maximum depth of sqrt chains to use when synthesizing exponentiation by a real constant. โœจ
  • max-dse-active-local-stores โ€” maximum number of active local stores in RTL dead store elimination.
  • asan-instrument-allocas โ€” enables asan allocas/VLAs protection.
  • max-iterations-computation-cost โ€” a bound on the cost of an expression used to compute the number of iterations.
  • max-isl-operations โ€” maximum number of isl operations; 0 means unlimited.
  • graphite-max-arrays-per-scop โ€” maximum number of arrays per scop.
  • max-vartrack-reverse-op-size โ€” max size of loc list for which reverse ops should be added.
  • fsm-scale-path-stmts โ€” scale factor to apply to the number of statements in a threading path crossing a loop backedge, when comparing against --param=max-jump-thread-duplication-stmts.
  • uninit-control-dep-attempts โ€” maximum number of nested calls to search for control dependencies during uninitialized variable analysis.
  • uninit-max-chain-len โ€” maximum number of predicates anded for each predicate ored in the normalized predicate chain.
  • uninit-max-num-chains โ€” maximum number of predicates ored in the normalized predicate chain.
  • sched-autopref-queue-depth โ€” hardware autoprefetcher scheduler model control flag. it's the number of lookahead cycles the model looks into; at ' ' only enable instruction sorting heuristic. (yes, that's literally a space in there, we don't make the rules ๐Ÿ’…)
  • loop-versioning-max-inner-insns โ€” the maximum number of instructions an inner loop can have before the loop versioning pass decides it's too big to copy.
  • loop-versioning-max-outer-insns โ€” the maximum number of instructions an outer loop can have before the loop versioning pass decides it's too big to copy โ€” and it discounts any instructions in inner loops that directly benefit from versioning.
  • ssa-name-def-chain-limit โ€” the maximum number of SSA_NAME assignments to follow when determining a property of a variable, like its value. this limits the number of iterations or recursive calls GCC performs when optimizing certain statements, or when determining their validity before issuing diagnostics.
  • store-merging-max-size โ€” maximum size of a single store merging region, in bytes.
  • hash-table-verification-limit โ€” the number of elements for which hash table verification is done, for each searched element.
  • max-find-base-term-values โ€” maximum number of VALUEs handled during a single find_base_term call.
  • analyzer-max-enodes-per-program-point โ€” the maximum number of exploded nodes per program point inside the analyzer, before it terminates analysis of that point. ๐Ÿ’€
  • analyzer-max-constraints โ€” the maximum number of constraints per state.
  • analyzer-min-snodes-for-call-summary โ€” the minimum number of supernodes within a function for the analyzer to consider summarizing its effects at call sites.
  • analyzer-max-enodes-for-full-dump โ€” the maximum depth of exploded nodes that should show up in a dot dump before it switches to a less verbose format.
  • analyzer-max-recursion-depth โ€” the maximum number of times a callsite can appear in a call stack within the analyzer, before it terminates analysis of a call that would recurse deeper.
  • analyzer-max-svalue-depth โ€” the maximum depth of a symbolic value, before it approximates the value as unknown.
  • analyzer-max-infeasible-edges โ€” the maximum number of infeasible edges to reject before declaring a diagnostic as infeasible.
  • gimple-fe-computed-hot-bb-threshold โ€” the number of executions of a basic block that gets considered hot. this parameter is used only in GIMPLE FE.
  • analyzer-bb-explosion-factor โ€” the maximum number of 'after supernode' exploded nodes within the analyzer per supernode, before it terminates analysis.
  • analyzer-text-art-string-ellipsis-threshold โ€” the number of bytes at which to ellipsize string literals in analyzer text art diagrams. ๐ŸŽ€
  • analyzer-text-art-ideal-canvas-width โ€” the ideal width in characters of text art diagrams generated by the analyzer.
  • analyzer-text-art-string-ellipsis-head-len โ€” the number of literal bytes to show at the head of a string literal in text art when ellipsizing it.
  • analyzer-text-art-string-ellipsis-tail-len โ€” the number of literal bytes to show at the tail of a string literal in text art when ellipsizing it.
  • ranger-logical-depth โ€” maximum depth of logical expression evaluation the ranger will look through when evaluating outgoing edge ranges.
  • ranger-recompute-depth โ€” maximum depth of instruction chains to consider for recomputation in the outgoing range calculator.
  • relation-block-limit โ€” maximum number of relations the oracle will register in a basic block.
  • min-pagesize โ€” minimum page size for warning purposes.
  • openacc-kernels โ€” specify the mode of OpenACC kernels constructs handling. with --param=openacc-kernels=decompose, OpenACC kernels constructs get decomposed into parts โ€” a sequence of compute constructs, each then handled individually. heads up bestie, this is work in progress ๐Ÿšง. with --param=openacc-kernels=parloops, OpenACC kernels constructs are handled by the parloops pass, en bloc. this is the current default.
  • openacc-privatization โ€” controls whether the -fopt-info-omp-note and applicable -fdump-tree-*-details options emit OpenACC privatization diagnostics. with --param=openacc-privatization=quiet, don't diagnose โ€” and this is the current default. with --param=openacc-privatization=noisy, do diagnose.

The following choices of name are available on AArch64 targets: ๐Ÿ‘‘

  • aarch64-vect-compare-costs โ€” when vectorizing, consider using multiple different approaches and let the cost model pick the cheapest one. this includes:
    • Trying both SVE and Advanced SIMD, when SVE is available.
    • Trying to use 64-bit Advanced SIMD vectors for the smallest data elements, rather than using 128-bit vectors for everything.
    • Trying to use "unpacked" SVE vectors for smaller elements. this includes storing smaller elements in larger containers and accessing elements with extending loads and truncating stores.
  • aarch64-float-recp-precision โ€” the number of Newton iterations for calculating the reciprocal for float type. the precision of division is proportional to this param when division approximation is enabled. the default value is 1. ๐Ÿฆ‹
  • aarch64-double-recp-precision โ€” how many Newton iterations we do when calculating the reciprocal for double type. When division approximation is turned on, the precision of division is proportional to this param. Default is 2. ๐Ÿ’…
  • aarch64-autovec-preference โ€” forces an ISA selection strategy for auto-vectorization, bestie. Takes values 0 through 4, inclusive:
    • 0 โ€” use the default heuristics ๐Ÿงš
    • 1 โ€” use only Advanced SIMD for auto-vectorization
    • 2 โ€” use only SVE for auto-vectorization
    • 3 โ€” use both Advanced SIMD and SVE. Prefer Advanced SIMD when the costs are deemed equal
    • 4 โ€” use both Advanced SIMD and SVE. Prefer SVE when the costs are deemed equal

The default value is 0. โœจ

  • aarch64-ldp-policy โ€” fine-grained policy for load pairs, like the little details matter (they do ๐Ÿ’–). With --param=aarch64-ldp-policy=default, use the policy of the tuning structure โ€” this is the current default. With --param=aarch64-ldp-policy=always, emit ldp regardless of alignment. With --param=aarch64-ldp-policy=never, do not emit ldp. With --param=aarch64-ldp-policy=aligned, emit ldp only if the source pointer is aligned to at least double the alignment of the type.
  • aarch64-stp-policy โ€” fine-grained policy for store pairs. With --param=aarch64-stp-policy=default, use the policy of the tuning structure โ€” current default, slay. With --param=aarch64-stp-policy=always, emit stp regardless of alignment. With --param=aarch64-stp-policy=never, do not emit stp. With --param=aarch64-stp-policy=aligned, emit stp only if the source pointer is aligned to at least double the alignment of the type.
  • aarch64-ldp-alias-check-limit โ€” the limit on how many alias checks the AArch64 load/store pair fusion pass performs when it's trying to form an ldp/stp. Higher values make the pass more aggressive at re-ordering loads over stores, but the tradeoff is increased compile time. ๐Ÿ‘‘
  • aarch64-ldp-writeback โ€” param controlling which writeback opportunities we try to handle in the AArch64 load/store pair fusion pass. A value of zero disables writeback handling. One means we try to form pairs involving one or more existing individual writeback accesses where possible. A value of two means we also try to opportunistically form writeback opportunities by folding in trailing destructive updates of the base register used by a pair. ๐ŸŒ€
  • aarch64-loop-vect-issue-rate-niters โ€” the tuning for some AArch64 CPUs tries to take both latencies and issue rates into account when deciding whether a loop should be vectorized using SVE, vectorized using Advanced SIMD, or not vectorized at all. If this parameter is set to n, GCC will not use this heuristic for loops that are known to execute in fewer than n Advanced SIMD iterations.
  • aarch64-vect-unroll-limit โ€” the vectorizer uses available tuning information to figure out whether it'd be beneficial to unroll the main vectorized loop, and by how much. This parameter sets the upper bound of how much the vectorizer will unroll the main loop. The default value is four. ๐ŸŽ€

The following choices of name are available on GCN targets:

  • gcn-preferred-vectorization-factor โ€” preferred vectorization factor: default, 32, 64.

The following choices of name are available on i386 and x86_64 targets:

  • x86-stlf-window-ninsns โ€” instructions number above which STFL stall penalty can be compensated.
  • x86-stv-max-visits โ€” the maximum number of use and def visits when discovering a STV chain before the discovery is aborted.

โœจ Program Instrumentation Options โœจ

GCC supports a bunch of command-line options that control adding run-time instrumentation to the code it normally generates. Like, one purpose of instrumentation is collecting profiling statistics for finding program hot spots, code coverage analysis, or profile-guided optimizations. Another whole class of program instrumentation is adding run-time checking to catch programming errors like invalid pointer dereferences or out-of-bounds array accesses, plus deliberately hostile attacks such as stack smashing or C++ vtable hijacking. ๐Ÿ˜ค And there's also a general hook you can use to implement other forms of tracing or function-level instrumentation for debug or program analysis purposes. It's giving swiss army knife, fr fr. ๐Ÿ”ฅ

  • -p
  • -pg โ€” generate extra code to write profile information suitable for the analysis program prof (for -p) or gprof (for -pg). You must use this option when compiling the source files you want data about, and you must also use it when linking. Bestie, don't forget the link step, I'm begging ๐Ÿ™ˆ

You can use the function attribute "no_instrument_function" to suppress profiling of individual functions when compiling with these options.

  • -fprofile-arcs โ€” add code so that program flow 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 auxname.gcda for each source file. The data may be used for profile-directed optimizations (-fbranch-probabilities), or for test coverage analysis (-ftest-coverage). Each object file's 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. foo.gcda for input file dir/foo.c, or dir/foo.gcda for output file specified as -o dir/foo.o).

Note that if a command line directly links source files, the corresponding .gcda files will be prefixed with the unsuffixed name of the output file. E.g. "gcc a.c b.c -o binary" would generate binary-a.gcda and binary-b.gcda files.
  • -fcondition-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 "gcov --conditions". โœจ
  • --coverage โ€” this option is used to compile and link code instrumented for coverage analysis. It's a synonym for -fprofile-arcs -ftest-coverage (when compiling) and -lgcov (when linking). See the documentation for those options for more details. ๐Ÿ‘‘
    1. Compile the source files with -fprofile-arcs plus optimization and code generation options. For test coverage analysis, use the additional -ftest-coverage option. You do not need to profile every source file in a program. ๐Ÿฆ‹
    2. Compile the source files additionally with -fprofile-abs-path to create absolute path names in the .gcno files. This allows gcov to find the correct sources in projects where compilations occur with different working directories.
    3. Link your object files with -lgcov or -fprofile-arcs (the latter implies the former).
    4. 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, "fork" calls are detected and correctly handled without double counting. ๐Ÿ˜ญ

Moreover, an object file can be recompiled multiple times and the corresponding .gcda file merges as long as the source file and the compiler options are unchanged.

  1. For profile-directed optimizations, compile the source files again with the same optimization and code generation options plus -fbranch-probabilities.
  2. For test coverage analysis, use gcov to produce human readable information from the .gcno and .gcda files. Refer to the gcov documentation for further information.

With -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 -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.

  • -ftest-coverage โ€” produce a notes file that the gcov code-coverage utility can use to show program coverage. Each source file's note file is called auxname.gcno. Refer to the -fprofile-arcs option above for a description of auxname and instructions on how to generate test coverage data. Coverage data matches the source files more closely if you do not optimize. ๐Ÿ’…
  • -fprofile-abs-path โ€” automatically convert relative source file names to absolute path names in the .gcno files. This allows gcov to find the correct sources in projects where compilations occur with different working directories. ๐ŸŒˆ
  • -fprofile-dir=path โ€” tells GCC which directory to go look in for the profile data files, bestie. It's the path. ๐Ÿ’– Heads up though: this one only touches the profile data that -fprofile-generate, -ftest-coverage and -fprofile-arcs make, and the data that -fprofile-use, -fbranch-probabilities and their little friend-options consume. Both absolute and relative paths are totally fine here. Default vibe? GCC just uses the current directory as path, so the profile data file ends up chillin' right next to the object file. And to stop file names from beefing with each other: if the object file name isn't an absolute path, GCC mangles the absolute path of the sourcename.gcda file and uses that as the name of the .gcda file. For the full tea on file naming, peep -fprofile-arcs. And there's a similar one, -fprofile-note ๐Ÿ‘€.

So when you run an executable in a massive parallel environment, it's recommended to save profiles to different folders. You can do that with these variables in path that get exported at run-time:

  • %p โ€” process ID. ๐Ÿ†”
  • %q{VAR} โ€” value of environment variable VAR.
  • -fprofile-generate
  • -fprofile-generate=path โ€” this turns on the options that are usually used for instrumenting an application so it produces profile info that's useful for later recompilation with profile-feedback-based optimization. โœจ Important: you gotta use -fprofile-generate both when compiling and when linking your program. Both. Fr fr.

These are the options it enables: -fprofile-arcs, -fprofile-values, -finline-functions, and -fipa-bit-cp.

If path is given, GCC looks at that path to find the profile feedback data files. See -fprofile-dir.

And to actually optimize your program based on all that collected profile info? Use -fprofile-use. ๐Ÿซถ

  • -fprofile-info-section
  • -fprofile-info-section=name โ€” registers the profile information in the section you name instead of using a constructor/destructor. The section name is name if you specify it; otherwise it defaults to ".gcov_info". For every translation unit, a pointer to the profile information generated by -fprofile-arcs gets placed in the specified section. Heads up: this option disables the profile information registration through a constructor, and it disables the profile information processing through a destructor.
This one is not meant for hosted environments like GNU/Linux. It's for freestanding environments (think embedded systems ๐Ÿงš) with limited resources that don't support constructors/destructors or the C library file I/O.

The linker could collect the input sections into one continuous memory block and define start and end symbols. Here's a GNU linker script example that defines a linker output section:

.gcov_info      :
{
  PROVIDE (__gcov_info_start = .);
  KEEP (*(.gcov_info))
  PROVIDE (__gcov_info_end = .);
}

And the program could dump the profiling information registered in this linker set, like, for example, like this:

#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;
}

The merge-stream subcommand of gcov-tool can be used to deserialize the data stream generated by the __gcov_filename_to_gcfn and __gcov_info_to_gcda functions, and merge the profile information into .gcda files on the host filesystem. ๐Ÿ’…

  • -fprofile-note=path โ€” if path is specified, GCC saves the .gcno file into that path location. But careful: if you combine this option with multiple source files, the .gcno file will get overwritten. ๐Ÿ˜ญ One file, one note, bestie.
  • -fprofile-prefix-path=path โ€” you can use this alongside profile-generate=profile_dir and profile-use=profile_dir to tell GCC where the base directory of the built source tree is. By default, profile_dir holds files with mangled absolute paths of all the object files in the built project. That's not it when the directory you used to build the instrumented binary is different from the directory you used to build the binary optimized with profile feedback โ€” because then the profile data won't be found during the optimized build. ๐Ÿ™ˆ In those setups, -fprofile-prefix-path=path with path pointing at the base directory of the build strips off the irrelevant part of the path and keeps all file names relative to the main build directory. Clean. โœจ
  • -fprofile-prefix-map=old=new โ€” when compiling files that live in directory old, record profiling information (with --coverage) describing them as if they lived in directory new instead. See also -ffile-prefix-map and -fcanon-prefix-map. ๐Ÿ‘‘
  • -fprofile-update=method โ€” changes the update method for an application instrumented for profile-feedback-based optimization. The method argument should be one of single, atomic or prefer-atomic. The first one is great for single-threaded applications; the second one prevents profile corruption by emitting thread-safe code. ๐Ÿงต
Warning: when an application doesn't properly join all threads (or creates a detached thread), a profile file can still get corrupted.

Using prefer-atomic gets transformed either into atomic (when the target supports it) or into single otherwise. The GCC driver automatically selects prefer-atomic when -pthread is on the command line; otherwise the default method is single.

If atomic is selected, the profile information is updated using atomic operations on a best-effort basis. Ideally, it's updated through atomic operations in hardware. But if the target platform doesn't support the required atomic operations in hardware, yet libatomic is available, then the profile info gets updated through calls to libatomic. And if the target platform supports neither the required atomic hardware ops nor libatomic? Then the profile information is not atomically updated and a warning is issued. In that case the profiling info you get 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. And if a signal interrupts those two operations updating a counter, the profiling information may end up in an inconsistent state. ๐Ÿ˜ฌ

  • -fprofile-filter-files=regex โ€” instruments only functions from files whose name matches any of the regular expressions (separated by semi-colons).

For example, -fprofile-filter-files=main\.c;module.*\.c will instrument only main.c and all C files starting with 'module'. ๐ŸŽฏ

  • -fprofile-exclude-files=regex โ€” instruments only functions from files whose name does not match any of the regular expressions (separated by semi-colons).

For example, -fprofile-exclude-files=/usr/.* will prevent instrumentation of all files located in the /usr/ folder. ๐Ÿšซ

  • -fprofile-reproducible=[multithreaded|parallel-runs|serial] โ€” controls the level of reproducibility of the profile gathered by -fprofile-generate. This makes it possible to rebuild a program with the same outcome, which is useful for, like, distribution packages. ๐Ÿ“ฆ

With -fprofile-reproducible=serial the profile gathered by -fprofile-generate is reproducible provided the trained program behaves the same at each invocation of the train run, it isn't multi-threaded, and profile data streaming is always done in the same order. Note that profile streaming happens at the end of a program run but also before the fork function is invoked.

Note that it's pretty common for execution counts of some part of programs to depend on, for example, the length of temporary file names or memory space randomization (which can affect hash-table collision rate). Such non-reproducible parts of programs may be annotated by the no_instrument_function function attribute. And gcov-dump with -l can be used to dump the gathered data and verify that it's indeed reproducible. ๐Ÿ”

With -fprofile-reproducible=parallel-runs the collected profile stays reproducible regardless of the order of streaming of the data into gcda files. This setting makes it possible to run multiple instances of the instrumented program in parallel (like with make -j). This reduces the quality of the gathered data, in particular of indirect call profiling. ๐ŸŒˆ

  • -fsanitize=address โ€” bestie, this is AddressSanitizer ๐Ÿ’– a fast little memory error detector. Memory access instructions get instrumented so it can catch out-of-bounds and use-after-free bugs. Turning this on also turns on -fsanitize-address-use-after-scope. Full deets at <https://github.com/google/sanitizers/wiki/AddressSanitizer>. The run-time behavior can be influenced using the ASAN_OPTIONS environment variable. Set it to "help=1" and the available options are shown at startup of the instrumented program. List of supported options lives at <https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags>. This option cannot be combined with -fsanitize=thread or -fsanitize=hwaddress. And heads up: the only targets -fsanitize=hwaddress is currently supported on are x86-64 (only with -mlam=u48 or -mlam=u57 options) and AArch64, in both cases only in ABIs with 64-bit pointers.

To get more accurate stack traces, it is possible to use options such as -O0, -O1, or -Og (which, for instance, prevent most function inlining), -fno-optimize-sibling-calls (which prevents optimizing sibling and tail recursive calls; this option is implicit for -O0, -O1, or -Og), or -fno-ipa-icf (which disables Identical Code Folding for functions). 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:

setarch `uname -m` -R ./prog
  • -fsanitize=kernel-address โ€” AddressSanitizer but make it Linux kernel ๐Ÿงšโœจ. See <https://github.com/google/kernel-sanitizers> for more details.
  • -fsanitize=hwaddress โ€” Hardware-assisted AddressSanitizer! ๐Ÿฆ‹ It uses a hardware ability to ignore the top byte of a pointer so it can detect 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 -fsanitize-address-use-after-scope. See <https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html> for more details. The run-time behavior can be influenced using the HWASAN_OPTIONS environment variable. When set to "help=1", the available options are shown at startup of the instrumented program. This one cannot be combined with -fsanitize=thread or -fsanitize=address, and is currently only available on AArch64.
  • -fsanitize=kernel-hwaddress โ€” Hardware-assisted AddressSanitizer for compilation of the Linux kernel ๐ŸŒˆ. Similar to -fsanitize=kernel-address but using an alternate instrumentation method, and similar to -fsanitize=hwaddress but with instrumentation differences necessary for compiling the Linux kernel. Those differences are to avoid hwasan library initialization calls and to account for the stack pointer having a different value in its top byte.
Note: this option has different defaults to the -fsanitize=hwaddress. Instrumenting the stack and alloca calls are not on by default but are still possible by specifying the command-line options --param hwasan-instrument-stack=1 and --param hwasan-instrument-allocas=1 respectively. Using a random frame tag is not implemented for kernel instrumentation.
  • -fsanitize=pointer-compare โ€” Instruments comparison operation (<, <=, >, >=) with pointer operands ๐Ÿ‘€. This option must be combined with either -fsanitize=kernel-address or -fsanitize=address. It cannot be combined with -fsanitize=thread.
Note: by default the check is disabled at run time. To enable it, add "detect_invalid_pointer_pairs=2" to the environment variable ASAN_OPTIONS. Using "detect_invalid_pointer_pairs=1" detects invalid operation only when both pointers are non-null.
  • -fsanitize=pointer-subtract โ€” Instruments subtraction with pointer operands โž–. This option must be combined with either -fsanitize=kernel-address or -fsanitize=address. It cannot be combined with -fsanitize=thread.
Note: by default the check is disabled at run time. To enable it, add "detect_invalid_pointer_pairs=2" to the environment variable ASAN_OPTIONS. Using "detect_invalid_pointer_pairs=1" detects invalid operation only when both pointers are non-null.
  • -fsanitize=shadow-call-stack โ€” Enables 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 "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 -ffixed-x18, otherwise functions compiled without -ffixed-x18 might clobber "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 -fno-exceptions to turn off exceptions.

See <https://clang.llvm.org/docs/ShadowCallStack.html> for more details.

Note that sanitized atomic builtins cannot throw exceptions when operating on invalid memory addresses with non-call exceptions (-fnon-call-exceptions).
  • -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 "malloc" and other allocator functions. See <https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer> for more details. The run-time behavior can be influenced using the LSAN_OPTIONS environment variable. The option cannot be combined with -fsanitize=thread.
  • -fsanitize=undefined โ€” Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector ๐Ÿ˜ฑโœจ. Various computations are instrumented to detect undefined behavior at runtime. See <https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html> for more details. The run-time behavior can be influenced using the UBSAN_OPTIONS environment variable. Current suboptions are:
    • -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, -fsanitize=shift-base and -fsanitize=shift-exponent.
    • -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.
    • -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.
    • -fsanitize=integer-divide-by-zero โ€” Detect integer division by zero ๐Ÿšซ0๏ธโƒฃ.
    • -fsanitize=unreachable โ€” With this option, the compiler turns the "__builtin_unreachable" call into a diagnostics message call instead. When reaching the "__builtin_unreachable" call, the behavior is undefined.
    • -fsanitize=vla-bound โ€” This option instructs the compiler to check that the size of a variable length array is positive.
    • -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 ๐Ÿ™ˆ.
    • -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.
    • -fsanitize=signed-integer-overflow โ€” This option enables signed integer overflow checking. We check that the result of "+", "*", and both unary and binary "-" does not overflow in the signed arithmetics. This also detects "INT_MIN / -1" signed division. Note, integer promotion rules must be taken into account. That is, the following is not an overflow:
signed char a = SCHAR_MAX;
a++;
  • -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 "-fstrict-flex-arrays" or "-fstrict-flex-arrays=" options or "strict_flex_array" attributes say they shouldn't be treated like flexible array member-like arrays.
  • -fsanitize=bounds-strict โ€” okay so this is the strict girly version of array bounds instrumentation ๐Ÿ’…. Most out-of-bounds accesses get caught, including flexible array member-like arrays. But bestie, listen: initializers of variables with static storage are not instrumented. Not them. They're exempt. ๐Ÿ™ˆ
  • -fsanitize=alignment โ€” this one checks pointer alignment when pointers get dereferenced, or when a reference is bound to an insufficiently aligned target, or when a method or constructor is invoked on an insufficiently aligned object. Alignment vibe check, basically. โœจ
  • -fsanitize=object-size โ€” instruments memory references using the __builtin_dynamic_object_size function. Various out-of-bounds pointer accesses get detected. It's giving caught in 4K. ๐Ÿ‘‘
  • -fsanitize=float-divide-by-zero โ€” detects floating-point division by zero. But here's the tea: unlike other similar options, -fsanitize=float-divide-by-zero is not enabled by -fsanitize=undefined, because floating-point division by zero can be a legitimate way of obtaining infinities and NaNs. It's not a bug, it's a lifestyle. ๐Ÿฆ‹
  • -fsanitize=float-cast-overflow โ€” enables floating-point type to integer conversion checking. We check that the result of the conversion does not overflow. And again, unlike other similar options, -fsanitize=float-cast-overflow is not enabled by -fsanitize=undefined. Also it does not work well with FE_INVALID exceptions enabled โ€” so like, don't. ๐Ÿ˜ญ
  • -fsanitize=nonnull-attribute โ€” instruments calls, checking whether null values are not passed to arguments marked as requiring a non-null value by the nonnull function attribute. Passing null where you promised not to? Absolutely not, we don't do that here. ๐Ÿ’€
  • -fsanitize=returns-nonnull-attribute โ€” instruments return statements in functions marked with the returns_nonnull function attribute, to detect returning null values from such functions. You said non-null, bestie. You said it. ๐Ÿซถ
  • -fsanitize=bool โ€” instruments loads from bool. If a value other than 0/1 is loaded, a run-time error is issued. Bool said binary only, and it meant it. โญ
  • -fsanitize=enum โ€” instruments 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. Stay in your lane, enum. ๐ŸŒธ
  • -fsanitize=vptr โ€” this is the C++ one ๐Ÿ˜Œ. It instruments 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. Like, are you actually who you say you are? Main character verification. ๐Ÿ’œ
  • -fsanitize=pointer-overflow โ€” instruments pointer arithmetics. If the pointer arithmetics overflows, a run-time error is issued. Math with pointers going off the rails = caught. ๐Ÿ”ฅ
  • -fsanitize=builtin โ€” instruments 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 __builtin_ctz or __builtin_clz invokes undefined behavior and is diagnosed by this option. So likeโ€ฆ don't pass 0 there. Seriously. ๐Ÿ™ˆ

Heads up bestie: sanitizers tend to increase the rate of false positive warnings, most notably those around -Wmaybe-uninitialized. We recommend against combining -Werror and [the use of] sanitizers. The drama is not worth it. ๐Ÿ˜ญ

While -ftrapv causes traps for signed overflows to be emitted, -fsanitize=undefined gives a diagnostic message. This currently works only for the C family of languages. Fyi. ๐Ÿ’…


  • -fno-sanitize=all โ€” this disables all previously enabled sanitizers. And no, -fsanitize=all is not allowed, because some sanitizers cannot be used together. They're not friends. They don't vibe. Periodt. ๐Ÿ’€
  • -fasan-shadow-offset=number โ€” forces GCC to use a custom shadow offset in AddressSanitizer checks. It's useful for experimenting with different shadow memory layouts in Kernel AddressSanitizer. Science girlie behavior, we love it. ๐Ÿงš
  • -fsanitize-sections=s1,s2,... โ€” sanitize global variables in selected user-defined sections. si may contain wildcards. Wildcards!! โœจ
  • -fsanitize-recover[=opts] โ€” okay this one is long, sit down. -fsanitize-recover= controls error recovery mode for sanitizers mentioned in the comma-separated list of 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 -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 -fsanitize=undefined (and its suboptions except for -fsanitize=unreachable and -fsanitize=return), -fsanitize=float-cast-overflow, -fsanitize=float-divide-by-zero, -fsanitize=bounds-strict, -fsanitize=kernel-address and -fsanitize=address. For these sanitizers error recovery is turned on by default, except -fsanitize=address, for which this feature is experimental. -fsanitize-recover=all and -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 halt_on_error=0 for ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for AddressSanitizer is halt_on_error=1. This can be overridden through setting the halt_on_error flag in the corresponding environment variable.

Syntax without an explicit opts parameter is deprecated. It is equivalent to specifying an opts list of:
undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
  • -fsanitize-address-use-after-scope โ€” enables sanitization of local variables to detect use-after-scope bugs. The option sets -fstack-reuse to none. Snitching on your own locals, but make it safe. ๐ŸŽ€
  • -fsanitize-trap[=opts] โ€” the -fsanitize-trap= option instructs the compiler to report for sanitizers mentioned in the comma-separated list of opts undefined behavior using __builtin_trap rather than a libubsan library routine. If this option is enabled for a certain sanitizer, it takes precedence over the -fsanitizer-recover= for that sanitizer, __builtin_trap will be emitted and be fatal regardless of whether recovery is enabled or disabled using -fsanitize-recover=.

The advantage of this is that the libubsan library is not needed and is not linked in, so this is usable even in freestanding environments. No library? No problem. ๐Ÿ’…

Currently this feature works with -fsanitize=undefined (and its suboptions except for -fsanitize=vptr), -fsanitize=float-cast-overflow, -fsanitize=float-divide-by-zero and -fsanitize=bounds-strict. -fsanitize-trap=all can be also specified, which enables it for undefined suboptions, -fsanitize=float-cast-overflow, -fsanitize=float-divide-by-zero and -fsanitize=bounds-strict. If -fsanitize-trap=undefined or -fsanitize-trap=all is used and -fsanitize=vptr is enabled on the command line, the instrumentation is silently ignored as the instrumentation always needs libubsan support, -fsanitize-trap=vptr is not allowed. ๐Ÿšซ

  • -fsanitize-undefined-trap-on-error โ€” this option is the deprecated equivalent of -fsanitize-trap=all. She's retired, but she still shows up sometimes. ๐Ÿซถ
  • -fsanitize-coverage=trace-pc โ€” enables coverage-guided fuzzing code instrumentation. Inserts a call to __sanitizer_cov_trace_pc into every basic block. Every. Single. One. ๐ŸŒˆ
  • -fsanitize-coverage=trace-cmp โ€” enables dataflow guided fuzzing code instrumentation. Inserts a call to __sanitizer_cov_trace_cmp1, __sanitizer_cov_trace_cmp2, __sanitizer_cov_trace_cmp4 or __sanitizer_cov_trace_cmp8 for integral comparison with both operands variable, or __sanitizer_cov_trace_const_cmp1, __sanitizer_cov_trace_const_cmp2, __sanitizer_cov_trace_const_cmp4 or __sanitizer_cov_trace_const_cmp8 for integral comparison with one operand constant, __sanitizer_cov_trace_cmpf or __sanitizer_cov_trace_cmpd for float or double comparisons, and __sanitizer_cov_trace_switch for switch statements. Look at all those little trace functions, they're iconic honestly. ๐Ÿ‘‘
  • -fcf-protection=[full|branch|return|none|check] โ€” enables code instrumentation of control-flow transfers 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). Security girlie, we stan. ๐Ÿ”ฅ

The value 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 return implements checking of validity at the point of returning from a function. The value full is an alias for specifying both branch and return. The value none turns off instrumentation.

To override -fcf-protection, -fcf-protection=none needs to be added and then with -fcf-protection=xxx. Yes, in that order. Don't fight it. ๐Ÿ™ˆ

The value check is used for the final link with link-time optimization (LTO). An error is issued if LTO object files are compiled with different -fcf-protection values. The value check is ignored at the compile time.

The macro __CET__ is defined when -fcf-protection is used. The first bit of __CET__ is set to 1 for the value branch and the second bit of __CET__ is set to 1 for the return.

You can also use the nocf_check attribute to identify which functions and calls should be skipped from instrumentation. Opting out, but make it explicit. ๐Ÿ’œ

Currently the x86 GNU/Linux target provides an implementation based on Intel Control-flow Enforcement Technology (CET) which works for i686 processor or newer. ๐Ÿ’…

  • -fharden-compares โ€” for every logical test that survives gimple optimizations and is 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 __builtin_trap if the results do not match. Use with -fharden-conditional-branches to cover all conditionals. Double-checking the double-check, highkey paranoid but honestly? Respect. ๐Ÿฆ‹
  • -fharden-conditional-branches โ€” bestie, for every single non-vectorized conditional branch that makes it through gimple optimizations, GCC goes and emits extra code that computes the reversed condition and verifies it, then calls __builtin_trap if the result is unexpected. Use it together with -fharden-compares to cover all the conditionals. ๐Ÿ’…
  • -fharden-control-flow-redundancy โ€” this one emits extra code that sets booleans when you enter basic blocks, then verifies and traps at function exits whenever those booleans don't form an execution path that's compatible with the control flow graph. It's giving security-guard energy fr fr. ๐Ÿ›ก๏ธ

Verification goes down before returns, before mandatory tail calls (see below), and optionally before escaping exceptions with -fhardcfr-check-exceptions, before returning calls with -fhardcfr-check-returning-calls, and before noreturn calls with -fhardcfr-check-noreturn-calls. The tuning options --param hardcfr-max-blocks and --param hardcfr-max-inline-blocks are there for you. โœจ

Tail call optimization happens too late to affect control flow redundancy, but calls annotated as mandatory tail calls by language front-ends โ€” plus any calls marked early enough as potential tail calls โ€” would also get verification issued before the call. But ngl these possibilities are merely theoretical, because those conditions can only be met when you're using custom compiler plugins. ๐Ÿ™ˆ

  • -fhardcfr-skip-leaf โ€” turns off -fharden-control-flow-redundancy in leaf functions. Simple as that. ๐Ÿƒ
  • -fhardcfr-check-exceptions โ€” when -fharden-control-flow-redundancy is active, this checks the recorded execution path against the control flow graph at exception escape points, as if the function body were wrapped in a cleanup handler that performed the check and reraised. This option is enabled by default, so use -fno-hardcfr-check-exceptions if you wanna turn it off. ๐ŸŽ€
  • -fhardcfr-check-returning-calls โ€” when -fharden-control-flow-redundancy is active, this checks the recorded execution path against the control flow graph before any function call that's immediately followed by a return of its result (if any), so it doesn't block tail-call optimization โ€” whether or not that call ends up optimized to a tail call. ๐Ÿ‘‘

This option is enabled by default whenever sibling call optimizations are enabled (see -foptimize-sibling-calls), but you can enable or disable it (using its negated form) explicitly, regardless of the optimizations. Iconic behaviour tbh. ๐Ÿ’–

  • -fhardcfr-check-noreturn-calls=[always|no-xthrow|nothrow|never] โ€” when -fharden-control-flow-redundancy is active, this checks the recorded execution path against the control flow graph before noreturn calls. Either all of them (always), or those that aren't expected to return control to the caller through an exception (no-xthrow, which is the default), or those that may not return control to the caller through an exception either (nothrow), or none of them (never). ๐ŸŒˆ

Checking before a noreturn function that may return control to the caller through an exception can make checking happen more than once, if the exception gets caught in the caller โ€” whether by a handler or a cleanup. When -fhardcfr-check-exceptions is also enabled, the compiler avoids associating a noreturn call with the implicitly-added cleanup handler, since that would be redundant with the check done before the call. But other handlers or cleanups in the function, if they get activated, will modify the recorded execution path and check it again when another checkpoint is hit. And the checkpoint may even be another noreturn call, so checking can end up performed multiple times. ๐Ÿ˜ญ

Various optimizers may cause calls to be marked as noreturn and/or nothrow, even without the corresponding attributes, which may affect where checks get placed before calls, and whether implicit cleanup handlers get added for them. This unpredictability, plus the fact that raising and reraising exceptions frequently amounts to implicitly calling noreturn functions, is why no-xthrow is the default for this option: it excludes from the noreturn treatment only internal functions used to (re)raise exceptions, which aren't affected by these optimizations. ๐Ÿ’€

  • -fhardened โ€” enables a set of flags for C and C++ that level up the security of the generated code without touching its ABI. The precise flags enabled may change between major releases of GCC, but currently they are:
-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 (x86 GNU/Linux only)

The list of options enabled by -fhardened can be generated using the --help=hardened option. ๐Ÿซถ

When the system glibc is older than 2.35, -D_FORTIFY_SOURCE=2 is used instead. ๐Ÿ‘€

This option is intended to be used in production builds, not merely in debug builds. It said what it said. ๐Ÿ’…

Currently, -fhardened is only supported on GNU/Linux targets. ๐Ÿง

-fhardened only enables a particular option if it wasn't already specified anywhere on the command line. For instance, -fhardened -fstack-protector will only enable -fstack-protector, but not -fstack-protector-strong. โœจ

  • -fstack-protector โ€” emits extra code to check for buffer overflows, like stack smashing attacks. It does this by adding a guard variable to functions with vulnerable objects. That includes functions that call 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 count โ€” optimized-away variables or variables allocated in registers don't. ๐Ÿ”ฅ
  • -fstack-protector-all โ€” like -fstack-protector, except all functions are protected. No skipping, periodt. ๐Ÿ’–
  • -fstack-protector-strong โ€” like -fstack-protector, but it includes additional functions to be protected โ€” those that have local array definitions, or have references to local frame addresses. Again, only variables actually allocated on the stack are considered; optimized away variables or variables allocated in registers don't count. ๐ŸŒธ
  • -fstack-protector-explicit โ€” like -fstack-protector, but it only protects those functions which have the stack_protect attribute. VIP only, iykyk. ๐ŸŽ€
  • -fstack-check โ€” generates code to verify that you don't go beyond the boundary of the stack. You should specify this flag if you're running in an environment with multiple threads, but you only rarely need it in a single-threaded environment, since stack overflow is automatically detected on nearly all systems when there's only one stack. ๐Ÿงš

Note that this switch does not actually cause checking to be done โ€” the operating system or the language runtime has to do that. The switch causes generation of code to ensure that they see the stack being extended. ๐Ÿ‘‘

You can additionally specify a string parameter: no means no checking, generic means force the use of old-style checking, and specific means use the best checking method, which is equivalent to bare -fstack-check. ๐Ÿ’…

Old-style checking is a generic mechanism that requires no specific target support in the compiler, but it comes with these drawbacks:

  1. Modified allocation strategy for large objects: they're always allocated dynamically if their size exceeds a fixed threshold. Note this may change the semantics of some code.
  2. Fixed limit on the size of the static frame of functions: when it's topped by a particular function, stack checking isn't reliable and a warning is issued by the compiler.
  3. Inefficiency: because of both the modified allocation strategy and the generic implementation, code performance is hampered. ๐Ÿ˜ญ

Note that old-style stack checking is also the fallback method for specific if no target support has been added in the compiler. ๐Ÿ™ˆ

-fstack-check= is designed for Ada's needs to detect infinite recursion and stack overflows. specific is an excellent choice when compiling Ada code. It's not generally sufficient to protect against stack-clash attacks. To protect against those you want -fstack-clash-protection. ๐ŸŒˆ

  • -fstack-clash-protection โ€” generates code to prevent stack clash style attacks. When this option is enabled, the compiler only allocates one page of stack space at a time, and each page is accessed immediately after allocation. So it prevents allocations from jumping over any stack guard page provided by the operating system. ๐Ÿ”ฅ

Most targets don't fully support stack clash protection. However, on those targets -fstack-clash-protection will protect dynamic stack allocations. -fstack-clash-protection may also provide limited protection for static stack allocations if the target supports -fstack-check=specific. โœจ

  • -fstack-limit-register=reg
  • -fstack-limit-symbol=sym
  • -fno-stack-limit โ€” generates code to ensure that the stack doesn't 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's possible to catch the signal without taking special precautions. ๐Ÿ’–

For instance, if the stack starts at absolute address 0x80000000 and grows downwards, you can use the flags -fstack-limit-symbol=__stack_limit and -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 no_stack_limit function attribute. ๐Ÿ‘‘

  • -fsplit-stack โ€” generates 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, since it's 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. ๐Ÿฆ‹

okay so picture this: code that was built with -fsplit-stack calls code that was not built with -fsplit-stack, and suddenly there might not be much stack space left for that second chunk to actually run in. ๐Ÿ˜ญ rude.

If compiling every single thing โ€” library code included โ€” with -fsplit-stack is just not on the table, then the linker can come through and fix up those calls so the code compiled without -fsplit-stack always has a big stack. ๐Ÿซถ Support for this is implemented in the gold linker in GNU binutils release 2.21 and later. periodt.


-fstrub=disable

Turn stack scrubbing all the way off, ignoring any "strub" attributes you may have sprinkled around. See

-fstrub=strict

Functions default to "strub" mode "disabled", and this applies the restriction strictly: only functions associated with "strub"-"callable" modes ("at-calls", "callable" and "always_inline" "internal") are "callable" by functions with "strub"-enabled modes ("at-calls" and "internal"). no exceptions bestie ๐Ÿ’…

-fstrub=relaxed

Restores the default stack scrub ("strub") setting, meaning "strub" is only enabled as required by "strub" attributes attached to function and data types. "Relaxed" means strub contexts are only prevented from calling functions explicitly associated with "strub" mode "disabled". This option is only useful to override other -fstrub=* options that come before it in the command line. ๐ŸŽ€

-fstrub=at-calls

Enables "at-calls" "strub" mode where it's viable. Mainly a testing thing. It exercises the "strub" machinery in scenarios strictly local to a translation unit. Heads up: this "strub" mode modifies function interfaces, so any function that's visible to other translation units, or that has its address taken, will not be affected by this option. Optimization options may also affect viability. Go read the "strub" attribute documentation for the details on viability and eligibility requirements. ๐Ÿ‘‘

-fstrub=internal

Enables "internal" "strub" mode where it's viable. Also mainly for testing. This one is intended to thoroughly exercise the parts of the "strub" machinery that implement the less efficient, but interface-preserving "strub" mode. Functions that wouldn't be affected by this option are, like, quite uncommon. ๐ŸŒธ

-fstrub=all

Enables some "strub" mode where it's viable. When both strub modes are viable, "at-calls" is preferred. -fdump-ipa-strubm adds function attributes that tell you which mode got selected for each function. Primary use of this option is testing, to thoroughly exercise the "strub" machinery. ๐Ÿ’–

-fvtable-verify=[std|preinit|none]

This one is only available when compiling C++ code. It turns on (or off, if you're using -fvtable-verify=none) the security feature that verifies at run time, for every virtual call, that the vtable pointer the call is made through is actually valid for the type of the object โ€” and that it hasn't been corrupted or overwritten. If an invalid vtable pointer gets detected at run time, an error is reported and execution of the program is halted immediately. ๐Ÿ’€

This option causes run-time data structures to be built at program startup, and those are what verifies the vtable pointers. The options std and preinit control the timing of when those data structures get built. In both cases the data structures are built before execution reaches main. Using -fvtable-verify=std makes the data structures get built after shared libraries have been loaded and initialized. -fvtable-verify=preinit makes them get built before shared libraries have been loaded and initialized.

If this option shows up multiple times in the command line with different values specified, none takes highest priority over both std and preinit; preinit takes priority over std. the way that priority order just exists ๐Ÿงš

-fvtv-debug

When used alongside -fvtable-verify=std or -fvtable-verify=preinit, this causes debug versions of the runtime functions for the vtable verification feature to be called. This flag also makes the compiler log information about which vtable pointers it finds for each class. That info gets written to a file named vtv_set_ptr_data.log, in the directory named by the environment variable VTV_LOGS_DIR if that's defined, or the current working directory otherwise. ๐Ÿ“

Note: this feature appends data to the log file. If you want a fresh log file, be sure to delete any existing one first, bestie. ๐Ÿ™ˆ

-fvtv-counts

This is a debugging flag. When used in conjunction with -fvtable-verify=std or -fvtable-verify=preinit, it makes the compiler 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 vtv_count_data.log, in the directory named by the environment variable VTV_LOGS_DIR if that's defined, or the current working directory otherwise. It also counts the size of the vtable pointer sets for each class, and writes that information to vtv_class_set_sizes.log in the same directory. โœจ

Note: this feature appends data to the log files. To get fresh log files, be sure to delete any existing ones. ๐Ÿซถ

-finstrument-functions

Generates instrumentation calls for entry and exit to functions. Just after function entry and just before function exit, these profiling functions get called with the address of the current function and its call site. (On some platforms, __builtin_return_address does not work beyond the current function, so the call site information may not be available to the profiling functions otherwise.) ๐Ÿ˜ญ

void __cyg_profile_func_enter (void *this_fn,
                               void *call_site);
void __cyg_profile_func_exit  (void *this_fn,
                               void *call_site);

The first argument is the address of the start of the current function, which you can look up exactly in the symbol table. ๐Ÿ”

This instrumentation also happens for functions expanded inline in other functions. The profiling calls indicate where, conceptually, the inline function is entered and exited. That means 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 extern inline in your C code, an addressable version of such functions must be provided. (That's 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 no_instrument_function, in which case this instrumentation is not done. You can use this for, like, the profiling functions listed above, high-priority interrupt routines, and any functions from which the profiling functions cannot safely be called (maybe signal handlers, if the profiling routines generate output or allocate memory). ๐ŸŒˆ

-finstrument-functions-once

Similar to -finstrument-functions, but the profiling functions get 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 "once" for the purposes 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 least once per process and at 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. ๐Ÿฆ‹

-finstrument-functions-exclude-file-list=file,file,...

Sets the list of functions that are excluded from instrumentation (peep the description of -finstrument-functions). If the file that contains a function definition matches with one of file, then that function is not instrumented. The match is done on substrings: if the file parameter is a substring of the file name, it counts as a match.

For example:

-finstrument-functions-exclude-file-list=/bits/stl,include/sys

excludes any inline function defined in files whose pathnames contain /bits/stl or include/sys. ๐Ÿซถ

If, for some reason, you want to include letter , in one of sym, write ,. For example, -finstrument-functions-exclude-file-list=',,tmp' (note the single quote surrounding the option).

-finstrument-functions-exclude-function-list=sym,sym,...

Similar to -finstrument-functions-exclude-file-list, but this option sets the list of function names to be excluded from instrumentation. The function name that gets matched is its user-visible name, like vector<int> blah(const vector<int> &), not the internal mangled name (e.g., _Z4blahRSt6vectorIiSaIiEE). The match is done on substrings: if the sym parameter is a substring of the function name, it counts as a match. For C99 and C++ extended identifiers, the function name must be given in UTF-8, not using universal character names. โœจ

-fpatchable-function-entry=N[,M]

Generates N NOPs right at the beginning of each function, with the function entry point before the Mth NOP. If M is omitted, it defaults to 0, so the function entry points to the address just at the first NOP. These NOP instructions reserve extra space that you can use to patch in whatever instrumentation you want 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 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 M โ€” are additionally collected in the __patchable_function_entries section of the resulting binary. ๐Ÿ’–

Also heads up bestie: the value of __attribute__ ((patchable_function_entry (N,M))) takes precedence over the command-line option -fpatchable-function-entry=N,M. So you can use the attribute to grow the area or yeet it entirely for one single function. And if N=0? No pad location gets recorded, periodt.

The NOP instructions get inserted at โ€” and maybe before, it depends on M โ€” the function entry address, and yes, that's 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. ๐Ÿ’…

The max value for both N and M is 65535. On PowerPC with the ELFv2 ABI, for a function with dual entry points, the supported values for M are 0, 2, 6 and 14.


โœจ Options Controlling the Preprocessor โœจ

These options control the C preprocessor, which gets run on every C source file before the actual compilation happens. ๐Ÿงš

If you use the -E option, literally nothing happens except preprocessing. Some of these options only make sense alongside -E, because they make the preprocessor output unsuitable for actual compilation. Not me warning you twice. ๐Ÿ’€

On top of the options listed right here, there are a bunch of options controlling search paths for include files, documented over in Directory Options. And options controlling preprocessor diagnostics live in Warning Options.

  • -D name โ€” Predefine name as a macro, with definition 1.
  • -D name=definition โ€” The contents of definition are tokenized and processed as if they showed up during translation phase three in a #define directive. In particular, the definition gets truncated by embedded newline characters. ๐Ÿ™ˆ

If you're invoking the preprocessor from a shell or shell-like program, you may need to use the shell's quoting syntax to protect characters like spaces that mean something in shell syntax.

Wanna define a function-like macro on the command line? Write its argument list with surrounding parentheses before the equals sign (if there is one). Parentheses are meaningful to most shells, so quote the option, bestie. With sh and csh, -D'name(args...)=definition' works. ๐Ÿซถ

-D and -U options are processed in the order they're given on the command line. All -imacros file and -include file options are processed after all the -D and -U options. Order matters, iykyk.

  • -U name โ€” Cancel any previous definition of name, whether it was built in or provided with a -D option. Gone. Deleted. ๐Ÿ’…
  • -include file โ€” Process file as if #include "file" appeared as the very first line of the primary source file. BUT โ€” and this is the twist โ€” the first directory searched for file is the preprocessor's working directory, not the directory containing the main source file. If it's not found there, it gets searched for in the remainder of the #include "..." search chain as normal.

If multiple -include options are given, the files are included in the order they appear on the command line.

  • -imacros file โ€” Exactly like -include, except that any output produced by scanning file is thrown away. Macros it defines stay defined though. This lets you scoop up all the macros from a header without also processing its declarations. Iconic, honestly.

All files specified by -imacros are processed before all files specified by -include.

  • -undef โ€” Do not predefine any system-specific or GCC-specific macros. The standard predefined macros remain defined, no cap.
  • -pthread โ€” Define additional macros required for using the POSIX threads library. You should use this option consistently for both compilation and linking. This option is supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets.
  • -M โ€” Instead of outputting the result of preprocessing, output a rule suitable for make describing the dependencies of the main source file. The preprocessor outputs one make rule containing the object file name for that source file, a colon, and the names of all the included files โ€” including those coming from -include or -imacros command-line options. ๐ŸŽ€

Unless specified explicitly (with -MT or -MQ), the object file name consists of the name of the source file with any suffix replaced with the object file suffix, and with any leading directory parts removed. If there are many included files, then the rule gets split into several lines using \-newline. The rule has no commands.

This option does not suppress the preprocessor's debug output, like -dM. To avoid mixing that debug output with the dependency rules, you should explicitly specify the dependency output file with -MF, or use an environment variable like DEPENDENCIES_OUTPUT. Debug output is still sent to the regular output stream as normal.

Passing -M to the driver implies -E, and suppresses warnings with an implicit -w.

  • -MM โ€” Like -M but do not mention header files found in system header directories, nor header files included, directly or indirectly, from such a header.

This implies that the choice of angle brackets or double quotes in an #include directive does not in itself determine whether that header appears in -MM dependency output.

  • -MF file โ€” When used with -M or -MM, specifies a file to write the dependencies to. If no -MF switch is given, the preprocessor sends the rules to the same place it would send preprocessed output.

When used with the driver options -MD or -MMD, -MF overrides the default dependency output file.

If file is -, then the dependencies are written to stdout. โœจ

  • -MG โ€” In conjunction with an option such as -M requesting dependency generation, -MG assumes missing header files are generated files and adds them to the dependency list without raising an error. The dependency filename is taken directly from the #include directive without prepending any path. -MG also suppresses preprocessed output, since a missing header file renders that useless.

This feature is used in automatic updating of makefiles.

  • -Mno-modules โ€” Disable dependency generation for compiled module interfaces.
  • -MP โ€” This option instructs CPP to add a phony target for each dependency other than the main file, causing each to depend on nothing. These dummy rules work around the errors make gives you if you remove header files without updating the Makefile to match. ๐Ÿ˜ญ

This is typical output:

test.o: test.c test.h

test.h:
  • -MT target โ€” Change the target of the rule emitted by dependency generation. By default, CPP takes the name of the main input file, deletes any directory components and any file suffix like .c, and appends the platform's usual object suffix. That result is the target.

An -MT option sets the target to be exactly the string you specify. Want multiple targets? You can specify them as a single argument to -MT, or use multiple -MT options.

For example, -MT '$(objpfx)foo.o' might give:

$(objpfx)foo.o: foo.c
  • -MQ target โ€” Same as -MT, but it quotes any characters which are special to Make. So -MQ '$(objpfx)foo.o' gives:
$$(objpfx)foo.o: foo.c

The default target is automatically quoted, as if it were given with -MQ.

  • -MD โ€” -MD is equivalent to -M -MF file, except that -E is not implied. The driver determines file based on whether an -o option is given. If it is, the driver uses its argument but with a suffix of .d; otherwise it takes the name of the input file, removes any directory components and suffix, and applies a .d suffix.

If -MD is used in conjunction with -E, any -o switch is understood to specify the dependency output file, but if used without -E, each -o is understood to specify a target object file.

Since -E is not implied, -MD can be used to generate a dependency output file as a side effect of the compilation process. Sneaky and efficient, we love her. ๐Ÿ’…

  • -MMD โ€” Like -MD except mention only user header files, not system header files.
  • -fpreprocessed โ€” Indicate to the preprocessor that the input file has already been preprocessed. This suppresses things like macro expansion, trigraph conversion, escaped newline splicing, and processing of most directives. The preprocessor still recognizes and removes comments, so you can pass a file preprocessed with -C to the compiler without problems. In this mode the integrated preprocessor is little more than a tokenizer for the front ends. ๐Ÿงš

-fpreprocessed is implicit if the input file has one of the extensions .i, .ii or .mi. Those are the extensions GCC uses for preprocessed files created by -save-temps.

  • -fdirectives-only โ€” When preprocessing, handle directives, but do not expand macros.

The option's behavior depends on the -E and -fpreprocessed options.

With -E, preprocessing is limited to the handling of directives such as #define, #ifdef, and #error. Other preprocessor operations, such as macro expansion and trigraph conversion, are not performed. In addition, the -dD option is implicitly enabled.

With -fpreprocessed, predefinition of command line and most builtin macros is disabled. Macros such as __LINE__, which are contextually dependent, are handled normally. This enables compilation of files previously preprocessed with -E -fdirectives-only.

With both -E and -fpreprocessed, the rules for -fpreprocessed take precedence. This enables full preprocessing of files previously preprocessed with -E -fdirectives-only.

  • -fdollars-in-identifiers โ€” Accept $ in identifiers.
  • -fextended-identifiers โ€” Accept universal character names and extended characters in identifiers. This option is enabled by default for C99 (and later C standard versions) and C++. โœจ
  • -fno-canonical-system-headers โ€” When preprocessing, do not shorten system header paths with canonicalization.
  • -fmax-include-depth=depth โ€” Set the maximum depth of the nested #include. The default is 200.
  • -ftabstop=width โ€” Set the distance between tab stops. This helps the preprocessor report correct column numbers in warnings or errors, even if tabs appear on the line. If the value is less than 1 or greater than 100, the option is ignored. The default is 8.
  • -ftrack-macro-expansion[=level] โ€” okay so this one tracks where all the tokens go when macros expand, and bestie, that's lowkey a whole vibe ๐Ÿ’ซ. It lets the compiler spill the tea about the current macro-expansion stack when a compilation error happens inside a macro expansion. Downside? It makes the preprocessor AND the compiler eat more memory ๐Ÿ˜ญ. The level param picks how precise the tracking is, so you can dial down memory if you need to:
    • Value 0 of level โ€” de-activates this option, periodt.
    • Value 1 โ€” tracks token locations in a degraded mode for minimal memory overhead. In this mode every token that comes out of expanding an argument of a function-like macro gets the same location. It's giving "close enough" energy.
    • Value 2 โ€” tracks token locations completely. This value is the most memory hungry, fr fr.
    • When the option is given with no argument, the default parameter value is 2.
Heads up: -ftrack-macro-expansion=2 is activated by default. Yes queen, it's already on ๐Ÿ’….
  • -fmacro-prefix-map=old=new โ€” when you're preprocessing files that live in directory old, this expands the __FILE__ and __BASE_FILE__ macros as if those files actually lived in directory new instead. You can use this to flip an absolute path into a relative one by using . for new, which can give you more reproducible builds that are location independent โœจ. This option also affects __builtin_FILE() during compilation. See also -ffile-prefix-map and -fcanon-prefix-map โ€” they're all in the same friend group ๐Ÿซถ.
  • -fexec-charset=charset โ€” sets the execution character set, which is what's used for string and character constants. The default is UTF-8. charset can be any encoding supported by the system's iconv library routine.
  • -fwide-exec-charset=charset โ€” sets the wide execution character set, used for wide string and character constants. The default is one of UTF-32BE, UTF-32LE, UTF-16BE, or UTF-16LE โ€” whichever one matches the width of wchar_t and the big-endian or little-endian byte order being used for code generation. Same as -fexec-charset, charset can be any encoding supported by the system's iconv library routine; however, you're gonna have problems with encodings that don't fit exactly in wchar_t. Not a slay, sorry bestie ๐Ÿ’€.
  • -finput-charset=charset โ€” sets the input character set, used to translate from the character set of the input file over to the source character set GCC uses. If the locale doesn't specify it, or GCC can't get this info from the locale, the default is UTF-8. This can be overridden by either the locale or this command-line option. Currently the command-line option takes precedence if there's a conflict โ€” she's the main character here ๐Ÿ‘‘. charset can be any encoding supported by the system's iconv library routine.
  • -fpch-deps โ€” when you're using precompiled headers, this flag makes the dependency-output flags also list the files from the precompiled header's dependencies. If you don't specify it, only the precompiled header gets listed and not the files that were used to create it, because those files aren't consulted when a precompiled header is used. Makes sense, iconic behavior ๐ŸŒˆ.
  • -fpch-preprocess โ€” this option lets you use a precompiled header together with -E. It inserts a special #pragma, #pragma GCC pch_preprocess "filename", in the output to mark the place where the precompiled header was found, plus its filename. When -fpreprocessed is in use, GCC recognizes this #pragma and loads the PCH ๐ŸŽ€.

This option is off by default, because the resulting preprocessed output is only really suitable as input to GCC. It gets switched on by -save-temps.

You should not write this #pragma in your own code, but it is safe to edit the filename if the PCH file is available in a different location. The filename may be absolute or it may be relative to GCC's current directory.
  • -fworking-directory โ€” turns on generation of linemarkers in the preprocessor output that let the compiler know the current working directory at the time of preprocessing. When this is enabled, the preprocessor emits, after the initial linemarker, a second linemarker with the current working directory followed by two slashes. GCC uses this directory, when it's present in the preprocessed input, as the directory emitted as the current working directory in some debugging information formats. This option is implicitly enabled if debugging information is enabled, but that can be inhibited with the negated form -fno-working-directory. And if the -P flag is present in the command line, this option has no effect, since no #line directives are emitted whatsoever. Bye bestie ๐Ÿ™ˆ.
  • -A predicate=answer โ€” make an assertion with the predicate predicate and answer answer. This form is preferred over the older form -A predicate(answer), which is still supported, because it doesn't use shell special characters. New form ate, no cap ๐Ÿ’….
  • -A -predicate=answer โ€” cancel an assertion with the predicate predicate and answer answer.
  • -C โ€” do not discard comments. All comments get passed through to the output file, except for comments in processed directives, which are deleted along with the directive. Ngl, be prepared for side effects when you use -C; it causes the preprocessor to treat comments as tokens in their own right ๐Ÿ˜ณ. For example, comments appearing at the start of what would be a directive line have the effect of turning that line into an ordinary source line, since the first token on the line is no longer a #.
  • -CC โ€” do not discard comments, including during macro expansion. This is like -C, except that comments contained within macros are also passed through to the output file where the macro is expanded.

On top of the side effects of the -C option, the -CC option causes all C++-style comments inside a macro to be converted to C-style comments. This is to prevent later use of that macro from inadvertently commenting out the remainder of the source line.

The -CC option is generally used to support lint comments. Slay for the linters ๐Ÿฆ‹.

  • -P โ€” inhibit generation of linemarkers in the output from the preprocessor. This might be useful when you're running the preprocessor on something that isn't C code, and it's gonna be sent to a program which might get confused by the linemarkers. Protect the innocent, periodt ๐Ÿ’–.
  • -traditional
  • -traditional-cpp โ€” try to imitate the behavior of pre-standard C preprocessors, as opposed to ISO C preprocessors. See the GNU CPP manual for the details, iykyk.
Note that GCC does not otherwise attempt to emulate a pre-standard C compiler, and these options are only supported with the -E switch, or when invoking CPP explicitly. Don't come for her with anything else ๐Ÿ’€.
  • -trigraphs โ€” support ISO C trigraphs. These are three-character sequences, all starting with ??, that are defined by ISO C to stand for single characters. For example, ??/ stands for \, so '??/n' is a character constant for a newline. The nine trigraphs and their replacements are:
Trigraph:       ??(  ??)  ??<  ??>  ??=  ??/  ??'  ??!  ??-
Replacement:      [    ]    {    }    #    \    ^    |    ~

By default, GCC ignores trigraphs, but in standard-conforming modes it converts them. See the -std and -ansi options. Pick your lane โœจ.

  • -remap โ€” enable special code to work around file systems which only permit very short file names, such as MS-DOS. Retro problem, retro fix ๐ŸŒธ.
  • -H โ€” print the name of each header file used, in addition to other normal activities. Each name is indented to show how deep in the #include stack it is. Precompiled header files are also printed, even if they're found to be invalid; an invalid precompiled header file is printed with ...x and a valid one with ...! . Vibe check on your headers, always ๐Ÿ‘‘.
  • -dletters โ€” says to make debugging dumps during compilation as specified by letters. The flags documented here are those relevant to the preprocessor. Other letters are interpreted by the compiler proper, or reserved for future versions of GCC, and so are silently ignored. If you specify letters whose behavior conflicts, the result is undefined โ€” that's a hard no, bestie ๐Ÿ˜ญ.
    • -dM โ€” instead of the normal output, generate a list of #define directives for all the macros defined during the execution of the preprocessor, including predefined macros. This gives you a way of finding out what's predefined in your version of the preprocessor. Assuming you have no file foo.h, the command
touch foo.h; cpp -dM foo.h

shows all the predefined macros.

If you use -dM without the -E option, -dM is interpreted as a synonym for -fdump-rtl-mach. Plot twist ๐ŸŒ€.

  • -dD โ€” like -dM except that it outputs both the #define directives and the result of preprocessing. Both kinds of output go to the standard output file.
  • -dN โ€” like -dD, but emit only the macro names, not their expansions. Minimalist queen ๐Ÿ’….
  • -dI โ€” output #include directives in addition to the result of preprocessing.
  • -dU โ€” like -dD except that only macros that are expanded, or whose definedness is tested in preprocessor directives, are output; the output is delayed until the use or test of the macro; and #undef directives are also output for macros tested but undefined at the time.
  • -fdebug-cpp โ€” this option is only useful for debugging GCC. When used from CPP or with -E, it dumps debugging information about location maps. Every token in the output is preceded by the dump of the map its location belongs to. When used from GCC without -E, this option has no effect. It's giving "I'm only here for the debug girlies" ๐Ÿงš.
  • -Wp,option โ€” you can use -Wp,option to bypass the compiler driver and pass option directly through to the preprocessor. If option contains commas, it's 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 -Wp forcibly bypasses this phase. The preprocessor's direct interface is undocumented and subject to change, so whenever possible you should avoid using -Wp and let the driver handle the options instead. Live dangerously if you want, but she warned you ๐Ÿ™ˆ.
  • -Xpreprocessor option โ€” pass 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 -Xpreprocessor twice โ€” once for the option and once for the argument. Two-step, but make it fashion ๐Ÿ’œ.
  • -no-integrated-cpp โ€” bestie, by default GCC just does the preprocessing inside the whole tokenizing-and-parsing situation, all integrated, one big vibe. Pass this and it does preprocessing as its own separate pass before compilation instead. Concretely: the right language front end (cc1, cc1plus, or cc1obj for C, C++, and Objective-C, respectively) gets invoked twice โ€” once for preprocessing only, and once to actually compile the preprocessed input. Lowkey useful with -B or -wrapper if you wanna slot in an alternate preprocessor or do extra processing on the source between normal preprocessing and compilation. ๐Ÿ’…
  • -flarge-source-files โ€” tells GCC to expect large source files, at the cost of slower compilation and higher memory usage. Here's the tea: GCC normally tracks both column numbers and line numbers inside source files, and prints both in diagnostics. But once it's chewed through a certain number of source lines, it stops tracking column numbers and only tracks line numbers. Which means diagnostics for later lines come with no column numbers, and options like -Wmisleading-indentation just stop working at that point โ€” though the compiler does print a note when that happens, so at least it tells you. Passing -flarge-source-files significantly increases the number of source lines GCC can handle before it gives up on columns. ๐Ÿฆ‹

โœจ Passing Options to the Assembler โœจ

Yes bestie, you can pass options straight through to the assembler. Obsessed.

  • -Wa,option โ€” passes option as an option to the assembler. If option contains commas, it gets split into multiple options at the commas. (So comma = new option, got it.)
  • -Xassembler option โ€” passes option as an option to the assembler. Use this one to supply system-specific assembler options that GCC doesn't even recognize. ๐Ÿ™ˆ
Heads up: if you wanna pass an option that takes an argument, you have to use -Xassembler twice โ€” once for the option and once for the argument. Fr fr.

๐Ÿ’– Options for Linking ๐Ÿ’–

These ones only come into play when the compiler links object files into an executable output file. If there's no link step happening, they're meaningless. No link, no vibe check. ๐Ÿ˜ญ

  • object-file-name โ€” a file name that doesn't end in a special recognized suffix is considered to name an object file or library. (Object files get distinguished from libraries by the linker based on the file contents, iykyk.) If linking is done, these object files are used as input to the linker.
  • -c
  • -S
  • -E โ€” if any of these three is used, then the linker is not run, and object file names should not be used as arguments. Periodt.
  • -flinker-output=type โ€” this one controls code generation of the link-time optimizer. By default the linker output is automatically determined by the linker plugin. But for debugging the compiler, or if you want incremental linking with a non-LTO object file, manually controlling type can be useful. Let's break down the types:
    • If type is exec, code generation produces a static binary. In this case -fpic and -fpie are both disabled.
    • If type is dyn, code generation produces a shared library. In this case -fpic or -fPIC is preserved, but not enabled automatically. This allows building shared libraries without position-independent code on architectures where that's possible, i.e. on x86.
    • If type is pie, code generation produces an -fpie executable. This results in similar optimizations as exec, except that -fpie is not disabled if specified at compilation time.
    • If type is rel, the compiler assumes incremental linking is being done. The sections containing intermediate code for link-time optimization are merged, pre-optimized, and output to the resulting object file. Also, if -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. And at link time, the result of incremental linking also loads faster than a static library โ€” assuming the majority of objects in the library are actually used. ๐ŸŒธ
    • Finally, 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 -r) the linker plugin defaults to rel. With current interfaces to GNU Binutils it is however not possible to incrementally link LTO objects and non-LTO objects into a single mixed object file. If any of the object files in the incremental link can't be used for link-time optimization, the linker plugin issues a warning and uses nolto-rel. To maintain whole program optimization, it's recommended to link such objects into a static library instead. Alternatively you can use H.J. Lu's binutils with support for mixed objects. โœจ

  • -fuse-ld=bfd โ€” use the bfd linker instead of the default linker.
  • -fuse-ld=gold โ€” use the gold linker instead of the default linker.
  • -fuse-ld=lld โ€” use the LLVM lld linker instead of the default linker.
  • -fuse-ld=mold โ€” use the Modern Linker (mold) instead of the default linker. ๐Ÿ’…
  • -llibrary
  • -l library โ€” searches the library named library when linking. (The second form, with the library as a separate argument, is only there for POSIX compliance and is not recommended, so maybe don't.)

The -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 -L.

Static libraries are archives of object files, and have file names like liblibrary.a. Some targets also support shared libraries, which typically have names like liblibrary.so. If both static and shared libraries are found, the linker gives preference to linking with the shared library unless the -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. So foo.o -lz bar.o searches library z after file foo.o but before bar.o. If bar.o refers to functions in z, those functions may not be loaded. ๐Ÿ’€ Order matters, bestie.

  • -lobjc โ€” you need this special case of the -l option in order to link an Objective-C or Objective-C++ program.
  • -nostartfiles โ€” don't use the standard system startup files when linking. The standard system libraries are used normally, unless -nostdlib, -nolibc, or -nodefaultlibs is used.
  • -nodefaultlibs โ€” don't 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 โ€” like -static-libgcc or -shared-libgcc โ€” are ignored. The standard startup files are used normally, unless -nostartfiles is used.

The compiler may generate calls to memcmp, memset, memcpy and 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. ๐Ÿซถ

  • -nolibc โ€” don't use the C library or system libraries tightly coupled with it when linking. It still links with the startup files, libgcc, or toolchain-provided language support libraries such as libgnat, libgfortran or libstdc++ โ€” unless options preventing their inclusion are used as well. This typically removes -lc from the link command line, plus system libraries that normally go with it and become meaningless when absence of a C library is assumed โ€” for example -lpthread or -lm in some configurations. This is intended for bare-board targets when there really is no C library available.
  • -nostdlib โ€” don't use the standard system startup files or libraries when linking. No startup files, and only the libraries you specify are passed to the linker. Options specifying linkage of the system libraries, such as -static-libgcc or -shared-libgcc, are ignored.

The compiler may generate calls to memcmp, memset, memcpy and 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.

One of the standard libraries bypassed by -nostdlib and -nodefaultlibs is libgcc.a, a library of internal subroutines which GCC uses to overcome shortcomings of particular machines, or special needs for some languages.

In most cases, you need libgcc.a even when you want to avoid other standard libraries. In other words, when you specify -nostdlib or -nodefaultlibs you should usually specify -lgcc as well. This ensures you have no unresolved references to internal GCC library subroutines. (An example of such an internal subroutine is __main, used to ensure C++ constructors are called.)

  • -nostdlib++ โ€” don't implicitly link with standard C++ libraries.
  • -e entry
  • --entry= entry โ€” specifies that the program entry point is entry. The argument is interpreted by the linker; the GNU linker accepts either a symbol name or an address. โœจ
  • -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 (-fpie, -fPIE, or model suboptions) when you specify this linker option.
  • -no-pie โ€” don't produce a dynamically linked position independent executable.
  • -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 (-fpie, -fPIE, or model suboptions) when you specify this linker option. ๐Ÿ’œ
  • -pthread โ€” bestie, this links you up with the POSIX threads library ๐Ÿ’…. It's supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets. Heads up tho: on some targets this option also sets flags for the preprocessor, so you gotta use it consistently for both compilation and linking, no cap.
  • -r โ€” produces a relocatable object as output. Also known as partial linking โœจ.
  • -rdynamic โ€” passes the flag -export-dynamic to the ELF linker, on targets that support it. This tells the linker to add all symbols to the dynamic symbol table, not just the used ones ๐Ÿ‘‘. You need this for some uses of dlopen or to allow obtaining backtraces from within a program.
  • -s โ€” removes all symbol table and relocation information from the executable ๐Ÿงน.
  • -static โ€” on systems that support dynamic linking, this overrides -pie and prevents linking with the shared libraries. On other systems, this option has no effect.
  • -shared โ€” produces 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 (-fpic, -fPIC, or model suboptions) when you specify this linker option.[1]
  • -shared-libgcc, -static-libgcc โ€” on systems that provide libgcc as a shared library, these options force the use of either the shared or static version, respectively. If no shared version of 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 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 libgcc ๐Ÿซถ.

Therefore, the G++ driver automatically adds -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 libgcc. If GCC finds, at its configuration time, that you have a non-GNU linker or a GNU linker that does not support option --eh-frame-hdr, it links the shared version of libgcc into shared libraries by default. Otherwise, it takes advantage of the linker and optimizes away the linking with the shared version of 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 -shared-libgcc, such that it is linked with the shared libgcc.

  • -static-libasan โ€” when the -fsanitize=address option is used to link a program, the GCC driver automatically links against libasan. If libasan is available as a shared library, and the -static option is not used, then this links against the shared version of libasan. The -static-libasan option directs the GCC driver to link libasan statically, without necessarily linking other libraries statically ๐Ÿงš.
  • -static-libtsan โ€” when the -fsanitize=thread option is used to link a program, the GCC driver automatically links against libtsan. If libtsan is available as a shared library, and the -static option is not used, then this links against the shared version of libtsan. The -static-libtsan option directs the GCC driver to link libtsan statically, without necessarily linking other libraries statically ๐Ÿงš.
  • -static-liblsan โ€” when the -fsanitize=leak option is used to link a program, the GCC driver automatically links against liblsan. If liblsan is available as a shared library, and the -static option is not used, then this links against the shared version of liblsan. The -static-liblsan option directs the GCC driver to link liblsan statically, without necessarily linking other libraries statically ๐Ÿงš.
  • -static-libubsan โ€” when the -fsanitize=undefined option is used to link a program, the GCC driver automatically links against libubsan. If libubsan is available as a shared library, and the -static option is not used, then this links against the shared version of libubsan. The -static-libubsan option directs the GCC driver to link libubsan statically, without necessarily linking other libraries statically ๐Ÿงš.
  • -static-libstdc++ โ€” when the g++ program is used to link a C++ program, it normally automatically links against libstdc++. If libstdc++ is available as a shared library, and the -static option is not used, then this links against the shared version of libstdc++. That is normally fine โœจ. However, it is sometimes useful to freeze the version of libstdc++ used by the program without going all the way to a fully static link. The -static-libstdc++ option directs the g++ driver to link libstdc++ statically, without necessarily linking other libraries statically.
  • -symbolic โ€” binds references to global symbols when building a shared object. Warns about any unresolved references (unless overridden by the link editor option -Xlinker -z -Xlinker defs). Only a few systems support this option ๐Ÿ‘€.
  • -T script โ€” uses 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 -T option may be required when linking to avoid references to undefined symbols.
  • -Xlinker option โ€” passes 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 -Xlinker twice, once for the option and once for the argument. For example, to pass -assert definitions, you must write -Xlinker -assert -Xlinker definitions. It does not work to write -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=value syntax than as separate arguments. For example, you can specify -Xlinker -Map=output.map rather than -Xlinker -Map -Xlinker output.map. Other linkers may not support this syntax for command-line options.

  • -Wl,option โ€” passes option as an option to the linker. If 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, -Wl,-Map,output.map passes -Map output.map to the linker. When using the GNU linker, you can also get the same effect with -Wl,-Map=output.map.
  • -u symbol โ€” pretends the symbol symbol is undefined, to force linking of library modules to define it. You can use -u multiple times with different symbols to force loading of additional library modules ๐Ÿ‘‘.
  • -z keyword โ€” -z is passed directly on to the linker along with the keyword keyword. See the section in the documentation of your linker for permitted values and their meanings.

These options specify directories to search for header files, for libraries and for parts of the compiler ๐Ÿฆ‹:

  • -I dir
  • -iquote dir
  • -isystem dir
  • -idirafter dir

Add the directory dir to the list of directories to be searched for header files during preprocessing. If dir begins with = or $SYSROOT, then the = or $SYSROOT is replaced by the sysroot prefix; see --sysroot and -isysroot.

Directories specified with -iquote apply only to the quote form of the directive, #include "file". Directories specified with -I, -isystem, or -idirafter apply to lookup for both the #include "file" and #include <file> directives.

You can specify any number or combination of these options on the command line to search for header files in several directories. The lookup order is as follows:

  1. For the quote form of the include directive, the directory of the current file is searched first.
  2. For the quote form of the include directive, the directories specified by -iquote options are searched in left-to-right order, as they appear on the command line.
  3. Directories specified with -I options are scanned in left-to-right order.
  4. Directories specified with -isystem options are scanned in left-to-right order.
  5. Standard system directories are scanned.
  6. Directories specified with -idirafter options are scanned in left-to-right order.

You can use -I to override a system header file, substituting your own version, since these directories are searched before the standard system header file directories ๐Ÿ’…. However, you should not use this option to add directories that contain vendor-supplied system header files; use -isystem for that.

The -isystem and -idirafter options also mark the directory as a system directory, so that it gets the same special treatment that is applied to the standard system directories โœจ.

If a standard system include directory, or a directory specified with -isystem, is also specified with -I, the -I option is ignored. The directory is still searched but as a system directory at its normal position in the system include chain. This is to ensure that GCC's procedure to fix buggy system headers and the ordering for the #include_next directive are not inadvertently changed. If you really need to change the search order for system directories, use the -nostdinc and/or -isystem options.

  • -I- โ€” split the include path. This option has been deprecated ๐Ÿ’€. Please use -iquote instead for -I directories before the -I- and remove the -I- option.

Any directories specified with -I options before -I- are searched only for headers requested with #include "file"; they are not searched for #include <file>. If additional directories are specified with -I options after the -I-, those directories are searched for all #include directives.

  • okay so lowkey the messiest part of -I- โ€” it also blocks the directory of the current file from being the first search directory for #include "file". And bestieโ€ฆ there is no way to override this effect of -I-. none. zero. it's giving final boss. periodt. ๐Ÿ’…
  • -iprefix prefix โ€” sets prefix as the prefix for the -iwithprefix options that come after it. if that prefix is a whole directory, pls include the trailing / or it'll be weird. ๐ŸŽ€
  • -iwithprefix dir / -iwithprefixbefore dir โ€” append dir to whatever prefix you set earlier with -iprefix, and drop the resulting directory onto the include search path. The difference: -iwithprefixbefore slots it in the same place -I would, and -iwithprefix slots it where -idirafter would. two vibes, one prefix, iconic. โœจ
  • -isysroot dir โ€” basically --sysroot but only for header files (โ€ฆexcept on Darwin targets, where it does headers and libraries, main character behaviour tbh). Go peek at the --sysroot option for the deets. ๐Ÿฆ‹
  • -imultilib dir โ€” use dir as a subdirectory of the directory that holds the target-specific C++ headers. yes it's niche, yes it's important. ๐Ÿ’œ
  • -nostdinc โ€” do NOT search the standard system directories for header files. The only places searched are the directories you explicitly gave with -I, -iquote, -isystem, and/or -idirafter (plus the directory of the current file, if that's appropriate). you're on your own now bestie. ๐Ÿ˜ญ
  • -nostdinc++ โ€” skip the C++-specific standard directories for headers, but still search all the other standard directories. (This one gets used when you're building the C++ library itself.) ๐Ÿงš
  • -iplugindir= dir โ€” sets the directory to search for plugins that get passed by -fplugin=name instead of -fplugin=path/name.so. and likeโ€ฆ this is not for the user โ€” it's only passed by the driver. hands off, it's a driver thing. ๐Ÿ™ˆ
  • -L dir โ€” add directory dir to the list of directories searched for -l. ๐Ÿ“
  • -B prefix โ€” tells the compiler where to find the executables, libraries, include files, and data files of the compiler itself. it's the compiler's own lil treasure map ๐Ÿ—บ๏ธ

The compiler driver program runs one or more of the subprograms cpp, cc1, as and ld. It tries prefix as a prefix for each program it tries to run, both with and without machine/version/ for the corresponding target machine and compiler version.

For each subprogram to be run, the compiler driver first tries the -B prefix, if there is one. If that name isn't found, or if -B wasn't given at all, the driver tries two standard prefixes: /usr/lib/gcc/ and /usr/local/lib/gcc/. If neither of those lands on a file name that's actually found, then the unmodified program name gets searched for using the directories in your PATH environment variable. so like, plan A, plan B, plan C, and then PATH. โœจ

The compiler checks whether the path from -B refers to a directory, and if necessary it adds a directory separator character at the end of the path. tidying up the lil path, as one does. ๐Ÿ’…

-B prefixes that effectively specify directory names also apply to libraries in the linker, because the compiler translates those options into -L options for the linker. They also apply to include files in the preprocessor, because the compiler translates those options into -isystem options for the preprocessor. In that case, the compiler appends include to the prefix. so sneaky, so efficient. ๐ŸŽ€

The runtime support file libgcc.a can also be searched for using the -B prefix, if needed. If it's not found there, the two standard prefixes above are tried, and that is all. If it's not found by those means, the file is left out of the link. brutal but true. ๐Ÿ˜ญ

Another way to specify a prefix much like the -B prefix is to use the environment variable GCC_EXEC_PREFIX. ๐ŸŒธ

And as a special kludge: if the path provided by -B is [dir/]stageN/, where N is a number in the range 0 to 9, then it gets replaced by [dir/]include. This is to help with boot-strapping the compiler. a kludge!! a real one!! documented and everything!! ๐Ÿ‘‘

  • -no-canonical-prefixes โ€” do not expand any symbolic links, resolve references to /../ or /./, or make the path absolute when generating a relative prefix. leave the path exactly as it is, bestie. ๐Ÿฆ‹
  • --sysroot= dir โ€” use dir as the logical root directory for headers and libraries. For example, if the compiler normally searches for headers in /usr/include and libraries in /usr/lib, it instead searches dir/usr/include and dir/usr/lib. same energy, new root. ๐ŸŒˆ

If you use both this option and the -isysroot option, then --sysroot applies to libraries, but -isysroot applies to header files. split duties, no drama. ๐Ÿ’…

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 --sysroot still works, but the library aspect does not. so check your linker before you get your hopes up. ๐Ÿ’€

  • --no-sysroot-suffix โ€” for some targets, a suffix gets added to the root directory specified with --sysroot, depending on the other options used, so headers may for example be found in dir/suffix/usr/include instead of dir/usr/include. This option disables the addition of such a suffix. no suffix, no problem. โœจ

โœจ Options for Code Generation Conventions โœจ

these machine-independent options control the interface conventions used in code generation. ๐ŸŽ€

Most of them have both a positive and a negative form โ€” the negative form of -ffoo is -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 no- or adding it. it's giving choose-your-own-adventure but for flags. ๐Ÿ’œ

  • -fstack-reuse= reuse-level โ€” this option controls stack space reuse for user-declared local/auto variables and compiler-generated temporaries. reuse_level can be all, named_vars, or none. all enables stack reuse for all local variables and temporaries, named_vars enables the reuse only for user-defined local variables with names, and none disables stack reuse completely. The default value is 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 the 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,

int *p;
{
  int local1;

  p = &local1;
  local1 = 10;
  ....
}
{
   int local2;
   local2 = 20;
   ...
}

if (*p == 10)  // out of scope use of local1
  {

  }

Another example:

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?
}

The lifetime of a compiler-generated temporary is well defined by the C++ standard. When the 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 legacy code relies on the behavior of older compilers in which temporaries' stack space is not reused, and the aggressive stack reuse can lead to runtime errors. this option is used to control the temporary stack reuse optimization. ๐Ÿ˜ญ

  • -ftrapv โ€” this option generates traps for signed overflow on addition, subtraction, and multiplication operations. The options -ftrapv and -fwrapv override each other, so using -ftrapv -fwrapv on the command line results in -fwrapv being effective. Note that only active options override, so using -ftrapv -fwrapv -fno-wrapv on the command line results in -ftrapv being effective. last one standing wins, fr fr. ๐Ÿ”ฅ
  • -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 -ftrapv and -fwrapv override each other, so using -ftrapv -fwrapv on the command line results in -fwrapv being effective. Note that only active options override, so using -ftrapv -fwrapv -fno-wrapv on the command line results in -ftrapv being effective. wrapping around, cute and chaotic. ๐ŸŒ€
  • -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. pointers get the same wrap treatment. ๐ŸŽ€
  • -fstrict-overflow โ€” this option implies -fno-wrapv -fno-wrapv-pointer, and when negated implies -fwrapv -fwrapv-pointer. package deal, no substitutions. โœจ
  • -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 don't 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're compiling older C++ programs that don't use exception handling. bigger data, same speed, choose wisely bestie. ๐Ÿฆ‹
  • -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 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 "SIGALRM". This enables -fexceptions. so likeโ€ฆ traps can throw, signal handlers can't. important distinction!! ๐Ÿ’…
  • -fdelete-dead-exceptions โ€” okay so bestie, this one says: if some instructions might throw exceptions but they literally don't do anything else for the program's execution, we can just yeet them in optimization. Important caveat though: this does not affect calls to functions, except the ones rocking the pure or const attributes. It's on by default for the Ada and C++ compilers, since the language specs say that's allowed. And the optimization passes that actually remove dead exceptions get turned on independently at different optimization levels, so like, they're doing their own thing. ๐Ÿ’…
  • -funwind-tables โ€” kinda like -fexceptions, except it only generates whatever static data is needed and does not touch the generated code in any other way. You normally do not need to enable this option; instead, a language processor that needs this handling turns it on for you. So just... let them handle it, bestie. ๐Ÿซถ
  • -fasynchronous-unwind-tables โ€” generates an unwind table in DWARF format, if the target machine supports it. The table is exact at every single instruction boundary, which means it can be used for stack unwinding from asynchronous events โ€” think debuggers or garbage collectors doing their little surprise appearances. โœจ
  • -fno-gnu-unique โ€” okay so on systems with a recent GNU assembler and C library, the C++ compiler uses the STB_GNU_UNIQUE binding to make sure that definitions of template static data members and static local variables in inline functions stay unique even when RTLD_LOCAL is in the picture. This is necessary to avoid problems where a library used by two different RTLD_LOCAL plugins depends on a definition in one of them, and therefore disagrees with the other one about the binding of the symbol. ๐Ÿ˜ญ But โ€” and here's the plot twist โ€” this causes dlclose to be ignored for affected DSOs. So if your program relies on reinitialization of a DSO via dlclose and dlopen, you can use -fno-gnu-unique. There's your escape hatch. ๐Ÿšช
  • -fpcc-struct-return โ€” returns short struct and union values in memory like the longer ones, instead of 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.

โš ๏ธ Warning: code compiled with the -fpcc-struct-return switch is not binary compatible with code compiled with the -freg-struct-return switch. Use it to conform to a non-default application binary interface.
  • -freg-struct-return โ€” returns struct and union values in registers when possible. This is more efficient for small structures than -fpcc-struct-return. โœจ

If you specify neither -fpcc-struct-return nor -freg-struct-return, GCC defaults to whichever convention is standard for the target. If there is no standard convention, GCC defaults to -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. Slay. ๐Ÿ‘‘

โš ๏ธ Warning: code compiled with the -freg-struct-return switch is not binary compatible with code compiled with the -fpcc-struct-return switch. Use it to conform to a non-default application binary interface.
  • -fshort-enums โ€” allocates to an enum type only as many bytes as it needs for the declared range of possible values. Specifically, the enum type is equivalent to the smallest integer type that has enough room. Tiny enum, tiny footprint. This option has no effect for an enumeration type with a fixed underlying type.
โš ๏ธ Warning: the -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.
  • -fshort-wchar โ€” overrides the underlying type for wchar_t to be short unsigned int instead of the default for the target. This option is useful for building programs to run under WINE. ๐Ÿท
โš ๏ธ Warning: the -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.
  • -fcommon โ€” in C code, this option controls the placement of global variables defined without an initializer, known as tentative definitions in the C standard. Tentative definitions are distinct from declarations of a variable with the extern keyword, which do not allocate storage.

The default is -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 -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. ๐Ÿ›๏ธ

  • -fno-ident โ€” ignore the #ident directive. That's it. That's the whole vibe. ๐Ÿ™ˆ
  • -finhibit-size-directive โ€” don't output a .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 crtstuff.c; you should not need to use it for anything else. Leave it alone bestie, it's not for you. ๐ŸŽ€
  • -fverbose-asm โ€” puts 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). iykyk โœจ

-fno-verbose-asm, the default, causes the extra information to be omitted and is useful when comparing two assembler files.

The added comments include:

  • information on the compiler version and command-line options,
  • the source code lines associated with the assembly instructions, in the form FILENAME:LINENUMBER:CONTENT OF LINE,
  • hints on which high-level expressions correspond to the various assembly instruction operands.

For example, given this C source file:

int test (int n)
{
  int i;
  int total = 0;

  for (i = 0; i < n; i++)
    total += i * i;

  return total;
}

compiling to (x86_64) assembly via -S and emitting the result direct to stdout via -o -

gcc -S test.c -fverbose-asm -Os -o -

gives output similar to this:

        .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

The comments are intended for humans rather than machines and hence the precise format of the comments is subject to change. Don't get attached, bestie. ๐Ÿ’…

  • -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 -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 -grecord-gcc-switches for another way of storing compiler options into the object file. ๐Ÿ“
  • -fpic โ€” generates 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 -fpic does not work; in that case, recompile with -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 __pic__ and __PIC__ are defined to 1. โœจ

  • -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.

And when this flag is set, the macros __pic__ and __PIC__ are defined to 2. ๐Ÿ’ซ


  • -fpie, -fPIE โ€” okay so these are the cousins of -fpic and -fPIC, except the position-independent code they generate can only be linked into executables. No shared-lib slay for these ones, bestie. Usually you reach for them when you're compiling code that's gonna get linked using the -pie GCC option. Both of them define the macros __pie__ and __PIE__ โ€” the macros hold the value 1 for -fpie and 2 for -fPIE.
  • -fno-plt โ€” do not use the PLT for external function calls in position-independent code. Instead, the callee address gets loaded at call sites from the GOT and then we branch to it. It's giving efficiency: PLT stubs get eliminated and GOT loads get exposed to optimizations. On architectures like 32-bit x86, where PLT stubs expect the GOT pointer in a specific register, this hands the compiler way more register allocation freedom. โš ๏ธ Lazy binding requires use of the PLT, so with -fno-plt all external symbols are resolved at load time. Alternatively, the function attribute 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.
  • -fno-jump-tables โ€” do not use jump tables for switch statements, even where that would be more efficient than other code generation strategies. This one's your girl when you're working alongside -fpic or -fPIC to build code that forms part of a dynamic linker and cannot reference the address of a jump table. On some targets, jump tables don't require a GOT at all, and then this option isn't needed. ๐Ÿซถ
  • -fno-bit-tests โ€” do not use bit tests for switch statements, even where that would be more efficient than other code generation strategies. Periodt.
  • -ffixed-reg โ€” treat the register named 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). reg must be the name of a register. The register names accepted are machine-specific and are defined in the REGISTER_NAMES macro in the machine description macro file. This flag does not have a negative form, because it specifies a three-way choice.
  • -fcall-used-reg โ€” treat the register named 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 reg.
It is an error to use this flag with the frame pointer or stack pointer. And using 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.

  • -fcall-saved-reg โ€” treat the register named 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 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.

  • -fpack-struct[=n] โ€” without a value specified, pack all structure members together without holes. When a value is specified (and it 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).
Warning: the -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.
  • -fleading-underscore โ€” this option and its counterpart, -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. ๐Ÿงš
Warning: the -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.
  • -ftls-model=model โ€” alter the thread-local storage model to be used. The model argument should be one of global-dynamic, local-dynamic, initial-exec, or 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 -fpic is not given on the command line. โœจ The default without -fpic is initial-exec; with -fpic the default is global-dynamic.
  • -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. -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, -fno-trampolines is enabled by default only for Ada. Moreover, code compiled with -ftrampolines and code compiled with -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 -ftrampolines and -fno-trampolines options currently have no effect, and trampolines are always generated on platforms that need them for nested functions.
  • -ftrampoline-impl=[stack|heap] โ€” by default, trampolines are generated on stack. However, certain platforms (such as the Apple M1) do not permit an executable stack. Compiling with -ftrampoline-impl=heap generate calls to __gcc_nested_func_ptr_created and __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.
PLEASE NOTE: Heap trampolines are not guaranteed to be correctly deallocated if you setjmp, instantiate nested functions, and then longjmp back to a state prior to having allocated those nested functions. ๐Ÿ’€
  • -fvisibility=[default|internal|hidden|protected] โ€” 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 strongly recommended that you use this in any shared objects you distribute. ๐Ÿ‘‘ Despite the nomenclature, default always means public; i.e., available to be linked against from outside the shared object. protected and internal are pretty useless in real-world usage so the only other commonly used option is hidden. The default if -fvisibility isn't specified is 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 <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 -fvisibility=hidden and __attribute__ ((visibility("default"))) instead of __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 #pragma GCC visibility of use. This works by you enclosing the declarations you wish to set visibility for with (for example) #pragma GCC visibility push(hidden) and #pragma GCC visibility pop. Bear in mind that symbol visibility should be viewed 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 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, operator new and 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 #pragma GCC visibility push(default) before including any such headers. extern declarations are not affected by -fvisibility, so a lot of code can be recompiled with -fvisibility=hidden with no modifications. However, this means that calls to extern functions with no explicit visibility use the PLT, so it is more effective to use __attribute ((visibility)) and/or #pragma GCC visibility to tell the compiler which extern declarations should be treated as hidden. ๐ŸŒธ
ngl bestie this is the part where GCC lowkey starts talking to itself โ€” the compiler-nerd dev options. buckle up ๐ŸŽ€

Ok so quick heads-up: -fvisibility does affect C++ vague linkage entities. which means โ€” for example โ€” an exception class that's getting thrown between DSOs has to be explicitly marked with default visibility so the type_info nodes get unified between the DSOs. no unified type_info, no vibe. ๐Ÿ’…

There's a whole overview of these techniques + their benefits + how to use them at <https://gcc.gnu.org/wiki/Visibility>. go read it, it's giving academic but in a cute way.


โœจ -fstrict-volatile-bitfields โœจ

Use this one if accesses to volatile bit-fields (or other structure fields, though ngl the compiler usually honors those types anyway) should be a single access of the width of the field's type, aligned to a natural alignment if that's possible.

Example time, bestie: targets with memory-mapped peripheral registers might literally require all such accesses to be 16 bits wide. with this flag you can declare all peripheral bit-fields as unsigned short (assuming short is 16 bits on these targets) to force GCC to use 16-bit accesses instead of, like, maybe a more efficient 32-bit access. ๐Ÿ“

If this option is disabled, the compiler just uses the most efficient instruction. in the previous example that might be a 32-bit load instruction โ€” even though that touches bytes that don't contain any portion of the bit-field, or memory-mapped registers unrelated to the one being updated. messy but fast, yk? ๐Ÿ’€

In some cases, like when the packed attribute is applied to a structure field, it might not be possible to access the field with a single read or write that's correctly aligned for the target machine. when that happens, GCC falls back to generating multiple accesses rather than code that'll 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. so it's recommended to define all bits of the field's type as bit-field members. periodt.

The default value of this option is determined by the application binary interface for the target processor. (iykyk โ€” it's an ABI thing.)


โœจ -fsync-libcalls โœจ

This option controls whether any out-of-line instance of the __sync family of functions may be used to implement the C++11 __atomic family of functions. ๐Ÿฆ‹

The default value is enabled, so the only useful form of the option is -fno-sync-libcalls. This option is used in the implementation of the libatomic runtime library. slay, libatomic.


๐Ÿ’– GCC Developer Options ๐Ÿ’–

This section describes command-line options that are primarily of interest to GCC developers โ€” the compiler girlies who write the compiler, not just use it. This includes options to support compiler testing and investigation of compiler bugs and compile-time performance problems.

Specifically it covers:

  • options that produce debug dumps at various points in the compilation
  • options that print statistics like memory use and execution time
  • options that print info about GCC's configuration, like where it searches for libraries
Real talk: you should rarely need any of these for ordinary compilation and linking tasks. these are the backstage-pass options. ๐ŸŽŸ๏ธ

dump files, explained (the =filename thing) ๐Ÿงš

Many developer options that make GCC dump output to a file take an optional =filename suffix. You can specify stdout or - to dump to standard output, and stderr for standard error. ๐Ÿ“ค

If =filename is omitted, a default dump file name gets constructed by concatenating:

  1. the base dump file name,
  2. a pass number,
  3. a phase letter, and
  4. a pass name.

The base dump file name is the name of the output file produced by the compiler if it was explicitly specified and not an executable; otherwise it's 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 final, even if they're executed earlier. messy, I know. ๐Ÿ™ˆ

The phase letter is one of:

  • i โ€” inter-procedural analysis
  • l โ€” language-specific
  • r โ€” RTL
  • t โ€” tree

The files are created in the directory of the output file. cute and tidy. ๐ŸŽ€


โœจ -fcallgraph-info โœจ

โœจ -fcallgraph-info=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 you additionally specify a list of comma-separated markers. When the su marker is specified, the callgraph is decorated with stack usage information โ€” it's equivalent to -fstack-usage. When the da marker is specified, the callgraph is decorated with information about dynamically allocated objects. ๐ŸŒธ

When compiling with -flto, no callgraph information is output along with the object file. At LTO link time, -fcallgraph-info may generate multiple callgraph information files next to intermediate LTO output files. ngl that's a lil chaotic but that's the deal.


โœจ -dletters โœจ

โœจ -fdump-rtl-pass โœจ

โœจ -fdump-rtl-pass=filename โœจ

Says to make debugging dumps during compilation at times specified by letters. This is used for debugging the RTL-based passes of the compiler. ๐Ÿ”ฌ

Some -dletters switches have different meaning when -E is used for preprocessing. heads up.

Debug dumps can be enabled with a -fdump-rtl switch or some -d option letters. Here are the possible letters for use in pass and letters, and their meanings, bestie:

  • -fdump-rtl-alignments โ€” Dump after branch alignments have been computed.
  • -fdump-rtl-asmcons โ€” Dump after fixing rtl statements that have unsatisfied in/out constraints.
  • -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.
  • -fdump-rtl-barriers โ€” Dump after cleaning up the barrier instructions.
  • -fdump-rtl-bbpart โ€” Dump after partitioning hot and cold basic blocks.
  • -fdump-rtl-bbro โ€” Dump after block reordering.
  • -fdump-rtl-btl1, -fdump-rtl-btl2 โ€” -fdump-rtl-btl1 and -fdump-rtl-btl2 enable dumping after the two branch target load optimization passes.
  • -fdump-rtl-bypass โ€” Dump after jump bypassing and control flow optimizations.
  • -fdump-rtl-combine โ€” Dump after the RTL instruction combination pass.
  • -fdump-rtl-compgotos โ€” Dump after duplicating the computed gotos.
  • -fdump-rtl-ce1, -fdump-rtl-ce2, -fdump-rtl-ce3 โ€” -fdump-rtl-ce1, -fdump-rtl-ce2, and -fdump-rtl-ce3 enable dumping after the three if conversion passes.
  • -fdump-rtl-cprop_hardreg โ€” Dump after hard register copy propagation.
  • -fdump-rtl-csa โ€” Dump after combining stack adjustments.
  • -fdump-rtl-cse1, -fdump-rtl-cse2 โ€” -fdump-rtl-cse1 and -fdump-rtl-cse2 enable dumping after the two common subexpression elimination passes.
  • -fdump-rtl-dce โ€” Dump after the standalone dead code elimination passes.
  • -fdump-rtl-dbr โ€” Dump after delayed branch scheduling.
  • -fdump-rtl-dce1, -fdump-rtl-dce2 โ€” -fdump-rtl-dce1 and -fdump-rtl-dce2 enable dumping after the two dead store elimination passes.
  • -fdump-rtl-eh โ€” Dump after finalization of EH handling code.
  • -fdump-rtl-eh_ranges โ€” Dump after conversion of EH handling range regions.
  • -fdump-rtl-expand โ€” Dump after RTL generation.
  • -fdump-rtl-fwprop1, -fdump-rtl-fwprop2 โ€” -fdump-rtl-fwprop1 and -fdump-rtl-fwprop2 enable dumping after the two forward propagation passes.
  • -fdump-rtl-gcse1, -fdump-rtl-gcse2 โ€” -fdump-rtl-gcse1 and -fdump-rtl-gcse2 enable dumping after global common subexpression elimination.
  • -fdump-rtl-init-regs โ€” Dump after the initialization of the registers.
  • -fdump-rtl-initvals โ€” Dump after the computation of the initial value sets.
  • -fdump-rtl-into_cfglayout โ€” Dump after converting to cfglayout mode.
  • -fdump-rtl-ira โ€” Dump after iterated register allocation.
  • -fdump-rtl-jump โ€” Dump after the second jump optimization.
  • -fdump-rtl-loop2 โ€” -fdump-rtl-loop2 enables dumping after the rtl loop optimization passes.
  • -fdump-rtl-mach โ€” Dump after performing the machine dependent reorganization pass, if that pass exists.
  • -fdump-rtl-mode_sw โ€” Dump after removing redundant mode switches.
  • -fdump-rtl-rnreg โ€” Dump after register renumbering.
  • -fdump-rtl-outof_cfglayout โ€” Dump after converting from cfglayout mode.
  • -fdump-rtl-peephole2 โ€” Dump after the peephole pass.
  • -fdump-rtl-postreload โ€” Dump after post-reload optimizations.
  • -fdump-rtl-pro_and_epilogue โ€” Dump after generating the function prologues and epilogues.
  • -fdump-rtl-sched1, -fdump-rtl-sched2 โ€” -fdump-rtl-sched1 and -fdump-rtl-sched2 enable dumping after the basic block scheduling passes.
  • -fdump-rtl-ree โ€” Dump after sign/zero extension elimination.
  • -fdump-rtl-seqabstr โ€” Dump after common sequence discovery.
  • -fdump-rtl-shorten โ€” Dump after shortening branches.
  • -fdump-rtl-sibling โ€” Dump after sibling call optimizations.
  • -fdump-rtl-split1, -fdump-rtl-split2, -fdump-rtl-split3, -fdump-rtl-split4, -fdump-rtl-split5 โ€” These options enable dumping after five rounds of instruction splitting.
  • -fdump-rtl-sms โ€” Dump after modulo scheduling. This pass is only run on some architectures.
  • -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.
  • -fdump-rtl-subreg1, -fdump-rtl-subreg2 โ€” -fdump-rtl-subreg1 and -fdump-rtl-subreg2 enable dumping after the two subreg expansion passes.
  • -fdump-rtl-unshare โ€” Dump after all rtl has been unshared.
  • -fdump-rtl-vartrack โ€” Dump after variable tracking.
  • -fdump-rtl-vregs โ€” Dump after converting virtual registers to hard registers.
  • -fdump-rtl-web โ€” Dump after live range splitting.
  • -fdump-rtl-regclass, -fdump-rtl-subregs_of_mode_init, -fdump-rtl-subregs_of_mode_finish, -fdump-rtl-dfinit, -fdump-rtl-dfinish โ€” These dumps are defined but always produce empty files. ๐Ÿ’€ literally just vibes and nothing else.
  • -da, -fdump-rtl-all โ€” Produce all the dumps listed above. the whole menu, chef's kiss. ๐Ÿ‘‘

ok that's a whole lotta dumps and we're still going โ€” more coming, don't go anywhere bestie ๐Ÿซถ

  • -dA โ€” slaps annotations on the assembler output with all the miscellaneous debugging tea โ˜•โœจ
  • -dD โ€” dumps every macro definition at the end of preprocessing, on top of the normal output. like, everything, bestie ๐Ÿ’…
  • -dH โ€” produces a core dump whenever an error occurs. yes fr, on purpose ๐Ÿ™ˆ
  • -dp โ€” annotates the assembler output with a comment saying which pattern and alternative got used, plus prints the length and cost of every instruction ๐Ÿ”
  • -dP โ€” dumps the RTL in the assembler output as a comment before each instruction. also flips on -dp annotation while it's at it โœจ
  • -dx โ€” just generates RTL for a function instead of actually compiling it. usually chills with -fdump-rtl-expand ๐Ÿซถ

  • -fdump-debug โ€” dumps the debugging info that got generated during the debug generation phase ๐Ÿ›
  • -fdump-earlydebug โ€” dumps the debugging info that got generated during the early debug generation phase ๐ŸŒ…
  • -fdump-noaddr โ€” when it's doing debugging dumps, suppresses address output. this makes it way more feasible to run diff on debugging dumps for compiler invocations that use different compiler binaries and/or different text / bss / data / heap / stack / dso start locations. iconic for comparing stuff ๐Ÿ‘‘
  • -freport-bug โ€” collects and dumps debug information into a temporary file if an internal compiler error (ICE) happens. so if it crashes, you've got receipts ๐Ÿ’€
  • -fdump-unnumbered โ€” when doing debugging dumps, suppresses instruction numbers and address output. makes running diff on debugging dumps for compiler invocations with different options way more feasible โ€” especially with and without -g ๐ŸŒˆ
  • -fdump-unnumbered-links โ€” when doing debugging dumps (peep the -d option up above), suppresses instruction numbers for the links to the previous and next instructions in a sequence ๐Ÿ”—
  • -fdump-ipa-switch
  • -fdump-ipa-switch-options โ€” controls the dumping at various stages of inter-procedural analysis language tree to a file ๐Ÿ“‚ the file name gets generated by appending a switch-specific suffix to the source file name, and the file gets created in the same directory as the output file. the dumps you can get are:
    • all โ€” enables all inter-procedural analysis dumps. all of them. the whole buffet ๐Ÿ“
    • cgraph โ€” dumps info about call-graph optimization, unused function removal, and inlining decisions.
    • inline โ€” dump after function inlining.
    • strubm โ€” dump after selecting "strub" modes, and recording the selections as function attributes.
    • strub โ€” dump "strub" transformations: interface changes, function wrapping, and insertion of builtin calls for stack scrubbing and watermarking.

on top of that, the options -optimized, -missed, -note, and -all can be provided, with the same meaning as for -fopt-info, and they default to -optimized โœจ

for example, -fdump-ipa-inline-optimized-missed will emit information on callsites that were inlined, along with callsites that were not inlined. snitching on both sides fr ๐Ÿ‘€

by default, the dump will contain messages about successful optimizations (equivalent to -optimized) together with low-level details about the analysis.

  • -fdump-ipa-clones โ€” creates a dump file with info about the creation of call graph node clones and the removals of call graph nodes during inter-procedural optimizations and transformations ๐Ÿงฌ its main intended use is so that tools that create live-patches can figure out the set of functions that need to be live-patched to completely replace a particular function (see -flive-patching). the file name gets generated by appending the suffix "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:

  1. String "Callgraph clone".
  2. Name of the function being cloned as it is presented to the assembler.
  3. 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.
  4. The file name of the source file where the function is defined.
  5. The line on which the function definition is located.
  6. The column where the function definition is located.
  7. Name of the new function clone as it is presented to the assembler.
  8. 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.
  9. The file name of the source file where the source code location of the new clone points to.
  10. The line to which the source code location of the new clone points to.
  11. The column to which the source code location of the new clone points to.
  12. A string that determines the reason for cloning.

in the case of call graph clone removal, the individual fields are:

  1. String "Callgraph removal".
  2. Name of the function being removed as it would be presented to the assembler.
  3. 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.
  4. The file name of the source file where the function is defined.
  5. The line on which the function definition is located.
  6. The column where the function definition is located.
  • -fdump-lang โ€” dumps language-specific information ๐ŸŒ the file name is made by appending .lang to the source file name.
  • -fdump-lang-all
  • -fdump-lang-switch
  • -fdump-lang-switch-options
  • -fdump-lang-switch-options=filename โ€” controls the dumping of language-specific information. the options and filename portions behave exactly as described in the -fdump-tree option. the switch values it accepts are:
    • all โ€” enable all language-specific dumps.
    • class โ€” dump class hierarchy information. virtual table information is emitted unless 'slim' is specified. this option is applicable to C++ only.
    • module โ€” dump module information. options lineno (locations), graph (reachability), blocks (clusters), uid (serialization), alias (mergeable), asmname (Elrond), eh (mapper) & vops (macros) may provide additional information. this option is applicable to C++ only.
    • raw โ€” dump the raw internal tree data. this option is applicable to C++ only.
  • -fdump-passes โ€” prints the list of optimization passes that are turned on and off by the current command-line options, right there on stderr ๐Ÿ‘€
  • -fdump-statistics-option โ€” enables and controls dumping of pass statistics into a separate file ๐Ÿ“Š the file name is generated by appending a suffix ending in .statistics to the source file name, and the file is created in the same directory as the output file. if the -option form is used, -stats causes counters to be summed over the whole compilation unit, while -details dumps every event as the passes generate them. the default with no option is to sum counters for each function compiled.
  • -fdump-tree-all
  • -fdump-tree-switch
  • -fdump-tree-switch-options
  • -fdump-tree-switch-options=filename โ€” controls the dumping at various stages of processing the intermediate language tree to a file ๐ŸŒณ if the -options form is used, options is a list of - separated options which control the details of the dump. not all options are applicable to all dumps โ€” the ones that aren't meaningful just get ignored, no hard feelings ๐Ÿ’… the following options are available:
    • address โ€” print the address of each node. usually this is not meaningful since it changes according to the environment and source file. its primary use is for tying up a dump file with a debug environment.
    • asmname โ€” if "DECL_ASSEMBLER_NAME" has been set for a given decl, use that in the dump instead of "DECL_NAME". its primary use is ease of use working backward from mangled names in the assembly file.
    • slim โ€” when dumping front-end intermediate representations, inhibits 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.
    • raw โ€” print a raw representation of the tree. by default, trees are pretty-printed into a C-like representation.
    • details โ€” enable more detailed dumps (not honored by every dump option). also includes information from the optimization passes.
    • stats โ€” enable dumping various statistics about the pass (not honored by every dump option).
    • blocks โ€” enable showing basic block boundaries (disabled in raw dumps).
    • graph โ€” for each of the other indicated dump files (-fdump-rtl-pass), dump a representation of the control flow graph suitable for viewing with GraphViz to file.passid.pass.dot. each function in the file is pretty-printed as a subgraph, so that GraphViz can render them all in a single plot. this option currently only works for RTL dumps, and the RTL is always dumped in slim form ๐Ÿ“ˆ
    • vops โ€” enable showing virtual operands for every statement.
    • lineno โ€” enable showing line numbers for statements.
    • uid โ€” enable showing the unique ID ("DECL_UID") for each variable.
    • verbose โ€” enable showing the tree dump for each statement.
    • eh โ€” enable showing the EH region number holding each statement.
    • scev โ€” enable showing scalar evolution analysis details.
    • optimized โ€” enable showing optimization information (only available in certain passes).
    • missed โ€” enable showing missed optimization information (only available in certain passes).
    • note โ€” enable other detailed optimization information (only available in certain passes).
  • all โ€” turn on all the options, except raw, slim, verbose and lineno. not those four, bestie, they're on their own vibe ๐Ÿ’…
  • optall โ€” turn on all the optimization options, i.e. optimized, missed, and note. so like, the whole optimization glow-up โœจ

So to figure out what tree dumps are even available, or to hunt down the dump for a pass you're obsessed with, just follow these steps, okay? ๐Ÿ‘‘

  1. Invoke GCC with -fdump-passes and in the stderr output look for a code that corresponds to the pass you are interested in. For example, the codes "tree-evrp", "tree-vrp1", and "tree-vrp2" correspond to the three Value Range Propagation passes. The number at the end distinguishes distinct invocations of the same pass. so tree-vrp1 and tree-vrp2 are literally the same pass running at different times, the number is how you tell them apart ๐Ÿซถ
  2. To enable the creation of the dump file, append the pass code to the -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 -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. ๐Ÿ’–
  3. 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 t for tree passes (and the letter r for RTL passes), and finally the pass code. For example, the Early VRP pass dump might be in a file named 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. so yeah, 038 today might be something else tomorrow, do not hardcode that number, i am begging ๐Ÿ˜ญ

  • -fopt-info, -fopt-info-options, -fopt-info-options=filename โ€” controls optimization dumps from various optimization passes. If the -options form is used, options is a list of - separated option keywords to select the dump details and optimizations. hyphen-separated, bestie, not comma, not underscore ๐Ÿ’…

The options can be divided into three groups:

  1. options describing what kinds of messages should be emitted,
  2. options describing the verbosity of the dump, and
  3. options describing which optimizations should be included.

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. last one wins, classic ๐ŸŽ€

The following options control which kinds of messages should be emitted:

  • 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. ๐Ÿฆ‹
  • missed โ€” print information about missed optimizations. Individual passes control which information to include in the output. the "aw girl you almost had it" report ๐Ÿ˜ญ
  • note โ€” print verbose information about optimizations, such as certain transformations, more detailed messages about decisions etc.
  • all โ€” print detailed optimization information. This includes optimized, missed, and note. the full tea โ˜•

The following option controls the dump verbosity:

  • 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. GCC devs only, no cap ๐Ÿ™ˆ

One or more of the following option keywords can be used to describe a group of optimizations:

  • ipa โ€” enable dumps from all interprocedural optimizations.
  • loop โ€” enable dumps from all loop optimizations. ๐ŸŒ€
  • inline โ€” enable dumps from all inlining optimizations.
  • omp โ€” enable dumps from all OMP (Offloading and Multi Processing) optimizations.
  • vec โ€” enable dumps from all vectorization optimizations. โญ
  • optall โ€” enable dumps from all optimizations. This is a superset of the optimization groups listed above. the upgrade package, includes everything ๐Ÿ‘‘

If options is omitted, it defaults to optimized-optall, which means to dump messages about successful optimizations from all the passes, omitting messages that are treated as "internals".

If the filename is provided, then the dumps from all the applicable optimizations are concatenated into the filename. Otherwise the dump is output onto stderr. Though multiple -fopt-info options are accepted, only one of them can include a filename. If other filenames are provided then all but the first such option are ignored. one filename only, the rest get ghosted ๐Ÿ’€

Note that the output filename is overwritten in case of multiple translation units. If a combined output from multiple translation units is desired, stderr should be used instead. so if you compile a bunch of TUs, the file gets clobbered each time, pls use stderr if you want them all together ๐Ÿซถ

In the following example, the optimization info is output to stderr:

gcc -O3 -fopt-info

This example:

gcc -O3 -fopt-info-missed=missed.all

outputs missed optimization report from all the passes into missed.all, and this one:

gcc -O2 -ftree-vectorize -fopt-info-vec-missed

prints information about missed optimization opportunities from vectorization passes on stderr. Note that -fopt-info-vec-missed is equivalent to -fopt-info-missed-vec. The order of the optimization group names and message types listed after -fopt-info does not matter. order? irrelevant, she doesn't care ๐Ÿ’…

As another example,

gcc -O3 -fopt-info-inline-optimized-missed=inline.txt

outputs information about missed optimizations as well as optimized locations from all the inlining passes into inline.txt.

Finally, consider:

gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt

Here the two output filenames vec.miss and 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 vec.miss is produced which contains dumps from the vectorizer about missed opportunities. only the first one survives, the second one is literally not invited ๐Ÿ˜ญ


  • -fsave-optimization-record โ€” write a SRCFILE.opt-record.json.gz file detailing what optimizations were performed, for those optimizations that support -fopt-info. ๐Ÿ“
This option is experimental and the format of the data within the compressed JSON file is subject to change. EXPERIMENTAL. the format can change on you, do not build your whole toolchain on this without knowing that ๐Ÿ’€

It is roughly equivalent to a machine-readable version of -fopt-info-all, as a collection of messages with source file, line number and column number, with the following additional data for each message:

  • 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, ๐Ÿ”ฅ
  • the function name of the code being optimized, where applicable,
  • 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, the whole family tree of inlining, iconic
  • 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,
  • the GCC pass that emitted the message, and
  • the location in GCC's own code from which the message was emitted

Additionally, some messages are logically nested within other messages, reflecting implementation details of the optimization passes. nesting, like a little matryoshka of compiler tea ๐ŸŽ€


  • -fsched-verbose=n โ€” on targets that use instruction scheduling, this option controls the amount of debugging output the scheduler prints to the dump files. ๐Ÿ—‚๏ธ

For n greater than zero, -fsched-verbose outputs the same information as -fdump-rtl-sched1 and -fdump-rtl-sched2. For n greater than one, it also output basic block probabilities, detailed ready list information and unit/insn info. For n greater than two, it includes RTL at abort point, control-flow and regions info. And for n over four, -fsched-verbose also includes dependence info. so 0 < 1 < 2 < 3 < 5+, each level adds more, and yeah the manpage literally says "it also output", we keep the typos around here ๐Ÿซถ


  • -fenable-kind-pass, -fdisable-kind-pass=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.
DEBUGGING ONLY, bestie!! if you're just a normal compiler user, use the regular options, these are for the GCC devs poking at the internals ๐Ÿ”ง
  • -fdisable-ipa-pass โ€” disable IPA pass pass. 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.
  • -fdisable-rtl-pass, -fdisable-rtl-pass=range-list โ€” disable RTL pass pass. 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. 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 uid falls within one of the specified ranges, the pass is disabled for that function. The uid is shown in the function header of a dump file, and the pass names can be dumped by using option -fdump-passes. so 5:9 means 5 through 9, both ends included, and if you just want one function you can write the single number, no colon needed โœจ
  • -fdisable-tree-pass, -fdisable-tree-pass=range-list โ€” disable tree pass pass. See -fdisable-rtl for the description of option arguments.
  • -fenable-ipa-pass โ€” enable IPA pass pass. 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.
  • -fenable-rtl-pass, -fenable-rtl-pass=range-list โ€” enable RTL pass pass. See -fdisable-rtl for option argument description and examples.
  • -fenable-tree-pass, -fenable-tree-pass=range-list โ€” enable tree pass pass. See -fdisable-rtl for the description of option arguments.

Here are some examples showing uses of these options. ๐Ÿ“

# 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

  • -fchecking
  • -fchecking=n โ€” turns on the compiler's internal consistency checking. What it defaults to depends on how your compiler was built (its configuration), okay? And -fchecking=2 goes even further and turns on extra internal consistency checking that might actually affect code generation. ๐Ÿ‘€
  • -frandom-seed=string โ€” this hands GCC a seed to use instead of random numbers when it's making certain symbol names that have to be different in every single compiled file. It also drops unique stamps into coverage data files and the object files that produce them. Bestie, the reason you'd even want this: use -frandom-seed to get reproducibly identical object files. Slay. โœจ

The string can be either a number (decimal, octal or hex) or an arbitrary string โ€” and in that case it gets converted to a number by computing CRC32. Wild, I know.

Lowkey important: the string should be different for every file you compile. No reusing, no sharing. ๐Ÿ’…
  • -save-temps โ€” stores the usual "temporary" intermediate files permanently; they get named as auxiliary output files, as specified/described under -dumpbase and -dumpdir.

When you use it together with the -x command-line option, -save-temps is sensible enough to avoid overwriting an input source file that has the same extension as an intermediate file. Wanna get that corresponding intermediate file anyway? Rename the source file before using -save-temps. Easy. ๐ŸŽ€

  • -save-temps=cwd โ€” equivalent to -save-temps -dumpdir ./.
  • -save-temps=obj โ€” equivalent to -save-temps -dumpdir outdir/, where outdir/ is the directory of the output file you named after the -o option, including any directory separators. And if you didn't use -o at all? Then -save-temps=obj just behaves like -save-temps=cwd. โœจ
  • -time[=file] โ€” reports the CPU time taken by each subprocess in the compilation sequence. For C source files, that's the compiler proper and assembler (plus the linker, if linking is happening).

Without naming an output file, the output looks like this:

# cc1 0.12 0.01
# as 0.00 0.01

The first number on each line is the "user time" โ€” 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, no cap. โฑ๏ธ

With an output file named, the output is appended to that file and looks like this:

0.12 0.01 cc1 <options>
0.00 0.01 as <options>

So now the "user time" and "system time" get moved before the program name, and the options passed to the program are shown too โ€” so later you can tell what file was being compiled, and with which options. Iconic for debugging. ๐Ÿ‘‘

  • -fdump-final-insns[=file] โ€” dumps the final internal representation (RTL) to file. If the optional argument is omitted (or if file is .), the name of the dump file is determined by appending .gkd to the dump base name, see -dumpbase.
  • -fcompare-debug[=opts] โ€” if no error happens during compilation, it runs the compiler a second time, adding opts and -fcompare-debug-second to the arguments passed to that second compilation. It dumps the final internal representation in both compilations, and prints an error if they differ. Detective energy fr fr. ๐Ÿ•ต๏ธ

If the equal sign is omitted, the default -gtoggle is used.

The environment variable GCC_COMPARE_DEBUG, if it's defined, non-empty and nonzero, implicitly enables -fcompare-debug. And if GCC_COMPARE_DEBUG is defined to a string starting with a dash, then it's used for opts โ€” otherwise the default -gtoggle is used.

-fcompare-debug=, with the equal sign but without opts, is equivalent to -fno-compare-debug, which disables the dumping of the final representation and the second compilation โ€” preventing even GCC_COMPARE_DEBUG from taking effect.

To verify full coverage during -fcompare-debug testing, set GCC_COMPARE_DEBUG to say -fcompare-debug-not-overridden, which GCC rejects as an invalid option in any actual compilation (rather than preprocessing, assembly or linking). Want just a warning instead of a hard reject? Setting GCC_COMPARE_DEBUG to -w%n-fcompare-debug not overridden will do it. ๐Ÿ’…

  • -fcompare-debug-second โ€” this option is implicitly passed to the compiler for the second compilation requested by -fcompare-debug, along with options to silence warnings, and it omits 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 .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 first compilation to be skipped โ€” which makes it useful for little other than debugging the compiler proper. Not me saying that, the manual says it. ๐Ÿ™ˆ

  • -gtoggle โ€” turns off generation of debug info if leaving out this option generates it, or turns 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 you give it. It's mainly intended to be used with -fcompare-debug.
  • -fvar-tracking-assignments-toggle โ€” toggles -fvar-tracking-assignments, in the same way that -gtoggle toggles -g. Cute symmetry, honestly. โœจ
  • -Q โ€” makes the compiler print out each function name as it's compiled, and print some statistics about each pass when it finishes.
  • -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 -fdiagnostics-format=sarif-file or -fdiagnostics-format=sarif-stderr then the -ftime-report information is instead emitted in JSON form as part of SARIF output. Heads up though: 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. ๐Ÿซถ

  • -ftime-report-details โ€” records the time consumed by infrastructure parts separately for each pass.
  • -fira-verbose=n โ€” controls the verbosity of the dump file for the integrated register allocator. The default value is 5. And if the value n is greater or equal to 10, the dump output is sent to stderr using the same format as n minus 10. Math-y but make it fashion. ๐Ÿ’…
  • -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's meant to be useful to GCC developers when processing object files in LTO mode (via -flto).

Disabled by default.

  • -flto-report-wpa โ€” like -flto-report, but only prints for the WPA phase of link-time optimization.
  • -fmem-report โ€” makes the compiler print some statistics about permanent memory allocation when it finishes.
  • -fmem-report-wpa โ€” makes the compiler print some statistics about permanent memory allocation for the WPA phase only.
  • -fpre-ipa-mem-report
  • -fpost-ipa-mem-report โ€” makes the compiler print some statistics about permanent memory allocation before or after interprocedural optimization. โœจ
  • -fmultiflags โ€” this option enables multilib-aware "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 set up by compiler internals, by the target, or by builders at configure time.

Like "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 aren't ideal for their target environment โ€” whereas rebuilding the runtime libraries is usually not as easy or desirable. ๐Ÿ’…

Unlike "TFLAGS", the use of specs enables different flags to be selected for different multilibs. The way to accomplish that is to build with make TFLAGS=-fmultiflags, after configuring --with-specs=%{fmultiflags:...}.

This option is discarded by the driver once it's done processing driver self spec.

It's also useful to check that "TFLAGS" are being used to build all target libraries, by configuring a non-bootstrap compiler --with-specs='%{!fmultiflags:%emissing TFLAGS}' and building the compiler and target libraries. ๐ŸŽ€

  • -fprofile-report โ€” makes the compiler print some statistics about consistency of the (estimated) profile and effect of individual passes.
  • -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 .su to the auxname. auxname is generated from the name of the output file, if explicitly specified and it isn't an executable โ€” otherwise it's the basename of the source file. An entry is made up of three fields:
    • The name of the function.
    • A number of bytes.
    • One or more qualifiers: static, dynamic, bounded.

The qualifier 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 "dynamic" means the function is out here doing the most with the stack โ€” like, besides the static allocation we already talked about, it also makes stack adjustments inside the body of the function, for example to push/pop arguments around function calls. ๐Ÿ’… If the qualifier "bounded" is also present, then the amount of those 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 "bounded" is not there, then the amount of those adjustments is not bounded at compile time, and the second field only represents the bounded part. (so like, a partial answer, not the whole vibe check.)


  • -fstats โ€” Emit statistics about front-end processing at the end of the compilation. โœจ This option is supported only by the C++ front end, and ngl the info is generally only useful to the G++ development team. iykyk.
  • -fdbg-cnt-list โ€” Print the name and the counter upper bound for all debug counters. ๐Ÿ“‹
  • -fdbg-cnt=counter-value-list โ€” Set the internal debug counter lower and upper bound. counter-value-list is a comma-separated list of name:lower_bound1-upper_bound1 [:lower_bound2-upper_bound2...] tuples which sets the name of the counter and list of closed intervals. The lower_bound is optional and is zero initialized if not set. For example, with -fdbg-cnt=dce:2-4:10-11,tail_call:10, dbg_cnt(dce) returns true only for second, third, fourth, tenth and eleventh invocation. For dbg_cnt(tail_call) true is returned for first 10 invocations. ๐Ÿงฎ
  • -print-file-name=library โ€” Print the full absolute name of the library file 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. Periodt.
  • -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 GCC_EXEC_PREFIX. ๐Ÿ“‚
  • -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 ;, and each switch starts with an @ instead of the -, without spaces between multiple switches. This is supposed to ease shell processing. ๐Ÿš
  • -print-multi-os-directory โ€” Print the path to OS libraries for the selected multilib, relative to some lib subdirectory. If OS libraries are present in the lib subdirectory and no multilibs are used, this is usually just ., if OS libraries are present in libsuffix sibling directories this prints e.g. ../lib64, ../lib or ../lib32, or if OS libraries are present in lib/subdir subdirectories it prints e.g. amd64, sparcv9 or ev6. ๐Ÿ—บ๏ธ
  • -print-multiarch โ€” Print the path to OS libraries for the selected multiarch, relative to some lib subdirectory. ๐Ÿฆ‹
  • -print-prog-name=program โ€” Like -print-file-name, but searches for a program such as cpp. ๐Ÿ”
  • -print-libgcc-file-name โ€” Same as -print-file-name=libgcc.a.

This is useful when you use -nostdlib or -nodefaultlibs but you do want to link with libgcc.a. You can do:

gcc -nostdlib <files>... `gcc -print-libgcc-file-name`
  • -print-search-dirs โ€” Print the name of the configured installation directory and a list of program and library directories gcc searches โ€” and don't do anything else. ๐Ÿ”Ž

This is useful when gcc prints the error message installation problem, cannot exec cpp0: No such file or directory. To resolve this you either need to put cpp0 and the other compiler components where gcc expects to find them, or you can set the environment variable GCC_EXEC_PREFIX to the directory where you installed them. Don't forget the trailing /. โš ๏ธ (fr fr, the trailing slash is not optional, bestie.)

  • -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 --sysroot option, possibly with an extra suffix that depends on compilation options. If no target sysroot is specified, the option prints nothing. ๐Ÿ™ˆ
  • -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. ๐Ÿ’…
  • -dumpmachine โ€” Print the compiler's target machine (for example, i686-pc-linux-gnu) โ€” and don't do anything else. ๐Ÿ–จ๏ธ
  • -dumpversion โ€” Print the compiler version (for example, 3.0, 6.3.0 or 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). ๐Ÿ”ข
  • -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. โœจ
  • -dumpspecs โ€” Print the compiler's built-in specs โ€” and don't do anything else. (This is used when GCC itself is being built.) ๐Ÿ‘‘

๐ŸŒˆ Machine-Dependent 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. ๐Ÿ› ๏ธ By convention, the names of machine-specific options start with -m.

Some configurations of the compiler also support additional target-specific options, usually for compatibility with other compilers on the same platform. ๐Ÿค


๐Ÿงš AArch64 Options ๐Ÿงš

These options are defined for AArch64 implementations:

  • -mabi=name โ€” Generate code for the specified data model. Permissible values are ilp32 for SysV-like data model where int, long int and pointers are 32 bits, and 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. ๐Ÿšจ (do not mix, bestie, it's giving chaos.)

  • -mbig-endian โ€” Generate big-endian code. This is the default when GCC is configured for an aarch64_be-*-* target. ๐Ÿ˜
  • -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. ๐Ÿ™…โ™€๏ธ
  • -mlittle-endian โ€” Generate little-endian code. This is the default when GCC is configured for an aarch64-*-* but not an aarch64_be-*-* target. ๐Ÿญ
  • -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. ๐Ÿœ
  • -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. โœจ
  • -mcmodel=large โ€” Generate code for the large code model. This makes no assumptions about addresses and sizes of sections. Programs can be statically linked only. The -mcmodel=large option is incompatible with -mabi=ilp32, -fpic and -fPIC. ๐Ÿ’€ (pick one, you cannot have both.)
  • -mtp=name โ€” Specify the system register to use as a thread pointer. The valid values are tpidr_el0, tpidrro_el0, tpidr_el1, tpidr_el2, tpidr_el3. For backwards compatibility the aliases el0, el1, el2, el3 are also accepted. The default setting is 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. ๐Ÿงต
  • -mstrict-align, -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. ๐Ÿ“
  • -momit-leaf-frame-pointer, -mno-omit-leaf-frame-pointer โ€” Omit or keep the frame pointer in leaf functions. The former behavior is the default. ๐Ÿƒ
  • -mstack-protector-guard=guard, -mstack-protector-guard-reg=reg, -mstack-protector-guard-offset=offset โ€” Generate stack protection code using canary at guard. Supported locations are global for a global canary or sysreg for a canary in an appropriate system register. ๐Ÿค

With the latter choice the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=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. โš ๏ธ

  • -mtls-dialect=desc โ€” Use TLS descriptors as the thread-local storage mechanism for dynamic accesses of TLS variables. This is the default. ๐ŸŽ€
  • -mtls-dialect=traditional โ€” Use traditional TLS as the thread-local storage mechanism for dynamic accesses of TLS variables. ๐Ÿงถ
  • -mtls-size=size โ€” Specify bit size of immediate TLS offsets. Valid values are 12, 24, 32, 48. This option requires binutils 2.26 or newer. ๐Ÿ”ง
  • -mfix-cortex-a53-835769, -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. ๐Ÿฉน
  • -mfix-cortex-a53-843419, -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. ๐Ÿ”—
  • -mlow-precision-recip-sqrt, -mno-low-precision-recip-sqrt โ€” Enable or disable the reciprocal square root approximation. This option only has an effect if -ffast-math or -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. ๐ŸŽฏ
  • -mlow-precision-sqrt, -mno-low-precision-sqrt โ€” Enable or disable the square root approximation. This option only has an effect if -ffast-math or -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 -mlow-precision-recip-sqrt. ๐Ÿงฎ
  • -mlow-precision-div, -mno-low-precision-div โ€” turn the division approximation on or off. โš ๏ธ heads up bestie: this literally does nothing unless you also pass -ffast-math or -funsafe-math-optimizations. And when you do turn it on, it trades away precision โ€” division results get crunched down to about 16 bits for single precision and 32 bits for double precision. It's giving "fast but blurry" ๐Ÿ’…
  • -mtrack-speculation, -mno-track-speculation โ€” turn generation of extra code on/off that tracks speculative execution through conditional branches. That tracking state then gets used by the compiler when it expands calls to __builtin_speculation_safe_copy, so it can spit out a more efficient code sequence. ๐Ÿ•ต๏ธโœจ
  • -moutline-atomics, -mno-outline-atomics โ€” turn calls to out-of-line helpers on/off, the ones that implement atomic operations. These helpers figure out at runtime whether the LSE instructions from ARMv8.1-A are available; if they're not, they fall back to the load/store-exclusive instructions that live in the base ARMv8.0 ISA. ๐Ÿ”„

This option only even applies when you're compiling for the base ARMv8.0 instruction set. If you're on a later revision โ€” say -march=armv8.1-a or -march=armv8-a+lse โ€” the ARMv8.1-Atomics instructions get used directly. Same story with -mcpu= when the cpu you picked supports the lse feature. And fun fact: this option is on by default. ๐Ÿ‘‘

  • -march=name โ€” name the target architecture, and optionally tack on one or more feature modifiers. The shape is -march=arch{+[no]feature}*.

Here's the rundown of what arch values you're allowed to use and which features they turn on by default (no cap, this is the whole list ๐Ÿซถ):

  • armv8-a โ€” Architecture: Armv8-A โ€” Includes by default: +fp, +simd
  • armv8.1-a โ€” Architecture: Armv8.1-A โ€” Includes by default: armv8-a, +crc, +lse, +rdma
  • armv8.2-a โ€” Architecture: Armv8.2-A โ€” Includes by default: armv8.1-a
  • armv8.3-a โ€” Architecture: Armv8.3-A โ€” Includes by default: armv8.2-a, +pauth
  • armv8.4-a โ€” Architecture: Armv8.4-A โ€” Includes by default: armv8.3-a, +flagm, +fp16fml, +dotprod
  • armv8.5-a โ€” Architecture: Armv8.5-A โ€” Includes by default: armv8.4-a, +sb, +ssbs, +predres
  • armv8.6-a โ€” Architecture: Armv8.6-A โ€” Includes by default: armv8.5-a, +bf16, +i8mm
  • armv8.7-a โ€” Architecture: Armv8.7-A โ€” Includes by default: armv8.6-a, +ls64
  • armv8.8-a โ€” Architecture: Armv8.8-a โ€” Includes by default: armv8.7-a, +mops
  • armv8.9-a โ€” Architecture: Armv8.9-a โ€” Includes by default: armv8.8-a
  • armv9-a โ€” Architecture: Armv9-A โ€” Includes by default: armv8.5-a, +sve, +sve2
  • armv9.1-a โ€” Architecture: Armv9.1-A โ€” Includes by default: armv9-a, +bf16, +i8mm
  • armv9.2-a โ€” Architecture: Armv9.2-A โ€” Includes by default: armv9.1-a, +ls64
  • armv9.3-a โ€” Architecture: Armv9.3-A โ€” Includes by default: armv9.2-a, +mops
  • armv9.4-a โ€” Architecture: Armv9.4-A โ€” Includes by default: armv9.3-a
  • armv8-r โ€” Architecture: Armv8-R โ€” Includes by default: armv8-r

The value native is available on native AArch64 GNU/Linux and makes the compiler just grab whatever architecture the host system has. If the compiler can't recognize the host's architecture, this option does absolutely nothing. ๐Ÿ™ˆ

As for what feature values are allowed โ€” those are listed in the sub-section on aarch64-feature-modifiers,,-march and -mcpu Feature Modifiers. And if you specify conflicting feature modifiers? The right-most feature wins. Periodt.

GCC uses name to decide what kind of instructions it's allowed to emit when it generates assembly code. And if you specify -march without also giving -mtune or -mcpu, the code gets tuned to perform well across a whole range of target processors that implement that target architecture. ๐ŸŒˆ

  • -mtune=name โ€” name the target processor GCC should tune the performance of the code for. The permissible values are: generic, cortex-a35, cortex-a53, cortex-a55, cortex-a57, cortex-a72, cortex-a73, cortex-a75, cortex-a76, cortex-a76ae, cortex-a77, cortex-a65, cortex-a65ae, cortex-a34, cortex-a78, cortex-a78ae, cortex-a78c, ares, exynos-m1, emag, falkor, neoverse-512tvb, neoverse-e1, neoverse-n1, neoverse-n2, neoverse-n3, neoverse-v1, neoverse-v2, neoverse-v3, neoverse-v3ae, grace, qdf24xx, saphira, phecda, xgene1, vulcan, octeontx, octeontx81, octeontx83, octeontx2, octeontx2t98, octeontx2t96 octeontx2t93, octeontx2f95, octeontx2f95n, octeontx2f95mm, a64fx, fujitsu-monaka, thunderx, thunderxt88, thunderxt88p1, thunderxt81, tsv110, hip12, thunderxt83, thunderx2t99, thunderx3t110, zeus, cortex-a57.cortex-a53, cortex-a72.cortex-a53, cortex-a73.cortex-a35, cortex-a73.cortex-a53, cortex-a75.cortex-a55, cortex-a76.cortex-a55, cortex-r82, cortex-x1, cortex-x1c, cortex-x2, cortex-x3, cortex-x4, cortex-x925, cortex-a510, cortex-a520, cortex-a710, cortex-a715, cortex-a720, cortex-a725, ampere1, ampere1a, ampere1b, cobalt-100 and native.

The values cortex-a57.cortex-a53, cortex-a72.cortex-a53, cortex-a73.cortex-a35, cortex-a73.cortex-a53, cortex-a75.cortex-a55, cortex-a76.cortex-a55 mean GCC should tune for a big.LITTLE system. ๐Ÿ™๏ธ๐ŸŒ†

The value neoverse-512tvb means 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 โ€” and I'm quoting the vibe here โ€” 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 one specific core like Neoverse V1, but more specific than the default tuning described below. ๐ŸŽฏ

Also, on native AArch64 GNU/Linux systems, the value native tunes performance to the host system. If the compiler can't recognize the host system's processor, this option does nothing.

And where none of -mtune=, -mcpu= or -march= are specified, the code is tuned to perform well across a range of target processors.

โš ๏ธ One thing: this option cannot be suffixed by feature modifiers. Not even one. Sorry bestie. ๐Ÿ’…

  • -mcpu=name โ€” name the target processor, optionally suffixed with one or more feature modifiers. The shape is -mcpu=cpu{+[no]feature}*, and the permissible values for cpu are the exact same ones available for -mtune. The permissible values for feature are documented in the sub-section on aarch64-feature-modifiers,,-march and -mcpu Feature Modifiers. Conflicting feature modifiers? Right-most one wins, every time. โœจ

GCC uses name to figure out what kind of instructions it can emit when generating assembly code (as if by -march) and to determine the target processor to tune for performance (as if by -mtune). And if you use this option alongside -march or -mtune, those options take precedence over the appropriate part of this one. Teamwork, but with a hierarchy. ๐Ÿ‘‘

-mcpu=neoverse-512tvb is special โ€” it doesn't refer to one specific core, it refers to all Neoverse cores that (a) implement SVE and (b) have a total vector bandwidth of 512 bits a cycle. Unless it's overridden by -march, -mcpu=neoverse-512tvb generates code that can run on a Neoverse V1 core, since Neoverse V1 is the first Neoverse core with these properties. And unless it's overridden by -mtune, -mcpu=neoverse-512tvb tunes code in the same way as for -mtune=neoverse-512tvb. ๐Ÿฆ‹

  • -moverride=string โ€” override tuning decisions that the back-end made in response to a -mtune= switch. ๐Ÿšจ Real talk: the syntax, semantics, and accepted values for string here are not guaranteed to be consistent across releases.
This option is only intended to be useful when you're developing GCC. It is not for you, casual user. It is for the compiler devs. ๐Ÿ™ˆ
  • -mverbose-cost-dump โ€” enable verbose cost model dumping in the debug dump files. This option exists for debugging the compiler. ๐Ÿ”
  • -mpc-relative-literal-loads, -mno-pc-relative-literal-loads โ€” turn PC-relative literal loads on/off. With this on, literal pools get accessed using a single instruction and are emitted after each function. That limits the maximum size of functions to 1MB. This is enabled by default for -mcmodel=tiny. ๐Ÿ“
  • -msign-return-address=scope โ€” pick the function scope that return address signing applies to. The permissible values are none, which disables return address signing entirely, non-leaf, which enables pointer signing for functions that are not leaf functions, and all, which enables pointer signing for all functions. Default value is none. โš ๏ธ Heads up: this option has been deprecated by -mbranch-protection.
  • -mbranch-protection=none|standard|pac-ret[+leaf+b-key]|bti โ€” pick which branch protection features to use. ๐Ÿ›ก๏ธ
    • none is the default and turns off all types of branch protection.
    • standard turns on all types of branch protection features. If a feature has additional tuning options, then standard sets it to its standard level.
    • pac-ret[+leaf] turns on return address signing to its standard level: signing functions that save the return address to memory (non-leaf functions will practically always do this) using the a-key. The optional argument leaf extends the signing to include leaf functions too. The optional argument b-key signs the functions with the B-key instead of the A-key.
    • bti turns on the branch target identification mechanism.
  • -mharden-sls=opts โ€” enable compiler hardening against straight line speculation (SLS). opts is a comma-separated list of these options:
retbr
blr

Plus, -mharden-sls=all enables all SLS hardening, while -mharden-sls=none disables all SLS hardening. ๐Ÿ”ฅ

  • -mearly-ra=scope โ€” decide 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, like SME2's strided LD1 and ST1. ๐Ÿงš

The possible values of scope are: all, which runs the pass on all functions; strided, which runs the pass on functions that have access to strided multi-register instructions; and none, which disables the pass.

-mearly-ra=all is the default for -O2 and above, and for -Os. -mearly-ra=none is the default otherwise. โœจ

  • -mearly-ldp-fusion โ€” enable the copy of the AArch64 load/store pair fusion pass that runs before register allocation. Enabled by default at -O and above. ๐Ÿ‘‘
  • -mlate-ldp-fusion โ€” enable the copy of the AArch64 load/store pair fusion pass that runs after register allocation. Enabled by default at -O and above. ๐Ÿ’…
  • -msve-vector-bits=bits โ€” specify the number of bits in an SVE vector register. This option only has an effect when SVE is enabled. ๐ŸŒธ

GCC's got two whole flavors of SVE code generation, bestie: vector-length agnostic output that works with literally any size of vector register, and vector-length specific output that lets GCC make assumptions about the vector length when that's actually useful for optimization reasons. โœจ

So the possible values of bits are: scalable, 128, 256, 512, 1024 and 2048. Specifying scalable selects vector-length agnostic output. At present -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 scalable should be relied on for producing code that is portable across different hardware SVE vector lengths. Like, fr fr, don't build your whole life on 256 okay? ๐Ÿ˜ญ

The default is -msve-vector-bits=scalable, which produces vector-length agnostic code. ๐Ÿ’…


๐ŸŒˆ -march and -mcpu Feature Modifiers ๐ŸŒˆ

Feature modifiers used with -march and -mcpu can be any of the following, and their inverses nofeature (so like, crc has nocrc, you get the vibe ๐Ÿ˜Œ):

  • crc โ€” Enable CRC extension. This is on by default for -march=armv8.1-a.
  • crypto โ€” Enable Crypto extension. This also enables Advanced SIMD and floating-point instructions.
  • fp โ€” Enable floating-point instructions. This is on by default for all possible values for options -march and -mcpu.
  • simd โ€” Enable Advanced SIMD instructions. This also enables floating-point instructions. This is on by default for all possible values for options -march and -mcpu.
  • sve โ€” Enable Scalable Vector Extension instructions. This also enables Advanced SIMD and floating-point instructions.
  • lse โ€” Enable Large System Extension instructions. This is on by default for -march=armv8.1-a.
  • rdma โ€” Enable Round Double Multiply Accumulate instructions. This is on by default for -march=armv8.1-a.
  • fp16 โ€” Enable FP16 extension. This also enables floating-point instructions.
  • fp16fml โ€” Enable FP16 fmla extension. This also enables FP16 extensions and floating-point instructions. This option is enabled by default for -march=armv8.4-a. Use of this option with architectures prior to Armv8.2-A is not supported.
  • 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.
  • dotprod โ€” Enable the Dot Product extension. This also enables Advanced SIMD instructions.
  • aes โ€” Enable the Armv8-a aes and pmull crypto extension. This also enables Advanced SIMD instructions.
  • sha2 โ€” Enable the Armv8-a sha2 crypto extension. This also enables Advanced SIMD instructions.
  • 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.
  • 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.
  • profile โ€” Enable the Statistical Profiling extension. This option is only to enable the extension at the assembler level and does not affect code generation.
  • 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.
  • memtag โ€” Enable the Armv8.5-a Memory Tagging Extensions. Use of this option with architectures prior to Armv8.5-A is not supported.
  • 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 -march=armv8.5-a.
  • 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 -march=armv8.5-a.
  • 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 -march=armv8.5-a.
  • sve2 โ€” Enable the Armv8-a Scalable Vector Extension 2. This also enables SVE instructions.
  • sve2-bitperm โ€” Enable SVE2 bitperm instructions. This also enables SVE2 instructions.
  • sve2-sm4 โ€” Enable SVE2 sm4 instructions. This also enables SVE2 instructions.
  • sve2-aes โ€” Enable SVE2 aes instructions. This also enables SVE2 instructions.
  • sve2-sha3 โ€” Enable SVE2 sha3 instructions. This also enables SVE2 instructions.
  • tme โ€” Enable the Transactional Memory Extension.
  • i8mm โ€” Enable 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions. This option is enabled by default for -march=armv8.6-a. Use of this option with architectures prior to Armv8.2-A is not supported.
  • 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.
  • 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.
  • bf16 โ€” Enable brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions. This option is enabled by default for -march=armv8.6-a. Use of this option with architectures prior to Armv8.2-A is not supported.
  • ls64 โ€” Enable the 64-byte atomic load and store instructions for accelerators. This option is enabled by default for -march=armv8.7-a.
  • mops โ€” Enable the instructions to accelerate memory operations like memcpy, memmove, memset. This option is enabled by default for -march=armv8.8-a
  • flagm โ€” Enable the Flag Manipulation instructions Extension.
  • pauth โ€” Enable the Pointer Authentication Extension.
  • cssc โ€” Enable the Common Short Sequence Compression instructions.
  • sme โ€” Enable the Scalable Matrix Extension.
  • sme-i16i64 โ€” Enable the FEAT_SME_I16I64 extension to SME.
  • sme-f64f64 โ€” Enable the FEAT_SME_F64F64 extension to SME.
+@item sme2 Enable the Scalable Matrix Extension 2.  This also enables SME instructions.
  • lse128 โ€” Enable the LSE128 128-bit atomic instructions extension. This also enables LSE instructions.
  • d128 โ€” Enable support for 128-bit system register read/write instructions. This also enables the LSE128 extension.
  • gcs โ€” Enable support for Armv9.4-a Guarded Control Stack extension.
  • the โ€” Enable support for Armv8.9-a/9.4-a translation hardening extension.
  • rcpc3 โ€” Enable the RCpc3 (Release Consistency) extension.

Feature crypto implies aes, sha2, and simd, which implies fp. Conversely, nofp implies nosimd, which implies nocrypto, noaes and nosha2. ๐Ÿฆ‹ It's giving chain reaction, iykyk.


๐Ÿงš Adapteva Epiphany Options ๐Ÿงš

These -m options are defined for Adapteva Epiphany:

  • -mhalf-reg-file โ€” Don't allocate any register in the range r32...r63. That allows code to run on hardware variants that lack these registers.
  • -mprefer-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. ๐Ÿ™ˆ
  • *-mbranch-cost=num* โ€” Set the cost of branches to roughly num "simple" instructions. This cost is only a heuristic and is not guaranteed to produce consistent results across releases.
  • -mcmove โ€” Enable the generation of conditional moves.
  • *-mnops=num* โ€” Emit num NOPs before every other generated instruction.
  • -mno-soft-cmpsf โ€” For single-precision floating-point comparisons, emit an 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 -msoft-cmpsf, which uses slower, but IEEE-compliant, software comparisons. ๐Ÿ˜ญ
So like, speed vs. correctness, pick your fighter.
  • -mstack-offset=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 sp+0...sp+7 can be used by leaf functions without stack allocation. Values other than 8 or 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 --with-stack-offset=num* option. ๐Ÿ’…
  • -mno-round-nearest โ€” Make the scheduler assume that the rounding mode has been set to truncating. The default is -mround-nearest.
  • -mlong-calls โ€” If not otherwise specified by an attribute, assume all calls might be beyond the offset range of the b / bl instructions, and therefore load the function address into a register before performing a (otherwise direct) call. This is the default.
  • -mshort-calls โ€” If not otherwise specified by an attribute, assume all direct calls are in the range of the b / bl instructions, so use these instructions for direct calls. The default is -mlong-calls.
  • -msmall16 โ€” Assume addresses can be loaded as 16-bit unsigned values. This does not apply to function addresses for which -mlong-calls semantics are in effect.
  • *-mfp-mode=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. ๐ŸŒธ

mode can be set to one the following values:

  • caller โ€” honestly the chillest mode ๐Ÿซถ Any mode at function entry is valid, and it gets retained or restored when the function returns, and also when it calls other functions. It's giving "universal adapter" energy: perfect for compiling libraries or other compilation units you might wanna drop 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 of any extra mode switching that might be needed, compared with what you'd need with a more specific choice of prevailing FPU mode.
  • truncate โ€” this is the mode used for floating-point calculations with truncating rounding mode, i.e. round towards zero. That includes conversion from floating point to integer. no cap ๐Ÿ’…
  • round-nearest โ€” this is the mode used for floating-point calculations with round-to-nearest-or-even rounding mode.
  • int โ€” this is the mode used to perform integer calculations in the FPU, e.g. integer multiply, or integer multiply-and-accumulate.

The default is -mfp-mode=caller โœจ


  • -mno-split-lohi, -mno-postinc, -mno-postmodify โ€” code generation tweaks that disable, respectively, splitting of 32-bit loads, generation of post-increment addresses, and generation of post-modify addresses. The defaults are msplit-lohi, -mpost-inc, and -mpost-modify.
  • -mnovect-double โ€” change the preferred SIMD mode to SImode. The default is -mvect-double, which uses DImode as preferred SIMD mode.
  • -max-vect-align=num โ€” the maximum alignment for SIMD vector mode types. num may be 4 or 8. The default is 8. ๐Ÿ‘€ Heads up though: 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.
  • -msplit-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. ๐Ÿ’€ theory said slay, reality said no.
  • -m1reg-reg โ€” specify a register to hold the constant -1, which makes loading small negative constants and certain bitmasks faster. Allowable values for reg are r43 and r63, which specify use of that register as a fixed register, and none, which means that no register is used for this purpose. The default is -m1reg-none.

โœจ AMD GCN Options โœจ

These options are defined specifically for the AMD GCN port. ๐ŸŒˆ

  • -march=gpu, -mtune=gpu โ€” set architecture type or tuning for gpu. Supported values for gpu are:
    • fiji โ€” compile for GCN3 Fiji devices (gfx803). Support deprecated; availablility depends on how GCC has been configured, see --with-arch and --with-multilib-list. ๐Ÿ™ˆ
    • gfx900 โ€” compile for GCN5 Vega 10 devices (gfx900).
    • gfx906 โ€” compile for GCN5 Vega 20 devices (gfx906).
    • gfx908 โ€” compile for CDNA1 Instinct MI100 series devices (gfx908).
    • gfx90a โ€” compile for CDNA2 Instinct MI200 series devices (gfx90a).
    • gfx90c โ€” compile for GCN5 Vega 7 devices (gfx90c).
    • gfx1030 โ€” compile for RDNA2 gfx1030 devices (GFX10 series).
    • gfx1036 โ€” compile for RDNA2 gfx1036 devices (GFX10 series).
    • gfx1100 โ€” compile for RDNA3 gfx1100 devices (GFX11 series).
    • gfx1103 โ€” compile for RDNA3 gfx1103 devices (GFX11 series).
  • -msram-ecc=on, -msram-ecc=off, -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 any, for devices that support it.
  • -mstack-size=bytes โ€” specify how many bytes of stack space will be requested for each GPU thread (wave-front). โš ๏ธ Beware that there may be many threads and limited memory available. The size of the stack allocation may also have an impact on run-time performance. The default is 32KB when using OpenACC or OpenMP, and 1MB otherwise.
  • -mxnack=on, -mxnack=off, -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 -mxnack=any on devices that support Unified Shared Memory, and -mxnack=no otherwise.

โœจ ARC Options โœจ

The following options control the architecture variant for which code is being compiled: ๐Ÿฆ‹

  • -mbarrel-shifter โ€” generate instructions supported by barrel shifter. This is the default unless -mcpu=ARC601 or -mcpu=ARCEM is in effect.
  • -mjli-always โ€” force to call a function using jli_s instruction. This option is valid only for ARCv2 architecture.
  • -mcpu=cpu โ€” set architecture type, register usage, and instruction scheduling parameters for cpu. There are also shortcut alias options available for backward compatibility and convenience. Supported values for cpu are:
    • arc600 โ€” compile for ARC600. Aliases: -mA6, -mARC600.
    • arc601 โ€” compile for ARC601. Alias: -mARC601.
    • arc700 โ€” compile for ARC700. Aliases: -mA7, -mARC700. This is the default when configured with --with-cpu=arc700.
    • arcem โ€” compile for ARC EM.
    • archs โ€” compile for ARC HS.
    • em โ€” compile for ARC EM CPU with no hardware extensions.
    • em4 โ€” compile for ARC EM4 CPU.
    • em4_dmips โ€” compile for ARC EM4 DMIPS CPU.
    • em4_fpus โ€” compile for ARC EM4 DMIPS CPU with the single-precision floating-point extension.
    • em4_fpuda โ€” compile for ARC EM4 DMIPS CPU with single-precision floating-point and double assist instructions.
    • hs โ€” compile for ARC HS CPU with no hardware extensions except the atomic instructions.
    • hs34 โ€” compile for ARC HS34 CPU.
    • hs38 โ€” compile for ARC HS38 CPU.
    • hs38_linux โ€” compile for ARC HS38 CPU with all hardware extensions on.
    • hs4x โ€” compile for ARC HS4x CPU.
    • hs4xd โ€” compile for ARC HS4xD CPU.
    • hs4x_rel31 โ€” compile for ARC HS4x CPU release 3.10a.
    • arc600_norm โ€” compile for ARC 600 CPU with "norm" instructions enabled.
    • arc600_mul32x16 โ€” compile for ARC 600 CPU with "norm" and 32x16-bit multiply instructions enabled.
    • arc600_mul64 โ€” compile for ARC 600 CPU with "norm" and "mul64"-family instructions enabled.
    • arc601_norm โ€” compile for ARC 601 CPU with "norm" instructions enabled.
    • arc601_mul32x16 โ€” compile for ARC 601 CPU with "norm" and 32x16-bit multiply instructions enabled.
    • arc601_mul64 โ€” compile for ARC 601 CPU with "norm" and "mul64"-family instructions enabled.
    • nps400 โ€” compile for ARC 700 on NPS400 chip.
    • em_mini โ€” compile for ARC EM minimalist configuration featuring reduced register set.
  • -mdpfp, -mdpfp-compact โ€” generate double-precision FPX instructions, tuned for the compact implementation.
  • -mdpfp-fast โ€” generate double-precision FPX instructions, tuned for the fast implementation.
  • -mno-dpfp-lrsr โ€” disable "lr" and "sr" instructions from using FPX extension aux registers.
  • -mea โ€” generate extended arithmetic instructions. Currently only "divaw", "adds", "subs", and "sat16" are supported. Only valid for -mcpu=ARC700.
  • -mno-mpy โ€” do not generate "mpy"-family instructions for ARC700. This option is deprecated. ๐Ÿซ 
  • -mmul32x16 โ€” generate 32x16-bit multiply and multiply-accumulate instructions.
  • -mmul64 โ€” generate "mul64" and "mulu64" instructions. Only valid for -mcpu=ARC600.
  • -mnorm โ€” generate "norm" instructions. This is the default if -mcpu=ARC700 is in effect.
  • -mspfp, -mspfp-compact โ€” generate single-precision FPX instructions, tuned for the compact implementation.
  • -mspfp-fast โ€” generate single-precision FPX instructions, tuned for the fast implementation.
  • -msimd โ€” enable generation of ARC SIMD instructions via target-specific builtins. Only valid for -mcpu=ARC700.
  • -msoft-float โ€” this option is ignored; it is provided for compatibility purposes only. Software floating-point code is emitted by default, and this default can be overridden by FPX options; -mspfp, -mspfp-compact, or -mspfp-fast for single precision, and -mdpfp, -mdpfp-compact, or -mdpfp-fast for double precision.
  • -mswap โ€” generate "swap" instructions.
  • -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.
  • -mdiv-rem โ€” enable "div" and "rem" instructions for ARCv2 cores.
  • -mcode-density โ€” enable code density instructions for ARC EM. This option is on by default for ARC HS.
  • -mll64 โ€” enable double load/store operations for ARC HS cores.
  • -mtp-regno=regno โ€” specify thread pointer register number.
  • -mmpy-option=multo โ€” compile ARCv2 code with a multiplier design option. You can specify the option using either a string or numeric value for multo. wlh1 is the default value. The recognized values are:
    • 0, none โ€” no multiplier available.
    • 1, w โ€” 16x16 multiplier, fully pipelined. The following instructions are enabled: "mpyw" and "mpyuw".
    • 2, wlh1 โ€” 32x32 multiplier, fully pipelined (1 stage). The following instructions are additionally enabled: "mpy", "mpyu", "mpym", "mpymu", and "mpy_s".
    • 3, wlh2 โ€” 32x32 multiplier, fully pipelined (2 stages). The following instructions are additionally enabled: "mpy", "mpyu", "mpym", "mpymu", and "mpy_s".
    • 4, wlh3 โ€” two 16x16 multipliers, blocking, sequential. The following instructions are additionally enabled: "mpy", "mpyu", "mpym", "mpymu", and "mpy_s".
    • 5, wlh4 โ€” one 16x16 multiplier, blocking, sequential. The following instructions are additionally enabled: "mpy", "mpyu", "mpym", "mpymu", and "mpy_s".
  1. wlh5 โ€” one 32x4 multiplier, blocking, sequential. It also unlocks these instructions: mpy, mpyu, mpym, mpymu, and mpy_s.
  2. plus_dmpy โ€” ARC HS SIMD support. โœจ
  3. plus_macd โ€” ARC HS SIMD support. โœจ
  4. plus_qmacw โ€” ARC HS SIMD support. โœจ

Quick heads up bestie: this option is only available for ARCv2 cores. ๐Ÿซถ

  • -mfpu=fpu โ€” turns on support for specific floating-point hardware extensions for ARCv2 cores. Here's everything fpu can be:
    • fpus โ€” enables support for single-precision floating-point hardware extensions.
    • fpud โ€” enables support for double-precision floating-point hardware extensions. Single-precision comes along for the ride too. Not available for ARC EM.
    • fpuda โ€” enables support for double-precision floating-point hardware extensions using double-precision assist instructions. Single-precision floating-point is also enabled. This one is only available for ARC EM.
    • fpuda_div โ€” enables support for double-precision floating-point hardware extensions using double-precision assist instructions. Single-precision floating-point, square-root, and divide extensions are also enabled. Only available for ARC EM.
    • fpuda_fma โ€” enables support for double-precision floating-point hardware extensions using double-precision assist instructions. Single-precision floating-point and fused multiply and add hardware extensions are also enabled. Only available for ARC EM.
    • 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. Only available for ARC EM.
    • fpus_div โ€” enables support for single-precision floating-point, square-root and divide hardware extensions.
    • fpud_div โ€” enables support for double-precision floating-point, square-root and divide hardware extensions. This option includes option fpus_div. Not available for ARC EM.
    • fpus_fma โ€” enables support for single-precision floating-point and fused multiply and add hardware extensions.
    • fpud_fma โ€” enables support for double-precision floating-point and fused multiply and add hardware extensions. This option includes option fpus_fma. Not available for ARC EM.
    • fpus_all โ€” enables support for all single-precision floating-point hardware extensions.
    • fpud_all โ€” enables support for all single- and double-precision floating-point hardware extensions. Not available for ARC EM.
  • -mirq-ctrl-saved=register-range, blink, lp_count โ€” names the general-purpose registers that the processor automatically saves/restores on interrupt entry and exit. register-range is written as two registers separated by a dash. The register range always starts with "r0", and the upper limit is the "fp" register. blink and lp_count are optional. This option is only valid for ARC EM and ARC HS cores. ๐Ÿ’–
  • -mrgf-banked-regs=number โ€” sets how many registers get replicated into the second register bank on entry to a fast interrupt. Fast interrupts = interrupts with the highest priority level P0. These interrupts save only the PC and STATUS32 registers, so no memory transactions happen during the interrupt entry and exit sequences. Use this option when you're using fast interrupts in an ARC V2 family processor. Permitted values are 4, 8, 16, and 32.
  • -mlpc-width=width โ€” sets the width of the "lp_count" register. Valid values for 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's known that the "lp_count" register can hold the required loop-counter value. Depending on the width you specify, the compiler and run-time library might keep using the loop mechanism for various needs. This option defines macro "__ARC_LPC_WIDTH__" with the value of width.
  • -mrf16 โ€” tells the compiler to generate code for a 16-entry register file. This option defines the "__ARC_RF16__" preprocessor macro. ๐ŸŽ€
  • -mbranch-index โ€” enables use of "bi" or "bih" instructions to implement jump tables.

๐Ÿ“ฆ The following options are passed through to the assembler, and also define preprocessor macro symbols

  • -mdsp-packa โ€” passed down to the assembler to enable the DSP Pack A extensions. Also sets the preprocessor symbol "__Xdsp_packa". This option is deprecated. ๐Ÿ’€
  • -mdvbf โ€” passed down to the assembler to enable the dual Viterbi butterfly extension. Also sets the preprocessor symbol "__Xdvbf". This option is deprecated.
  • -mlock โ€” passed down to the assembler to enable the locked load/store conditional extension. Also sets the preprocessor symbol "__Xlock".
  • -mmac-d16 โ€” passed down to the assembler. Also sets the preprocessor symbol "__Xxmac_d16". This option is deprecated.
  • -mmac-24 โ€” passed down to the assembler. Also sets the preprocessor symbol "__Xxmac_24". This option is deprecated.
  • -mrtsc โ€” passed down to the assembler to enable the 64-bit time-stamp counter extension instruction. Also sets the preprocessor symbol "__Xrtsc". This option is deprecated.
  • -mswape โ€” passed down to the assembler to enable the swap byte ordering extension instruction. Also sets the preprocessor symbol "__Xswape".
  • -mtelephony โ€” passed down to the assembler to enable dual- and single-operand instructions for telephony. Also sets the preprocessor symbol "__Xtelephony". This option is deprecated.
  • -mxy โ€” passed down to the assembler to enable the XY memory extension. Also sets the preprocessor symbol "__Xxy".

โœ๏ธ The following options control how the assembly code is annotated

  • -misize โ€” annotate assembler instructions with estimated addresses.
  • -mannotate-align โ€” does literally nothing. Preserved for backward compatibility. ๐Ÿ™ˆ

๐Ÿ”— The following options are passed through to the linker

  • -marclinux โ€” passed through to the linker, to specify use of the "arclinux" emulation. This option is enabled by default in tool chains built for "arc-linux-uclibc" and "arceb-linux-uclibc" targets when profiling is not requested.
  • -marclinux_prof โ€” passed through to the linker, to specify use of the "arclinux_prof" emulation. This option is enabled by default in tool chains built for "arc-linux-uclibc" and "arceb-linux-uclibc" targets when profiling is requested.

๐Ÿง  The following options control the semantics of generated code

  • -mlong-calls โ€” generate calls as register indirect calls, which gives you access to the full 32-bit address range.
  • -mmedium-calls โ€” don't use less than a 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, so you get the 25-bit range instead of the 21-bit range you'd have with conditional branch-and-link. This is the default for tool chains built for "arc-linux-uclibc" and "arceb-linux-uclibc" targets.
  • -G num โ€” put definitions of externally-visible data in a small data section if that data is no bigger than num bytes. The default value of num is 4 for any ARC configuration, or 8 when we have double load/store operations.
  • -mno-sdata โ€” don't generate sdata references. This is the default for tool chains built for "arc-linux-uclibc" and "arceb-linux-uclibc" targets.
  • -mvolatile-cache โ€” use ordinarily cached memory accesses for volatile references. This is the default.
  • -mno-volatile-cache โ€” enable cache bypass for volatile references.

๐ŸŽ›๏ธ The following options fine tune code generation

  • -malign-call โ€” does nothing. Preserved for backward compatibility.
  • -mauto-modify-reg โ€” enable the use of pre/post modify with register displacement.
  • -mbbit-peephole โ€” does nothing. Preserved for backward compatibility.
  • -mno-brcc โ€” disables a target-specific pass in arc_reorg to generate compare-and-branch ("brcc") instructions. It has no effect on generation of these instructions driven by the combiner pass.
  • -mcase-vector-pcrel โ€” use PC-relative switch case tables to enable case table shortening. This is the default for -Os.
  • -mcompact-casesi โ€” enable compact "casesi" pattern. This is the default for -Os, and only available for ARCv1 cores. This option is deprecated.
  • -mno-cond-exec โ€” disable the ARCompact-specific pass that generates conditional execution instructions.

Okay so why does this pass even exist? Because of delay slot scheduling and interactions between operand numbers, literal sizes, instruction lengths, and the support for conditional execution, the target-independent pass for generating 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's 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 -mmedium-calls instead.

  • -mearly-cbranchsi โ€” enable pre-reload use of the "cbranchsi" pattern.
  • -mexpand-adddi โ€” expand "adddi3" and "subdi3" at RTL generation time into "add.f", "adc" etc. This option is deprecated.
  • -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. ๐Ÿ˜ญ
  • -mlra โ€” enable Local Register Allocation. This is still experimental for ARC, so by default the compiler uses standard reload (i.e. -mno-lra).
  • -mlra-priority-none โ€” don't indicate any priority for target registers.
  • -mlra-priority-compact โ€” tells the compiler the target registers r0..r3 / r12..r15 are high priority ๐Ÿ’…
  • -mlra-priority-noncompact โ€” opposite vibe, bestie: it lowers the priority of those same target registers r0..r3 / r12..r15 ๐Ÿซถ
  • -mmillicode โ€” okay so when you're optimizing for size (that's -Os), prologues and epilogues that gotta save or restore a whole pile of registers often get shortened by calling a special function in libgcc. That's called a millicode call โœจ but these calls can cause performance issues and/or linking issues if you're linking in a nonstandard way, so this option exists to turn millicode call generation on or off ๐Ÿ”ฅ
  • -mcode-density-frame โ€” lets the compiler emit enter and leave instructions. Heads up tho: these instructions are only valid for CPUs with the code-density feature โš ๏ธ
  • -mmixed-code โ€” literally does nothing ๐Ÿ™ˆ kept around purely for backward compatibility.
  • -mq-class โ€” this one is deprecated, no cap. Enables q instruction alternatives. It's the default for -Os.
  • -mRcq โ€” does nothing ๐Ÿ’€ preserved for backward compatibility.
  • -mRcw โ€” also does nothing ๐Ÿ’€ preserved for backward compatibility.
  • -msize-level=level โ€” fine-tune size optimization re: instruction lengths and alignment ๐ŸŽ€ the recognized values for level are:
    • 0 โ€” no size optimization. This level is deprecated and treated like 1.
    • 1 โ€” short instructions are used opportunistically.
    • 2 โ€” in addition, alignment of loops and of code after barriers are dropped.
    • 3 โ€” in addition, optional data alignment is dropped, and the option Os is enabled.

This defaults to 3 when -Os is in effect. Otherwise, when this isn't set, the behavior is equivalent to level 1 โœจ

  • -mtune=cpu โ€” sets instruction scheduling parameters for cpu, overriding anything implied by -mcpu= ๐Ÿ‘‘

Supported values for cpu are:

  • ARC600 โ€” tune for ARC600 CPU.
  • ARC601 โ€” tune for ARC601 CPU.
  • ARC700 โ€” tune for ARC700 CPU with standard multiplier block.
  • ARC700-xmac โ€” tune for ARC700 CPU with XMAC block.
  • ARC725D โ€” tune for ARC725D CPU.
  • ARC750D โ€” tune for ARC750D CPU.
  • core3 โ€” tune for ARCv2 core3 type CPU. This option enables usage of the dbnz instruction.
  • release31a โ€” tune for ARC4x release 3.10a.
  • -mmultcost=num โ€” the cost to assume for a multiply instruction, where 4 is equal to a normal instruction ๐Ÿ’…
  • -munalign-prob-threshold=probability โ€” does nothing ๐Ÿ™ˆ preserved for backward compatibility.

The following options are maintained for backward compatibility, but are now deprecated and will be removed in a future release ๐Ÿšจ:

  • -margonaut โ€” obsolete FPX.
  • -mbig-endian, -EB โ€” compile code for big-endian targets. Use of these options is now deprecated โš ๏ธ big-endian code is supported by configuring GCC to build arceb-elf32 and arceb-linux-uclibc targets, for which big endian is the default.
  • -mlittle-endian, -EL โ€” compile code for little-endian targets. Use of these options is now deprecated โš ๏ธ little-endian code is supported by configuring GCC to build arc-elf32 and arc-linux-uclibc targets, for which little endian is the default.
  • -mbarrel_shifter โ€” replaced by -mbarrel-shifter.
  • -mdpfp_compact โ€” replaced by -mdpfp-compact.
  • -mdpfp_fast โ€” replaced by -mdpfp-fast.
  • -mdsp_packa โ€” replaced by -mdsp-packa.
  • -mEA โ€” replaced by -mea.
  • -mmac_24 โ€” replaced by -mmac-24.
  • -mmac_d16 โ€” replaced by -mmac-d16.
  • -mspfp_compact โ€” replaced by -mspfp-compact.
  • -mspfp_fast โ€” replaced by -mspfp-fast.
  • -mtune=cpu โ€” the values arc600, arc601, arc700 and arc700-xmac for cpu are replaced by ARC600, ARC601, ARC700 and ARC700-xmac respectively.
  • -multcost=num โ€” replaced by -mmultcost.

๐ŸŒˆ ARM Options ๐ŸŒˆ

These -m options are defined for the ARM port ๐Ÿ’–

  • -mabi=name โ€” generate code for the specified ABI. Permissible values are: apcs-gnu, atpcs, aapcs, aapcs-linux and iwmmxt โœจ
  • -mapcs-frame โ€” generate a stack frame that's compliant with the ARM Procedure Call Standard for all functions, even if it's not strictly necessary for correct execution of the code. Specifying -fomit-frame-pointer alongside this option means stack frames won't be generated for leaf functions. The default is -mno-apcs-frame. Heads up: this option is deprecated โš ๏ธ
  • -mapcs โ€” this is a synonym for -mapcs-frame and is deprecated ๐Ÿ™ˆ
  • -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 can't be reliably used inside one program. The default is -mno-thumb-interwork, since slightly larger code gets generated when -mthumb-interwork is specified. In AAPCS configurations this option is meaningless.
  • -mno-sched-prolog โ€” stops the reordering of instructions in the function prologue, and stops the merging of those instructions with the instructions in the function's body. Which means all functions start with a recognizable set of instructions (or actually one of a choice from a small set of different function prologues), and that info can be used to locate the start of functions inside an executable piece of code. The default is -msched-prolog ๐Ÿ’…
  • -mfloat-abi=name โ€” specifies which floating-point ABI to use. Permissible values are: soft, softfp and hard.
    • Specifying soft makes GCC generate output containing library calls for floating-point operations.
    • softfp allows generation of code using hardware floating-point instructions, but still uses the soft-float calling conventions.
    • 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.

  • -mgeneral-regs-only โ€” generate code which uses only the general-purpose registers. This prevents the compiler from using floating-point and Advanced SIMD registers, but it will not impose any restrictions on the assembler ๐ŸŽ€
  • -mlittle-endian โ€” generate code for a processor running in little-endian mode. This is the default for all standard configurations โœจ
  • -mbig-endian โ€” generate code for a processor running in big-endian mode; the default is to compile code for a little-endian processor.
  • -mbe8, -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 depends 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 โš ๏ธ
  • -march=name[+extension...] โ€” this specifies the name of the target ARM architecture. GCC uses this name to figure out what kind of instructions it can emit when generating assembly code. This option can be used in conjunction with, or instead of, the -mcpu= option ๐Ÿ‘‘

Permissible names are: armv4t, armv5t, armv5te, armv6, armv6j, armv6k, armv6kz, armv6t2, armv6z, armv6zk, armv7, armv7-a, armv7ve, armv8-a, armv8.1-a, armv8.2-a, armv8.3-a, armv8.4-a, armv8.5-a, armv8.6-a, armv9-a, armv7-r, armv8-r, armv6-m, armv6s-m, armv7-m, armv7e-m, armv8-m.base, armv8-m.main, armv8.1-m.main, armv9-a, iwmmxt and iwmmxt2.

Additionally, the following architectures, which lack support for the Thumb execution state, are recognized but support is deprecated: armv4.

Many of the architectures support extensions โœจ these can be added by appending +extension to the architecture name. Extension options are processed in order and capabilities accumulate. An extension will also enable any necessary base extensions it depends on. For example, the +crypto extension will always enable the +simd extension. The exception to the additive construction is for extensions prefixed with +no...: these disable the specified option and any other extensions that may depend on the presence of that extension.

For example, -march=armv7-a+simd+nofp+vfpv4 is equivalent to writing -march=armv7-a+vfpv4 since the +simd option is entirely disabled by the +nofp option that follows it ๐Ÿ’…

Most extension names are generically named, but have an effect that depends on the architecture to which they're applied. For example, the +simd option can be applied to both armv7-a and armv8-a architectures, but will enable the original ARMv7-A Advanced SIMD (Neon) extensions for armv7-a and the ARMv8-A variant for armv8-a ๐Ÿฆ‹

The table below lists the supported extensions for each architecture. Architectures not mentioned do not support any extensions.

  • armv5te
  • armv6
  • armv6j
  • armv6k
  • armv6kz
  • armv6t2
  • armv6z
  • armv6zk
    • +fp โ€” the VFPv2 floating-point instructions. The extension +vfpv2 can be used as an alias for this extension.
    • +nofp โ€” disable the floating-point instructions.
  • armv7

The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.

  • +fp โ€” the VFPv3 floating-point instructions, with 16 double-precision registers. The extension +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.
  • +nofp โ€” disable the floating-point instructions.
  • armv7-a
    • +mp โ€” the multiprocessing extension.
    • +sec โ€” the security extension.
    • +fp โ€” the VFPv3 floating-point instructions, with 16 double-precision registers. The extension +vfpv3-d16 can be used as an alias for this extension.
    • +simd โ€” the Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions. The extensions +neon and +neon-vfpv3 can be used as aliases for this extension.

๐Ÿฆ‹ the fp/simd extension tea (cont.)

  • +vfpv3 โ€” the VFPv3 floating-point instructions, with 32 double-precision registers. bestie the registers really said double it up ๐Ÿ’…
  • +vfpv3-d16-fp16 โ€” VFPv3 floating-point instructions, 16 double-precision registers, plus the half-precision floating-point conversion operations. combo meal โœจ
  • +vfpv3-fp16 โ€” VFPv3 floating-point instructions, 32 double-precision registers, and the half-precision floating-point conversion operations.
  • +vfpv4-d16 โ€” VFPv4 floating-point instructions, with 16 double-precision registers.
  • +vfpv4 โ€” VFPv4 floating-point instructions, with 32 double-precision registers. upgraded era fr fr ๐Ÿ”ฅ
  • +neon-fp16 โ€” the Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with the half-precision floating-point conversion operations.
  • +neon-vfpv4 โ€” the Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions. iconic duo tbh ๐Ÿ‘‘
  • +nosimd โ€” Disable the Advanced SIMD instructions (does not disable floating point). not me taking away the neon but leaving the fp like it's nothing ๐Ÿ˜ญ
  • +nofp โ€” Disable the floating-point and Advanced SIMD instructions. full shutdown energy ๐Ÿ’€

armv7ve

the extended version of the ARMv7-A architecture with support for virtualization. it's giving main character architecture ๐Ÿซถ

  • +fp โ€” the VFPv4 floating-point instructions, with 16 double-precision registers. The extension +vfpv4-d16 can be used as an alias for this extension.
  • +simd โ€” the Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions. The extension +neon-vfpv4 can be used as an alias for this extension.
  • +vfpv3-d16 โ€” the VFPv3 floating-point instructions, with 16 double-precision registers.
  • +vfpv3 โ€” the VFPv3 floating-point instructions, with 32 double-precision registers.
  • +vfpv3-d16-fp16 โ€” the VFPv3 floating-point instructions, with 16 double-precision registers and the half-precision floating-point conversion operations.
  • +vfpv3-fp16 โ€” the VFPv3 floating-point instructions, with 32 double-precision registers and the half-precision floating-point conversion operations.
  • +vfpv4-d16 โ€” the VFPv4 floating-point instructions, with 16 double-precision registers.
  • +vfpv4 โ€” the VFPv4 floating-point instructions, with 32 double-precision registers.
  • +neon โ€” the Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions. The extension +neon-vfpv3 can be used as an alias for this extension. so many aliases, so little time ๐ŸŒธ
  • +neon-fp16 โ€” the Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with the half-precision floating-point conversion operations.
  • +nosimd โ€” Disable the Advanced SIMD instructions (does not disable floating point).
  • +nofp โ€” Disable the floating-point and Advanced SIMD instructions.

armv8-a

  • +crc โ€” the Cyclic Redundancy Check (CRC) instructions.
  • +simd โ€” the ARMv8-A Advanced SIMD and floating-point instructions.
  • +crypto โ€” the cryptographic instructions. ๐Ÿ”
  • +nocrypto โ€” Disable the cryptographic instructions.
  • +nofp โ€” Disable the floating-point, Advanced SIMD and cryptographic instructions. that's a triple takeaway, ngl ๐Ÿ˜ณ
  • +sb โ€” Speculation Barrier Instruction.
  • +predres โ€” Execution and Data Prediction Restriction Instructions.

armv8.1-a

  • +simd โ€” the ARMv8.1-A Advanced SIMD and floating-point instructions.
  • +crypto โ€” the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions.
  • +nocrypto โ€” Disable the cryptographic instructions.
  • +nofp โ€” Disable the floating-point, Advanced SIMD and cryptographic instructions.
  • +sb โ€” Speculation Barrier Instruction.
  • +predres โ€” Execution and Data Prediction Restriction Instructions.

armv8.2-a

armv8.3-a

heads up bestie, these two share the exact same list of extensions ๐Ÿ’–
  • +fp16 โ€” the half-precision floating-point data processing instructions. This also enables the Advanced SIMD and floating-point instructions.
  • +fp16fml โ€” the half-precision floating-point fmla extension. This also enables the half-precision floating-point extension and Advanced SIMD and floating-point instructions.
  • +simd โ€” the ARMv8.1-A Advanced SIMD and floating-point instructions.
  • +crypto โ€” the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions.
  • +dotprod โ€” Enable the Dot Product extension. This also enables Advanced SIMD instructions.
  • +nocrypto โ€” Disable the cryptographic extension.
  • +nofp โ€” Disable the floating-point, Advanced SIMD and cryptographic instructions.
  • +sb โ€” Speculation Barrier Instruction.
  • +predres โ€” Execution and Data Prediction Restriction Instructions.
  • +i8mm โ€” 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions.
  • +bf16 โ€” Brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions. brain instructions?? ok genius behavior ๐Ÿง โœจ

armv8.4-a

  • +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.
  • +simd โ€” the ARMv8.3-A Advanced SIMD and floating-point instructions as well as the Dot Product extension.
  • +crypto โ€” the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension.
  • +nocrypto โ€” Disable the cryptographic extension.
  • +nofp โ€” Disable the floating-point, Advanced SIMD and cryptographic instructions.
  • +sb โ€” Speculation Barrier Instruction.
  • +predres โ€” Execution and Data Prediction Restriction Instructions.
  • +i8mm โ€” 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions.
  • +bf16 โ€” Brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions.

armv8.5-a

  • +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.
  • +simd โ€” the ARMv8.3-A Advanced SIMD and floating-point instructions as well as the Dot Product extension.
  • +crypto โ€” the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension.
  • +nocrypto โ€” Disable the cryptographic extension.
  • +nofp โ€” Disable the floating-point, Advanced SIMD and cryptographic instructions.
  • +i8mm โ€” 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions.
  • +bf16 โ€” Brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions.

armv8.6-a

  • +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.
  • +simd โ€” the ARMv8.3-A Advanced SIMD and floating-point instructions as well as the Dot Product extension.
  • +crypto โ€” the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension.
  • +nocrypto โ€” Disable the cryptographic extension.
  • +nofp โ€” Disable the floating-point, Advanced SIMD and cryptographic instructions.
  • +i8mm โ€” 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions.
  • +bf16 โ€” Brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions.

armv7-r

  • +fp.sp โ€” the single-precision VFPv3 floating-point instructions. The extension +vfpv3xd can be used as an alias for this extension.
  • +fp โ€” the VFPv3 floating-point instructions with 16 double-precision registers. The extension +vfpv3-d16 can be used as an alias for this extension.
  • +vfpv3xd-d16-fp16 โ€” the single-precision VFPv3 floating-point instructions with 16 double-precision registers and the half-precision floating-point conversion operations.
  • +vfpv3-d16-fp16 โ€” the VFPv3 floating-point instructions with 16 double-precision registers and the half-precision floating-point conversion operations.
  • +nofp โ€” Disable the floating-point extension.
  • +idiv โ€” the ARM-state integer division instructions.
  • +noidiv โ€” Disable the ARM-state integer division extension. ok so you can turn integer division OFF again, wild but slay ๐Ÿ™ˆ

armv7e-m

  • +fp โ€” the single-precision VFPv4 floating-point instructions.
  • +fpv5 โ€” the single-precision FPv5 floating-point instructions โœจ
    • +fp.dp โ€” the single- and double-precision FPv5 floating-point instructions ๐Ÿ’ซ
    • +nofp โ€” disable the floating-point extensions ๐Ÿ™…โ€โ™€๏ธ
    • armv8.1-m.main
      • +dsp โ€” the DSP instructions ๐ŸŽ›๏ธ
      • +mve โ€” the M-Profile Vector Extension (MVE) integer instructions ๐Ÿ’ช
      • +mve.fp โ€” the M-Profile Vector Extension (MVE) integer and single precision floating-point instructions ๐Ÿงฎ
      • +fp โ€” the single-precision floating-point instructions โœจ
      • +fp.dp โ€” the single- and double-precision floating-point instructions ๐Ÿ’ซ
      • +nofp โ€” disable the floating-point extension ๐Ÿšซ
      • +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 ๐ŸŽ€
      • +pacbti โ€” enable the Pointer Authentication and Branch Target Identification Extension ๐Ÿ”
    • armv8-m.main
      • +dsp โ€” the DSP instructions ๐ŸŽ›๏ธ
      • +nodsp โ€” disable the DSP extension ๐Ÿšซ
      • +fp โ€” the single-precision floating-point instructions โœจ
      • +fp.dp โ€” the single- and double-precision floating-point instructions ๐Ÿ’ซ
      • +nofp โ€” disable the floating-point extension ๐Ÿšซ
      • +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 ๐ŸŽ€
    • armv8-r
      • +crc โ€” the Cyclic Redundancy Check (CRC) instructions โœ…
      • +fp.sp โ€” the single-precision FPv5 floating-point instructions โœจ
      • +simd โ€” the ARMv8-A Advanced SIMD and floating-point instructions ๐Ÿงต
      • +crypto โ€” the cryptographic instructions ๐Ÿ”
      • +nocrypto โ€” disable the cryptographic instructions ๐Ÿšซ
      • +nofp โ€” disable the floating-point, Advanced SIMD and cryptographic instructions ๐Ÿ’€

Okay so -march=native makes the compiler auto-detect the architecture of the build computer. Ngl, at present this feature is only supported on GNU/Linux, and not all architectures are recognized. And if the auto-detect is unsuccessful? The option just... has no effect. It's giving "tried my best, no notes" ๐Ÿ™ˆ.


โœจ -mtune=name โœจ

This option says: hey, here's the name of the target ARM processor GCC should tune the performance of the code for. For some ARM implementations you genuinely get better performance by using this. Permissible names are:

arm7tdmi, arm7tdmi-s, arm710t, arm720t, arm740t, strongarm, strongarm110,
strongarm1100, strongarm1110, arm8, arm810, arm9, arm9e, arm920, arm920t,
arm922t, arm946e-s, arm966e-s, arm968e-s, arm926ej-s, arm940t, arm9tdmi,
arm10tdmi, arm1020t, arm1026ej-s, arm10e, arm1020e, arm1022e, arm1136j-s,
arm1136jf-s, mpcore, mpcorenovfp, arm1156t2-s, arm1156t2f-s, arm1176jz-s,
arm1176jzf-s, generic-armv7-a, cortex-a5, cortex-a7, cortex-a8, cortex-a9,
cortex-a12, cortex-a15, cortex-a17, cortex-a32, cortex-a35, cortex-a53,
cortex-a55, cortex-a57, cortex-a72, cortex-a73, cortex-a75, cortex-a76,
cortex-a76ae, cortex-a77, cortex-a78, cortex-a78ae, cortex-a78c, cortex-a710,
ares, cortex-r4, cortex-r4f, cortex-r5, cortex-r7, cortex-r8, cortex-r52,
cortex-r52plus, cortex-m0, cortex-m0plus, cortex-m1, cortex-m3, cortex-m4,
cortex-m7, cortex-m23, cortex-m33, cortex-m35p, cortex-m52, cortex-m55,
cortex-m85, cortex-x1, cortex-x1c, cortex-m1.small-multiply,
cortex-m0.small-multiply, cortex-m0plus.small-multiply, exynos-m1,
marvell-pj4, neoverse-n1, neoverse-n2, neoverse-v1, xscale, iwmmxt, iwmmxt2,
ep9312, fa526, fa626, fa606te, fa626te, fmp626, fa726te, star-mc1, xgene1

Additionally, this option can specify that GCC should tune the performance of the code for a big.LITTLE system. Permissible names are:

cortex-a15.cortex-a7, cortex-a17.cortex-a7, cortex-a57.cortex-a53,
cortex-a72.cortex-a53, cortex-a72.cortex-a35, cortex-a73.cortex-a53,
cortex-a75.cortex-a55, cortex-a76.cortex-a55

-mtune=generic-arch says GCC should tune the performance for a blend of processors within architecture arch. The whole point is to generate code that runs 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, fr fr ๐Ÿฆ‹.

-mtune permits the same extension options as -mcpu, but bestie, the extension options do not affect the tuning of the generated code. Noted ๐Ÿ“.

-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 ๐Ÿ’€.


โœจ -mcpu=name[+extension...] โœจ

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 -march) and the ARM processor type for which to tune for performance (as if specified by -mtune). But the way that โœจprecedenceโœจ works: where this option is used in conjunction with -march or -mtune, those options take precedence over the appropriate part of this option. Got it? ๐Ÿซถ

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 -mfloat-abi and -mfpu must also be considered: floating-point and Advanced SIMD instructions will only be used if -mfloat-abi is not set to soft; and any setting of -mfpu other than auto will override the available floating-point and SIMD extension instructions. Periodt ๐Ÿ’…

For example, 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 +nosimd and +nofp can be used to disable just the SIMD or both the SIMD and floating-point instructions respectively. Iconic, honestly.

Permissible names for this option are the same as those for -mtune.

The following extension options are common to the listed CPUs:

  • +nodsp โ€” disable the DSP instructions on cortex-m33, cortex-m35p, cortex-m52, cortex-m55 and cortex-m85. Also disable the M-Profile Vector Extension (MVE) integer and single precision floating-point instructions on cortex-m52, cortex-m55 and cortex-m85 ๐Ÿšซ
  • +nopacbti โ€” disable the Pointer Authentication and Branch Target Identification Extension on cortex-m52 and cortex-m85 ๐Ÿ”
  • +nomve โ€” disable the M-Profile Vector Extension (MVE) integer and single precision floating-point instructions on cortex-m52, cortex-m55 and cortex-m85 ๐Ÿšซ
  • +nomve.fp โ€” disable the M-Profile Vector Extension (MVE) single precision floating-point instructions on cortex-m52, cortex-m55 and cortex-m85 ๐Ÿšซ
  • +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 cortex-m52 and cortex-m55 ๐ŸŽ€
  • +nofp โ€” disables the floating-point instructions on arm9e, arm946e-s, arm966e-s, arm968e-s, arm10e, arm1020e, arm1022e, arm926ej-s, arm1026ej-s, cortex-r5, cortex-r7, cortex-r8, cortex-m4, cortex-m7, cortex-m33, cortex-m35p, cortex-m52, cortex-m55 and cortex-m85. Disables the floating-point and SIMD instructions on generic-armv7-a, cortex-a5, cortex-a7, cortex-a8, cortex-a9, cortex-a12, cortex-a15, cortex-a17, cortex-a15.cortex-a7, cortex-a17.cortex-a7, cortex-a32, cortex-a35, cortex-a53 and cortex-a55 ๐Ÿ’€
  • +nofp.dp โ€” disables the double-precision component of the floating-point instructions on cortex-r5, cortex-r7, cortex-r8, cortex-r52, cortex-r52plus and cortex-m7 ๐Ÿšซ
  • +nosimd โ€” disables the SIMD (but not floating-point) instructions on generic-armv7-a, cortex-a5, cortex-a7 and cortex-a9 ๐Ÿงต
  • +crypto โ€” enables the cryptographic instructions on cortex-a32, cortex-a35, cortex-a53, cortex-a55, cortex-a57, cortex-a72, cortex-a73, cortex-a75, exynos-m1, xgene1, cortex-a57.cortex-a53, cortex-a72.cortex-a53, cortex-a73.cortex-a35, cortex-a73.cortex-a53 and cortex-a75.cortex-a55 ๐Ÿ”

Additionally the generic-armv7-a pseudo target defaults to VFPv3 with 16 double-precision registers. It supports the following extension options: mp, sec, vfpv3-d16, vfpv3, vfpv3-d16-fp16, vfpv3-fp16, vfpv4-d16, vfpv4, neon, neon-vfpv3, neon-fp16, neon-vfpv4. The meanings are the same as for the extensions to -march=armv7-a โœจ.

-mcpu=generic-arch is also permissible, and is equivalent to -march=arch -mtune=generic-arch. See -mtune for more information ๐Ÿ‘€.

-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 ๐Ÿ™ˆ.


โœจ -mfpu=name โœจ

This specifies what floating-point hardware (or hardware emulation) is available on the target. Permissible names are: auto, vfpv2, vfpv3, vfpv3-fp16, vfpv3-d16, vfpv3-d16-fp16, vfpv3xd, vfpv3xd-fp16, neon-vfpv3, neon-fp16, vfpv4, vfpv4-d16, fpv4-sp-d16, neon-vfpv4, fpv5-d16, fpv5-sp-d16, fp-armv8, neon-fp-armv8 and crypto-neon-fp-armv8. Note that neon is an alias for neon-vfpv3 and vfp is an alias for vfpv2 ๐Ÿฆ‹.

The setting 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 -mcpu and -march. She's doing the deciding for you, bestie ๐Ÿ’….

Okay so if your selected floating-point hardware includes the NEON extension (like -mfpu=neon), bestie, listen โ€” floating-point ops are not generated by GCC's auto-vectorization pass unless you also throw in -funsafe-math-optimizations. Why? Because NEON hardware doesn't fully implement the IEEE 754 standard for floating-point arithmetic (specifically, denormal values get treated as zero ๐Ÿซ ), so using NEON instructions may lead to a loss of precision. It's giving "fast but a lil imprecise", and that's the whole vibe.

You can also set the fpu name at function level by using the target("fpu=") function attributes or pragmas. So flexible ๐Ÿ’….


  • -mfp16-format=name โ€” Specify the format of the __fp16 half-precision floating-point type. Permissible names are none, ieee, and alternative. The default is none, in which case the __fp16 type is justโ€ฆ not defined. Iconic "if you don't set it, it doesn't exist" energy โœจ.
  • -mstructure-size-boundary=n โ€” The sizes of all structures and unions get 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 is 8. A value of 64 is only allowed if the underlying ABI supports it, no exceptions, that's the rule ๐ŸŽ€.

Specifying a larger number can produce faster, more efficient code, but it can also increase the size of your program. And here's the tea โ˜•: 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. So like, pick one and commit, bestie.

This option is deprecated. ๐Ÿšซ
  • -mabort-on-noreturn โ€” Generate a call to the function abort at the end of a noreturn function. It gets executed if the function tries to return. So it's like a little security guard at the end of the function going "excuse me?? you're not supposed to be here" ๐Ÿ’€.
  • -mlong-calls
  • -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: static functions, functions that have the short_call attribute, functions that are inside the scope of a #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 long_call attribute or the section attribute, and functions that are within the scope of a #pragma long_calls directive are always turned into long calls. Rules upon rules, it's giving bureaucracy but make it compiler ๐ŸŒธ.

This feature is not enabled by default. Specifying -mno-long-calls restores the default behavior, as does placing the function calls within the scope of a #pragma long_calls_off directive. Note: these switches have no effect on how the compiler generates code to handle function calls via function pointers. Not me pointing out the fine print ๐Ÿ™ˆ.

  • -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. So the runtime does the homework, not the compiler โœจ.
  • -mpic-register=reg โ€” Specify the register to be used for PIC addressing. For standard PIC base case, the default is any suitable register determined by the compiler. For single PIC base case, the default is R9 if target is EABI based or stack-checking is enabled, otherwise the default is R10. Autopilot vibes ๐Ÿฆ‹.
  • -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 -msingle-pic-base by default. Sneaky little chain reaction, lowkey iconic ๐Ÿ’œ.
  • -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:
             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

When performing a stack backtrace, code can inspect the value of pc stored at fp + 0. If the trace function then looks at location 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 ((pc[-3]) & 0xff000000). Forensic detective work, honestly ๐Ÿ‘‘

  • -mthumb
  • -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 --with-mode=state configure option.

You can also override the ARM and Thumb mode for each function by using the target("thumb") and target("arm") function attributes or pragmas. Per-function glow-ups, we love to see it ๐Ÿ’….

  • -mflip-thumb โ€” Switch ARM/Thumb modes on alternating functions. This option is provided for regression testing of mixed Thumb/ARM code generation, and is not intended for ordinary use in compiling code. So like, it's a lab experiment, not a lifestyle ๐ŸŒˆ.
  • -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 -mno-tpcs-frame.
  • -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 -mno-apcs-leaf-frame. Yes bestie, that's what it says, I'm not gonna "fix" it for you, copy it exactly ๐Ÿ’–.
  • -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. Sorry, rules are rules ๐ŸŽ€.
  • -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. Same disclaimer, different flag, iykyk.
  • -mtp=name โ€” Specify the access model for the thread local storage pointer. The model soft generates calls to __aeabi_read_tp. Other accepted models are tpidrurw, tpidruro and 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 cp15 is also accepted as a convenience alias of tpidruro. The argument auto uses the best available method for the selected processor. The default setting is auto. Let it cook โœจ.
  • -mtls-dialect=dialect โ€” Specify the dialect to use for accessing thread local storage. Two dialects are supported --- gnu and gnu2. The gnu dialect selects the original GNU scheme for supporting local and global dynamic TLS models. The 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. Upgrade tax, unfortunately ๐Ÿ’€.
  • -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 -fpic or -fPIC is specified. This option conflicts with -mslow-flash-data. Pick a side, bestie, you can't have both ๐Ÿซถ.
  • -mfix-cortex-m3-ldrd โ€” Some Cortex-M3 cores can cause data corruption when ldrd instructions with overlapping destination and base registers are used. This option avoids generating these instructions. This option is enabled by default when -mcpu=cortex-m3 is specified. Protecting you from the chaos, no cap ๐Ÿ›ก๏ธ.
  • -mfix-cortex-a57-aes-1742098
  • -mno-fix-cortex-a57-aes-1742098
  • -mfix-cortex-a72-aes-1655431
  • -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 -mcpu=cortex-a57 or -mcpu=cortex-a72 is specified. Yes those numbers are erratum IDs and yes they go in the flag name, we don't make the rules ๐Ÿ‘‘
  • -munaligned-access
  • -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. Slow and steady, but correct ๐Ÿข.

The ARM attribute 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 __ARM_FEATURE_UNALIGNED is also defined. Receipts in the object file, we love documentation ๐Ÿ’–.

  • -mneon-for-64bits โ€” This option is deprecated and has no effect. It's giving ghost flag ๐Ÿ‘ป, it's literally just vibes and nothing else.
  • -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 -mword-relocations. Again: choose one, queen ๐ŸŒธ.
  • -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. Future you might have different defaults, so heads up ๐Ÿฆ‹.
  • -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. Structured, tidy, disciplined โ€” the main character of instruction blocks โœจ.
  • -mprint-tune-info โ€” drops CPU tuning info into your assembler file as a comment โœจ This one is strictly for regression-testing the compiler itself, not for anyone actually out here compiling real code, okay? It's off by default ๐Ÿ’…
  • -mverbose-cost-dump โ€” turns on verbose cost model dumping in the debug dump files ๐Ÿซถ It exists purely so compiler devs can debug the compiler. That's it. That's the whole job. Not for you, bestie, unless you're literally fixing GCC ๐Ÿ˜ญ
  • -mpure-code โ€” says NO to constant data living in code sections ๐Ÿšซ On top of that, when you're compiling for the ELF object format it gives every text section the ELF processor-specific section attribute SHF_ARM_PURECODE ๐Ÿ‘‘ Heads up tho: this option is only available when generating non-pic code for M-profile targets. Periodt.
  • -mcmse โ€” generates secure code exactly as the "ARMv8-M Security Extensions: Requirements on Development Tools Engineering Specification" says ๐ŸŒธ You can find that doc at <https://developer.arm.com/documentation/ecm0359818/latest/>. Go read it, it's giving very serious academic energy ๐Ÿ“š
  • -mfix-cmse-cve-2021-35465 โ€” mitigates a potential security issue with the VLLDM instruction on some M-profile devices when you're using CMSE (CVE-2021-365465) ๐Ÿ˜ณ This one is enabled by default whenever the option -mcpu= is used with cortex-m33, cortex-m35p, cortex-m52, cortex-m55, cortex-m85 or star-mc1. Wanna turn the mitigation off? Use -mno-fix-cmse-cve-2021-35465 ๐Ÿ™ˆ
  • *-mstack-protector-guard=guard* โ€” and โ€” *-mstack-protector-guard-offset=offset* โ€” generates stack protection code with the canary sitting at guard ๐Ÿค The supported locations are global for a global canary, or tls for a canary you can reach via the TLS register. Lowkey important: the option -mstack-protector-guard-offset= is meant to be used with -fstack-protector-guard=tls and not for use in user-land code ๐Ÿšซ
  • -mfdpic โ€” and its opposite โ€” -mno-fdpic โ€” picks the FDPIC ABI, which uses 64-bit function descriptors to represent pointers to functions ๐Ÿ’ซ When the compiler is configured for arm-*-uclinuxfdpiceabi targets, this option is on by default and implies -fPIE if you didn't hand it any of the PIC/PIE-related options. On other targets? It only enables the FDPIC-specific code generation features, and you gotta explicitly provide the PIC/PIE-related options yourself as needed, no cap ๐Ÿคทโ€โ™€๏ธ
Also note: static linking is not supported here, because it would still involve the dynamic linker when the program self-relocates ๐Ÿ˜ญ If that behavior is acceptable to you, use -static and -Wl,-dynamic-linker options.

The opposite -mno-fdpic option is useful (and honestly required) to build the Linux kernel using the same (arm-*-uclinuxfdpiceabi) toolchain as the one used to build the userland programs ๐Ÿ‘‘

  • -mbranch-protection=none|standard|pac-ret[+leaf][+bti]|bti[+pac-ret[+leaf]] โ€” turns on branch protection features (armv8.1-m.main only, bestie, don't get cute) ๐Ÿ›ก๏ธ
    • none โ€” generate code without branch protection or return address signing.
    • standard[+leaf] โ€” generate code with all branch protection features enabled at their standard level.
    • pac-ret[+leaf] โ€” generate code with return address signing set to its standard level, which is to sign all functions that save the return address to memory.
    • leaf โ€” when return address signing is enabled, also sign leaf functions even if they do not write the return address to memory ๐Ÿƒ
    • +bti โ€” add landing-pad instructions at the permitted targets of indirect branch instructions.

If the +pacbti architecture extension is not enabled, 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 will remain backwards-compatible with earlier versions of the architecture, but the additional security can be enabled at run time on processors that support the 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 -mbranch-protection=bti ๐Ÿ‘€

Any setting other than none is supported only on armv8-m.main or later. And the default? Generate code without branch protection or return address signing. Iconic, unbothered, moisturized ๐Ÿ’…


๐ŸŒˆ AVR Options ๐ŸŒˆ

These options are defined for AVR implementations, and they're honestly a whole vibe:

  • *-mmcu=mcu* โ€” specify the AVR instruction set architecture (ISA) or device type ๐Ÿ’– The default for this option is avr2.

Here's the thing tho, bestie โ€” the following AVR devices and ISAs are supported. Note: a complete device support consists of startup code crtmcu.o, a device header avr/io*.h, a device library libmcu.a and a device-specs (<https://gcc.gnu.org/wiki/avr-gcc#spec-files>) file specs-mcu ๐Ÿ“ฆ Only the latter is provided by the compiler according to the supported *mcu*s below. The rest is supported by AVR-LibC (<https://www.nongnu.org/avr-libc/>), or by means of atpack (<https://gcc.gnu.org/wiki/avr-gcc#atpack>) files from the hardware manufacturer ๐Ÿญ

  • avr2 โ€” "Classic" devices with up to 8 KiB of program memory. mcu = attiny22, attiny26, at90s2313, at90s2323, at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90c8534, at90s8515, at90s8535.
  • avr25 โ€” "Classic" devices with up to 8 KiB of program memory and with the MOVW instruction. mcu = attiny13, attiny13a, attiny24, attiny24a, attiny25, attiny261, attiny261a, attiny2313, attiny2313a, attiny43u, attiny44, attiny44a, attiny45, attiny48, attiny441, attiny461, attiny461a, attiny4313, attiny84, attiny84a, attiny85, attiny87, attiny88, attiny828, attiny841, attiny861, attiny861a, ata5272, ata6616c, at86rf401.
  • avr3 โ€” "Classic" devices with 16 KiB up to 64 KiB of program memory. mcu = at76c711, at43usb355.
  • avr31 โ€” "Classic" devices with 128 KiB of program memory. mcu = atmega103, at43usb320.
  • avr35 โ€” "Classic" devices with 16 KiB up to 64 KiB of program memory and with the MOVW instruction. mcu = attiny167, attiny1634, atmega8u2, atmega16u2, atmega32u2, ata5505, ata6617c, ata664251, at90usb82, at90usb162.
  • avr4 โ€” "Enhanced" devices with up to 8 KiB of program memory. mcu = atmega48, atmega48a, atmega48p, atmega48pa, atmega48pb, atmega8, atmega8a, atmega8hva, atmega88, atmega88a, atmega88p, atmega88pa, atmega88pb, atmega8515, atmega8535, ata5795, ata6285, ata6286, ata6289, ata6612c, at90pwm1, at90pwm2, at90pwm2b, at90pwm3, at90pwm3b, at90pwm81.
  • avr5 โ€” "Enhanced" devices with 16 KiB up to 64 KiB of program memory. mcu = atmega16, atmega16a, atmega16hva, atmega16hva2, atmega16hvb, atmega16hvbrevb, atmega16m1, atmega16u4, atmega161, atmega162, atmega163, atmega164a, atmega164p, atmega164pa, atmega165, atmega165a, atmega165p, atmega165pa, atmega168, atmega168a, atmega168p, atmega168pa, atmega168pb, atmega169, atmega169a, atmega169p, atmega169pa, atmega32, atmega32a, atmega32c1, atmega32hvb, atmega32hvbrevb, atmega32m1, atmega32u4, atmega32u6, atmega323, atmega324a, atmega324p, atmega324pa, atmega324pb, atmega325, atmega325a, atmega325p, atmega325pa, atmega328, atmega328p, atmega328pb, atmega329, atmega329a, atmega329p, atmega329pa, atmega3250, atmega3250a, atmega3250p, atmega3250pa, atmega3290, atmega3290a, atmega3290p, atmega3290pa, atmega406, atmega64, atmega64a, atmega64c1, atmega64hve, atmega64hve2, atmega64m1, atmega64rfr2, atmega640, atmega644, atmega644a, atmega644p, atmega644pa, atmega644rfr2, atmega645, atmega645a, atmega645p, atmega649, atmega649a, atmega649p, atmega6450, atmega6450a, atmega6450p, atmega6490, atmega6490a, atmega6490p, ata5790, ata5790n, ata5791, ata6613c, ata6614q, ata5782, ata5831, ata8210, ata8510, ata5787, ata5835, ata5700m322, ata5702m322, at90pwm161, at90pwm216, at90pwm316, at90can32, at90can64, at90scr100, at90usb646, at90usb647, at94k, m3000.
  • avr51 โ€” "Enhanced" devices with 128 KiB of program memory. mcu = atmega128, atmega128a, atmega128rfa1, atmega128rfr2, atmega1280, atmega1281, atmega1284, atmega1284p, atmega1284rfr2, at90can128, at90usb1286, at90usb1287.
  • avr6 โ€” "Enhanced" devices with 3-byte PC, i.e. with more than 128 KiB of program memory. mcu = atmega256rfr2, atmega2560, atmega2561, atmega2564rfr2.
  • avrxmega2 โ€” "XMEGA" devices with more than 8 KiB and up to 64 KiB of program memory. mcu = atxmega8e5, atxmega16a4, atxmega16a4u, atxmega16c4, atxmega16d4, atxmega16e5, atxmega32a4, atxmega32a4u, atxmega32c3, atxmega32c4, atxmega32d3, atxmega32d4, atxmega32e5, avr64da28, avr64da28s, avr64da32, avr64da32s, avr64da48, avr64da48s, avr64da64, avr64da64s, avr64db28, avr64db32, avr64db48, avr64db64, avr64dd14, avr64dd20, avr64dd28, avr64dd32, avr64du28, avr64du32, avr64ea28, avr64ea32, avr64ea48, avr64sd28, avr64sd32, avr64sd48.
  • "avrxmega3" โ€” "XMEGA" devices</p> with up to 64 KiB of combined program memory and RAM, and where program memory is visible in the RAM address space. ๐Ÿ’– mcu = a whole lil army:
"attiny202", "attiny204", "attiny212", "attiny214",
"attiny402", "attiny404", "attiny406", "attiny412", "attiny414",
"attiny416", "attiny416auto", "attiny417", "attiny424",
"attiny426", "attiny427", "attiny804", "attiny806", "attiny807",
"attiny814", "attiny816", "attiny817", "attiny824", "attiny826",
"attiny827", "attiny1604", "attiny1606", "attiny1607",
"attiny1614", "attiny1616", "attiny1617", "attiny1624",
"attiny1626", "attiny1627", "attiny3214", "attiny3216",
"attiny3217", "attiny3224", "attiny3226", "attiny3227",
"atmega808", "atmega809", "atmega1608", "atmega1609",
"atmega3208", "atmega3209", "atmega4808", "atmega4809",
"avr16dd14", "avr16dd20", "avr16dd28", "avr16dd32", "avr16du14",
"avr16du20", "avr16du28", "avr16du32", "avr16ea28", "avr16ea32",
"avr16ea48", "avr16eb14", "avr16eb20", "avr16eb28", "avr16eb32",
"avr16la14", "avr16la20", "avr16la28", "avr16la32", "avr32da28",
"avr32da28s", "avr32da32", "avr32da32s", "avr32da48",
"avr32da48s", "avr32db28", "avr32db32", "avr32db48",
"avr32dd14", "avr32dd20", "avr32dd28", "avr32dd32", "avr32du14",
"avr32du20", "avr32du28", "avr32du32", "avr32ea28", "avr32ea32",
"avr32ea48", "avr32eb14", "avr32eb20", "avr32eb28", "avr32eb32",
"avr32la14", "avr32la20", "avr32la28", "avr32la32", "avr32sd20",
"avr32sd28", "avr32sd32".
  • "avrxmega4" โ€” "XMEGA"</p> girlies with more than 64 KiB and up to 128 KiB of program memory. mcu = the roster:
"atxmega64a3", "atxmega64a3u",
"atxmega64a4u", "atxmega64b1", "atxmega64b3", "atxmega64c3",
"atxmega64d3", "atxmega64d4", "avr128da28", "avr128da28s",
"avr128da32", "avr128da32s", "avr128da48", "avr128da48s",
"avr128da64", "avr128da64s", "avr128db28", "avr128db32",
"avr128db48", "avr128db64".
  • "avrxmega5" โ€” "XMEGA"</p> devices with more than 64 KiB and up to 128 KiB of program memory and more than 64 KiB of RAM. mcu = just these two:
"atxmega64a1", "atxmega64a1u".
  • "avrxmega6" โ€” "XMEGA"</p> devices with more than 128 KiB of program memory. mcu = the big ones:
"atxmega128a3", "atxmega128a3u", "atxmega128b1", "atxmega128b3",
"atxmega128c3", "atxmega128d3", "atxmega128d4", "atxmega192a3",
"atxmega192a3u", "atxmega192c3", "atxmega192d3", "atxmega256a3",
"atxmega256a3b", "atxmega256a3bu", "atxmega256a3u",
"atxmega256c3", "atxmega256d3", "atxmega384c3", "atxmega384d3".
  • "avrxmega7" โ€” "XMEGA"</p> devices with more than 128 KiB of program memory and more than 64 KiB of RAM. mcu = three icons:
"atxmega128a1", "atxmega128a1u",
"atxmega128a4u".
  • "avrtiny" โ€” "Reduced Tiny"</p> Tiny core devices, and the way that they only have 16 general purpose registers and 512 B up to 4 KiB of program memory. literally so smol ๐Ÿฅบ mcu = the tiny squad:
"attiny4", "attiny5", "attiny9", "attiny10", "attiny102",
"attiny104", "attiny20", "attiny40".
  • "avr1" โ€” this ISA is implemented by the minimal AVR core and it's supported for assembler only. mcu = the classics:
"attiny11", "attiny12", "attiny15",
"attiny28", "at90s1200".

  • -mabsdata โ€” bestie, assume that all data in static storage can be accessed by LDS / STS instructions. ๐Ÿ’… This option only does anything on reduced Tiny devices like ATtiny40. See also the "absdata" AVR Variable Attributes,variable attribute. ๐Ÿ‘‘
  • -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.

Popping the arguments after the function call can be expensive on AVR, so 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. ๐Ÿ“

  • *-mbranch-cost=cost* โ€” set the branch costs for conditional branch instructions to cost. Reasonable values for cost are small, non-negative integers. The default branch cost is 0.
  • -mcall-prologues โ€” function prologues/epilogues are expanded as calls to appropriate subroutines. Code size is smaller. โœจ
  • -mfuse-add
  • -mno-fuse-add
  • *-mfuse-add=level* โ€” optimize indirect memory accesses on reduced Tiny devices. The default uses level=1 for optimizations -Og and -O1, and level=2 for higher optimizations. Valid values for level are 0, 1 and 2.
  • *-mdouble=bits*
  • *-mlong-double=bits* โ€” set the size (in bits) of the double or long double type, respectively. Possible values for bits are 32 and 64. Whether or not a specific value for bits is allowed depends on the --with-double= and --with-long-double= configure options (https://gcc.gnu.org/install/configure.html#avr), and the same applies for the default values of the options. iykyk ๐Ÿ’…
  • -mgas-isr-prologues โ€” interrupt service routines (ISRs) may use the __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 AVR Function Attributes,,"no_gccisr" function attribute. This feature is activated per default if optimization is on (but not with -Og, @pxref{Optimize Options}), and if GNU Binutils support PR21683 (https://sourceware.org/PR21683).
  • -mint8 โ€” assume int to be an 8-bit integer. This affects the sizes of all the types: a char is 1 byte, an int is 1 byte, a long is 2 bytes, and long long is 4 bytes.
๐Ÿšจ okay so heads up bestie: this option does not conform to the C standards. But it results in smaller code size, so. ๐Ÿคทโ™€๏ธ
  • -mmain-is-OS_task โ€” do not save registers in main. The effect is the same like attaching attribute AVR Function Attributes,,"OS_task" to main. It is activated per default if optimization is on.
  • -mno-interrupts โ€” generated code is not compatible with hardware interrupts. Code size is smaller.
  • -mrelax โ€” try to replace CALL resp. JMP instruction by the shorter RCALL resp. RJMP instruction if applicable. Setting -mrelax just adds the --mlink-relax option to the assembler's command line and the --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 assembler code generated by the compiler is the same, but the instructions in the executable may differ from instructions in the assembler code. ๐Ÿ™ˆ

Relaxing must be turned on if linker stubs are needed, see the section on "EIND" and linker stubs below. ๐Ÿ‘‡
  • -mrodata-in-ram
  • -mno-rodata-in-ram โ€” locate the .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, .rodata is located in flash memory per default, provided the required GNU Binutils support (PR31124 (https://sourceware.org/PR31124)) is available. In that case, -mrodata-in-ram can be used to return to the old layout with .rodata in RAM.

  • -mstrict-X โ€” use address register X in a way proposed by the hardware. This means that X is only used in indirect, post-increment or pre-decrement addressing.

Without this option, the X register may be used in the same way as Y or Z โ€” which then is emulated by additional instructions. For example, loading a value with X+const addressing with a small non-negative const < 64 to a register Rn is performed as

        adiw r26, const   ; X += const
        ld   <Rn>, X        ; <Rn> = *X
        sbiw r26, const   ; X -= const
  • -mtiny-stack โ€” only change the lower 8 bits of the stack pointer.
  • -mfract-convert-truncate โ€” allow to use truncation instead of rounding towards zero for fractional fixed-point types.
  • -nodevicelib โ€” don't link against AVR-LibC's device specific library lib<mcu>.a. ๐Ÿ™…โ™€๏ธ
  • -nodevicespecs โ€” don't add -specs=device-specs/specs-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 -specs=path-to-specs-file. There is no more need for option -mmcu=mcu.

This option can also serve as a replacement for the older way of specifying custom device-specs files that needed -B some-path to point to a directory which contains a folder named device-specs which contains a specs file named specs-mcu, where mcu was specified by -mmcu=mcu.

  • -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.
  • -Wmisspelled-isr โ€” warn if the ISR is misspelled, i.e. without __vector prefix. Enabled by default. ๐Ÿ‘‘

๐ŸŒˆ "EIND" and Devices with More Than 128 Ki Bytes of Flash ๐ŸŒˆ

Pointers in the implementation are 16 bits wide. The address of a function or label is represented as a word address so that indirect jumps and calls can target any code address in the range of 64 Ki words.

In order to facilitate indirect jump on devices with more than 128 Ki bytes of program memory space, there is a special function register called EIND that serves as most significant part of the target address when EICALL or EIJMP instructions are used. โœจ

Indirect jumps and calls on these devices are handled as follows by the compiler and are subject to some limitations:

  • The compiler never sets EIND.
  • The compiler uses EIND implicitly in EICALL/EIJMP instructions or might read EIND directly in order to emulate an indirect call/jump by means of a RET instruction.
  • The compiler assumes that EIND never changes during the startup code or during the application. In particular, EIND is not saved/restored in function or interrupt service routine prologue/epilogue. ๐Ÿ˜ญ
  • For indirect calls to functions and computed goto, the linker generates stubs. Stubs are jump pads, sometimes also called trampolines. So the indirect call/jump jumps to such a stub. The stub contains a direct jump to the desired address. Slay.
  • Linker relaxation must be turned on so the linker generates the stubs correctly in all situations. Peep the compiler option -mrelax and the linker option --relax. Ngl there are corner cases where the linker is supposed to generate stubs but just aborts โ€” no relaxation, no helpful error message, nothing. ๐Ÿ’€
  • The default linker script is arranged for code with EIND = 0. If your code is supposed to work for a setup with EIND != 0, you gotta use a custom linker script so you can place the sections whose name start with .trampolines into the segment where EIND points to. Lowkey important.
  • The startup code from libgcc never sets EIND. Not me pointing out that startup code is a blend of code from libgcc and AVR-LibC ๐Ÿซถ. For the impact of AVR-LibC on EIND, see the AVR-LibC user manual (https://www.nongnu.org/avr-libc/user-manual/).
  • It is legitimate for user-specific startup code to set up EIND early, for example by means of initialization code located in section .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 EIND to the segment where the vector table is located. Iconic behaviour, honestly.
#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");
}

The __trampolines_start symbol is defined in the linker script. โœจ

  • Stubs are generated automatically by the linker if the following two conditions are met:
    • The address of a label is taken by means of the gs modifier (short for generate stubs) like so:
LDI r24, lo8(gs(<func>))
LDI r25, hi8(gs(<func>))
  • The final location of that label is in a code segment outside the segment where the stubs are located.
  • The compiler emits such gs modifiers for code labels in the following situations:
    • Taking address of a function or code label.
    • Computed goto.
    • If prologue-save function is used, see -mcall-prologues command-line option.
    • Switch/case dispatch tables. If you do not want such dispatch tables you can specify the -fno-jump-tables command-line option.
    • C and C++ constructors/destructors called during startup/shutdown.
    • If the tools hit a gs() modifier explained above.
  • Jumping to non-symbolic addresses like so is not supported:
int main (void)
{
    /* Call function at word address 0x2 */
    return ((int(*)(void)) 0x2)();
}

Instead, a stub has to be set up, i.e. the function has to be called through a symbol (func_4 in the example):

int main (void)
{
    extern int func_4 (void);

    /* Call function at byte address 0x4 */
    return func_4();
}

and the application be linked with -Wl,--defsym,func_4=0x4. Alternatively, func_4 can be defined in the linker script. Periodt. ๐Ÿ’…


๐ŸŒˆ Handling of the RAMPD, RAMPX, RAMPY and RAMPZ Special Function Registers

Some AVR devices support memories larger than the 64 KiB range that can be accessed with 16-bit pointers. To access memory locations outside this 64 KiB range, the content of a RAMP register is used as high part of the address: the X, Y, Z address register is concatenated with the RAMPX, RAMPY, RAMPZ special function register, respectively, to get a wide address. Similarly, RAMPD is used together with direct addressing. Bestie, it's giving extended addressing.

  • The startup code initializes the RAMP special function registers with zero.
  • If a AVR Named Address Spaces, named address space other than generic or __flash is used, then RAMPZ is set as needed before the operation.
  • If the device supports RAM larger than 64 KiB and the compiler needs to change RAMPZ to accomplish an operation, RAMPZ is reset to zero after the operation.
  • If the device comes with a specific RAMP register, the ISR prologue/epilogue saves/restores that SFR and initializes it with zero in case the ISR code might (implicitly) use it.
  • RAM larger than 64 KiB is not supported by GCC for AVR targets. If you use inline assembler to read from locations outside the 16-bit address range and change one of the RAMP registers, you must reset it to zero after the access. Do not skip this. ๐Ÿ™ˆ

๐Ÿฆ‹ 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 -mmcu= command-line option.

For even more AVR-specific built-in macros see AVR Named Address Spaces and AVR Built-in Functions.

  • __AVR_ARCH__ โ€” Build-in macro that resolves to a decimal number that identifies the architecture and depends on the -mmcu=mcu option. Possible values are:

2, 25, 3, 31, 35, 4, 5, 51, 6

for mcu=avr2, avr25, avr3, avr31, avr35, avr4, avr5, avr51, avr6, respectively and

100, 102, 103, 104, 105, 106, 107

for mcu=avrtiny, avrxmega2, avrxmega3, avrxmega4, avrxmega5, avrxmega6, avrxmega7, respectively. If mcu specifies a device, this built-in macro is set accordingly. For example, with -mmcu=atmega8 the macro is defined to 4. โœจ

  • __AVR_Device__ โ€” Setting -mmcu=device defines this built-in macro which reflects the device's name. For example, -mmcu=atmega8 defines the built-in macro __AVR_ATmega8__, -mmcu=attiny261a defines __AVR_ATtiny261A__, etc.

The built-in macros' names follow the scheme __AVR_Device__ where Device is the device name as from the AVR user manual. The difference between Device in the built-in macro and device in -mmcu=device is that the latter is always lowercase.

If device is not a device but only a core architecture like avr51, this macro is not defined.

  • __AVR_DEVICE_NAME__ โ€” Setting -mmcu=device defines this built-in macro to the device's name. For example, with -mmcu=atmega8 the macro is defined to atmega8.

If device is not a device but only a core architecture like avr51, this macro is not defined.

  • __AVR_XMEGA__ โ€” The device / architecture belongs to the XMEGA family of devices.
  • __AVR_HAVE_ADIW__ โ€” The device has the ADIW and SBIW instructions.
  • __AVR_HAVE_ELPM__ โ€” The device has the ELPM instruction.
  • __AVR_HAVE_ELPMX__ โ€” The device has the ELPM Rn,Z and ELPM Rn,Z+ instructions.
  • __AVR_HAVE_LPMX__ โ€” The device has the LPM Rn,Z and LPM Rn,Z+ instructions.
  • __AVR_HAVE_MOVW__ โ€” The device has the MOVW instruction to perform 16-bit register-register moves.
  • __AVR_HAVE_MUL__ โ€” The device has a hardware multiplier. ๐Ÿ”ฅ
  • __AVR_HAVE_JMP_CALL__ โ€” The device has the JMP and CALL instructions. This is the case for devices with more than 8 KiB of program memory.
  • __AVR_HAVE_EIJMP_EICALL__, __AVR_3_BYTE_PC__ โ€” The device has the EIJMP and EICALL instructions. This is the case for devices with more than 128 KiB of program memory. This also means that the program counter (PC) is 3 bytes wide.
  • __AVR_2_BYTE_PC__ โ€” The program counter (PC) is 2 bytes wide. This is the case for devices with up to 128 KiB of program memory.
  • __AVR_HAVE_8BIT_SP__, __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 -mtiny-stack.
  • __AVR_HAVE_SPH__, __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 -mmcu= and in the cases of -mmcu=avr2 and -mmcu=avr25 also by -msp8.
  • __AVR_HAVE_RAMPD__, __AVR_HAVE_RAMPX__, __AVR_HAVE_RAMPY__, __AVR_HAVE_RAMPZ__ โ€” The device has the RAMPD, RAMPX, RAMPY, RAMPZ special function register, respectively.
  • __NO_INTERRUPTS__ โ€” This macro reflects the -mno-interrupts command-line option.
  • __AVR_ERRATA_SKIP__, __AVR_ERRATA_SKIP_JMP_CALL__ โ€” Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit instructions because of a hardware erratum. Skip instructions are SBRS, SBRC, SBIS, SBIC and CPSE. The second macro is only defined if __AVR_HAVE_JMP_CALL__ is also set.
  • __AVR_ISA_RMW__ โ€” The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
  • __AVR_SFR_OFFSET__=offset โ€” Instructions that can address I/O special function registers directly like IN, OUT, SBI, etc. may use a different address as if addressed by an instruction to access RAM like LD or 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 address.
  • __AVR_SHORT_CALLS__ โ€” The -mshort-calls command line option is set.
  • __AVR_PM_BASE_ADDRESS__=addr โ€” Some devices support reading from flash memory by means of LD* instructions. The flash memory is seen in the data address space at an offset of __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 .rodata into RAM. This is handled by the default linker description file, and is currently available for avrtiny and avrxmega3. Even more convenient, there is no need to use address spaces like __flash or features like attribute progmem and pgm_read_*. ๐Ÿ‘‘
  • __AVR_HAVE_FLMAP__ โ€” This macro is defined provided the following conditions are met:
    • The device has the NVMCTRL_CTRLB.FLMAP bitfield. This applies to the AVR64* and AVR128* devices.
    • It's not known at assembler-time which emulation will be used.

This implies the compiler was configured with GNU Binutils that implement PR31124 ("https://sourceware.org/PR31124").

  • __AVR_RODATA_IN_RAM__ โ€” okay so if you're compiling for a core architecture, this macro justโ€ฆ doesn't exist. undefined. gone. But if you're compiling for a device, it's defined to 1 when the .rodata sections for read-only data live in RAM, and defined to 0 when they don't. that's it, that's the whole vibe check ๐Ÿฆ‹
  • __WITH_AVRLIBC__ โ€” the compiler was configured to be used together with AVR-Libc. see the --with-avrlibc configure option. iykyk โœจ
  • __HAVE_DOUBLE_MULTILIB__ โ€” defined if -mdouble= acts as a multilib option. periodt ๐Ÿ’…
  • __HAVE_DOUBLE32__, __HAVE_DOUBLE64__ โ€” defined if the compiler supports 32-bit double resp. 64-bit double. the actual layout is specified by option -mdouble=. no cap ๐ŸŽ€
  • __DEFAULT_DOUBLE__ โ€” the size in bits of double if -mdouble= is not set. and if you wanna test the layout of double in a program, use the built-in macro __SIZEOF_DOUBLE__. iconic ๐Ÿ’–
  • __HAVE_LONG_DOUBLE32__, __HAVE_LONG_DOUBLE64__, __HAVE_LONG_DOUBLE_MULTILIB__, __DEFAULT_LONG_DOUBLE__ โ€” same as the above crew, but for long double instead of double. literally the same thing, different type bestie ๐ŸŒธ
  • __WITH_DOUBLE_COMPARISON__ โ€” reflects the --with-double-comparison={tristate|bool|libf7} configure option ("https://gcc.gnu.org/install/configure.html#avr") and is defined to 2 or 3. ๐Ÿ‘‘
  • __WITH_LIBF7_LIBGCC__, __WITH_LIBF7_MATH__, __WITH_LIBF7_MATH_SYMBOLS__ โ€” reflects the --with-libf7={libgcc|math|math-symbols} configure option ("https://gcc.gnu.org/install/configure.html#avr"). โญ

โœจ AVR Internal Options โœจ

okay bestie, listen. these options are used internally by the compiler, and to communicate between device specs files and the compiler proper. you do not need to set these by hand โ€” in particular, they are not optimization options.

Using these options in the wrong way may lead to sub-optimal or wrong code. like, actually wrong. not cute wrong. ๐Ÿ’€

they're documented for completeness, and so you can get a better understanding of device specs ("https://gcc.gnu.org/wiki/avr-gcc#spec-files") files. that's the whole reason. ๐Ÿงš

  • -mn-flash=num โ€” assume that the flash memory has a size of num times 64 KiB. this determines which __flashN address spaces are available. ๐Ÿ’…
  • -mflmap โ€” the device has the FLMAP bit field located in special function register NVMCTRL_CTRLB. ๐Ÿฆ‹
  • -mrmw โ€” assume that the device supports the Read-Modify-Write instructions XCH, LAC, LAS and LAT. โœจ
  • -mshort-calls โ€” assume that RJMP and RCALL can target the whole program memory. this option is used for multilib generation and selection for the devices from architecture avrxmega3. ๐ŸŽ€
  • -mskip-bug โ€” generate code without skips (CPSE, SBRS, SBRC, SBIS, SBIC) over 32-bit instructions. ๐Ÿ™ˆ
  • -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 avr2 and avr25. these architectures mix devices with and without SPH. ๐Ÿ˜ญ

๐Ÿ–ค Blackfin Options ๐Ÿ–ค

  • -mcpu=cpu[-sirevision] โ€” specifies the name of the target Blackfin processor. right now, cpu can be one of bf512, bf514, bf516, bf518, bf522, bf523, bf524, bf525, bf526, bf527, bf531, bf532, bf533, bf534, bf536, bf537, bf538, bf539, bf542, bf544, bf547, bf548, bf549, bf542m, bf544m, bf547m, bf548m, bf549m, bf561, bf592. that's a lot of bfs bestie, and yes you have to spell them exactly ๐Ÿ’…

the optional sirevision specifies the silicon revision of the target Blackfin processor. any workarounds available for the targeted silicon revision are enabled. if sirevision is none, no workarounds are enabled. if sirevision is any, all workarounds for the targeted processor are enabled. the __SILICON_REVISION__ macro is defined to two hexadecimal digits representing the major and minor numbers in the silicon revision. if sirevision is none, the __SILICON_REVISION__ is not defined. if sirevision is any, the __SILICON_REVISION__ is defined to be 0xffff. if this optional sirevision is not used, GCC assumes the latest known silicon revision of the targeted Blackfin processor. no cap ๐Ÿซถ

GCC defines a preprocessor macro for the specified cpu. for the bfin-elf toolchain, this option causes the hardware BSP provided by libgloss to be linked in if -msim is not given.

without this option, bf532 is used as the processor by default.

note that support for bf561 is incomplete. for bf561, only the preprocessor macro is defined. ๐Ÿ˜ญ
  • -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 bfin-elf toolchain. certain other options, such as -mid-shared-library and -mfdpic, imply -msim. ๐Ÿฆ‹
  • -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. free real estate โœจ
  • -mspecld-anomaly โ€” when enabled, the compiler ensures that the generated code does not contain speculative loads after jump instructions. if this option is used, __WORKAROUND_SPECULATIVE_LOADS is defined. ๐Ÿ”ฅ
  • -mno-specld-anomaly โ€” don't generate extra code to prevent speculative loads from occurring. ๐Ÿ“
  • -mcsync-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, __WORKAROUND_SPECULATIVE_SYNCS is defined. โญ
  • -mno-csync-anomaly โ€” don't generate extra code to prevent CSYNC or SSYNC instructions from occurring too soon after a conditional branch. ๐ŸŒธ
  • -mlow64k โ€” when enabled, the compiler is free to take advantage of the knowledge that the entire program fits into the low 64k of memory. ๐Ÿ‘‘
  • -mno-low64k โ€” assume that the program is arbitrarily large. this is the default. ๐Ÿ’œ
  • -mstack-check-l1 โ€” do stack checking using information placed into L1 scratchpad memory by the uClinux kernel. ๐Ÿงš
  • -mid-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 -fPIC. with a bfin-elf target, this option implies -msim. ๐Ÿ’–
  • -mno-id-shared-library โ€” generate code that doesn't assume ID-based shared libraries are being used. this is the default. ๐ŸŽ€
  • -mleaf-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. slay ๐Ÿ’…
  • -mno-leaf-id-shared-library โ€” do not assume that the code being compiled won't link against any ID shared libraries. slower code is generated for jump and call insns. the tradeoff, bestie ๐Ÿ˜ญ
  • -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. so likeโ€ฆ 0 or nothing, fr fr ๐Ÿฆ‹
  • -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 by eliminating relocations against the text section. โœจ
  • -mno-sep-data โ€” generate code that assumes that the data segment follows the text segment. this is the default. ๐Ÿ“
  • -mlong-calls, -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 -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. ๐Ÿ’€

  • -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. ๐Ÿ”ฅ
  • -minline-plt โ€” enable inlining of PLT entries in function calls to functions that are not known to bind locally. it has no effect without -mfdpic. โญ
  • -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 __BFIN_MULTICORE. it can only be used with -mcpu=bf561[-sirevision]. ๐Ÿ’œ

this option can be used with -mcorea or -mcoreb, which selects the one-application-per-core programming model. without -mcorea or -mcoreb, the single-application/dual-core programming model is used. in this model, the main function of Core B should be named as coreb_main. main character energy, but for core B ๐ŸŽ€

if this option is not used, the single-core application programming model is used.

  • -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 __BFIN_COREA is defined. this option can only be used in conjunction with -mmulticore. ๐ŸŒธ
  • -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 __BFIN_COREB is defined. when this option is used, coreb_main should be used instead of main. this option can only be used in conjunction with -mmulticore. ๐Ÿ‘‘
  • -msdram โ€” build a standalone application for SDRAM. proper start files and link scripts are used to put the application into SDRAM, and the macro __BFIN_SDRAM is defined. the loader should initialize SDRAM before loading the application. ๐Ÿฆ‹
  • -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. โœจ

โœจ C6X Options โœจ

Ok bestie, C6X time โ€” this is where you tell GCC exactly which flavour of TI DSP it's talking to ๐ŸŽ€

  • -march=name โ€” this is the name of the target architecture, and GCC uses it to figure out what kind of instructions it's even allowed to emit when it makes assembly code. The permissible names are c62x, c64x, c64x+, c67x, c67x+, c674x.
  • -mbig-endian โ€” generate code for a big-endian target.
  • -mlittle-endian โ€” generate code for a little-endian target. This one is the default, no cap.
  • -msim โ€” pick startup files and a linker script that are suitable for the simulator.
  • -msdata=default โ€” put small global and static data in the .neardata section, which is pointed to by register B14. Put small uninitialized global and static data in the .bss section, which sits adjacent to .neardata. Put small read-only data into the .rodata section. The corresponding sections used for large pieces of data are .fardata, .far and .const.
  • -msdata=all โ€” put all the data in the small-data sections, not just the small objects, and use addressing relative to the B14 register to access it all.
  • -msdata=none โ€” make no use of the small-data sections at all, and use absolute addresses to access every single piece of data. All initialized global and static data goes in .fardata, all uninitialized data goes in .far, and all constant data goes in .const.

โœจ CRIS Options โœจ

These ones are defined specifically for the CRIS ports, periodt ๐Ÿ’…

  • -march=architecture-type
  • -mcpu=architecture-type

Generate code for the specified architecture. The choices for architecture-type are v3, v8 and v10, for ETRAX 4, ETRAX 100, and ETRAX 100 LX respectively. The default is v0.

  • -mtune=architecture-type โ€” tune to architecture-type everything applicable about the generated code, except for the ABI and the set of available instructions. The choices for architecture-type are the same ones as for -march=architecture-type.
  • -mmax-stack-frame=n โ€” warn when the stack frame of a function exceeds n bytes.
  • -metrax4
  • -metrax100

The options -metrax4 and -metrax100 are synonyms for -march=v3 and -march=v8 respectively.

  • -mmul-bug-workaround
  • -mno-mul-bug-workaround

Work around a bug in the muls and mulu instructions, for CPU models where it applies. This option is disabled by default.

  • -mpdebug โ€” enable CRIS-specific verbose debug-related information in the assembly code. This option also has the effect of turning off the #NO_APP formatted-code indicator to the assembler at the beginning of the assembly file.
  • -mcc-init โ€” do not use condition-code results from a previous instruction; always emit compare and test instructions before use of condition codes.
  • -mno-side-effects โ€” do not emit instructions with side effects in addressing modes other than post-increment.
  • -mstack-align
  • -mno-stack-align
  • -mdata-align
  • -mno-data-align
  • -mconst-align
  • -mno-const-align

These options (and their no- versions) arrange โ€” or eliminate the arrangement โ€” 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.

  • -m32-bit
  • -m16-bit
  • -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.

  • -mno-prologue-epilogue
  • -mprologue-epilogue

With -mno-prologue-epilogue, the normal function prologue and epilogue that set up the stack frame are omitted, and no return instructions or return sequences are generated in the code.

โš ๏ธ girlypop, 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. It will not tell you. ๐Ÿ’€
  • -melf โ€” legacy no-op option. It's giving decoration.
  • -sim โ€” this option arranges to link with input-output functions from a simulator library. Code, initialized data and zero-initialized data are allocated consecutively.
  • -sim2 โ€” like -sim, but pass linker options to locate initialized data at 0x40000000 and zero-initialized data at 0x80000000.

โœจ C-SKY Options โœจ

GCC supports these options when compiling for C-SKY V2 processors ๐Ÿฆ‹

  • -march=arch โ€” specify the C-SKY target architecture. Valid values for arch are: ck801, ck802, ck803, ck807, and ck810. The default is ck810.
  • -mcpu=cpu โ€” specify the C-SKY target processor. Valid values for cpu are:
ck801, ck801t, ck802, ck802t, ck802j, ck803, ck803h, ck803t,
ck803ht, ck803f, ck803fh, ck803e, ck803eh, ck803et, ck803eht,
ck803ef, ck803efh, ck803ft, ck803eft, ck803efht, ck803r1, ck803hr1,
ck803tr1, ck803htr1, ck803fr1, ck803fhr1, ck803er1, ck803ehr1,
ck803etr1, ck803ehtr1, ck803efr1, ck803efhr1, ck803ftr1, ck803eftr1,
ck803efhtr1, ck803s, ck803st, ck803se, ck803sf, ck803sef, ck803seft,
ck807e, ck807ef, ck807, ck807f, ck810e, ck810et, ck810ef, ck810eft,
ck810, ck810v, ck810f, ck810t, ck810fv, ck810tv, ck810ft, and
ck810ftv.
  • -mbig-endian
  • -EB
  • -mlittle-endian
  • -EL

Select big- or little-endian code. The default is little-endian.

  • -mfloat-abi=name โ€” specifies which floating-point ABI to use. Permissible values are: soft, softfp and hard.

Specifying soft causes GCC to generate output containing library calls for floating-point operations. softfp allows the generation of code using hardware floating-point instructions, but still uses the soft-float calling conventions. 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.

  • -mhard-float
  • -msoft-float

Select hardware or software floating-point implementations. The default is soft float.

  • -mdouble-float
  • -mno-double-float

When -mhard-float is in effect, enable generation of double-precision float instructions. This is the default except when compiling for CK803.

  • -mfdivdu
  • -mno-fdivdu

When -mhard-float is in effect, enable generation of frecipd, fsqrtd, and fdivd instructions. This is the default except when compiling for CK803.

  • -mfpu=fpu โ€” select the floating-point processor. This option can only be used with -mhard-float. Values for fpu are fpv2_sf (equivalent to -mno-double-float -mno-fdivdu), fpv2 (-mdouble-float -mno-divdu), and fpv2_divd (-mdouble-float -mdivdu).
  • -melrw
  • -mno-elrw

Enable the extended lrw instruction. This option defaults to on for CK801 and off otherwise.

  • -mistack
  • -mno-istack

Enable interrupt stack instructions; the default is off.

The -mistack option is required to handle the interrupt and isr function attributes.

  • -mmp โ€” enable multiprocessor instructions; the default is off.
  • -mcp โ€” enable coprocessor instructions; the default is off.
  • -mcache โ€” enable coprocessor instructions; the default is off.
  • -msecurity โ€” enable C-SKY security instructions; the default is off.
  • -mtrust โ€” enable C-SKY trust instructions; the default is off.
  • -mdsp
  • -medsp
  • -mvdsp

Enable C-SKY DSP, Enhanced DSP, or Vector DSP instructions, respectively. All of these options default to off.

  • -mdiv
  • -mno-div

Generate divide instructions. Default is off.

  • -msmart
  • -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.

  • -mhigh-registers
  • -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.

  • -manchor
  • -mno-anchor

Generate code using global anchor symbol addresses.

  • -mpushpop
  • -mno-pushpop

Generate code using push and pop instructions. This option defaults to on.

  • -mmultiple-stld
  • -mstm
  • -mno-multiple-stld
  • -mno-stm

Generate code using stm and ldm instructions. This option isn't supported on CK801 but is enabled by default on other processors.

  • -mconstpool
  • -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.

  • -mstack-size
  • -mno-stack-size

Emit .stack_size directives for each function in the assembly output. This option defaults to off.

  • -mccrt
  • -mno-ccrt

Generate code for the C-SKY compiler runtime instead of libgcc. This option defaults to off.

  • -mbranch-cost=n โ€” set the branch costs to roughly n instructions. The default is 1.
  • -msched-prolog
  • -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. So likeโ€ฆ be careful bestie.
  • -msim โ€” links the library libsemi.a which is in compatible with simulator. Applicable to ELF compiler only.

โœจ 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 -arch options are used; it does so by running the compiler or linker multiple times and joining the results together with lipo.

The subtype of the file created (like ppc7400 or ppc970 or i686) is determined by the flags that specify the ISA that GCC is targeting, like -mcpu or -march. The -force_cpusubtype_ALL option can be used to override this.

okay so the Darwin tools are NOT all on the same page when you hit them with an ISA mismatch, and honestly? the drama ๐Ÿ’€

The assembler, as, is the strict one โ€” it only permits instructions to be used that are valid for the subtype of the file it's generating, so you cannot put 64-bit instructions in a ppc750 object file. Periodt. The linker for shared libraries, /usr/bin/libtool, also fails and prints an error if you ask it to create a shared library with a less restrictive subtype than its input files (like, trying to put a ppc970 object file in a ppc7400 library? denied bestie). And the linker for executables, ld, is the chill one โ€” it quietly gives the executable the most restrictive subtype of any of its input files. silent. decisive. iconic. โœจ


  • -Fdir โ€” adds the framework directory dir to the head of the list of directories to be searched for header files ๐Ÿ‘‘. These directories are interleaved with those specified by -I options and are scanned in a left-to-right order.

So what even is a framework directory, you ask? It's a directory with frameworks in it. A framework is a directory with a Headers and/or PrivateHeaders directory contained directly in it that ends in .framework. The name of a framework is the name of this directory excluding the .framework. Headers associated with the framework are found in one of those two directories, with Headers being searched first ๐Ÿ’–.

A subframework is a framework directory that is in a framework's 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 /System/Library/Frameworks and /Library/Frameworks. An example include looks like "#include <Framework/header.h>", where Framework denotes the name of the framework and header.h is found in the PrivateHeaders or Headers directory. ๐Ÿฆ‹

  • -iframeworkdir โ€” like -F except the directory is a treated as a system directory. The main difference between this -iframework and -F is that with -iframework the compiler does not warn about constructs contained within header files found via dir. This option is valid only for the C family of languages. โœจ
  • -gused โ€” emits debugging information for symbols that are used. For stabs debugging format, this enables -feliminate-unused-debug-symbols. This is by default ON ๐Ÿ’…
  • -gfull โ€” emits debugging information for all symbols and types. the way that it just gives you everything ๐Ÿ˜ญ
  • -fconstant-cfstrings โ€” the -fconstant-cfstrings is an alias for -mconstant-cfstrings. that's it, that's the whole flag ๐ŸŽ€
  • -mconstant-cfstrings โ€” when the NeXT runtime is being used (the default on these systems), override any -fconstant-string-class setting and cause @"..." literals to be laid out as constant CoreFoundation strings ๐Ÿ‘‘
  • -mmacosx-version-min=version โ€” the earliest version of MacOS X that this executable will run on is version. Typical values supported for version include 12, 10.12, and 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. ๐ŸŒˆ

  • -mkernel โ€” enable kernel development mode ๐Ÿ”ฅ The -mkernel option sets -static, -fno-common, -fno-use-cxa-atexit, -fno-exceptions, -fno-non-call-exceptions, -fapple-kext, -fno-weak and -fno-rtti where applicable. This mode also sets -mno-altivec, -msoft-float, -fno-builtin and -mlong-branch for PowerPC targets. it's giving main character energy, honestly
  • -mone-byte-bool โ€” override the defaults for bool so that sizeof(bool)==1. By default sizeof(bool) is 4 when compiling for Darwin/PowerPC and 1 when compiling for Darwin/x86, so this option has no effect on x86.
โš ๏ธ Warning: The -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. not a casual little flag, bestie, do NOT just vibe-check this one
  • -mfix-and-continue, -ffix-and-continue, -findirect-data โ€” generate code suitable for fast turnaround development, such as to allow GDB to dynamically load .o files into already-running programs ๐Ÿƒโ€โ™€๏ธ๐Ÿ’จ -findirect-data and -ffix-and-continue are provided for backwards compatibility.

and now for the Darwin linker girlies โ€” every single one of these gets passed to the Darwin linker, and the Darwin linker man page describes them in detail. iykyk ๐Ÿ“š

  • -all_load โ€” loads all members of static archive libraries. See man ld(1) for more information.
  • -arch_errors_fatal โ€” cause the errors having to do with files that have the wrong architecture to be fatal. ๐Ÿ’€
  • -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.
  • -bundle โ€” produce a Mach-o bundle format file. See man ld(1) for more information.
  • -bundle_loader executable โ€” this option specifies the executable that will load the build output file being linked. See man ld(1) for more information.
  • -dynamiclib โ€” when passed this option, GCC produces a dynamic library instead of an executable when linking, using the Darwin libtool command.
  • -force_cpusubtype_ALL โ€” this causes GCC's output file to have the ALL subtype, instead of one controlled by the -mcpu or -march option.
  • -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 -nodefaultrpaths to the link line. Run paths are needed (and therefore enforced) to build on macOS version 10.11 or later.
  • -allowable_client client_name
  • -client_name
  • -compatibility_version
  • -current_version
  • -dead_strip
  • -dependency-file
  • -dylib_file
  • -dylinker_install_name
  • -dynamic
  • -exported_symbols_list
  • -filelist
  • -flat_namespace
  • -force_flat_namespace
  • -headerpad_max_install_names
  • -image_base
  • -init
  • -install_name
  • -keep_private_externs
  • -multi_module
  • -multiply_defined
  • -multiply_defined_unused
  • -noall_load
  • -no_dead_strip_inits_and_terms
  • -nofixprebinding
  • -nomultidefs
  • -noprebind
  • -noseglinkedit
  • -pagezero_size
  • -prebind
  • -prebind_all_twolevel_modules
  • -private_bundle
  • -read_only_relocs
  • -sectalign
  • -sectobjectsymbols
  • -whyload
  • -seg1addr
  • -sectcreate
  • -sectobjectsymbols
  • -sectorder
  • -segaddr
  • -segs_read_only_addr
  • -segs_read_write_addr
  • -seg_addr_table
  • -seg_addr_table_filename
  • -seglinkedit
  • -segprot
  • -segs_read_only_addr
  • -segs_read_write_addr
  • -single_module
  • -static
  • -sub_library
  • -sub_umbrella
  • -twolevel_namespace
  • -umbrella
  • -undefined
  • -unexported_symbols_list
  • -weak_reference_mismatches
  • -whatsloaded

these options are passed to the Darwin linker. The Darwin linker man page describes them in detail. ๐Ÿซถ


๐Ÿฆ‹ DEC Alpha Options ๐Ÿฆ‹

These -m options are defined for the DEC Alpha implementations:

  • -mno-soft-float, -msoft-float โ€” use (do not use) the hardware floating-point instructions for floating-point operations. When -msoft-float is specified, functions in 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. the way that it needs the registers even when it's not using them ๐Ÿ˜ญ

  • -mfp-reg, -mno-fp-regs โ€” generate code that uses (does not use) the floating-point register set. -mno-fp-regs implies -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 $0 instead of $f0. This is a non-standard calling sequence, so any function with a floating-point argument or return value called by code compiled with -mno-fp-regs must also be compiled with that option. โš ๏ธ like, the whole call chain has to match or it's over

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. ๐Ÿ‘‘

  • -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 except that the inexact-flag is not maintained (see below). If this option is turned on, the preprocessor macro _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 -ieee_with_no_inexact. โœจ
  • -mieee-with-inexact โ€” this is like -mieee except the generated code also maintains the IEEE inexact-flag. Turning on this option causes the generated code to implement fully-compliant IEEE math ๐Ÿงฎ In addition to _IEEE_FP, _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 inexact-flag, you should normally not specify this option. Other Alpha compilers call this option -ieee_with_inexact.
  • -mfp-trap-mode=trap-mode โ€” this option controls what floating-point related traps are enabled. Other Alpha compilers call this option -fptm trap-mode. The trap mode can be set to one of four values:
    • 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).
    • u โ€” in addition to the traps enabled by n, underflow traps are enabled as well.
    • su โ€” like u, but the instructions are marked to be safe for software completion (see Alpha architecture manual for details).
  • sui โ€” literally just like su, except inexact traps are enabled too. slay. ๐Ÿ’…

  • -mfp-rounding-mode=rounding-mode โ€” picks the IEEE rounding mode. other Alpha compilers call this one -fprm rounding-mode. bestie, the rounding-mode has to be one of these:
    • n โ€” Normal IEEE rounding mode. floating-point numbers get rounded towards the nearest machine number, or towards the even machine number when it's a tie. very "no drama, we go with the flow" of it.
    • m โ€” Round towards minus infinity. going down, always down ๐Ÿซถ
    • c โ€” Chopped rounding mode. floating-point numbers get rounded towards zero. it's giving "we don't round, we truncate".
    • d โ€” Dynamic rounding mode. there's a field in the floating-point control register (fpcr, see Alpha architecture reference manual) that controls which rounding mode is actually in effect. the C library initializes this register for rounding towards plus infinity. so unless your program goes in and modifies the fpcr, d = round towards plus infinity. iykyk.
  • -mtrap-precision=trap-precision โ€” okay so in the Alpha architecture, floating-point traps are imprecise ๐Ÿ˜ญ which means without software help it's genuinely impossible to recover from a floating trap, and program execution normally just has to be terminated. GCC can generate code that helps OS trap handlers figure out the exact location that caused the floating-point trap. depending on what your app needs, you can pick different levels of precision:
    • p โ€” Program precision. this one is the default, and it means a trap handler can only identify which program caused the floating-point exception. the vibes are vague on purpose.
    • f โ€” Function precision. the trap handler can determine the function that caused the floating-point exception.
    • i โ€” Instruction precision. the trap handler can determine the exact instruction that caused the floating-point exception. main character precision, periodt.

other Alpha compilers hand you the equivalent options named -scope_safe and -resumption_safe.

  • -mieee-conformant โ€” this marks the generated code as IEEE conformant. โš ๏ธ bestie you must not use this option unless you also specify -mtrap-precision=i and either -mfp-trap-mode=su or -mfp-trap-mode=sui. its one and only effect is to emit the line .eflag 48 in the function prologue of the generated assembly file.
  • -mbuild-constants โ€” normally GCC looks at a 32- or 64-bit integer constant and checks whether it can build it out of smaller constants in two or three instructions. if it can't, 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 all integer constants using code, even when that takes more instructions (the max is six). you typically reach for this one when building a shared library dynamic loader โ€” itself a shared library, it has to relocate itself in memory before it can find the variables and constants in its own data segment. ๐ŸŒ€
  • -mbwx, -mno-bwx, -mcix, -mno-cix, -mfix, -mno-fix, -mmax, -mno-max โ€” these tell GCC whether it should generate code that uses the optional BWX, CIX, FIX and MAX instruction sets. the default is to use the instruction sets supported by the CPU type you specified via the -mcpu= option โ€” or the instruction sets of the CPU GCC was built on, if you didn't specify anything.
  • -mfloat-vax, -mfloat-ieee โ€” generate code that uses (or, you know, does not use) VAX F and G floating-point arithmetic instead of IEEE single and double precision. pick your fighter. โœจ
  • -mexplicit-relocs, -mno-explicit-relocs โ€” back in the day, older Alpha assemblers gave you no way to generate symbol relocations except through assembler macros. and using those macros does not allow optimal instruction scheduling ๐Ÿ˜ค. GNU binutils as of version 2.12 supports a new syntax that lets the compiler explicitly mark which relocations apply to which instructions. this option is mostly useful for debugging, since GCC detects the capabilities of the assembler when it's built and sets the default accordingly.
  • -msmall-data, -mlarge-data โ€” when -mexplicit-relocs is in effect, static data gets accessed via gp-relative relocations. with -msmall-data, objects that are 8 bytes long or smaller go into a small data area (the .sdata and .sbss sections) and are accessed via 16-bit relocations off of the $gp register. this caps the small data area at 64KB, but it lets the variables be directly accessed with a single instruction. so cute, so efficient.

the default is -mlarge-data. with that one, the data area is limited to just below 2GB. programs that need more than 2GB of data have to use malloc or mmap to allocate the data in the heap instead of in the program's data segment. no cap fr.

when generating code for shared libraries, -fpic implies -msmall-data and -fPIC implies -mlarge-data.

  • -msmall-text, -mlarge-text โ€” with -msmall-text, the compiler assumes the code of the entire program (or shared library) fits in 4MB, and is therefore reachable with a branch instruction. when -msmall-data is used, the compiler can assume that all local symbols share the same $gp value, and thus reduce the number of instructions needed for a function call from 4 down to 1. glow up ๐Ÿ“ˆ

the default is -mlarge-text.

  • -mcpu=cpu_type โ€” sets the instruction set and the instruction scheduling parameters for machine type cpu_type. you can give either the EV style name or the corresponding chip number. GCC supports scheduling parameters for the EV4, EV5 and EV6 family of processors and picks the default values for the instruction set from the processor you specify. if you don't specify a processor type, GCC defaults to the processor on which the compiler was built.

supported values for cpu_type are:

  • ev4, ev45, 21064 โ€” schedules as an EV4 and has no instruction set extensions.
  • ev5, 21164 โ€” schedules as an EV5 and has no instruction set extensions.
  • ev56, 21164a โ€” schedules as an EV5 and supports the BWX extension.
  • pca56, 21164pc, 21164PC โ€” schedules as an EV5 and supports the BWX and MAX extensions.
  • ev6, 21264 โ€” schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
  • ev67, 21264a โ€” schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.

native toolchains also support the value native, which selects the best architecture option for the host processor. heads up: -mcpu=native has no effect if GCC doesn't recognize the processor. ๐Ÿ™ˆ

  • -mtune=cpu_type โ€” sets only the instruction scheduling parameters for machine type cpu_type. the instruction set stays exactly as it was, untouched, unbothered. ๐Ÿ’…

native toolchains also support the value native, which selects the best architecture option for the host processor. and again: -mtune=native has no effect if GCC doesn't recognize the processor.

  • -mmemory-latency=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 your application uses and on the size of the external cache on the machine. valid options for time are:
    • number โ€” a decimal number representing clock cycles.
    • L1, L2, L3, main โ€” the compiler has built-in 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), plus main memory. note that L3 is only valid for EV5. ๐Ÿ‘‘

โœจ eBPF Options โœจ

  • -mframe-limit=bytes โ€” specifies the hard limit for frame sizes, in bytes. right now, the value you can specify should be less than or equal to 32767. defaults to whatever limit is imposed by the version of the Linux kernel being targeted.
  • -mbig-endian โ€” generate code for a big-endian target.
  • -mlittle-endian โ€” generate code for a little-endian target. this is the default. tiny endian supremacy ๐ŸŽ€
  • -mjmpext, -mno-jmpext โ€” enable or disable generation of extra conditional-branch instructions. enabled for CPU v2 and above.
  • -mjmp32, -mno-jmp32 โ€” enable or disable generation of 32-bit jump instructions. enabled for CPU v3 and above.
  • -malu32, -mno-alu32 โ€” enable or disable generation of 32-bit ALU instructions. enabled for CPU v3 and above.
  • -mv3-atomics, -mno-v3-atomics โ€” enable or disable instructions for general atomic operations introduced in CPU v3. enabled for CPU v3 and above.
  • -mbswap, -mno-bswap โ€” enable or disable byte swap instructions. enabled for CPU v4 and above.
  • -msdiv, -mno-sdiv โ€” enable or disable signed division and modulus instructions. enabled for CPU v4 and above.
  • -msmov, -mno-smov โ€” enable or disable sign-extending move and memory load instructions. enabled for CPU v4 and above.
  • -mcpu=version โ€” specifies which version of the eBPF ISA to target. newer versions may not be supported by all kernels, so know your kernel bestie. the default is v4.

supported values for version are:

  • v1 โ€” the first stable eBPF ISA with no special features or extensions.
  • v2 โ€” supports the jump extensions, as in -mjmpext.
  • v3 โ€” all features of v2, plus:
    • 32-bit jump operations, as in -mjmp32
    • 32-bit ALU operations, as in -malu32
    • general atomic operations, as in -mv3-atomics
  • v4 โ€” all features of v3, plus:
    • byte swap instructions, as in -mbswap
    • signed division and modulus instructions, as in -msdiv
    • sign-extending move and memory load instructions, as in -msmov
  • -mco-re โ€” enable BPF Compile Once - Run Everywhere (CO-RE) support. requires -gbtf, and is implied by -gbtf. ๐ŸŒˆ
  • -mno-co-re โ€” 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.
  • -mxbpf โ€” generate code for an expanded version of BPF, which relaxes some of the restrictions imposed by the BPF architecture:
    • save and restore callee-saved registers at function entry and exit, respectively.
  • -masm=dialect โ€” outputs assembly instructions using eBPF selected dialect. the default is pseudoc.

supported values for dialect are:

  • normal โ€” outputs normal assembly dialect.
  • pseudoc โ€” outputs pseudo-c assembly dialect.
  • -minline-memops-threshold=bytes โ€” sets a size threshold, in bytes, at or below which memmove, memcpy and memset are always expanded inline. Anything bigger than that threshold would need a library call instead of inline expansion, but since BPF straight up doesn't allow libcalls, going over this threshold = compile-time error, no cap. Default is 1024 bytes.

๐ŸŽ€ FR30 Options ๐ŸŽ€

These ones are defined specifically for the FR30 port, bestie.

  • -msmall-model โ€” use the small address space model. Smaller code vibes, but it does assume all symbolic values and addresses fit into a 20-bit range. ๐Ÿ‘€
  • -mno-lsim โ€” assume runtime support has already been provided, so there's no need to include the simulator library (libsim.a) on the linker command line.

๐ŸŒธ FT32 Options ๐ŸŒธ

Defined specifically for the FT32 port, periodt.

  • -msim โ€” says the program will be run on the simulator. This makes an alternate runtime startup and library get linked in. > You must not use this option when generating programs that will run on real hardware โ€” you have to provide your own runtime library for whatever I/O functions are needed. ๐Ÿ’€
  • -mlra โ€” enable Local Register Allocation. Still experimental for FT32, so by default the compiler uses standard reload.
  • -mnodiv โ€” do not use div and mod instructions.
  • -mft32b โ€” enable use of the extended instructions of the FT32B processor. โœจ
  • -mcompress โ€” compress all code using the Ft32B code compression scheme.
  • -mnopm โ€” do not generate code that reads program memory.

๐Ÿฆ‹ FRV Options ๐Ÿฆ‹

  • -mgpr-32 โ€” only use the first 32 general-purpose registers.
  • -mgpr-64 โ€” use all 64 general-purpose registers.
  • -mfpr-32 โ€” use only the first 32 floating-point registers.
  • -mfpr-64 โ€” use all 64 floating-point registers.
  • -mhard-float โ€” use hardware instructions for floating-point operations.
  • -msoft-float โ€” use library routines for floating-point operations.
  • -malloc-cc โ€” dynamically allocate condition code registers.
  • -mfixed-cc โ€” do not try to dynamically allocate condition code registers, only use icc0 and fcc0.
  • -mdword โ€” change ABI to use double word insns.
  • -mno-dword โ€” do not use double word instructions.
  • -mdouble โ€” use floating-point double instructions.
  • -mno-double โ€” do not use floating-point double instructions.
  • -mmedia โ€” use media instructions.
  • -mno-media โ€” do not use media instructions.
  • -mmuladd โ€” use multiply and add/subtract instructions.
  • -mno-muladd โ€” do not use multiply and add/subtract instructions.
  • -mfdpic โ€” select the FDPIC ABI, which uses function descriptors to represent pointers to functions. Without any PIC/PIE-related options, it implies -fPIE. With -fpic or -fpie, it assumes GOT entries and small data are within a 12-bit range from the GOT base address; with -fPIC or -fPIE, GOT offsets are computed with 32 bits. With a bfin-elf target, this option implies -msim.
  • -minline-plt โ€” enable inlining of PLT entries in function calls to functions that are not known to bind locally. It has no effect without -mfdpic. It's enabled by default if optimizing for speed and compiling for shared libraries (i.e., -fPIC or -fpic), or when an optimization option such as -O3 or above is present in the command line.
  • -mTLS โ€” assume a large TLS segment when generating thread-local code.
  • -mtls โ€” do not assume a large TLS segment when generating thread-local code.
  • -mgprel-ro โ€” enable the use of GPREL relocations in the FDPIC ABI for data that is known to be in read-only sections. It's enabled by default, except for -fpic or -fpie: even though it may help make the global offset table smaller, it trades 1 instruction for 4. With -fPIC or -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, -mno-gprel-ro can be used to disable it.
  • -multilib-library-pic โ€” link with the (library, not FD) pic libraries. It's implied by -mlibrary-pic, as well as by -fPIC and -fpic without -mfdpic. You should never have to use it explicitly.
  • -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 -mno-linked-fp.
  • -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. ๐ŸŒˆ
  • -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.
  • -mlibrary-pic โ€” generate position-independent EABI code.
  • -macc-4 โ€” use only the first four media accumulator registers.
  • -macc-8 โ€” use all eight media accumulator registers.
  • -mpack โ€” pack VLIW instructions.
  • -mno-pack โ€” do not pack VLIW instructions.
  • -mno-eflags โ€” do not mark ABI switches in e_flags.
  • -mcond-move โ€” enable the use of conditional-move instructions (default).
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mno-cond-move โ€” disable the use of conditional-move instructions.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mscc โ€” enable the use of conditional set instructions (default).
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mno-scc โ€” disable the use of conditional set instructions.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mcond-exec โ€” enable the use of conditional execution (default).
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mno-cond-exec โ€” disable the use of conditional execution.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mvliw-branch โ€” run a pass to pack branches into VLIW instructions (default).
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mno-vliw-branch โ€” do not run a pass to pack branches into VLIW instructions.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mmulti-cond-exec โ€” enable optimization of && and || in conditional execution (default).
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mno-multi-cond-exec โ€” disable optimization of && and || in conditional execution.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mnested-cond-exec โ€” enable nested conditional execution optimizations (default).
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -mno-nested-cond-exec โ€” disable nested conditional execution optimizations.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘€
  • -moptimize-membar โ€” this switch removes redundant membar instructions from the compiler-generated code. It is enabled by default.
  • -mno-optimize-membar โ€” this switch disables the automatic removal of redundant membar instructions from the generated code.
  • -mtomcat-stats โ€” cause gas to print out tomcat statistics.
  • -mcpu=cpu โ€” select the processor type for which to generate code. Possible values are frv, fr550, tomcat, fr500, fr450, fr405, fr400, fr300 and simple. โœจ

๐Ÿ’œ GNU/Linux Options ๐Ÿ’œ

These -m options are defined for GNU/Linux targets:

  • -mglibc โ€” use the GNU C library. This is the default except on *-*-linux-*uclibc*, *-*-linux-*musl* and *-*-linux-*android* targets.
  • -muclibc โ€” use uClibc C library. This is the default on *-*-linux-*uclibc* targets.
  • -mmusl โ€” use the musl C library. This is the default on *-*-linux-*musl* targets.
  • -mbionic โ€” use Bionic C library. This is the default on *-*-linux-*android* targets.
  • -mandroid โ€” compile code compatible with Android platform. This is the default on *-*-linux-*android* targets.

When compiling, this option enables -mbionic, -fPIC, -fno-exceptions and -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 __ANDROID__ to be defined. ๐Ÿค–

  • -tno-android-cc โ€” disable compilation effects of -mandroid, i.e., do not enable -mbionic, -fPIC, -fno-exceptions and -fno-rtti by default.
  • -tno-android-ld โ€” disable linking effects of -mandroid, i.e., pass standard Linux linking options to the linker.

๐Ÿ“ H8/300 Options ๐Ÿ“

These -m options are defined for the H8/300 implementations:

  • -mrelax โ€” shorten some address references at link time, when possible; uses the linker option -relax.
  • -mh โ€” generate code for the H8/300H.
  • -ms โ€” generate code for the H8S.
  • -mn โ€” generate code for the H8S and H8/300H in the normal mode. This switch must be used either with -mh or -ms.
  • -ms2600 โ€” generate code for the H8S/2600. This switch must be used with -ms.
  • -mexr โ€” extended registers are stored on stack before execution of function with monitor attribute. Default option is -mexr. This option is valid only for H8S targets.
  • -mno-exr โ€” extended registers are not stored on stack before execution of function with monitor attribute. Default option is -mno-exr. This option is valid only for H8S targets.
  • -mint32 โ€” make int data 32 bits by default.
  • -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. -malign-300 causes them to be aligned on 2-byte boundaries. This option has no effect on the H8/300.

๐ŸŽ€ HPPA Options ๐ŸŽ€

okay bestie, these -m options are the ones defined for the HPPA family of computers:

  • -march=architecture-type โ€” generate code for the architecture you name. The choices for architecture-type are 1.0 for PA 1.0, 1.1 for PA 1.1, and 2.0 for PA 2.0 processors. Go peek at /usr/lib/sched.models on an HP-UX system to figure out the proper architecture option for your machine. And listen: code compiled for lower-numbered architectures runs on higher-numbered architectures, but not the other way around. ๐Ÿ’…
  • -mpa-risc-1-0 โ€” synonym for -march=1.0, fr fr.
  • -mpa-risc-1-1 โ€” synonym for -march=1.1, no cap.
  • -mpa-risc-2-0 โ€” synonym for -march=2.0, periodt.
  • -matomic-libcalls โ€” generate libcalls for atomic loads and stores when sync libcalls are disabled. This one is enabled by default โœจ. It only affects the generation of atomic libcalls by the HPPA backend, iykyk.

Both the sync and 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're implemented as a single access.

The PA-RISC architecture does not support any atomic operations in hardware except for the "ldcw" instruction. So all atomic support is implemented using sync and atomic libcalls. Sync libcall support lives in libgcc.a. Atomic libcall support lives in libatomic.

This option generates "__atomic_exchange" calls for atomic stores. It also provides special handling for atomic DImode accesses on 32-bit targets. ๐Ÿซถ

  • -mbig-switch โ€” does literally nothing ๐Ÿ™ˆ. Preserved for backward compatibility.
  • -mcaller-copies โ€” the caller copies function arguments passed by hidden reference. Use this one with care, bestie, because 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.
  • -mcoherent-ldcw โ€” use ldcw/ldcd coherent cache-control hint. โœจ
  • -mdisable-fpregs โ€” disable floating-point registers. Equivalent to -msoft-float.
  • -mdisable-indexing โ€” stop the compiler from using indexing address modes. This avoids some rather obscure problems when compiling MIG generated code under MACH.
  • -mfast-indirect-calls โ€” generate code that assumes calls never cross space boundaries. This lets GCC emit code that performs faster indirect calls. ๐ŸŽ๏ธ
This option does not work in the presence of shared libraries or nested functions. ๐Ÿ’€
  • -mfixed-range=register-range โ€” generate code treating the given register range as fixed registers. A fixed register is one that the register allocator cannot use. Super 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.
  • -mgas โ€” enable the use of assembler directives only GAS understands. ๐Ÿ‘‘
  • -mgnu-ld โ€” use options specific to GNU ld. This passes -shared to ld when building a shared library. It's the default when GCC is configured, explicitly or implicitly, with the GNU linker. This option does not affect which ld is called; it only changes what parameters get passed to that ld. The ld that's called is determined by the --with-ld configure option, GCC's program search path, and finally by the user's PATH. The linker used by GCC can be printed using which \gcc -print-prog-name=ld`. This option is only available on the 64-bit HP-UX GCC, i.e. configured with hppa*64*--hpux`.
  • -mhp-ld โ€” use options specific to HP ld. This passes -b to ld when building a shared library and passes +Accept TypeMismatch to ld on all links. It's the default when GCC is configured, explicitly or implicitly, with the HP linker. This option does not affect which ld is called; it only changes what parameters get passed to that ld. The ld that's called is determined by the --with-ld configure option, GCC's program search path, and finally by the user's PATH. The linker used by GCC can be printed using which \gcc -print-prog-name=ld`. This option is only available on the 64-bit HP-UX GCC, i.e. configured with hppa*64*--hpux`.
  • -mlinker-opt โ€” enable the optimization pass in the HP-UX linker. Heads up bestie: this makes symbolic debugging impossible ๐Ÿ˜ญ. It also triggers a bug in the HP-UX 8 and HP-UX 9 linkers where they give bogus error messages when linking some programs.
  • -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. Sibcalls are always limited at 240,000 bytes.

Distances are measured from the beginning of functions when using the -ffunction-sections option, or when using the -mgas and -mno-portable-runtime options together under HP-UX with the SOM linker.

It's normally not desirable to use this option, since 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 depend 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. ๐ŸŒˆ

  • -mlong-load-store โ€” generate 3-instruction load and store sequences as sometimes required by the HP-UX 10 linker. This is equivalent to the +k option to the HP compilers.
  • -mjump-in-delay โ€” this option is ignored and provided for compatibility purposes only. ๐Ÿ™ˆ
  • -mno-space-regs โ€” generate code that assumes the target has no space registers. This lets GCC generate faster indirect calls and use unscaled index address modes. Such code is suitable for level 0 PA systems and kernels. ๐Ÿฆ‹
  • -mordered โ€” assume memory references are ordered and barriers are not needed.
  • -mportable-runtime โ€” use the portable calling conventions proposed by HP for ELF systems.
  • -mschedule=cpu-type โ€” schedule code according to the constraints for the machine type cpu-type. The choices for cpu-type are 700, 7100, 7100LC, 7200, 7300 and 8000. Go check /usr/lib/sched.models on an HP-UX system to figure out the proper scheduling option for your machine. The default scheduling is 8000. โœจ
  • -msio โ€” generate the predefine "_SIO" for server IO. The default is -mwsio. This generates the predefines "__hp9000s700", "__hp9000s700__" and "_WSIO" for workstation IO. These options are available under HP-UX and HI-UX.
  • -msoft-float โ€” generate output containing library calls for floating point. โš ๏ธ 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.

-msoft-float changes the calling convention in the output file; therefore, it's only useful if you compile all of a program with this option. In particular, you need to compile libgcc.a, the library that comes with GCC, with -msoft-float in order for this to work.

  • -msoft-mult โ€” use software integer multiplication. This disables the use of the "xmpyu" instruction.
  • -munix=unix-std โ€” generate compiler predefines and select a startfile for the specified UNIX standard. The choices for unix-std are 93, 95 and 98. 93 is supported on all HP-UX versions. 95 is available on HP-UX 10.10 and later. 98 is available on HP-UX 11.11 and later. The default values are 93 for HP-UX 10.00, 95 for HP-UX 10.10 through to 11.00, and 98 for HP-UX 11.11 and later.

-munix=93 provides the same predefines as GCC 3.3 and 3.4. -munix=95 provides additional predefines for "XOPEN_UNIX" and "_XOPEN_SOURCE_EXTENDED", and the startfile unix95.o. -munix=98 provides additional predefines for "_XOPEN_UNIX", "_XOPEN_SOURCE_EXTENDED", "_INCLUDE__STDC_A1_SOURCE" and "_INCLUDE_XOPEN_SOURCE_500", and the startfile unix98.o.

It is important to note that this option changes the interfaces for various library routines. It also affects the operational behavior of the C library. So extreme care is needed when using this option, bestie, I'm serious. ๐Ÿ˜ญ

Library code that's intended to operate with more than one UNIX standard must test, set and restore the variable "__xpg4_extended_mask" as appropriate. Most GNU software doesn't provide this capability.

  • -nolibdld โ€” suppress the generation of link options to search libdld.sl when the -static option is specified on HP-UX 10 and later.
  • -static โ€” the HP-UX implementation of setlocale in libc has a dependency on libdld.sl. There isn't an archive version of libdld.sl. So when the -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 libdld.sl when the -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 -nolibdld option can be used to prevent the GCC driver from adding these link options.

  • -threads โ€” add support for multithreading with the dce thread library under HP-UX. This option sets flags for both the preprocessor and linker. ๐Ÿงš

๐Ÿ’œ IA-64 Options ๐Ÿ’œ

These are the -m options defined for the Intel IA-64 architecture. ๐Ÿ‘‘

  • -mbig-endian โ€” generate code for a big-endian target. This is the default for HP-UX.
  • -mlittle-endian โ€” generate code for a little-endian target. This is the default for AIX5 and GNU/Linux. ๐Ÿง
  • -mgnu-as โ€” generate code for the GNU assembler. This is the default.
  • -mno-gnu-as โ€” don't generate code for the GNU assembler.
  • -mgnu-ld โ€” generate code for the GNU linker. This is the default.
  • -mno-gnu-ld โ€” don't generate code for the GNU linker.
  • -mno-pic โ€” generate code that does not use a global pointer register. Bestie, the result is not position independent code, and it violates the IA-64 ABI. ๐Ÿ’€ So likeโ€ฆ know what you're doing, okay?
  • -mvolatile-asm-stop, -mno-volatile-asm-stop โ€” do (or don't) generate a stop bit right before and right after volatile asm statements. ๐ŸŽ€
  • -mregister-names, -mno-register-names โ€” do (or don't) generate in, loc, and out register names for the stacked registers. This may make assembler output more readable โ€” it's giving "actually legible, thank u". โœจ
  • -mno-sdata, -msdata โ€” disable (or enable) optimizations that use the small data section. Lowkey useful for working around optimizer bugs. ๐Ÿ›
  • -mconstant-gp โ€” generate code that uses a single constant global pointer value. Iconic for compiling kernel code. ๐Ÿ‘‘
  • -mauto-pic โ€” generate code that is self-relocatable. This implies -mconstant-gp. Obsessed, honestly โ€” it's for compiling firmware code. ๐Ÿงš
  • -minline-float-divide-min-latency โ€” generate code for inline divides of floating-point values using the minimum latency algorithm. ๐Ÿ“
  • -minline-float-divide-max-throughput โ€” generate code for inline divides of floating-point values using the maximum throughput algorithm. ๐Ÿ”ฅ
  • -mno-inline-float-divide โ€” do not generate inline code for divides of floating-point values. ๐Ÿ™ˆ
  • -minline-int-divide-min-latency โ€” generate code for inline divides of integer values using the minimum latency algorithm. โญ
  • -minline-int-divide-max-throughput โ€” generate code for inline divides of integer values using the maximum throughput algorithm. ๐Ÿ’œ
  • -mno-inline-int-divide โ€” do not generate inline code for divides of integer values. ๐Ÿ’€
  • -minline-sqrt-min-latency โ€” generate code for inline square roots using the minimum latency algorithm. ๐ŸŒธ
  • -minline-sqrt-max-throughput โ€” generate code for inline square roots using the maximum throughput algorithm. ๐ŸŒˆ
  • -mno-inline-sqrt โ€” do not generate inline code for "sqrt". no cap.
  • -mfused-madd, -mno-fused-madd โ€” do (don't) generate code that uses the fused multiply/add or multiply/subtract instructions. The default is to use these instructions. slay. ๐Ÿ’…
  • -mno-dwarf2-asm, -mdwarf2-asm โ€” don't (or do) generate assembler code for the DWARF line number debugging info. This may be useful when you're not using the GNU assembler. ๐Ÿฆ‹
  • -mearly-stop-bits, -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. it's giving "results may vary". ๐Ÿ˜ญ
  • -mfixed-range=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. ๐ŸŽ€
  • *-mtls-size=tls-size* โ€” specify bit size of immediate TLS offsets. Valid values are 14, 22, and 64. ๐Ÿ‘‘
  • *-mtune=cpu-type* โ€” tune the instruction scheduling for a particular CPU. Valid values are itanium, itanium1, merced, itanium2, and mckinley. โœจ
  • -milp32, -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. ๐Ÿซถ
  • -mno-sched-br-data-spec, -msched-br-data-spec โ€” (dis/en)able data speculative scheduling before reload. This results in generation of "ld.a" instructions and the corresponding check instructions ("ld.c" / "chk.a"). The default setting is disabled. ๐Ÿ’€
  • -msched-ar-data-spec, -mno-sched-ar-data-spec โ€” (en/dis)able data speculative scheduling after reload. This results in generation of "ld.a" instructions and the corresponding check instructions ("ld.c" / "chk.a"). The default setting is enabled. ๐Ÿ”ฅ
  • -mno-sched-control-spec, -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 "ld.s" instructions and the corresponding check instructions "chk.s". The default setting is disabled. ๐Ÿ™ˆ
  • -msched-br-in-data-spec, -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 -msched-br-data-spec enabled. The default setting is enabled. โญ
  • -msched-ar-in-data-spec, -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 -msched-ar-data-spec enabled. The default setting is enabled. ๐ŸŒธ
  • -msched-in-control-spec, -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 -msched-control-spec enabled. The default setting is enabled. ๐ŸŒˆ
  • -mno-sched-prefer-non-data-spec-insns, -msched-prefer-non-data-spec-insns โ€” if enabled, data-speculative instructions are chosen for schedule only if there are no other choices at the moment. This makes the use of the data speculation much more conservative. The default setting is disabled. ๐Ÿงš
  • -mno-sched-prefer-non-control-spec-insns, -msched-prefer-non-control-spec-insns โ€” if enabled, control-speculative instructions are chosen for schedule only if there are no other choices at the moment. This makes the use of the control speculation much more conservative. The default setting is disabled. ๐Ÿ’œ
  • -mno-sched-count-spec-in-critical-path, -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. ๐Ÿ“
  • -msched-spec-ldc โ€” use a simple data speculation check. This option is on by default. ๐Ÿ’…
  • -msched-control-spec-ldc โ€” use a simple check for control speculation. This option is on by default. โœจ
  • -msched-stop-bits-after-every-cycle โ€” place a stop bit after every cycle when scheduling. This option is on by default. ๐Ÿ‘‘
  • -msched-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. ๐Ÿฆ‹
  • -msel-sched-dont-check-control-spec โ€” generate checks for control speculation in selective scheduling. This flag is disabled by default. ๐Ÿ˜ญ
  • -msched-max-memory-insns=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. ๐ŸŽ€
  • -msched-max-memory-insns-hard-limit โ€” makes the limit specified by 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. ๐Ÿ”ฅ

LM32 Options ๐ŸŒธ

These -m options are defined for the LatticeMico32 architecture:

  • -mbarrel-shift-enabled โ€” enable barrel-shift instructions. ๐ŸŽ€
  • -mdivide-enabled โ€” enable divide and modulus instructions. ๐Ÿ’œ
  • -mmultiply-enabled โ€” enable multiply instructions. โœจ
  • -msign-extend-enabled โ€” enable sign extend instructions. โญ
  • -muser-enabled โ€” enable user-defined instructions. ๐Ÿ‘‘ like, build-your-own, but for opcodes.

LoongArch Options ๐Ÿ‰

These command-line options are defined for LoongArch targets:

  • -march=arch-type โ€” generate instructions for the machine type arch-type. -march=arch-type allows GCC to generate code that **may not run at all on processors other than the one indicated. โš ๏ธ

The choices for arch-type are:

  • native โ€” local processor type detected by the native compiler.
  • loongarch64 โ€” generic LoongArch 64-bit processor.
  • la464 โ€” LoongArch LA464-based processor with LSX, LASX.
  • la664 โ€” LoongArch LA664-based processor with LSX, LASX and all LoongArch v1.1 instructions.
  • la64v1.0 โ€” LoongArch64 ISA version 1.0.
  • la64v1.1 โ€” LoongArch64 ISA version 1.1.

More information about LoongArch ISA versions can be found at <https://github.com/loongson/la-toolchain-conventions>. ๐Ÿฆ‹

  • *-mtune=tune-type* โ€” optimize the generated code for the given processor target.

The choices for tune-type are:

  • native โ€” local processor type detected by the native compiler.
  • generic โ€” generic LoongArch processor.
  • loongarch64 โ€” generic LoongArch 64-bit processor.
  • la464 โ€” LoongArch LA464 core.
  • la664 โ€” LoongArch LA664 core.
  • *-mabi=base-abi-type* โ€” generate code for the specified calling convention. base-abi-type can be one of:
    • lp64d โ€” uses 64-bit general purpose registers and 32/64-bit floating-point registers for parameter passing. Data model is LP64, where int is 32 bits, while long int and pointers are 64 bits.
    • lp64f โ€” uses 64-bit general purpose registers and 32-bit floating-point registers for parameter passing. Data model is LP64, where int is 32 bits, while long int and pointers are 64 bits.
    • lp64s โ€” uses 64-bit general purpose registers and no floating-point registers for parameter passing. Data model is LP64, where int is 32 bits, while long int and pointers are 64 bits.
  • *-mfpu=fpu-type* โ€” generate code for the specified FPU type, which can be one of:
    • 64 โ€” allow the use of hardware floating-point instructions for 32-bit and 64-bit operations.
    • 32 โ€” allow the use of hardware floating-point instructions for 32-bit operations.
    • none, 0 โ€” prevent the use of hardware floating-point instructions.
  • *-msimd=simd-type* โ€” enable generation of LoongArch SIMD instructions for vectorization and via builtin functions. The value can be one of:
    • lasx โ€” enable generating instructions from the 256-bit LoongArch Advanced SIMD Extension (LASX) and the 128-bit LoongArch SIMD Extension (LSX).
  • lsx โ€” bestie, this one turns on generating instructions from the 128-bit LoongArch SIMD Extension (LSX). โœจ
  • none โ€” and this one means nope, not a single LoongArch SIMD instruction may be generated. ๐Ÿ’€
  • -msoft-float โ€” forces -mfpu=none and blocks floating-point registers from being used for parameter passing. Heads up: this option may change the target ABI. ๐Ÿซถ
  • -msingle-float โ€” forces -mfpu=32 and lets 32-bit floating-point registers handle parameter passing. Also may change the target ABI, so watch out. ๐ŸŒธ
  • -mdouble-float โ€” forces -mfpu=64 and lets 32/64-bit floating-point registers handle parameter passing. Yep, this one may change the target ABI too. ๐Ÿ’…
  • -mlasx, -mno-lasx, -mlsx, -mno-lsx โ€” these incrementally adjust the scope of the SIMD extensions (none / LSX / LASX) the compiler is allowed to use for code generation. Enabling LASX with mlasx automatically enables LSX, and diabling LSX with mno-lsx automatically disables LASX. These are driver-only options โ€” they act upon the final msimd configuration state and make incremental chagnes in the order they appear on the GCC driver's command line, deriving the final / canonicalized msimd option that gets passed to the compiler proper. (yes, the source really spells it "chagnes", we're keeping it exactly, no cap ๐Ÿ’œ)
  • -mbranch-cost=n โ€” sets the cost of branches to roughly n instructions.
  • -mcheck-zero-division, -mno-check-zero-divison โ€” trap (do not trap) on integer division by zero. Default is -mcheck-zero-division for -O0 or -Og, and -mno-check-zero-division for other optimization levels.
  • -mcond-move-int, -mno-cond-move-int โ€” conditional moves for integral data in general-purpose registers are enabled (disabled). Default is -mcond-move-int. ๐Ÿ‘‘
  • -mcond-move-float, -mno-cond-move-float โ€” conditional moves for floating-point registers are enabled (disabled). Default is -mcond-move-float.
  • -mmemcpy, -mno-memcpy โ€” force (do not force) the use of memcpy for non-trivial block moves. The default is -mno-memcpy, which lets GCC inline most constant-sized copies. Setting the optimization level to -Os also forces the use of memcpy, but -mno-memcpy may override this behavior if explicitly specified, regardless of the order these options appear on the command line. ๐Ÿฆ‹
  • -mstrict-align, -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 -mno-strict-align.
  • -msmall-data-limit=number โ€” put global and static data smaller than number bytes into a special section (on some targets). The default value is 0.
  • -mmax-inline-memcpy-size=n โ€” inline all block moves (such as calls to memcpy or structure copies) less than or equal to n bytes. The default value of n is 1024.
  • -mcmodel=code-model โ€” set the code model to one of:
    • tiny-static (Not implemented yet) ๐Ÿ™ˆ
    • tiny (Not implemented yet) ๐Ÿ™ˆ
    • normal โ€” the text segment must be within 128MB addressing space. The data segment must be within 2GB addressing space.
    • medium โ€” the text segment and data segment must be within 2GB addressing space.
    • large (Not implemented yet) ๐Ÿ™ˆ
    • extreme โ€” this mode does not limit the size of the code segment and data segment. The -mcmodel=extreme option is incompatible with -fplt and/or -mexplicit-relocs=none. ๐Ÿšจ

The default code model is normal.

  • -mexplicit-relocs=style โ€” sets 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 -mexplicit-relocs=none the assembler macros are always used, with -mexplicit-relocs=always the assembler relocation operators are always used, and with -mexplicit-relocs=auto the compiler will use the relocation operators where the 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 -mrelax: -mexplicit-relocs=none if the assembler does not support relocation operators at all, -mexplicit-relocs=always if the assembler supports relocation operators but -mrelax is not enabled, -mexplicit-relocs=auto if the assembler supports relocation operators and -mrelax is enabled. (okay this one is a whole paragraph, but it's giving thorough, periodt โœจ)
  • -mexplicit-relocs โ€” an alias of -mexplicit-relocs=always for backward compatibility.
  • -mno-explicit-relocs โ€” an alias of -mexplicit-relocs=none for backward compatibility.
  • -mdirect-extern-access, -mno-direct-extern-access โ€” do not use or use GOT to access external symbols. The default is -mno-direct-extern-access: GOT is used for external symbols with default visibility, but not used for other external symbols.

With -mdirect-extern-access, GOT is not used and all external symbols are PC-relatively addressed. It is only suitable for environments where no dynamic link is performed, like firmwares, OS kernels, executables linked with -static or -static-pie. -mdirect-extern-access is not compatible with -fPIC or -fpic. ๐Ÿšจ

  • -mrelax, -mno-relax โ€” take (do not take) advantage of linker relaxations. If -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: -mrelax if the assembler supports both the -mrelax option and the conditional branch relaxation (it's required or the .align directives and conditional branch instructions in the assembly code outputted by GCC may be rejected by the assembler because of a relocation overflow), -mno-relax otherwise.
  • -mpass-mrelax-to-as, -mno-pass-mrelax-to-as โ€” pass (do not pass) the -mrelax or -mno-relax option to the assembler. The default is determined during GCC build-time by detecting corresponding assembler support: -mpass-mrelax-to-as if the assembler supports the -mrelax option, -mno-pass-mrelax-to-as otherwise. This option is mostly useful for debugging, or interoperation with assemblers different from the build-time one.
  • -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 -funsafe-math-optimizations is enabled together with -ffinite-math-only and -fno-trapping-math. This option is off by default. Before you can use this option, you must sure the target CPU supports frecipe and 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). ๐Ÿ˜ญ
  • -mrecip=opt โ€” this option controls which reciprocal estimate instructions may be used. opt is a comma-separated list of options, which may be preceded by a ! to invert the option:
    • all โ€” enable all estimate instructions.
    • default โ€” enable the default instructions, equivalent to -mrecip.
    • none โ€” disable all estimate instructions, equivalent to -mno-recip.
    • div โ€” enable the approximation for scalar division.
    • vec-div โ€” enable the approximation for vectorized division.
    • sqrt โ€” enable the approximation for scalar square root.
    • vec-sqrt โ€” enable the approximation for vectorized square root.
    • rsqrt โ€” enable the approximation for scalar reciprocal square root.
    • vec-rsqrt โ€” enable the approximation for vectorized reciprocal square root.

So, for example, -mrecip=all,!sqrt enables all of the reciprocal approximations, except for scalar square root. ๐ŸŽ€

  • -mfrecipe, -mno-frecipe โ€” use (do not use) frecipe.{s/d} and frsqrte.{s/d} instructions. When build with -march=la664, it is enabled by default. The default is -mno-frecipe.
  • -mdiv32, -mno-div32 โ€” use (do not use) div.w[u] and mod.w[u] instructions with input not sign-extended. When build with -march=la664, it is enabled by default. The default is -mno-div32.
  • -mlam-bh, -mno-lam-bh โ€” use (do not use) am{swap/add}[_db].{b/h} instructions. When build with -march=la664, it is enabled by default. The default is -mno-lam-bh.
  • -mlamcas, -mno-lamcas โ€” use (do not use) amcas[_db].{b/h/w/d} instructions. When build with -march=la664, it is enabled by default. The default is -mno-lamcas.
  • -mld-seq-sa, -mno-ld-seq-sa โ€” whether a same-address load-load barrier (dbar 0x700) is needed. When build with -march=la664, it is enabled by default. The default is -mno-ld-seq-sa, the load-load barrier is needed.
  • -mtls-dialect=opt โ€” this option controls which tls dialect may be used for general dynamic and local dynamic TLS models.
    • trad โ€” use traditional TLS. This is the default. ๐Ÿ‘‘
    • desc โ€” use TLS descriptors.
  • --param loongarch-vect-unroll-limit=n โ€” the vectorizer will use available tuning information to determine whether it would be beneficial to unroll the main vectorized loop and by how much. This parameter set's the upper bound of how much the vectorizer will unroll the main loop. The default value is six. ๐Ÿ”ฅ

M32C Options ๐ŸŽ€

  • -mcpu=name โ€” select the CPU for which code is generated. name may be one of r8c for the R8C/Tiny series, m16c for the M16C (up to /60) series, m32cm for the M16C/80 series, or m32c for the M32C/80 series. โœจ
  • -msim โ€” specifies that the program will be run on the simulator. This causes an alternate runtime library to be linked in which supports, for example, file I/O.
bestie listen to me carefully: 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. ๐Ÿ’€
  • -memregs=number โ€” sets how many memory-based pseudo-registers GCC gets to use while it's generating code โœจ. These pseudo-registers get treated like actual registers, so it's giving a whole tradeoff situation: GCC's ability to fit your code into the registers that are actually available vs. the performance hit of using memory instead of registers ๐Ÿ’…. Big warning bestie: every single module in a program must be compiled with the same value for this option. And because of that, you must not use this option with GCC's default runtime libraries ๐Ÿšซ.

๐ŸŒธ M32R/D Options ๐ŸŒธ

These -m options are defined for Renesas M32R/D architectures, okay? ๐Ÿ’–

  • -m32r2 โ€” generate code for the M32R/2 ๐Ÿฆ‹.
  • -m32rx โ€” generate code for the M32R/X โœจ.
  • -m32r โ€” generate code for the M32R. This one is the default ๐Ÿ‘‘.
  • -mmodel=small โ€” assume every object lives in the lower 16MB of memory (so their addresses can just be loaded with the ld24 instruction), and assume every subroutine is reachable with the bl instruction. This is the default ๐Ÿ’….

The addressability of a particular object can be set with the model attribute ๐ŸŽ€.

  • -mmodel=medium โ€” assume objects may be anywhere in the 32-bit address space (so the compiler generates seth/add3 instructions to load their addresses), and assume all subroutines are reachable with the bl instruction ๐ŸŒˆ.
  • -mmodel=large โ€” assume objects may be anywhere in the 32-bit address space (compiler generates seth/add3 instructions to load their addresses), and assume subroutines may not be reachable with the bl instruction. In that case the compiler generates the much slower seth/add3/jl instruction sequence ๐Ÿ˜ญ.
  • -msdata=none โ€” disable use of the small data area. Variables get put into one of .data, .bss, or .rodata (unless the section attribute has been specified). This is the default โœจ.

The small data area consists of the sections .sdata and .sbss. Objects may be explicitly put in the small data area with the section attribute using one of these sections ๐Ÿ’ซ.

  • -msdata=sdata โ€” put small global and static data in the small data area, but don't generate special code to reference them ๐Ÿซถ.
  • -msdata=use โ€” put small global and static data in the small data area, and generate special instructions to reference them ๐Ÿ”ฅ.
  • -G num โ€” put global and static objects less than or equal to num bytes into the small data or BSS sections instead of the normal data or BSS sections. The default value of num is 8. The -msdata option must be set to one of sdata or use for this option to have any effect ๐Ÿ’….

All modules should be compiled with the same -G num value. Compiling with different values of num may or may not work; if it doesn't, the linker gives an error message---incorrect code is not generated โš ๏ธ.

  • -mdebug โ€” makes the M32R-specific code in the compiler display some statistics that might help when you're debugging programs ๐Ÿ›.
  • -malign-loops โ€” align all loops to a 32-byte boundary ๐Ÿ“.
  • -mno-align-loops โ€” do not enforce a 32-byte alignment for loops. This is the default ๐ŸŒธ.
  • -missue-rate=number โ€” issue number instructions per cycle. number can only be 1 or 2 โญ.
  • -mbranch-cost=number โ€” number can only be 1 or 2. If it's 1 then branches are preferred over conditional code; if it's 2, then the opposite applies ๐Ÿ™ƒ.
  • -mflush-trap=number โ€” specifies the trap number to use to flush the cache. The default is 12. Valid numbers are between 0 and 15 inclusive ๐ŸŽ€.
  • -mno-flush-trap โ€” specifies that the cache cannot be flushed by using a trap ๐Ÿ’€.
  • -mflush-func=name โ€” specifies the name of the operating system function to call to flush the cache. The default is _flush_cache, but a function call is only used if a trap is not available โœจ.
  • -mno-flush-func โ€” indicates that there is no OS function for flushing the cache ๐Ÿšซ.

๐ŸŒˆ M680x0 Options ๐ŸŒˆ

These are the -m options defined for M680x0 and ColdFire processors, bestie ๐Ÿ’œ. The default settings depend on which architecture was selected when the compiler was configured; the defaults for the most common choices are given below ๐Ÿ‘‡.

  • -march=arch โ€” generate code for a specific M680x0 or ColdFire instruction set architecture. Permissible values of arch for M680x0 architectures are: 68000, 68010, 68020, 68030, 68040, 68060 and cpu32. ColdFire architectures are selected according to Freescale's ISA classification and the permissible values are: isaa, isaaplus, isab and isac ๐Ÿ’….

GCC defines a macro __mcfarch__ whenever it is generating code for a ColdFire target. The arch in this macro is one of the -march arguments given above โœจ.

When used together, -march and -mtune select code that runs on a family of similar processors but that is optimized for a particular microarchitecture ๐Ÿ‘‘.

  • -mcpu=cpu โ€” generate code for a specific M680x0 or ColdFire processor. The M680x0 cpus are: 68000, 68010, 68020, 68030, 68040, 68060, 68302, 68332 and cpu32. The ColdFire cpus are given by the table below, which also classifies the CPUs into families ๐Ÿฆ‹:
Family : -mcpu arguments
51 : 51 51ac 51ag 51cn 51em 51je 51jf 51jg 51jm 51mm 51qe 51qm
5206 : 5202 5204 5206
5206e : 5206e
5208 : 5207 5208
5211a : 5210a 5211a
5213 : 5211 5212 5213
5216 : 5214 5216
52235 : 52230 52231 52232 52233 52234 52235
5225 : 5224 5225
52259 : 52252 52254 52255 52256 52258 52259
5235 : 5232 5233 5234 5235 523x
5249 : 5249
5250 : 5250
5271 : 5270 5271
5272 : 5272
5275 : 5274 5275
5282 : 5280 5281 5282 528x
53017 : 53011 53012 53013 53014 53015 53016 53017
5307 : 5307
5329 : 5327 5328 5329 532x
5373 : 5372 5373 537x
5407 : 5407
5475 : 5470 5471 5472 5473 5474 5475 547x 5480 5481 5482 5483 5484
5485

-mcpu=cpu overrides -march=arch if arch is compatible with cpu. Other combinations of -mcpu and -march are rejected ๐Ÿšซ.

GCC defines the macro __mcf_cpu_cpu when ColdFire target cpu is selected. It also defines __mcf_family_family, where the value of family is given by the table above โœจ.

  • -mtune=tune โ€” tune the code for a particular microarchitecture within the constraints set by -march and -mcpu. The M680x0 microarchitectures are: 68000, 68010, 68020, 68030, 68040, 68060 and cpu32. The ColdFire microarchitectures are: cfv1, cfv2, cfv3, cfv4 and cfv4e ๐Ÿ’….

You can also use -mtune=68020-40 for code that needs to run relatively well on 68020, 68030 and 68040 targets. -mtune=68020-60 is similar but includes 68060 targets as well. These two options select the same tuning decisions as -m68020-40 and -m68020-60 respectively ๐ŸŽ€.

GCC defines the macros __mcarch and __mcarch__ when tuning for 680x0 architecture arch. It also defines mcarch unless either -ansi or a non-GNU -std option is used. If GCC is tuning for a range of architectures, as selected by -mtune=68020-40 or -mtune=68020-60, it defines the macros for every architecture in the range ๐ŸŒˆ.

GCC also defines the macro __muarch__ when tuning for ColdFire microarchitecture uarch, where uarch is one of the arguments given above โญ.

  • -m68000, -mc68000 โ€” generate output for a 68000. This is the default when the compiler is configured for 68000-based systems. It is equivalent to -march=68000 ๐Ÿ‘‘.

Use this option for microcontrollers with a 68000 or EC000 core, including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356 ๐Ÿ’–.

  • -m68010 โ€” generate output for a 68010. This is the default when the compiler is configured for 68010-based systems. It is equivalent to -march=68010 โœจ.
  • -m68020, -mc68020 โ€” generate output for a 68020. This is the default when the compiler is configured for 68020-based systems. It is equivalent to -march=68020 ๐ŸŒธ.
  • -m68030 โ€” generate output for a 68030. This is the default when the compiler is configured for 68030-based systems. It is equivalent to -march=68030 ๐Ÿฆ‹.
  • -m68040 โ€” generate output for a 68040. This is the default when the compiler is configured for 68040-based systems. It is equivalent to -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 โš ๏ธ.

  • -m68060 โ€” generate output for a 68060. This is the default when the compiler is configured for 68060-based systems. It is equivalent to -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 โš ๏ธ.

  • -mcpu32 โ€” generate output for a CPU32. This is the default when the compiler is configured for CPU32-based systems. It is equivalent to -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 ๐Ÿ’œ.

  • -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 -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 โœจ.

  • -m5206e โ€” generate output for a 5206e ColdFire CPU. The option is now deprecated in favor of the equivalent -mcpu=5206e ๐Ÿ’€.
  • -m528x โ€” generate output for a member of the ColdFire 528X family. The option is now deprecated in favor of the equivalent -mcpu=528x ๐Ÿ’€.
  • -m5307 โ€” generate output for a ColdFire 5307 CPU. The option is now deprecated in favor of the equivalent -mcpu=5307 ๐Ÿ’€.
  • -m5407 โ€” generate output for a ColdFire 5407 CPU. The option is now deprecated in favor of the equivalent -mcpu=5407 ๐Ÿ’€.
  • -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 -mcpu=547x, and is now deprecated in favor of that option ๐Ÿ˜ญ.
  • -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 ๐Ÿ‘€.
  • -m68020-60 โ€” bestie this one generates output for a 68060 but without touching any of the new instructions, so the code runs pretty efficiently on a 68020/68881, a 68030, or a 68040. It does use the 68881 instructions that get emulated on the 68060, so that's fine. โœจ

It's literally equivalent to -march=68020 -mtune=68020-60.

  • -mhard-float, -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 __HAVE_68881__ on M680x0 targets and __mcffpu__ on ColdFire targets. ๐Ÿ’…
  • -msoft-float โ€” do not generate floating-point instructions, use library calls instead. This is the default for 68000, 68010, and 68832 targets. It's also the default for ColdFire devices that have no FPU.
  • -mdiv, -mno-div โ€” generate (or don't generate) ColdFire hardware divide and remainder instructions. If -march is used without -mcpu, the default is "on" for ColdFire architectures and "off" for M680x0 architectures. Otherwise the default comes from the target CPU (either the default CPU, or the one you named with -mcpu). For example, the default is "off" for -mcpu=5206 and "on" for -mcpu=5206e.

GCC defines the macro __mcfhwdiv__ when this option is enabled. ๐Ÿฆ‹

  • -mshort โ€” treats type int as 16 bits wide, like short int. Also, parameters passed on the stack get aligned to a 16-bit boundary too, even on targets whose API mandates promotion to 32-bit.
  • -mno-short โ€” don't treat type int as 16 bits wide. This is the default.
  • -mnobitfield, -mno-bitfield โ€” do not use the bit-field instructions. The -m68000, -mcpu32 and -m5200 options imply -mnobitfield.
  • -mbitfield โ€” do use the bit-field instructions. The -m68020 option implies -mbitfield. This is the default if you use a configuration designed for a 68020.
  • -mrtd โ€” use a different function-calling convention, where functions that take a fixed number of arguments return with the rtd instruction, which pops their arguments while returning. This saves one instruction in the caller since there's 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 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 rtd instruction is supported by the 68010, 68020, 68030, 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.

The default is -mno-rtd.

  • -malign-int, -mno-align-int โ€” control whether GCC aligns int, long, long long, float, double, and long double variables on a 32-bit boundary (-malign-int) or a 16-bit boundary (-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.
โš ๏ธ Warning: if you use the -malign-int switch, GCC aligns structures containing the above types differently than most published application binary interface specifications for the m68k. so like. heads up bestie ๐Ÿซถ

Use the pc-relative addressing mode of the 68000 directly, instead of using a global offset table. At present, this option implies -fpic, allowing at most a 16-bit offset for pc-relative addressing. -fPIC is not presently supported with -mpcrel, though this could be supported for 68020 and higher processors.

  • -mno-strict-align, -mstrict-align โ€” do not (do) assume that unaligned memory references are handled by the system.
  • -msep-data โ€” generate code that lets the data segment live 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 -fPIC. ๐Ÿ‘‘
  • -mno-sep-data โ€” generate code that assumes the data segment follows the text segment. This is the default.
  • -mid-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 -fPIC.
  • -mno-id-shared-library โ€” generate code that doesn't assume ID-based shared libraries are being used. This is the default.
  • *-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.
  • -mxgot, -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; -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:

relocation truncated to fit: R_68K_GOT16O foobar

If this happens, you should recompile your code with -mxgot. It should then work with very large GOTs. However, code generated with -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 -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.

  • -mlong-jump-table-offsets โ€” use 32-bit offsets in switch tables. The default is to use 16-bit offsets.

๐ŸŽ€ MCore Options ๐ŸŽ€

These are the -m options defined for the Motorola M*Core processors. ๐Ÿ’–

  • -mhardlit, -mno-hardlit โ€” inline constants into the code stream if it can be done in two instructions or less.
  • -mdiv, -mno-div โ€” use the divide instruction. (Enabled by default).
  • -mrelax-immediate, -mno-relax-immediate โ€” allow arbitrary-sized immediates in bit operations.
  • -mwide-bitfields, -mno-wide-bitfields โ€” always treat bit-fields as int-sized.
  • -m4byte-functions, -mno-4byte-functions โ€” force all functions to be aligned to a 4-byte boundary.
  • -mcallgraph-data, -mno-callgraph-data โ€” emit callgraph information.
  • -mslow-bytes, -mno-slow-bytes โ€” prefer word access when reading byte quantities.
  • -mlittle-endian, -mbig-endian โ€” generate code for a little-endian target.
  • -m210, -m340 โ€” generate code for the 210 processor.
  • -mno-lsim โ€” assume that runtime support has been provided and so omit the simulator library (libsim.a) from the linker command line.
  • -mstack-increment=size โ€” set the maximum amount for a single stack increment operation. Large values can increase the speed of programs that contain functions needing 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.

๐ŸŒˆ MicroBlaze Options ๐ŸŒˆ

  • -msoft-float โ€” use software emulation for floating point (default).
  • -mhard-float โ€” use hardware floating-point instructions.
  • -mmemcpy โ€” do not optimize block moves, use memcpy.
  • -mno-clearbss โ€” > ๐Ÿšจ This option is deprecated. Use -fno-zero-initialized-in-bss instead.
  • *-mcpu=cpu-type* โ€” use features of, and schedule code for, the given CPU. Supported values are in the format vX.YY.Z, where X is a major version, YY is the minor version, and Z is compatibility code. Example values are v3.00.a, v4.00.b, v5.00.a, v5.00.b, v6.00.a.
  • -mxl-soft-mul โ€” use software multiply emulation (default).
  • -mxl-soft-div โ€” use software emulation for divides (default).
  • -mxl-barrel-shift โ€” use the hardware barrel shifter.
  • -mxl-pattern-compare โ€” use pattern compare instructions.
  • -msmall-divides โ€” use table lookup optimization for small signed integer divisions.
  • -mxl-stack-check โ€” > ๐Ÿšจ This option is deprecated. Use -fstack-check instead.
  • -mxl-gp-opt โ€” use GP-relative .sdata/.sbss sections.
  • -mxl-multiply-high โ€” use multiply high instructions for high part of 32x32 multiply.
  • -mxl-float-convert โ€” use hardware floating-point conversion instructions.
  • -mxl-float-sqrt โ€” use hardware floating-point square root instruction.
  • -mbig-endian โ€” generate code for a big-endian target.
  • -mlittle-endian โ€” generate code for a little-endian target.
  • -mxl-reorder โ€” use reorder instructions (swap and byte reversed load/store).
  • -mxl-mode-app-model โ€” select application model app-model. Valid models are: โœจ
    • executable โ€” normal executable (default), uses startup code crt0.o.
    • xmdstub โ€” for use with Xilinx Microprocessor Debugger (XMD) based software intrusive debug agent called xmdstub. This uses startup file crt1.o and sets the start address of the program to 0x800.
    • bootstrap โ€” for applications that are loaded using a bootloader. This model uses startup 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.
    • 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 crt3.o as a startup file.

Option -xl-mode-app-model is a deprecated alias for -mxl-mode-app-model. ๐Ÿ’…

  • -mpic-data-is-text-relative โ€” assume the displacement between the text and data segments is fixed at static link time ๐Ÿ’… so data can be referenced by offset from the start of the text address instead of via the GOT, since PC-relative addressing isn't a thing here. no cap.

โœจ MIPS Options โœจ ๐Ÿฆ‹

  • -EB โ€” generate big-endian code ๐Ÿ˜
  • -EL โ€” generate little-endian code ๐Ÿญ and this is the default for mips*el-*-* configurations.
  • -march=arch โ€” generate code that runs on arch, which can be the name of a generic MIPS ISA, or the name of a particular processor ๐Ÿ”ฅ The ISA names are: mips1, mips2, mips3, mips4, mips32, mips32r2, mips32r3, mips32r5, mips32r6, mips64, mips64r2, mips64r3, mips64r5 and mips64r6. The processor names are: 4kc, 4km, 4kp, 4ksc, 4kec, 4kem, 4kep, 4ksd, 5kc, 5kf, 20kc, 24kc, 24kf2_1, 24kf1_1, 24kec, 24kef2_1, 24kef1_1, 34kc, 34kf2_1, 34kf1_1, 34kn, 74kc, 74kf2_1, 74kf1_1, 74kf3_2, 1004kc, 1004kf2_1, 1004kf1_1, i6400, i6500, interaptiv, loongson2e, loongson2f, loongson3a, gs464, gs464e, gs264e, m4k, m14k, m14kc, m14ke, m14kec, m5100, m5101, octeon, octeon+, octeon2, octeon3, orion, p5600, p6600, r2000, r3000, r3900, r4000, r4400, r4600, r4650, r4700, r5900, r6000, r8000, rm7000, rm9000, r10000, r12000, r14000, r16000, sb1, sr71000, vr4100, vr4111, vr4120, vr4130, vr4300, vr5000, vr5400, vr5500, xlr and xlp. The special value from-abi selects the most compatible architecture for the selected ABI (that is, mips1 for 32-bit ABIs and mips3 for 64-bit ABIs) ๐Ÿ’–

The native Linux/GNU toolchain also supports the value native, which selects the best architecture option for the host processor. -march=native has no effect if GCC does not recognize the processor ๐Ÿ˜ญ

In processor names, a final 000 can be abbreviated as k (for example, -march=r2k) โœจ Prefixes are optional, and vr may be written r.

Names of the form nf2_1 refer to processors with FPUs clocked at half the rate of the core, names of the form nf1_1 refer to processors with FPUs clocked at the same rate as the core, and names of the form nf3_2 refer to processors with FPUs clocked a ratio of 3:2 with respect to the core ๐Ÿซถ For compatibility reasons, nf is accepted as a synonym for nf2_1 while nx and bfx are accepted as synonyms for nf1_1.

GCC defines two macros based on the value of this option ๐Ÿ‘‘ The first is _MIPS_ARCH, which gives the name of target architecture, as a string. The second has the form _MIPS_ARCH_foo, where foo is the capitalized value of _MIPS_ARCH. For example, -march=r2000 sets _MIPS_ARCH to r2000 and defines the macro _MIPS_ARCH_R2000.

Note that the _MIPS_ARCH macro uses the processor names given above ๐Ÿ’€ In other words, it has the full prefix and does not abbreviate 000 as k. In the case of from-abi, the macro names the resolved architecture (either mips1 or mips3). It names the default architecture when no -march option is given.

  • -mtune=arch โ€” optimize for arch ๐ŸŒธ Among other things, this option controls the way instructions are scheduled, and the perceived cost of arithmetic operations. The list of arch values is the same as for -march.

When this option is not used, GCC optimizes for the processor specified by -march โœจ By using -march and -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. iconic tbh.

-mtune defines the macros _MIPS_TUNE and _MIPS_TUNE_foo, which work in the same way as the -march ones described above ๐Ÿ’…

  • -mips1 โ€” equivalent to -march=mips1.
  • -mips2 โ€” equivalent to -march=mips2.
  • -mips3 โ€” equivalent to -march=mips3.
  • -mips4 โ€” equivalent to -march=mips4.
  • -mips32 โ€” equivalent to -march=mips32.
  • -mips32r3 โ€” equivalent to -march=mips32r3.
  • -mips32r5 โ€” equivalent to -march=mips32r5.
  • -mips32r6 โ€” equivalent to -march=mips32r6.
  • -mips64 โ€” equivalent to -march=mips64.
  • -mips64r2 โ€” equivalent to -march=mips64r2.
  • -mips64r3 โ€” equivalent to -march=mips64r3.
  • -mips64r5 โ€” equivalent to -march=mips64r5.
  • -mips64r6 โ€” equivalent to -march=mips64r6.
  • -mips16, -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 mips16 and nomips16 attributes ๐Ÿฆ‹

  • -mmips16e2, -mno-mips16e2 โ€” use (do not use) the MIPS16e2 ASE โœจ This option modifies the behavior of the -mips16 option such that it targets the MIPS16e2 ASE.
  • -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. fr fr, hands off.
  • -minterlink-compressed, -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 ๐Ÿซถ -minterlink-compressed therefore disables direct jumps unless GCC knows that the target of the jump is not compressed.

  • -minterlink-mips16, -mno-interlink-mips16 โ€” aliases of -minterlink-compressed and -mno-interlink-compressed ๐ŸŒˆ These options predate the microMIPS ASE and are retained for backwards compatibility.
  • -mabi=32, -mabi=o64, -mabi=n32, -mabi=64, -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 -mgp32 to get 32-bit code instead.

For information about the O64 ABI, see <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 -mabi=32 -mfp64. This ABI relies on the mthc1 and 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 $f0 only, not a $f0/$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 (-mfpxx) and FP64A (-mfp64 -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 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 โœจ

  • -mabicalls, -mno-abicalls โ€” generate (do not generate) code that is suitable for SVR4-style dynamic objects ๐ŸŒธ -mabicalls is the default for SVR4-based systems.
  • -mshared, -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 -mabicalls.

All -mabicalls code has traditionally been position-independent, regardless of options like -fPIC and -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 -mno-shared ๐Ÿ’…

-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 -mno-shared generally makes executables both smaller and quicker. slay.

-mshared is the default โญ

  • -mplt, -mno-plt โ€” assume (do not assume) that the static and dynamic linkers support PLTs and copy relocations ๐Ÿ”ฅ This option only affects -mno-shared -mabicalls. For the n64 ABI, this option has no effect without -msym32.

You can make -mplt the default by configuring GCC with --with-mips-plt ๐Ÿ’– The default is -mno-plt otherwise.

  • -mxgot, -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:

relocation truncated to fit: R_MIPS_GOT16 foobar

If this happens, you should recompile your code with -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 -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 ๐Ÿ™ˆ

  • -mgp32 โ€” assume that general-purpose registers are 32 bits wide.
  • -mgp64 โ€” assume that general-purpose registers are 64 bits wide.
  • -mfp32 โ€” assume that floating-point registers are 32 bits wide.
  • -mfp64 โ€” assume that floating-point registers are 64 bits wide.
  • -mfpxx โ€” do not assume the width of floating-point registers ๐ŸŒธ
  • -mhard-float โ€” use floating-point coprocessor instructions ๐Ÿ”ฅ
  • -msoft-float โ€” do not use floating-point coprocessor instructions ๐Ÿงš Implement floating-point calculations using library calls instead.
  • -mno-float โ€” lowkey the same energy as -msoft-float, but it also pinky-promises that the program you're compiling does zero floating-point operations. fr fr. rn this one's only supported by some bare-metal MIPS configurations, where it might pull in a special set of libraries that have literally no floating-point support at all (including, bestie, the floating-point printf formats ๐Ÿ’€). So if code compiled with -mno-float accidentally has floating-point ops hiding in it, it's probably gonna fail at link time or run time. not a vibe.
  • -msingle-float โ€” assume the floating-point coprocessor only does single-precision operations. that's it, that's the whole thing. ๐Ÿ’…
  • -mdouble-float โ€” assume the floating-point coprocessor does support double-precision operations. this is the default, so if you didn't touch anything, congrats, you already have it. โœจ
  • -modd-spreg, -mno-odd-spreg โ€” turn on (or off) using odd-numbered single-precision floating-point registers for the o32 ABI. -modd-spreg is the default for processors known to support these registers ๐Ÿซถ. but when you're using the o32 FPXX ABI, -mno-odd-spreg gets set by default. slay, but with rules.
  • -mabs=2008, -mabs=legacy โ€” these control how the special not-a-number (NaN) IEEE 754 floating-point data gets treated by the abs.fmt and neg.fmt machine instructions.

By default, or when you pass -mabs=legacy, the legacy treatment wins. in that case those instructions are considered arithmetic and get avoided wherever correct operation is required and the input operand might be a NaN ๐Ÿ˜ญ. instead, a longer sequence of instructions that manually manipulate the sign bit of the floating-point datum gets used โ€” unless you also passed -ffinite-math-only.

The -mabs=2008 option selects the IEEE 754-2008 treatment. here those instructions are considered non-arithmetic, which means they operate correctly in every case, especially when the input operand is a NaN. so they're always used for the respective operations. iconic. ๐Ÿ‘‘

  • -mnan=2008, -mnan=legacy โ€” these control the encoding of the special not-a-number (NaN) IEEE 754 floating-point data.

The -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, while signaling NaNs (sNaNs) are denoted by the first bit of their trailing significand field being 1.

The -mnan=2008 option selects the IEEE 754-2008 encoding. here qNaNs are denoted by the first bit of their trailing significand field being 1, while sNaNs are denoted by the first bit of their trailing significand field being 0. (yes bestie they literally swap. the drama. ๐Ÿ’€)

The default is -mnan=legacy unless GCC has been configured with --with-nan=2008.

  • -mllsc, -mno-llsc โ€” use (or don't use) ll, sc, and sync instructions to implement atomic memory built-in functions. when neither option is specified, GCC uses the instructions if the target architecture supports them.

-mllsc is useful when the runtime environment can emulate those instructions, and -mno-llsc can be useful when compiling for nonstandard ISAs. you can make either one the default by configuring GCC with --with-llsc and --without-llsc respectively ๐ŸŒˆ. --with-llsc is the default for some configurations โ€” check the installation documentation for the deets.

  • -mdsp, -mno-dsp โ€” use (or don't use) revision 1 of the MIPS DSP ASE. this option defines the preprocessor macro __mips_dsp. it also defines __mips_dsp_rev to 1. ๐ŸŽ€
  • -mdspr2, -mno-dspr2 โ€” use (or don't use) revision 2 of the MIPS DSP ASE. this option defines the preprocessor macros __mips_dsp and __mips_dspr2. it also defines __mips_dsp_rev to 2. โœจ
  • -msmartmips, -mno-smartmips โ€” use (or don't use) the MIPS SmartMIPS ASE.
  • -mpaired-single, -mno-paired-single โ€” use (or don't use) paired-single floating-point instructions. heads up: this option requires hardware floating-point support to be enabled. ๐Ÿซถ
  • -mdmx, -mno-mdmx โ€” use (or don't use) MIPS Digital Media Extension instructions. this one can only be used when generating 64-bit code and it requires hardware floating-point support to be enabled. so many prerequisites, so little time ๐Ÿ˜ญ.
  • -mips3d, -mno-mips3d โ€” use (or don't use) the MIPS-3D ASE. the option -mips3d implies -mpaired-single. the way it just drags its friend along ๐Ÿ’….
  • -mmicromips, -mno-micromips โ€” generate (or don't generate) microMIPS code.

microMIPS code generation can also be controlled on a per-function basis by means of micromips and nomicromips attributes.

  • -mmt, -mno-mt โ€” use (or don't use) MT Multithreading instructions.
  • -mmcu, -mno-mcu โ€” use (or don't use) the MIPS MCU ASE instructions.
  • -meva, -mno-eva โ€” use (or don't use) the MIPS Enhanced Virtual Addressing instructions.
  • -mvirt, -mno-virt โ€” use (or don't use) the MIPS Virtualization (VZ) instructions.
  • -mxpa, -mno-xpa โ€” use (or don't use) the MIPS eXtended Physical Address (XPA) instructions.
  • -mcrc, -mno-crc โ€” use (or don't use) the MIPS Cyclic Redundancy Check (CRC) instructions.
  • -mginv, -mno-ginv โ€” use (or don't use) the MIPS Global INValidate (GINV) instructions.
  • -mloongson-mmi, -mno-loongson-mmi โ€” use (or don't use) the MIPS Loongson MultiMedia extensions Instructions (MMI).
  • -mloongson-ext, -mno-loongson-ext โ€” use (or don't use) the MIPS Loongson EXTensions (EXT) instructions.
  • -mloongson-ext2, -mno-loongson-ext2 โ€” use (or don't use) the MIPS Loongson EXTensions r2 (EXT2) instructions.
  • -mlong64 โ€” force long types to be 64 bits wide. see -mlong32 for the explanation of the default and the way pointer size gets determined. ๐Ÿ‘€
  • -mlong32 โ€” force long, int, and pointer types to be 32 bits wide.

the default size of ints, longs and pointers depends on the ABI. all the supported ABIs use 32-bit ints. the n64 ABI uses 64-bit longs, as does the 64-bit EABI; the others use 32-bit longs. pointers are the same size as longs, or the same size as integer registers, whichever is smaller. math is mathing ๐Ÿ“โœจ

  • -msym32, -mno-sym32 โ€” assume (or don't assume) that all symbols have 32-bit values, regardless of the selected ABI. this option is useful in combination with -mabi=64 and -mno-abicalls because it lets GCC generate shorter and faster references to symbolic addresses. speed AND efficiency? we love to see it ๐Ÿ”ฅ.
  • -G num โ€” put definitions of externally-visible data in a small data section if that data is no bigger than num bytes. GCC can then generate more efficient accesses to the data; see -mgpopt for details.

the default -G option depends on the configuration.

  • -mlocal-sdata, -mno-local-sdata โ€” extend (or don't extend) the -G behavior to local data too, like static variables in C. -mlocal-sdata is the default for all configurations.

if the linker starts complaining that an application is using too much small data, you might wanna try rebuilding the less performance-critical parts with -mno-local-sdata ๐Ÿ™ˆ. you might also wanna build large libraries with -mno-local-sdata, so the libraries leave more room for the main program.

  • -mextern-sdata, -mno-extern-sdata โ€” assume (or don't assume) that externally-defined data is in a small data section if the size of that data is within the -G limit. -mextern-sdata is the default for all configurations.
okay bestie this next bit is important, read carefully ๐Ÿ’–

if you compile a module Mod with -mextern-sdata -G num -mgpopt, and Mod references a variable Var that is no bigger than num bytes, you must make sure that Var is placed in a small data section. if Var is defined by another module, you must either compile that module with a high-enough -G setting or attach a section attribute to Var's definition. if Var is common, you must link the application with a high-enough -G setting.

the easiest way of satisfying these restrictions is to compile and link every module with the same -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 -G setting and additionally using -mno-extern-sdata to stop the library from making assumptions about externally-defined data. ๐Ÿงš

  • -mgpopt, -mno-gpopt โ€” use (or don't use) GP-relative accesses for symbols that are known to be in a small data section; see -G, -mlocal-sdata and -mextern-sdata. -mgpopt is the default for all configurations.

-mno-gpopt is useful for cases where the $gp register might not hold the value of _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 $gp. (in such situations, the boot monitor itself is usually compiled with -G0.)

-mno-gpopt implies -mno-local-sdata and -mno-extern-sdata. the chain reaction ๐Ÿ’€.

  • -membedded-data, -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 it reduces the amount of RAM required when executing, and thus may be preferred for some embedded systems. trade-off queen ๐ŸŒธ.
  • -muninit-const-in-rodata, -mno-uninit-const-in-rodata โ€” put uninitialized const variables in the read-only data section. this option is only meaningful in conjunction with -membedded-data. iykyk.
  • -mcode-readable= setting โ€” specify whether GCC may generate code that reads from executable sections. there are three possible settings:
    • -mcode-readable=yes โ€” instructions may freely access executable sections. this is the default setting. โœจ
    • -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's 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. ๐Ÿซถ
    • -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. no shortcuts, periodt. ๐Ÿ’…
  • -msplit-addresses, -mno-split-addresses โ€” turns ON (or OFF, bestie) the use of the %hi() and %lo() assembler relocation operators. This one's been superseded by -mexplicit-relocs but it's still here for backwards compatibility, living its nostalgic little life ๐Ÿ’…
  • -mexplicit-relocs=none, -mexplicit-relocs=base, -mexplicit-relocs=pcrel, -mexplicit-relocs, -mno-explicit-relocs โ€” these control whether explicit relocs (like %gp_rel, bestie) get used or not. The default value depends on which version of GAS was around when GCC itself got built.

The "base" explicit-relocs support landed in GAS in 2001. The "pcrel" explicit-relocs support landed in GAS in 2014, and it's the one that supports %pcrel_hi and %pcrel_lo.

  • -mcheck-zero-division, -mno-check-zero-division โ€” trap (or don't trap) on integer division by zero. Periodt.

The default is -mcheck-zero-division.

  • -mdivide-traps, -mdivide-breaks โ€” MIPS systems check for division by zero by generating either a conditional trap or a break instruction. Using traps gives you smaller code, but it's only supported on MIPS II and later. Also โ€” and this is the annoying part ๐Ÿ˜ญ โ€” some versions of the Linux kernel have a bug that stops trap from generating the proper signal (SIGFPE). Use -mdivide-traps to allow conditional traps on architectures that support them, and -mdivide-breaks to force the use of breaks.

The default is usually -mdivide-traps, but this can be overridden at configure time using --with-divide=breaks. Divide-by-zero checks can be completely disabled using -mno-check-zero-division.

  • -mload-store-pairs, -mno-load-store-pairs โ€” enable (disable) an optimization that pairs consecutive load or store instructions so load/store bonding can happen. It's enabled by default, but it only does anything when the selected architecture is known to support bonding. iykyk ๐Ÿฆ‹
  • -mstrict-align, -mno-strict-align, -munaligned-access, -mno-unaligned-access โ€” disable (enable) direct unaligned access for MIPS Release 6. MIPSr6 requires load/store unaligned-access support, by hardware or by trap & emulate. So -mstrict-align may be needed by kernel. The options -munaligned-access and -mno-unaligned-access are obsoleted, and only hang around for backward compatibility.
  • -mmemcpy, -mno-memcpy โ€” force (or don't force) the use of memcpy for non-trivial block moves. The default is -mno-memcpy, which lets GCC inline most constant-sized copies. slay ๐Ÿ’–
  • -mlong-calls, -mno-long-calls โ€” disable (don't disable) use of the jal instruction. Calling functions using jal is more efficient, but it requires the caller and callee to be in the same 256 megabyte segment. So like... it's a vibe tradeoff.

This option has no effect on abicalls code. The default is -mno-long-calls.

  • -mmad, -mno-mad โ€” enable (disable) use of the mad, madu and mul instructions, as provided by the R4650 ISA.
  • -mimadd, -mno-imadd โ€” enable (disable) use of the madd and msub integer instructions. The default is -mimadd on architectures that support madd and msub, except for the 74k architecture, where it was found to generate slower code. not the 74k catching strays ๐Ÿ˜ญ
  • -mfused-madd, -mno-fused-madd โ€” enable (disable) use of the floating-point multiply-accumulate instructions, when they're available. The default is -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.

  • -nocpp โ€” tell the MIPS assembler to NOT run its preprocessor over user assembler files (the ones with a .s suffix) when assembling them. leave those files alone bestie ๐Ÿ™ˆ
  • -mfix-24k, -mno-fix-24k โ€” work around the 24K E48 errata (that's lost data on stores during refill, iconic behavior in the worst way ๐Ÿ’€). The workarounds are implemented by the assembler rather than by GCC.
  • -mfix-r4000, -mno-fix-r4000 โ€” work around certain R4000 CPU errata:
    • A double-word or a variable shift may give an incorrect result if executed immediately after starting an integer division.
    • A double-word or a variable shift may give an incorrect result if executed while an integer multiplication is in progress.
    • An integer division may give an incorrect result if started in a delay slot of a taken branch or a jump.
  • -mfix-r4400, -mno-fix-r4400 โ€” work around certain R4400 CPU errata:
    • A double-word or a variable shift may give an incorrect result if executed immediately after starting an integer division.
  • -mfix-r10000, -mno-fix-r10000 โ€” work around certain R10000 errata:
    • ll/sc sequences may not behave atomically on revisions prior to 3.0. They may deadlock on revisions 2.6 and earlier. ๐Ÿ˜ณ

This option can only be used if the target architecture supports branch-likely instructions. -mfix-r10000 is the default when -march=r10000 is used; -mno-fix-r10000 is the default otherwise.

  • -mfix-r5900, -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 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.
  • -mfix-rm7000, -mno-fix-rm7000 โ€” work around the RM7000 dmult/dmultu errata. The workarounds are implemented by the assembler rather than by GCC.
  • -mfix-vr4120, -mno-fix-vr4120 โ€” work around certain VR4120 errata:
    • dmultu does not always produce the correct result.
    • div and ddiv do not always produce the correct result if one of the operands is negative.

The workarounds for the division errata rely on special functions in libgcc.a. At present, these functions are only provided by the 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.

  • -mfix-vr4130 โ€” work around the VR4130 mflo/mfhi errata. The workarounds are implemented by the assembler rather than by GCC, although GCC avoids using mflo and mfhi if the VR4130 macc, macchi, dmacc and dmacchi instructions are available instead. iconic workaround energy ๐Ÿ‘‘
  • -mfix-sb1, -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.)
  • -mr10k-cache-barrier=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. -mr10k-cache-barrier=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:

  1. the memory occupied by the current function's stack frame;
  2. the memory occupied by an incoming stack argument;
  3. the memory occupied by an object with a link-time-constant address.

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:

void foo (void);

then the implementation of foo must allow j foo and 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:

  • -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.
  • -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.
  • -mr10k-cache-barrier=none โ€” disable the insertion of cache barriers. This is the default setting.
  • -mflush-func=func, -mno-flush-func โ€” specifies the function to call to flush the I and D caches, or to not call any such function at all. If it is called, the function must take the same arguments as the common _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 it's either _flush_func or __cpu_flush.
  • -mbranch-cost=num โ€” set the cost of branches to roughly 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 -mtune setting. fr fr, heuristics are like that ๐ŸŒธ
  • -mbranch-likely, -mno-branch-likely โ€” turns Branch Likely instructions on or off, no matter what the selected architecture's default says ๐Ÿ’…. Normally, Branch Likely instructions may get generated if your architecture supports them. The one exception: MIPS32 and MIPS64 architectures, plus any processor implementing them โ€” for those, Branch Likely instructions do not get generated by default, because MIPS32 and MIPS64 straight up deprecate using them. Rude of them but okay.
  • -mcompact-branches=never, -mcompact-branches=optimal, -mcompact-branches=always โ€” these three control which form of branches get generated. Default is -mcompact-branches=optimal โœจ.
    • -mcompact-branches=never โ€” compact branch instructions will literally never be generated, periodt.
    • -mcompact-branches=always โ€” a compact branch instruction gets generated if one is available for MIPS Release 6 onwards. If a compact branch instruction isn't available (or you're pre-R6), a delay slot form of the branch gets used instead.
    • If you use it for MIPS16/microMIPS targets, it's just ignored right now. The behaviour for MIPS16/microMIPS may change in the future, since they do have some compact branch instructions. ๐Ÿ‘€
    • -mcompact-branches=optimal โ€” 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 gets chosen if one is available.
  • -mfp-exceptions, -mno-fp-exceptions โ€” says whether FP exceptions are enabled. This affects how FP instructions get scheduled for some processors. Default: FP exceptions are enabled ๐Ÿซถ.
    • For example, on the SB-1, if FP exceptions are disabled and we're emitting 64-bit code, then we can use both FP pipes. Otherwise we can only use one FP pipe.
  • -mvr4130-align, -mno-vr4130-align โ€” the VR4130 pipeline is two-way superscalar, but it 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's enabled by default at optimization level -O3.
  • -msynci, -mno-synci โ€” enable (or disable) generation of synci instructions on architectures that support it. The synci instructions (if enabled) get generated when __builtin___clear_cache is compiled.
    • This option defaults to -mno-synci, but the default can be overridden by configuring GCC with --with-synci.
    • When compiling code for single processor systems, it's generally safe to use synci. However, on many multi-core (SMP) systems, it does not invalidate the instruction caches on all cores and may lead to undefined behavior ๐Ÿ˜ญ. So like, be careful bestie.
  • -mrelax-pic-calls, -mno-relax-pic-calls โ€” try to turn PIC calls that are normally dispatched via register $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 ๐Ÿ”ฅ.
    • -mrelax-pic-calls is the default if GCC was configured to use an assembler and a linker that support the .reloc assembly directive and -mexplicit-relocs is in effect. With -mno-explicit-relocs, this optimization can be performed by the assembler and the linker alone without help from the compiler.
  • -mmcount-ra-address, -mno-mcount-ra-address โ€” emit (or don't emit) code that allows _mcount to modify the calling function's return address. When enabled, this option extends the usual _mcount interface with a new ra-address parameter, which has type intptr_t * and is passed in register $12. _mcount can then modify the return address by doing both of the following:
    • Returning the new address in register $31.
    • Storing the new address in *ra-address, if ra-address is nonnull.
    • Default is -mno-mcount-ra-address.
  • -mframe-header-opt, -mno-frame-header-opt โ€” enable (or disable) frame header optimization in the o32 ABI. When using the o32 ABI, calling functions will allocate 16 bytes on the stack for the called function to write out register arguments. When enabled, this optimization will suppress the allocation of the frame header if it can be determined that it's unused ๐ŸŽ€.
    • This optimization is off by default at all optimization levels.
  • -mlxc1-sxc1, -mno-lxc1-sxc1 โ€” when applicable, enable (or disable) the generation of lwxc1, swxc1, ldxc1, sdxc1 instructions. Enabled by default โœจ.
  • -mmadd4, -mno-madd4 โ€” when applicable, enable (or disable) the generation of 4-operand madd.s, madd.d and related instructions. Enabled by default ๐Ÿ’œ.

โœจ MMIX Options โœจ

These options are defined for the MMIX, bestie:

  • -mlibfuncs, -mno-libfuncs โ€” specify that intrinsic library functions are being compiled, passing all values in registers, no matter the size.
  • -mepsilon, -mno-epsilon โ€” generate floating-point comparison instructions that compare with respect to the rE epsilon register.
  • -mabi=mmixware, -mabi=gnu โ€” generate code that passes function parameters and return values that (in the called function) are seen as registers $0 and up, as opposed to the GNU ABI which uses global registers $231 and up.
  • -mzero-extend, -mno-zero-extend โ€” when reading data from memory in sizes shorter than 64 bits, use (or don't use) zero-extending load instructions by default, rather than sign-extending ones.
  • -mknuthdiv, -mno-knuthdiv โ€” make the result of a division yielding a remainder have the same sign as the divisor. With the default, -mno-knuthdiv, the sign of the remainder follows the sign of the dividend. Both methods are arithmetically valid, the latter being almost exclusively used ๐Ÿค“.
  • -mtoplevel-symbols, -mno-toplevel-symbols โ€” prepend (or don't prepend) a : to all global symbols, so the assembly code can be used with the PREFIX assembly directive.
  • -melf โ€” generate an executable in the ELF format, rather than the default mmo format used by the mmix simulator.
  • -mbranch-predict, -mno-branch-predict โ€” use (or don't use) the probable-branch instructions, when static branch prediction indicates a probable branch.
  • -mbase-addresses, -mno-base-addresses โ€” generate (or don't generate) code that uses 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. This 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 -mno-base-addresses.
  • -msingle-exit, -mno-single-exit โ€” force (or don't force) generated code to have a single exit point in each function.

๐Ÿฆ‹ MN10300 Options ๐Ÿฆ‹

These -m options are defined for Matsushita MN10300 architectures:

  • -mmult-bug โ€” generate code to avoid bugs in the multiply instructions for the MN10300 processors. This is the default.
  • -mno-mult-bug โ€” do not generate code to avoid bugs in the multiply instructions for the MN10300 processors.
  • -mam33 โ€” generate code using features specific to the AM33 processor.
  • -mno-am33 โ€” do not generate code using features specific to the AM33 processor. This is the default.
  • -mam33-2 โ€” generate code using features specific to the AM33/2.0 processor.
  • -mam34 โ€” generate code using features specific to the AM34 processor.
  • -mtune=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 mn10300, am33, am33-2 or am34.
  • -mreturn-pointer-on-d0 โ€” when generating a function that returns a pointer, return the pointer in both a0 and d0. Otherwise the pointer is returned only in a0, and attempts to call such functions without a prototype result in errors ๐Ÿ‘€. Note that this option is on by default; use -mno-return-pointer-on-d0 to disable it.
  • -mno-crt0 โ€” do not link in the C run-time initialization object file.
  • -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 ๐Ÿ’€. Not a vibe if you were planning to debug, fr fr.
  • -mliw โ€” allow the compiler to generate Long Instruction Word instructions if the target is the AM33 or later. This is the default. This option defines the preprocessor macro __LIW__.
  • -mno-liw โ€” do not allow the compiler to generate Long Instruction Word instructions. This option defines the preprocessor macro __NO_LIW__.
  • -msetlb โ€” allow the compiler to generate the SETLB and Lcc instructions if the target is the AM33 or later. This is the default. This option defines the preprocessor macro __SETLB__.
  • -mno-setlb โ€” do not allow the compiler to generate SETLB or Lcc instructions. This option defines the preprocessor macro __NO_SETLB__.

๐ŸŒˆ Moxie Options ๐ŸŒˆ

  • -meb โ€” generate big-endian code. This is the default for moxie-*-* configurations.
  • -mel โ€” generate little-endian code.
  • -mmul.x โ€” generate mul.x and umul.x instructions. This is the default for moxiebox-*-* configurations.
  • -mno-crt0 โ€” do not link in the C run-time initialization object file.

๐Ÿ’– MSP430 Options ๐Ÿ’–

These options are defined for the MSP430:

  • -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 โœจ (aesthetic purposes, iconic).
  • -mmcu= โ€” 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 __. This in turn is used by the msp430.h header file to select an MCU-specific supplementary header file.

The option also sets which ISA to use. If the MCU name is one that's only known to support the 430 ISA, then that's the one that gets picked โ€” otherwise it's the 430X ISA. And you can also just pass the generic MCU name msp430 to select the 430 ISA. Same energy: the generic msp430x MCU name selects the 430X ISA. ๐Ÿ’…

On top of that, an MCU-specific linker script gets added to the linker command line. The script's name is just the MCU name with .ld stuck on the end. So like, specifying -mmcu=xxx on the gcc command line defines the C preprocessor symbol "__XXX__" and makes the linker go looking for a script called xxx.ld. ๐ŸŽ€

The ISA and hardware multiply support for the different MCUs is hard-coded into GCC. But bestie, plot twist: an external devices.csv file can be used to extend device support beyond the ones that are hard-coded. โœจ

GCC searches for the devices.csv file using the following methods in this precedence order โ€” where the first method takes precedence over the second, which takes precedence over the third. ๐Ÿ‘‘

  • Include path specified with -I and -L โ€” devices.csv will be searched for in each of the directories specified by include paths and linker library search paths.
  • Path specified by the environment variable MSP430_GCC_INCLUDE_DIR โ€” set the value of the global environment variable MSP430_GCC_INCLUDE_DIR to the full path of the directory containing devices.csv, and GCC will search this directory for devices.csv. If devices.csv is found, this directory will also be registered as an include path and linker library path. So header files and linker scripts in this directory can be used without manually specifying -I and -L on the command line. ๐Ÿซถ
  • The msp430-elf{,bare}/include/devices directory โ€” finally, GCC will examine msp430-elf{,bare}/include/devices from the toolchain root directory. This directory does not exist in a default installation, but if you created it and copied devices.csv there, then the MCU data will be read. As above, this directory will also be registered as an include path and linker library path.

If none of the above search methods find devices.csv, then the hard-coded MCU data is used.


  • -mwarn-mcu, -mno-warn-mcu โ€” this enables or disables warnings about conflicts between the MCU name specified by the -mmcu option and the ISA set by the -mcpu option and/or the hardware multiply support set by the -mhwmult option. It also toggles warnings about unrecognized MCU names. This option is on by default. ๐Ÿฆ‹
  • -mcpu= โ€” specifies the ISA to use. Accepted values are msp430, msp430x and msp430xv2. This option is deprecated, so likeโ€ฆ use the -mmcu= option to select the ISA instead. โš ๏ธ
  • -msim โ€” link to the simulator runtime libraries and linker script. Overrides any scripts that would be selected by the -mmcu= option.
  • -mlarge โ€” use large-model addressing (20-bit pointers, 20-bit "size_t").
  • -msmall โ€” use small-model addressing (16-bit pointers, 16-bit "size_t").
  • -mrelax โ€” this option is passed to the assembler and linker, and allows the linker to perform certain optimizations that can't be done until the final link. โœจ
  • mhwmult= โ€” describes the type of hardware multiply supported by the target. Accepted values are none for no hardware multiply, 16bit for the original 16-bit-only multiply supported by early MCUs, 32bit for the 16/32-bit multiply supported by later MCUs, and f5series for the 16/32-bit multiply supported by F5-series MCUs. You can also give a value of auto, which tells GCC to deduce the hardware multiply support based on the MCU name provided by the -mmcu option. If no -mmcu option is specified, or if the MCU name isn't recognized, then no hardware multiply support is assumed. "auto" is the default setting. ๐Ÿ’…

Hardware multiplies are normally performed by calling a library routine โ€” this saves space in the generated code. But when compiling at -O3 or higher, the hardware multiplier is invoked inline. That makes for bigger, but faster code. ๐Ÿš€

The hardware multiply routines disable interrupts while running and restore the previous interrupt state when they finish. So they're safe to use inside interrupt handlers as well as in normal code. ๐Ÿซถ

  • -minrt โ€” enable the use of a minimum runtime environment โ€” no 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.
  • -mtiny-printf โ€” enable reduced code size "printf" and "puts" library functions. The tiny implementations of these functions are not reentrant, so they must be used with caution in multi-threaded applications. ๐Ÿ’€

Support for streams has been removed and the string to be printed will always be sent to stdout via the "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 --enable-newlib-nano-formatted-io.

  • -mmax-inline-shift= โ€” this option takes an integer 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 can't 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.

  • -mcode-region=, -mdata-region= โ€” these options tell the compiler where to place functions and data that don't have one of the "lower", "upper", "either" or "section" attributes. Possible values are "lower", "upper", "either" or "any". The first three behave like the corresponding attribute. The fourth possible value โ€” "any" โ€” is the default. It leaves placement entirely up to the linker script and how it assigns the standard sections (".text", ".data", etc) to the memory regions. โœจ
  • -msilicon-errata= โ€” this option passes on a request to the assembler to enable the fixes for the named silicon errata.
  • -msilicon-errata-warn= โ€” this option passes on a request to the assembler to enable warning messages when a silicon errata might need to be applied.
  • -mwarn-devices-csv, -mno-warn-devices-csv โ€” warn if devices.csv isn't found or there are problems parsing it (default: on).

๐ŸŒˆ NDS32 Options ๐ŸŒˆ

These options are defined for NDS32 implementations:

  • -mbig-endian โ€” generate code in big-endian mode.
  • -mlittle-endian โ€” generate code in little-endian mode.
  • -mreduced-regs โ€” use reduced-set registers for register allocation.
  • -mfull-regs โ€” use full-set registers for register allocation.
  • -mcmov โ€” generate conditional move instructions.
  • -mno-cmov โ€” do not generate conditional move instructions.
  • -mext-perf โ€” generate performance extension instructions.
  • -mno-ext-perf โ€” do not generate performance extension instructions.
  • -mext-perf2 โ€” generate performance extension 2 instructions.
  • -mno-ext-perf2 โ€” do not generate performance extension 2 instructions.
  • -mext-string โ€” generate string extension instructions.
  • -mno-ext-string โ€” do not generate string extension instructions.
  • -mv3push โ€” generate v3 push25/pop25 instructions.
  • -mno-v3push โ€” do not generate v3 push25/pop25 instructions.
  • -m16-bit โ€” generate 16-bit instructions.
  • -mno-16-bit โ€” do not generate 16-bit instructions.
  • -misr-vector-size=num โ€” specify the size of each interrupt vector, which must be 4 or 16.
  • -mcache-block-size=num โ€” specify the size of each cache block, which must be a power of 2 between 4 and 512.
  • -march=arch โ€” specify the name of the target architecture.
  • -mcmodel=code-model โ€” set the code model to one of:
    • small โ€” all the data and read-only data segments must be within 512KB addressing space. The text segment must be within 16MB addressing space.
    • medium โ€” the data segment must be within 512KB while the read-only data segment can be within 4GB addressing space. The text segment should still be within 16MB addressing space.
    • large โ€” all the text and data segments can be within 4GB addressing space.
  • -mctor-dtor โ€” enable constructor/destructor feature.
  • -mrelax โ€” guide linker to relax instructions.

๐ŸŒธ Nios II Options ๐ŸŒธ

These are the options defined for the Altera Nios II processor:

  • -G num โ€” put global and static objects less than or equal to num bytes into the small data or BSS sections instead of the normal data or BSS sections. The default value of num is 8. ๐ŸŽ€
  • -mgpopt=option, -mgpopt, -mno-gpopt โ€” generate (do not generate) GP-relative accesses. The following option names are recognized:
    • none โ€” do not generate GP-relative accesses.
    • local โ€” generate GP-relative accesses for small data objects that are not external, weak, or uninitialized common symbols. Also use GP-relative addressing for objects that have been explicitly placed in a small data section via a "section" attribute.
    • global โ€” as for local, but also generate GP-relative accesses for small data objects that are external, weak, or common. If you use this option, you must ensure that all parts of your program (including libraries) are compiled with the same -G setting. โš ๏ธ
    • data โ€” generate GP-relative accesses for all data objects in the program. If you use this option, the entire data and BSS segments of your program must fit in 64K of memory and you must use an appropriate linker script to allocate them within the addressable range of the global pointer. ๐Ÿ’€
  • all โ€” generate GP-relative addresses for function pointers and data pointers. If you pick this one, lowkey the entire text, data, and BSS segments of your program have to fit inside 64K of memory, and you must use an appropriate linker script to allocate them within the addressable range of the global pointer. No pressure bestie ๐Ÿ’…

-mgpopt is literally the same as -mgpopt=local, and -mno-gpopt is the same as -mgpopt=none.

The default is -mgpopt, except when -fpic or -fPIC is specified to generate position-independent code. Heads up though: the Nios II ABI does not permit GP-relative accesses from shared libraries. That's just the rules, periodt.

You may need to specify -mno-gpopt explicitly when building programs that include large amounts of small data, including large GOT data sections. In this case, the 16-bit offset for GP-relative addressing may not be large enough to allow access to the entire small data section. It's giving "the address space said no" ๐Ÿ˜ญ


  • -mgprel-sec=regexp โ€” this option specifies additional section names that can be accessed via GP-relative addressing. It is most useful in conjunction with "section" attributes on variable declarations and a custom linker script. The regexp is a POSIX Extended Regular Expression. Obsessed with the precision tbh โœจ

This option does not affect the behavior of the -G option, and the specified sections are in addition to the standard ".sdata" and ".sbss" small-data sections that are recognized by -mgpopt.

  • -mr0rel-sec=regexp โ€” this option specifies names of sections that can be accessed via a 16-bit offset from "r0"; that is, in the low 32K or high 32K of the 32-bit address space. It is most useful in conjunction with "section" attributes on variable declarations and a custom linker script. The regexp is a POSIX Extended Regular Expression. ๐ŸŽ€

In contrast to the use of GP-relative addressing for small data, zero-based addressing is never generated by default and there are no conventional section names used in standard linker scripts for sections in the low or high areas of memory.

  • -mel
  • -meb โ€” generate little-endian (default) or big-endian (experimental) code, respectively. Pick your endianness, bestie ๐ŸŒธ
  • -march=arch โ€” this specifies the name of the target Nios II architecture. GCC uses this name to determine what kind of instructions it can emit when generating assembly code. Permissible names are: r1, r2. ๐Ÿ‘‘

The preprocessor macro __nios2_arch__ is available to programs, with value 1 or 2, indicating the targeted ISA level.

  • -mbypass-cache
  • -mno-bypass-cache โ€” force all load and store instructions to always bypass cache by using I/O variants of the instructions. The default is not to bypass the cache. She's skipping the line entirely ๐Ÿ’€
  • -mno-cache-volatile
  • -mcache-volatile โ€” volatile memory access bypass the cache using the I/O variants of the load and store instructions. The default is not to bypass the cache.
  • -mno-fast-sw-div
  • -mfast-sw-div โ€” do not use table-based fast divide for small numbers. The default is to use the fast divide at -O3 and above. Fast math stays winning ๐Ÿ”ฅ
  • -mno-hw-mul
  • -mhw-mul
  • -mno-hw-mulx
  • -mhw-mulx
  • -mno-hw-div
  • -mhw-div โ€” enable or disable emitting "mul", "mulx" and "div" family of instructions by the compiler. The default is to emit "mul" and not emit "div" and "mulx".
  • -mbmx
  • -mno-bmx
  • -mcdx
  • -mno-cdx โ€” enable or disable generation of Nios II R2 BMX (bit manipulation) and CDX (code density) instructions. Enabling these instructions also requires -march=r2. Since these instructions are optional extensions to the R2 architecture, the default is not to emit them. Optional extras, we respect it ๐Ÿ’…
  • -mcustom-insn=N
  • -mno-custom-insn โ€” each -mcustom-insn=N option enables use of a custom instruction with encoding N when generating code that uses insn. For example, -mcustom-fadds=253 generates custom instruction 253 for single-precision floating-point add operations instead of the default behavior of using a library call. Custom hardware era โœจ

The following values of insn are supported. Except as otherwise noted, floating-point operations are expected to be implemented with normal IEEE 754 semantics and correspond directly to the C operators or the equivalent GCC built-in functions.

Single-precision floating point:

  • fadds, fsubs, fdivs, fmuls โ€” binary arithmetic operations.
  • fnegs โ€” unary negation.
  • fabss โ€” unary absolute value.
  • fcmpeqs, fcmpges, fcmpgts, fcmples, fcmplts, fcmpnes โ€” comparison operations.
  • fmins, fmaxs โ€” floating-point minimum and maximum. These instructions are only generated if -ffinite-math-only is specified.
  • fsqrts โ€” unary square root operation.
  • fcoss, fsins, ftans, fatans, fexps, flogs โ€” floating-point trigonometric and exponential functions. These instructions are only generated if -funsafe-math-optimizations is also specified.

Double-precision floating point:

  • faddd, fsubd, fdivd, fmuld โ€” binary arithmetic operations.
  • fnegd โ€” unary negation.
  • fabsd โ€” unary absolute value.
  • fcmpeqd, fcmpged, fcmpgtd, fcmpled, fcmpltd, fcmpned โ€” comparison operations.
  • fmind, fmaxd โ€” double-precision minimum and maximum. These instructions are only generated if -ffinite-math-only is specified.
  • fsqrtd โ€” unary square root operation.
  • fcosd, fsind, ftand, fatand, fexpd, flogd โ€” double-precision trigonometric and exponential functions. These instructions are only generated if -funsafe-math-optimizations is also specified.

Conversions:

  • fextsd โ€” conversion from single precision to double precision.
  • ftruncds โ€” conversion from double precision to single precision.
  • fixsi, fixsu, fixdi, fixdu โ€” conversion from floating point to signed or unsigned integer types, with truncation towards zero.
  • round โ€” conversion from single-precision floating point to signed integer, rounding to the nearest integer and ties away from zero. This corresponds to the __builtin_lroundf function when -fno-math-errno is used.
  • floatis, floatus, floatid, floatud โ€” conversion from signed or unsigned integer types to floating-point types.

In addition, all of the following transfer instructions for internal registers X and Y must be provided to use any of the double-precision floating-point instructions. Custom instructions taking two double-precision source operands expect the first operand in the 64-bit register X. The other operand (or only operand of a unary operation) is given to the custom arithmetic instruction with the least significant half in source register src1 and the most significant half in src2. A custom instruction that returns a double-precision result returns the most significant 32 bits in the destination register and the other half in 32-bit register Y. GCC automatically generates the necessary code sequences to write register X and/or read register Y when double-precision floating-point instructions are used. It's giving very precise register choreography ๐Ÿฆ‹

  • fwrx โ€” write src1 into the least significant half of X and src2 into the most significant half of X.
  • fwry โ€” write src1 into Y.
  • frdxhi, frdxlo โ€” read the most or least (respectively) significant half of X and store it in dest.
  • frdy โ€” read the value of Y and store it into dest.
Note that you can gain more local control over generation of Nios II custom instructions by using the target("custom-insn=N") and target("no-custom-insn") function attributes or pragmas. Local control, we love to see it ๐Ÿซถ
  • -mcustom-fpu-cfg=name โ€” this option enables a predefined, named set of custom instruction encodings (see -mcustom-insn above). Currently, the following sets are defined:
    • -mcustom-fpu-cfg=60-1 is equivalent to: -mcustom-fmuls=252 -mcustom-fadds=253 -mcustom-fsubs=254 -fsingle-precision-constant
    • -mcustom-fpu-cfg=60-2 is equivalent to: -mcustom-fmuls=252 -mcustom-fadds=253 -mcustom-fsubs=254 -mcustom-fdivs=255 -fsingle-precision-constant
    • -mcustom-fpu-cfg=72-3 is equivalent to: -mcustom-floatus=243 -mcustom-fixsi=244 -mcustom-floatis=245 -mcustom-fcmpgts=246 -mcustom-fcmples=249 -mcustom-fcmpeqs=250 -mcustom-fcmpnes=251 -mcustom-fmuls=252 -mcustom-fadds=253 -mcustom-fsubs=254 -mcustom-fdivs=255 -fsingle-precision-constant
    • -mcustom-fpu-cfg=fph2 is equivalent to: -mcustom-fabss=224 -mcustom-fnegs=225 -mcustom-fcmpnes=226 -mcustom-fcmpeqs=227 -mcustom-fcmpges=228 -mcustom-fcmpgts=229 -mcustom-fcmples=230 -mcustom-fcmplts=231 -mcustom-fmaxs=232 -mcustom-fmins=233 -mcustom-round=248 -mcustom-fixsi=249 -mcustom-floatis=250 -mcustom-fsqrts=251 -mcustom-fmuls=252 -mcustom-fadds=253 -mcustom-fsubs=254 -mcustom-fdivs=255

Custom instruction assignments given by individual -mcustom-insn= options override those given by -mcustom-fpu-cfg=, regardless of the order of the options on the command line. The individual one always wins, no cap ๐Ÿ‘‘

Note that you can gain more local control over selection of a FPU configuration by using the target("custom-fpu-cfg=name") function attribute or pragma.

The name fph2 is an abbreviation for Nios II Floating Point Hardware 2 Component. Please note that the custom instructions enabled by -mcustom-fmins=233 and -mcustom-fmaxs=234 are only generated if -ffinite-math-only is specified. The custom instruction enabled by -mcustom-round=248 is only generated if -fno-math-errno is specified. In contrast to the other configurations, -fsingle-precision-constant is not set. Little exceptions, gotta respect them ๐Ÿ˜ญ


These additional -m options are available for the Altera Nios II ELF (bare-metal) target:

  • -mhal โ€” link with HAL BSP. This suppresses linking with the GCC-provided C runtime startup and termination code, and is typically used in conjunction with -msys-crt0= to specify the location of the alternate startup code provided by the HAL BSP.
  • -msmallc โ€” link with a limited version of the C library, -lsmallc, rather than Newlib.
  • -msys-crt0=startfile โ€” startfile is the file name of the startfile (crt0) to use when linking. This option is only useful in conjunction with -mhal. ๐ŸŒˆ
  • -msys-lib=systemlib โ€” systemlib is the name of the library that hands over the low-level system calls the C library needs, like read and write. Bestie, you'd normally reach for this when you're linking against a library some HAL BSP gave you. ๐Ÿซถ

๐ŸŽฎ Nvidia PTX Options

These ones are for Nvidia PTX, periodt:

  • -m64 โ€” lowkey ignored, but kept around for backward compatibility vibes. Only the 64-bit ABI is supported, so like... there's nothing else to pick. ๐Ÿ’€
  • -march=architecture-string โ€” generate code for the PTX ISA target architecture you name (e.g. sm_35). The valid architecture strings are sm_30, sm_35, sm_53, sm_70, sm_75 and sm_80. What you get by default depends on how the compiler was configured, see --with-arch.

This option sets the value of the preprocessor macro __PTX_SM__; for instance, for sm_35 it has the value 350. โœจ

  • -misa=architecture-string โ€” literally just an alias of -march=. Same energy, different name. ๐Ÿฆ‹
  • -march-map=architecture-string โ€” picks the closest available -march= value that is not more capable. For instance, for -march-map=sm_50 select -march=sm_35, and for -march-map=sm_53 select -march=sm_53.
  • -mptx=version-string โ€” generate code for the PTX ISA version you name (e.g. 7.0). Valid version strings include 3.1, 6.0, 6.3, and 7.0. The default PTX ISA version is 6.0, unless a higher version is required for the PTX ISA target architecture you specified via -march=. ๐Ÿ‘‘

This option sets the values of the preprocessor macros __PTX_ISA_VERSION_MAJOR__ and __PTX_ISA_VERSION_MINOR__; for instance, for 3.1 the macros have the values 3 and 1, respectively.

  • -mmainkernel โ€” link in code for a __main kernel. This is for stand-alone execution instead of offloading execution.
  • -moptimize โ€” apply partitioned execution optimizations. This is the default whenever any level of optimization is selected. Slay. ๐Ÿ”ฅ
  • -msoft-stack โ€” generate code that does not use .local memory directly for stack storage. Instead, a per-warp stack pointer is maintained explicitly. This enables variable-length stack allocation (with variable-length arrays or alloca), and when global memory is used for the underlying storage, it makes it possible to access automatic variables from other threads, or with atomic instructions. This code generation variant is what's 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 -mgomp. iykyk ๐Ÿงš
  • -muniform-simt โ€” switch to a code generation variant that lets you execute 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 (malloc, free, 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 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 tid.y with the current lane index to compute the master lane index. Main character energy fr fr. ๐Ÿ’…
  • -mgomp โ€” generate code for use in OpenMP offloading: enables the -msoft-stack and -muniform-simt options, and selects the corresponding multilib variant. ๐ŸŽ€

๐ŸŒฟ OpenRISC Options

These ones are defined for OpenRISC:

  • -mboard=name โ€” configure a board specific runtime. This will be passed to the linker for newlib board library linking. The default is or1ksim.
  • -mnewlib โ€” this option is ignored; it's for compatibility purposes only. It used to select linker and preprocessor options for use with newlib. ๐Ÿ’€
  • -msoft-div, -mhard-div โ€” select software or hardware divide (l.div, l.divu) instructions. The default is hardware divide.
  • -msoft-mul, -mhard-mul โ€” select software or hardware multiply (l.mul, l.muli) instructions. The default is hardware multiply.
  • -msoft-float, -mhard-float โ€” select software or hardware for floating point operations. The default is software.
  • -mdouble-float โ€” when -mhard-float is selected, enables generation of double-precision floating point instructions. By default, functions from libgcc are used to perform double-precision floating point operations. โœจ
  • -munordered-float โ€” when -mhard-float is selected, enables generation of unordered floating point compare and set flag (lf.sfun*) instructions. By default, functions from libgcc are used to perform unordered floating point compare and set flag operations.
  • -mcmov โ€” enable generation of conditional move (l.cmov) instructions. By default the equivalent will be generated using set and branch.
  • -mror โ€” enable generation of rotate right (l.ror) instructions. By default, functions from libgcc are used to perform rotate right operations.
  • -mrori โ€” enable generation of rotate right with immediate (l.rori) instructions. By default, functions from libgcc are used to perform rotate right with immediate operations.
  • -msext โ€” enable generation of sign extension (l.ext*) instructions. By default memory loads are used to perform sign extension.
  • -msfimm โ€” enable generation of compare and set flag with immediate (l.sf*i) instructions. By default extra instructions will be generated to store the immediate to a register first.
  • -mshftimm โ€” enable generation of shift with immediate (l.srai, l.srli, l.slli) instructions. By default extra instructions will be generated to store the immediate to a register first.
  • -mcmodel=small โ€” generate OpenRISC code for the small model: the GOT is limited to 64k. This is the default model.
  • -mcmodel=large โ€” generate OpenRISC code for the large model: the GOT may grow up to 4G in size. Big GOT energy. ๐ŸŒˆ

๐Ÿ•ฐ๏ธ PDP-11 Options

These options are defined for the PDP-11:

  • -mfpu โ€” use hardware FPP floating point. This is the default. (FIS floating point on the PDP-11/40 is not supported.) Implies -m45.
  • -msoft-float โ€” do not use hardware floating point.
  • -mac0 โ€” return floating-point results in ac0 (fr0 in Unix assembler syntax).
  • -mno-ac0 โ€” return floating-point results in memory. This is the default.
  • -m40 โ€” generate code for a PDP-11/40. Implies -msoft-float -mno-split.
  • -m45 โ€” generate code for a PDP-11/45. This is the default.
  • -m10 โ€” generate code for a PDP-11/10. Implies -msoft-float -mno-split.
  • -mint16, -mno-int32 โ€” use 16-bit int. This is the default.
  • -mint32, -mno-int16 โ€” use 32-bit int.
  • -msplit โ€” target has split instruction and data space. Implies -m45.
  • -munix-asm โ€” use Unix assembler syntax.
  • -mdec-asm โ€” use DEC assembler syntax.
  • -mgnu-asm โ€” use GNU assembler syntax. This is the default.
  • -mlra โ€” use the new LRA register allocator. By default, the old reload allocator is used. ๐Ÿงš

โšก PowerPC Options

These are listed under


๐Ÿงต PRU Options

These command-line options are defined for the PRU target:

  • -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 will not use those features.

The minimal startup code would not pass argc and argv arguments to main, so the latter must be declared as int main (void). This is already the norm for most firmware projects.

  • -mmcu=mcu โ€” specify the PRU hardware variant to use. A correspondingly named spec file would be loaded, passing the memory region sizes to the linker and defining hardware-specific C macros.

Newlib provides only the sim spec, intended for running regression tests using a simulator. Specs for real hardware can be obtained by installing the GnuPruMcu (https://github.com/dinuxbg/gnuprumcu/) package.

  • -mno-relax โ€” make GCC pass the --no-relax command-line option to the linker instead of the --relax option.
  • -mloop โ€” allow (or do not allow) GCC to use the LOOP instruction.
  • -mabi=variant โ€” specify the ABI variant to output code for. -mabi=ti selects the unmodified TI ABI while -mabi=gnu selects a GNU variant that copes more naturally with certain GCC assumptions. These are the differences:

Function Pointer Size

TI ABI specifies that function (code) pointers are 16-bit, whereas GNU supports only 32-bit data and code pointers.

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.

The current -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 -mabi=ti. ๐Ÿ˜ญ

Relaxation is a GNU feature and for safety reasons is disabled when using -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.

๐ŸŒŠ RISC-V Options

These command-line options are defined for RISC-V targets:

  • -mbranch-cost=n โ€” set the cost of branches to roughly n instructions.
  • -mplt, -mno-plt โ€” when generating PIC code, do or don't allow the use of PLTs. Ignored for non-PIC. The default is -mplt. ๐Ÿ’œ
  • -mabi=ABI-string โ€” this one's the โœจcalling conventionโœจ setting, and it covers both integers and floats. ABI-string has two parts: the size of integer types, and the registers used for floating-point types. So for example, -march=rv64ifd -mabi=lp64d means long and pointers are 64-bit (which implicitly defines int to be 32-bit, no cap), and floating-point values up to 64 bits wide get passed in F registers. ๐Ÿ’…

Now contrast that with -march=rv64ifd -mabi=lp64f โ€” this still lets the compiler generate code that uses the F and D extensions, but it only allows floating-point values up to 32 bits long to be passed in registers. And then -march=rv64ifd -mabi=lp64? In that one, no floating-point arguments will be passed in registers. literally none. ๐Ÿ’€

The default for this argument is system dependent, so if you want a specific calling convention, bestie, you should specify one explicitly. The valid calling conventions are: ilp32, ilp32f, ilp32d, lp64, lp64f, and lp64d. Some calling conventions are impossible to implement on some ISAs: for example, -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 ilp32e ABI that can only be used with the rv32e architecture, and the lp64e ABI that can only be used with the rv64e. Those ABIs are not well specified at present, and are subject to change โ€” so, heads up. ๐Ÿซถ

  • -mfdiv, -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. easy. โœจ
  • -mdiv, -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.
  • -misa-spec=ISA-spec-string โ€” tells GCC which version of the RISC-V Unprivileged (formerly User-Level) ISA specification to produce code conforming to. The possibilities for ISA-spec-string are:
    • 2.2 โ€” produce code conforming to version 2.2.
    • 20190608 โ€” produce code conforming to version 20190608.
    • 20191213 โ€” produce code conforming to version 20191213.

The default is -misa-spec=20191213 unless GCC has been configured with --with-isa-spec= specifying a different default version. ๐Ÿ‘‘

  • -march=ISA-string โ€” generate code for the given RISC-V ISA (e.g. rv64im). ISA strings must be lower-case, okay? Examples include rv64i, rv32g, rv32e, and rv32imaf. Also, there's a special value help (-march=help) that's accepted to list all supported extensions. ๐ŸŒˆ

The syntax of the ISA string is defined as follows:

  • The string must start with rv32 or rv64, followed by i, e, or g, referred to as the base ISA.
  • The subsequent part of the string is a list of extension names. Extension names can be categorized as multi-letter (e.g. zba) and single-letter (e.g. v). Single-letter extensions can appear consecutively, but multi-letter extensions must be separated by underscores.
  • 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.
  • Extension names may include an optional version number, following the syntax <major>p<minor> or <major>, (e.g. m2p1 or m2).

Supported extension are listed below โ€” and bestie, get comfy, there's a whole โœจmenuโœจ:

  • i โ€” supported version 2.0, 2.1 โ€” Base integer extension.
  • e โ€” supported version 2.0 โ€” Reduced base integer extension.
  • g โ€” supported version - โ€” General-purpose computing base extension, g will expand to i, m, a, f, d, zicsr and zifencei.
  • m โ€” supported version 2.0 โ€” Integer multiplication and division extension.
  • a โ€” supported version 2.0, 2.1 โ€” Atomic extension.
  • f โ€” supported version 2.0, 2.2 โ€” Single-precision floating-point extension.
  • d โ€” supported version 2.0, 2.2 โ€” Double-precision floating-point extension.
  • c โ€” supported version 2.0 โ€” Compressed extension.
  • h โ€” supported version 1.0 โ€” Hypervisor extension.
  • v โ€” supported version 1.0 โ€” Vector extension.
  • zicsr โ€” supported version 2.0 โ€” Control and status register access extension.
  • zifencei โ€” supported version 2.0 โ€” Instruction-fetch fence extension.
  • zicond โ€” supported version 1.0 โ€” Integer conditional operations extension.
  • za64rs โ€” supported version 1.0 โ€” Reservation set size of 64 bytes.
  • za128rs โ€” supported version 1.0 โ€” Reservation set size of 128 bytes.
  • zawrs โ€” supported version 1.0 โ€” Wait-on-reservation-set extension.
  • zba โ€” supported version 1.0 โ€” Address calculation extension.
  • zbb โ€” supported version 1.0 โ€” Basic bit manipulation extension.
  • zbc โ€” supported version 1.0 โ€” Carry-less multiplication extension.
  • zbs โ€” supported version 1.0 โ€” Single-bit operation extension.
  • zfinx โ€” supported version 1.0 โ€” Single-precision floating-point in integer registers extension.
  • zdinx โ€” supported version 1.0 โ€” Double-precision floating-point in integer registers extension.
  • zhinx โ€” supported version 1.0 โ€” Half-precision floating-point in integer registers extension.
  • zhinxmin โ€” supported version 1.0 โ€” Minimal half-precision floating-point in integer registers extension.
  • zbkb โ€” supported version 1.0 โ€” Cryptography bit-manipulation extension.
  • zbkc โ€” supported version 1.0 โ€” Cryptography carry-less multiply extension.
  • zbkx โ€” supported version 1.0 โ€” Cryptography crossbar permutation extension.
  • zkne โ€” supported version 1.0 โ€” AES Encryption extension.
  • zknd โ€” supported version 1.0 โ€” AES Decryption extension.
  • zknh โ€” supported version 1.0 โ€” Hash function extension.
  • zkr โ€” supported version 1.0 โ€” Entropy source extension.
  • zksed โ€” supported version 1.0 โ€” SM4 block cipher extension.
  • zksh โ€” supported version 1.0 โ€” SM3 hash function extension.
  • zkt โ€” supported version 1.0 โ€” Data independent execution latency extension.
  • zk โ€” supported version 1.0 โ€” Standard scalar cryptography extension.
  • zkn โ€” supported version 1.0 โ€” NIST algorithm suite extension.
  • zks โ€” supported version 1.0 โ€” ShangMi algorithm suite extension.
  • zihintntl โ€” supported version 1.0 โ€” Non-temporal locality hints extension.
  • zihintpause โ€” supported version 1.0 โ€” Pause hint extension.
  • zicboz โ€” supported version 1.0 โ€” Cache-block zero extension.
  • zicbom โ€” supported version 1.0 โ€” Cache-block management extension.
  • zicbop โ€” supported version 1.0 โ€” Cache-block prefetch extension.
  • zic64b โ€” supported version 1.0 โ€” Cache block size isf 64 bytes.
  • ziccamoa โ€” supported version 1.0 โ€” Main memory supports all atomics in A.
  • ziccif โ€” supported version 1.0 โ€” Main memory supports instruction fetch with atomicity requirement.
  • zicclsm โ€” supported version 1.0 โ€” Main memory supports misaligned loads/stores.
  • ziccrse โ€” supported version 1.0 โ€” Main memory supports forward progress on LR/SC sequences.
  • zicntr โ€” supported version 2.0 โ€” Standard extension for base counters and timers.
  • zihpm โ€” supported version 2.0 โ€” Standard extension for hardware performance counters.
  • ztso โ€” supported version 1.0 โ€” Total store ordering extension.
  • zve32x โ€” supported version 1.0 โ€” Vector extensions for embedded processors.
  • zve32f โ€” supported version 1.0 โ€” Vector extensions for embedded processors.
  • zve64x โ€” supported version 1.0 โ€” Vector extensions for embedded processors.
  • zve64f โ€” supported version 1.0 โ€” Vector extensions for embedded processors.
  • zve64d โ€” supported version 1.0 โ€” Vector extensions for embedded processors.
  • zvl32b โ€” supported version 1.0 โ€” Minimum vector length standard extensions
  • zvl64b โ€” supported version 1.0 โ€” Minimum vector length standard extensions
  • zvl128b โ€” supported version 1.0 โ€” Minimum vector length standard extensions
  • zvl256b โ€” supported version 1.0 โ€” Minimum vector length standard extensions
  • zvl512b โ€” supported version 1.0 โ€” Minimum vector length standard extensions
  • zvl1024b โ€” supported version 1.0 โ€” Minimum vector length standard extensions
  • zvl2048b โ€” supported version 1.0 โ€” Minimum vector length standard extensions
  • zvl4096b โ€” supported version 1.0 โ€” Minimum vector length standard extensions
  • zvbb โ€” supported version 1.0 โ€” Vector basic bit-manipulation extension.
  • zvbc โ€” supported version 1.0 โ€” Vector carryless multiplication extension.
  • zvkb โ€” supported version 1.0 โ€” Vector cryptography bit-manipulation extension.
  • zvkg โ€” supported version 1.0 โ€” Vector GCM/GMAC extension.
  • zvkned โ€” supported version 1.0 โ€” Vector AES block cipher extension.
  • zvknha โ€” supported version 1.0 โ€” Vector SHA-2 secure hash extension.
  • zvknhb โ€” supported version 1.0 โ€” Vector SHA-2 secure hash extension.
  • zvksed โ€” supported version 1.0 โ€” Vector SM4 Block Cipher extension.
  • zvksh โ€” supported version 1.0 โ€” Vector SM3 Secure Hash extension.
  • zvkn โ€” supported version 1.0 โ€” Vector NIST Algorithm Suite extension, zvkn will expand to zvkned, zvknhb, zvkb and zvkt.
  • zvknc โ€” supported version 1.0 โ€” Vector NIST Algorithm Suite with carryless multiply extension, zvknc will expand to zvkn and zvbc.
  • zvkng โ€” supported version 1.0 โ€” Vector NIST Algorithm Suite with GCM extension, zvkng will expand to zvkn and zvkg.
  • zvks โ€” supported version 1.0 โ€” Vector ShangMi algorithm suite extension, zvks will expand to zvksed, zvksh, zvkb and zvkt.
  • zvksc โ€” supported version 1.0 โ€” Vector ShangMi algorithm suite with carryless multiplication extension, zvksc will expand to zvks and zvbc.
  • zvksg โ€” supported version 1.0 โ€” Vector ShangMi algorithm suite with GCM extension, zvksg will expand to zvks and zvkg.
  • zvkt โ€” supported version 1.0 โ€” Vector data independent execution latency extension.
  • zfh โ€” supported version 1.0 โ€” Half-precision floating-point extension.
  • zfhmin โ€” supported version 1.0 โ€” Minimal half-precision floating-point extension.
  • zvfh โ€” supported version 1.0 โ€” Vector half-precision floating-point extension.
  • zvfhmin โ€” supported version 1.0 โ€” Vector minimal half-precision floating-point extension.
  • zvfbfmin โ€” supported version 1.0 โ€” Vector BF16 converts extension.
  • zfa โ€” supported version 1.0 โ€” Additional floating-point extension.
  • zmmul โ€” supported version 1.0 โ€” Integer multiplication extension.
  • zca โ€” supported version 1.0 โ€” Integer compressed instruction extension.
  • zcf โ€” supported version 1.0 โ€” Compressed single-precision floating point loads and stores extension.
  • zcd โ€” 1.0 โ€” Compressed double-precision floating point loads and stores extension ๐Ÿ’…
  • zcb โ€” 1.0 โ€” Simple compressed instruction extension.
  • zce โ€” 1.0 โ€” Compressed instruction extensions for embedded processors.
  • zcmp โ€” 1.0 โ€” Compressed push pop extension.
  • zcmt โ€” 1.0 โ€” Table jump instruction extension.
  • smaia โ€” 1.0 โ€” Advanced interrupt architecture extension.
  • smepmp โ€” 1.0 โ€” PMP Enhancements for memory access and execution prevention on Machine mode.
  • smstateen โ€” 1.0 โ€” State enable extension.
  • ssaia โ€” 1.0 โ€” Advanced interrupt architecture extension for supervisor-mode.
  • sscofpmf โ€” 1.0 โ€” Count overflow & filtering extension.
  • ssstateen โ€” 1.0 โ€” State-enable extension for supervisor-mode.
  • sstc โ€” 1.0 โ€” Supervisor-mode timer interrupts extension.
  • svinval โ€” 1.0 โ€” Fine-grained address-translation cache invalidation extension.
  • svnapot โ€” 1.0 โ€” NAPOT translation contiguity extension.
  • svpbmt โ€” 1.0 โ€” Page-based memory types extension.
  • xcvmac โ€” 1.0 โ€” Core-V multiply-accumulate extension.
  • xcvalu โ€” 1.0 โ€” Core-V miscellaneous ALU extension.
  • xcvelw โ€” 1.0 โ€” Core-V event load word extension.
  • xtheadba โ€” 1.0 โ€” T-head address calculation extension.
  • xtheadbb โ€” 1.0 โ€” T-head basic bit-manipulation extension.
  • xtheadbs โ€” 1.0 โ€” T-head single-bit instructions extension.
  • xtheadcmo โ€” 1.0 โ€” T-head cache management operations extension.
  • xtheadcondmov โ€” 1.0 โ€” T-head conditional move extension.
  • xtheadfmemidx โ€” 1.0 โ€” T-head indexed memory operations for floating-point registers extension.
  • xtheadfmv โ€” 1.0 โ€” T-head double floating-point high-bit data transmission extension.
  • xtheadint โ€” 1.0 โ€” T-head acceleration interruption extension.
  • xtheadmac โ€” 1.0 โ€” T-head multiply-accumulate extension.
  • xtheadmemidx โ€” 1.0 โ€” T-head indexed memory operation extension.
  • xtheadmempair โ€” 1.0 โ€” T-head two-GPR memory operation extension.
  • xtheadsync โ€” 1.0 โ€” T-head multi-core synchronization extension.
  • xventanacondops โ€” 1.0 โ€” Ventana integer conditional operations extension.

okay so when -march= isn't given? it just borrows whatever you set in -mcpu. easy ๐Ÿ’ซ

and if neither -march nor -mcpu= is specified?? the default is system dependent bestie ๐Ÿ˜ญ so if you actually want specific architecture extensions, pls just say so explicitly. don't leave it to the vibes.


  • -mcpu=processor-string โ€” use the architecture of, and optimize the output for, the processor you name via its particular CPU name. the allowed values are: sifive-e20, sifive-e21, sifive-e24, sifive-e31, sifive-e34, sifive-e76, sifive-s21, sifive-s51, sifive-s54, sifive-s76, sifive-u54, sifive-u74, sifive-x280, sifive-xp450, sifive-x670.
heads up: -mcpu does not override -march or -mtune. it's giving "i'm just here to help" energy ๐Ÿ™ˆ
  • -mtune=processor-string โ€” optimize the output for the processor you name, given by microarchitecture or by particular CPU name. allowed values: rocket, sifive-3-series, sifive-5-series, sifive-7-series, thead-c906, size, sifive-p400-series, sifive-p600-series, and literally every valid option for -mcpu=.

if -mtune= isn't specified, it takes the setting from -mcpu, and if both are missing the default is rocket. โญ

the size choice is not meant for end-users, ok? it's what gets used when -Os is specified. it overrides the instruction cost info that -mtune= provides, but it does not override the pipeline info. it's there to shrink code size while still keeping good performance. ๐Ÿ’…

  • -mpreferred-stack-boundary=num โ€” tries to keep the stack boundary aligned to a 2 raised to num byte boundary. if you don't pass -mpreferred-stack-boundary, the default is 4 (that's 16 bytes, aka 128-bits).
โš ๏ธ warning: if you use this switch you must build all modules with the same value, libraries included. yes, that means the system libraries and startup modules too. no cap, don't mix and match.
  • -msmall-data-limit=n โ€” puts global and static data smaller than n bytes into a special section (on some targets).
  • -msave-restore
  • -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. fast > smol here, periodt.
  • -mmovcc
  • -mno-movcc โ€” do, or don't, produce branchless conditional-move code sequences even on targets that don't have specific instructions for conditional operations. if it's enabled, sequences of ALU operations get produced using base integer ISA instructions where that's profitable. ๐Ÿงš
  • -minline-atomics
  • -mno-inline-atomics โ€” do, or don't, use smaller but slower subword atomic emulation code that calls libatomic functions. the default is fast inline subword atomics that don't need libatomic.
  • -minline-strlen
  • -mno-inline-strlen โ€” do, or don't, attempt to inline strlen calls if possible. inlining only happens if the string is properly aligned and instructions for accelerated processing are available. the default is to not inline strlen calls.
  • -minline-strcmp
  • -mno-inline-strcmp โ€” do, or don't, attempt to inline strcmp calls if possible. inlining only happens if the strings are properly aligned and instructions for accelerated processing are available. the default is to not inline strcmp calls.

the --param riscv-strcmp-inline-limit=n parameter controls the maximum number of bytes compared by the inlined code. the default value is 64. ๐ŸŒธ

  • -minline-strncmp
  • -mno-inline-strncmp โ€” do, or don't, attempt to inline strncmp calls if possible. inlining only happens if the strings are properly aligned and instructions for accelerated processing are available. the default is to not inline strncmp calls.

the --param riscv-strcmp-inline-limit=n parameter controls the maximum number of bytes compared by the inlined code. the default value is 64. ๐Ÿ’ซ

  • -mshorten-memrefs
  • -mno-shorten-memrefs โ€” do, or don't, try to make more use of compressed load/store instructions by swapping a load/store of base register + large offset for a new load/store of new base + small offset. if that new base gets stored in a compressed register, then the new load/store can be compressed. currently it only targets 32-bit integer load/stores. ๐ŸŽ€
  • -mstrict-align
  • -mno-strict-align โ€” don't, or do, generate unaligned memory accesses. the default depends on whether the processor you're optimizing for supports fast unaligned access or not. vibe check on the hardware, basically.
  • -mcmodel=medlow โ€” generate code for the medium-low code model. the program and its statically defined symbols must lie inside a single 2 GiB address range and must sit between absolute addresses -2 GiB and +2 GiB. programs can be statically or dynamically linked. this is the default code model. ๐Ÿ‘‘
  • -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 the medium-any code model generates is position-independent, but it's not guaranteed to function correctly when linked into position-independent executables or libraries. noted, bestie. ๐Ÿ˜ญ
  • -mexplicit-relocs
  • -mno-exlicit-relocs โ€” use, or don't use, assembler relocation operators when dealing with symbolic addresses. the alternative is using assembler macros instead, which may limit optimization. (yes that spelling is exactly what it says, don't come for me ๐Ÿ’€)
  • -mrelax
  • -mno-relax โ€” take advantage of linker relaxations to cut down the number of instructions needed to materialize symbol addresses, or don't. the default is to take advantage of linker relaxations. slay. โœจ
  • -mriscv-attribute
  • -mno-riscv-attribute โ€” emit (or don't emit) the RISC-V attribute to record extra info into ELF objects. this feature needs at least binutils 2.32. ๐Ÿฆ‹
  • -mcsr-check
  • -mno-csr-check โ€” enables or disables the CSR checking.
  • -malign-data=type โ€” controls how GCC aligns variables and constants of array, structure, or union types. supported values for type are xlen, which uses x register width as the alignment value, and natural, which uses natural alignment. xlen is the default. ๐Ÿ’œ
  • -mbig-endian โ€” generate big-endian code. this is the default when GCC is configured for a riscv64be-*-* or riscv32be-*-* target.
  • -mlittle-endian โ€” generate little-endian code. this is the default when GCC is configured for a riscv64-*-* or riscv32-*-* target โ€” but not a riscv64be-*-* or riscv32be-*-* target. read it twice, it's fine. ๐Ÿ™ˆ
  • -mstack-protector-guard=guard
  • -mstack-protector-guard-reg=reg
  • -mstack-protector-guard-offset=offset โ€” generate stack protection code using a canary at guard. supported locations are global for a global canary, or tls for a per-thread canary in the TLS block.

with that tls choice, the -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset options additionally say which register to use as the base register for reading the canary, and from what offset off that base register. there's no default register or offset, because this is entirely for use inside the Linux kernel. yep. ๐Ÿ‘‘

  • -mtls-dialect=desc โ€” use TLS descriptors as the thread-local storage mechanism for dynamic accesses of TLS variables.
  • -mtls-dialect=trad โ€” use traditional TLS as the thread-local storage mechanism for dynamic accesses of TLS variables. this one is the default. โญ

โœจ RL78 Options โœจ

  • -msim โ€” links in additional target libraries so things can actually operate inside a simulator. ๐ŸŒˆ
  • -mmul=none, -mmul=g10, -mmul=g13, -mmul=g14, -mmul=rl78 โ€” bestie, this is where you tell GCC what kind of hardware multiply-and-divide support you want it to lean on. The simplest one is none, which just uses software for both multiplication and division โ€” and yes, that's the default. The g13 value is for the hardware multiply/divide peripheral that lives on the RL78/G13 (S2 core) targets. The g14 value selects the multiplication and division instructions that the RL78/G14 (S3 core) parts support. And then the value rl78 is an alias for g14, while the value mg10 is an alias for none.

Also, a C preprocessor macro gets defined based on whatever you set here. The possible values are: __RL78_MUL_NONE__, __RL78_MUL_G13__ or __RL78_MUL_G14__.

  • -mcpu=g10, -mcpu=g13, -mcpu=g14, -mcpu=rl78 โ€” this one says which RL78 core you're targeting. Default is the G14 core, which is also known as an S3 core, or honestly just "RL78". The G13, aka S2 core, has no multiply or divide instructions โ€” it uses a hardware peripheral for those operations instead. And the G10, aka S1 core, doesn't have register banks at all, so it uses a different calling convention. ๐Ÿ’…

Now here's the plot twist: if you set this option, it also picks the type of hardware multiply support to use โ€” unless you override it with an explicit -mmul=none on the command line. So specifying -mcpu=g13 enables the G13 hardware multiply peripheral, and specifying -mcpu=g10 disables hardware multiplications entirely.

Note: even though the RL78/G14 core is the default target, actually writing -mcpu=g14 or -mcpu=rl78 on the command line does change how the toolchain behaves, because it also turns on G14 hardware multiply support. If you don't pass those options, software multiplication routines get used even though the code targets the RL78 core. Why? Backwards compatibility with older toolchains that didn't have hardware multiply and divide support. It's giving legacy energy. ๐Ÿซถ

And yep, a C preprocessor macro gets defined here too, based on the setting. Possible values: __RL78_G10__, __RL78_G13__ or __RL78_G14__.

  • -mg10, -mg13, -mg14, -mrl78 โ€” these are just aliases for the matching -mcpu= option. They exist purely for backwards compatibility. โœจ
  • -mallregs โ€” lets the compiler use all of the available registers. By default, registers r24..r31 are reserved for use in interrupt handlers. Flip this on and those registers become fair game in ordinary functions too.
  • -m64bit-doubles, -m32bit-doubles โ€” makes the double data type either 64 bits (-m64bit-doubles) or 32 bits (-m32bit-doubles) in size. The default is -m32bit-doubles.
  • -msave-mduc-in-interrupts, -mno-save-mduc-in-interrupts โ€” says that interrupt handler functions should preserve the MDUC registers. You only need this if normal code might actually use the MDUC registers โ€” like, say, because it does multiplication and division operations. The default is to ignore the MDUC registers, because that makes the interrupt handlers faster. Heads up though: you need to pass the target option -mg13 for this to work, since the feature only exists on the G13 target (S2 core). Also, the MDUC registers only get saved if the interrupt handler performs a multiplication or division operation, or if it calls another function. ๐Ÿงš

๐ŸŒˆ IBM RS/6000 and PowerPC Options ๐ŸŒˆ

These -m options are defined for the IBM RS/6000 and PowerPC, bestie:

  • -mpowerpc-gpopt, -mno-powerpc-gpopt, -mpowerpc-gfxopt, -mno-powerpc-gfxopt, -mpowerpc64, -mno-powerpc64, -mmfcrf, -mno-mfcrf, -mpopcntb, -mno-popcntb, -mpopcntd, -mno-popcntd, -mfprnd, -mno-fprnd, -mcmpb, -mno-cmpb, -mhard-dfp, -mno-hard-dfp โ€” you use these to specify which instructions are available on the processor you're using. The default value of these options is determined when GCC is configured. Specifying -mcpu=cpu_type overrides the specification of these options. And fr, we recommend you use -mcpu=cpu_type instead of the options listed above. ๐Ÿ‘‘

So: specifying -mpowerpc-gpopt lets GCC use the optional PowerPC architecture instructions in the General Purpose group, floating-point square root included. Specifying -mpowerpc-gfxopt lets GCC use the optional PowerPC architecture instructions in the Graphics group, floating-point select included.

The -mmfcrf option lets GCC generate the move-from-condition-register-field instruction implemented on the POWER4 processor and other processors that support the PowerPC V2.01 architecture. The -mpopcntb option lets GCC 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. The -mpopcntd option lets GCC generate the popcount instruction implemented on the POWER7 processor and other processors that support the PowerPC V2.06 architecture. The -mfprnd option lets GCC generate the FP round-to-integer instructions implemented on the POWER5+ processor and other processors that support the PowerPC V2.03 architecture. The -mcmpb option lets GCC generate the compare-bytes instruction implemented on the POWER6 processor and other processors that support the PowerPC V2.05 architecture. And the -mhard-dfp option lets GCC generate the decimal floating-point instructions implemented on some POWER processors.

The -mpowerpc64 option lets GCC generate the additional 64-bit instructions found in the full PowerPC64 architecture, and treats GPRs as 64-bit, doubleword quantities. GCC defaults to -mno-powerpc64.

  • -mcpu=cpu_type โ€” sets the architecture type, register usage, and instruction scheduling parameters for the machine type cpu_type. The supported values for cpu_type are:
401, 403, 405, 405fp, 440, 440fp, 464, 464fp, 476, 476fp, 505,
601, 602, 603, 603e, 604, 604e, 620, 630, 740, 7400, 7450, 750, 801,
821, 823, 860, 970, 8540, a2, e300c2, e300c3, e500mc, e500mc64,
e5500, e6500, ec603e, G3, G4, G5, titan, power3, power4, power5,
power5+, power6, power6x, power7, power8, power9, power10, power11,
powerpc, powerpc64, powerpc64le, rs64, and native.

-mcpu=powerpc, -mcpu=powerpc64, and -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 native as the cpu type detects and selects the architecture option that corresponds to the host processor of the system performing the compilation. Heads up: -mcpu=native has no effect if GCC doesn't 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. Lowkey dramatic but true.

The -mcpu options automatically enable or disable the following options:

-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 -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 want to set an individual option to a particular value, you may specify it after the -mcpu option, like -mcpu=970 -mno-altivec.

On AIX, the -maltivec and -mpowerpc64 options are not enabled or disabled by the -mcpu option at present, because AIX doesn't have full support for these options. You may still enable or disable them individually if you're sure it'll work in your environment. ๐ŸŒธ

  • -mtune=cpu_type โ€” sets the instruction scheduling parameters for machine type cpu_type, but does not set the architecture type or register usage the way -mcpu=cpu_type does. The same values for cpu_type are used for -mtune as for -mcpu. If you specify both, the code generated uses the architecture and registers set by -mcpu, but the scheduling parameters set by -mtune.
  • -mcmodel=small โ€” generate PowerPC64 code for the small model: the TOC is limited to 64k.
  • -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.
  • -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.
  • -maltivec, -mno-altivec โ€” generate code that uses (or doesn't 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 -mabi=altivec to adjust the current ABI with AltiVec ABI enhancements.

When -maltivec is used, the element order for AltiVec intrinsics such as vec_splat, vec_extract, and vec_insert matches 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. โœจ

  • -mvrsave, -mno-vrsave โ€” generate VRSAVE instructions when generating AltiVec code.
  • -msecure-plt โ€” generate code that allows ld and ld.so to build executables and shared libraries with non-executable .plt and .got sections. This is a PowerPC 32-bit SYSV ABI option.
  • -mbss-plt โ€” generate code that uses a BSS .plt section that ld.so fills in, and requires .plt and .got sections that are both writable and executable. This is a PowerPC 32-bit SYSV ABI option.
  • -misel, -mno-isel โ€” this switch enables or disables the generation of ISEL instructions.
  • -mvsx, -mno-vsx โ€” generate code that uses (or doesn't use) vector/scalar (VSX) instructions, and also enable the use of built-in functions that allow more direct access to the VSX instruction set. ๐Ÿฆ‹
  • -mcrypto, -mno-crypto โ€” turns on (or off) the built-in functions that give you direct access to the cryptographic instructions that got added back in version 2.07 of the PowerPC ISA. ๐Ÿ” slay.
  • -mhtm, -mno-htm โ€” enables (disables) the built-in functions that let you reach the Hardware Transactional Memory (HTM) instructions directly, also from version 2.07 of the PowerPC ISA. ๐Ÿง โœจ
  • -mpower8-fusion, -mno-power8-fusion โ€” makes GCC generate code that keeps (or doesn't keep) some integer operations adjacent so the instructions can be fused together on power8 and later processors. ๐Ÿซถ
  • -mquad-memory, -mno-quad-memory โ€” generate code that uses (or doesn't use) the non-atomic quad word memory instructions. Heads up bestie, -mquad-memory requires 64-bit mode. ๐Ÿ’…
  • -mquad-memory-atomic, -mno-quad-memory-atomic โ€” same energy but for the atomic quad word memory instructions. And yeah, -mquad-memory-atomic also requires 64-bit mode. no cap.
  • -mfloat128, -mno-float128 โ€” enable/disable the __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 (-mvsx) must be enabled to use the IEEE 128-bit floating point support. ๐Ÿซถ
    • IEEE 128-bit floating point is only supported on Linux.
    • The default for -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 (-mcpu=power9) on a 64-bit system, the IEEE 128-bit floating point support will also enable the generation of ISA 3.0 IEEE 128-bit floating point instructions. โœจ Otherwise, if you don't specify to generate ISA 3.0 instructions or you're targeting a 32-bit big endian system, IEEE 128-bit floating point will be done with software emulation.
  • -mfloat128-hardware, -mno-float128-hardware โ€” enable/disable using ISA 3.0 hardware instructions to support the __float128 data type. The default for -mfloat128-hardware is enabled on PowerPC Linux systems using the ISA 3.0 instruction set, and disabled on other systems. ๐Ÿ’–
  • -m32, -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 -mpowerpc64.
  • -mfull-toc, -mno-fp-in-toc, -mno-sum-in-toc, -mminimal-toc โ€” these four mess with the generation of the TOC (Table Of Contents), which gets created for every executable file. ๐Ÿ“š

-mfull-toc is the 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. But only 16,384 entries are available in the TOC. ๐Ÿ˜ญ

If you get a linker error message saying you've overflowed the available TOC space, you can reduce the TOC space used with -mno-fp-in-toc and -mno-sum-in-toc. -mno-fp-in-toc stops GCC from putting floating-point constants in the TOC, and -mno-sum-in-toc forces GCC to generate code that calculates 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. Each one causes GCC to produce very slightly slower and larger code, at the expense of conserving TOC space.

If you still run out of TOC space even with both of those on, specify -mminimal-toc instead. This one makes GCC create only one TOC entry for every file. When you specify it, GCC produces code that is slower and larger but uses extremely little TOC space. You may wish to use this option only on files that contain less frequently-executed code. ๐ŸŒ

  • -maix64, -maix32 โ€” enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit long type, and the infrastructure needed to support them. Specifying -maix64 implies -mpowerpc64, while -maix32 disables the 64-bit ABI and implies -mno-powerpc64. GCC defaults to -maix32. ๐ŸŽ€
  • -mxl-compat, -mno-xl-compat โ€” produce code that conforms more closely to IBM XL compiler semantics when using the AIX-compatible ABI. It passes floating-point arguments to prototyped functions beyond the register save area (RSA) on the stack in addition to argument FPRs. It does not assume that the most significant double in a 128-bit long double value is properly rounded when comparing values and converting to double. And it uses 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. ๐Ÿ™ˆ

  • -mpe โ€” support IBM RS/6000 SP Parallel Environment (PE). Links an application written to use message passing with special startup code so the application can run. The system must have PE installed in the standard location (/usr/lpp/ppe.poe/), or the specs file must be overridden with the -specs= option to specify the appropriate directory location. ๐Ÿ› ๏ธ The Parallel Environment does not support threads, so -mpe and -pthread are incompatible. ๐Ÿ’€
  • -malign-natural, -malign-power โ€” on AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, -malign-natural overrides the ABI-defined alignment of larger types, like floating-point doubles, on their natural size-based boundary. -malign-power tells 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 -malign-power is not supported. ๐ŸŒธ
  • -msoft-float, -mhard-float โ€” generate code that does not use (or does use) the floating-point register set. Software floating-point emulation is provided if you use -msoft-float, and pass the option to GCC when linking. ๐Ÿ’…
  • -mmultiple, -mno-multiple โ€” generate code that uses (or doesn't use) the load multiple word instructions and the store multiple word instructions. These are generated by default on POWER systems, and not generated on PowerPC systems.
Bestie, do not use -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.
  • -mupdate, -mno-update โ€” generate code that uses (or doesn't 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 -mno-update, there's a small window between the time 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. โš ๏ธ
  • -mavoid-indexed-addresses, -mno-avoid-indexed-addresses โ€” generate code that tries to avoid (or 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. ๐Ÿ”ฅ
  • -mfused-madd, -mno-fused-madd โ€” generate code that uses (or doesn't use) the floating-point multiply and accumulate instructions. These are generated by default if hardware floating point is used. The machine-dependent -mfused-madd option is now mapped to the machine-independent -ffp-contract=fast option, and -mno-fused-madd is mapped to -ffp-contract=off. ๐ŸŒ€
  • -mmulhw, -mno-mulhw โ€” generate code that uses (or doesn't 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. ๐Ÿงฎ
  • -mdlmzb, -mno-dlmzb โ€” generate code that uses (or doesn't use) the string-search dlmzb instruction on the IBM 405, 440, 464 and 476 processors. This instruction is generated by default when targeting those processors. ๐Ÿ”
  • -mno-bit-align, -mbit-align โ€” on System V.4 and embedded PowerPC systems, do not (or 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 unsigned bit-fields of length 1 is aligned to a 4-byte boundary and has a size of 4 bytes. By using -mno-bit-align, the structure is aligned to a 1-byte boundary and is 1 byte in size. ๐ŸŽ€
  • -mno-strict-align, -mstrict-align โ€” on System V.4 and embedded PowerPC systems, do not (or do) assume that unaligned memory references are handled by the system. โœจ
  • -mrelocatable, -mno-relocatable โ€” generate code that allows (or 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 .got2 and 4-byte locations listed in the .fixup section, a table of 32-bit addresses generated by this option. For this to work, all objects linked together must be compiled with -mrelocatable or -mrelocatable-lib. -mrelocatable code aligns the stack to an 8-byte boundary. ๐Ÿฆ‹
  • -mrelocatable-lib, -mno-relocatable-lib โ€” like -mrelocatable, -mrelocatable-lib generates a .fixup section to allow static executables to be relocated at run time, but -mrelocatable-lib does not use the smaller stack alignment of -mrelocatable. Objects compiled with -mrelocatable-lib may be linked with objects compiled with any combination of the -mrelocatable options. ๐Ÿซถ
  • -mno-toc, -mtoc โ€” on System V.4 and embedded PowerPC systems, do not (-mno-toc) / do (-mtoc) assume that register 2 holds a pointer to a global area pointing at the addresses your program uses. tiny register, big responsibilities โœจ
  • -mlittle, -mlittle-endian โ€” on System V.4 and embedded PowerPC systems, compile code for the processor in little-endian mode. -mlittle-endian is literally the same thing as -mlittle, no cap. ๐Ÿฆ‹
  • -mbig, -mbig-endian โ€” on System V.4 and embedded PowerPC systems, compile code for the processor in big-endian mode. And -mbig-endian is the same as -mbig. same energy, different spelling ๐Ÿ’…
  • -mdynamic-no-pic โ€” on Darwin / macOS systems, compile code so it's not relocatable, but its external references are relocatable. The resulting code is giving "applications only" โ€” it is not suitable for shared libraries. ๐Ÿšซ๐Ÿ“š
  • -msingle-pic-base โ€” treat the register used for PIC addressing as read-only, instead of loading it fresh in the prologue of every single function. The runtime system is the one responsible for initializing this register with an appropriate value before execution begins. not your job bestie, that's the runtime's job ๐Ÿซถ
  • -mprioritize-restricted-insns=priority โ€” this one controls the priority assigned to dispatch-slot restricted instructions during the second scheduling pass. The priority argument takes the value 0, 1, or 2, to assign no, highest, or second-highest priority (respectively) to dispatch-slot restricted instructions. โœจ
  • -msched-costly-dep=dependence_type โ€” controls which dependences the target treats as costly during instruction scheduling. The dependence_type argument takes one of these values:
    • no โ€” no dependence is costly. chill, nothing's expensive here
    • all โ€” all dependences are costly. everything is expensive, we're all suffering ๐Ÿ˜ญ
    • true_store_to_load โ€” a true dependence from store to load is costly.
    • store_to_load โ€” any dependence from store to load is costly.
    • number โ€” any dependence whose latency is greater than or equal to number is costly.
  • -minsert-sched-nops=scheme โ€” controls which NOP insertion scheme gets used during the second scheduling pass. The scheme argument takes one of these values:
    • no โ€” don't insert NOPs. we simply do not โœ‹
    • pad โ€” pad with NOPs any dispatch group that has vacant issue slots, according to the scheduler's grouping.
    • regroup_exact โ€” insert NOPs to force costly dependent insns into separate groups. Insert exactly as many NOPs as needed to force an insn into a new group, according to the estimated processor grouping. ๐ŸŽฏ
    • number โ€” insert NOPs to force costly dependent insns into separate groups. Insert number NOPs to force an insn into a new group.
  • -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 powerpc-*-eabiaix. ๐Ÿ‘‘
  • -mcall-sysv-eabi, -mcall-eabi โ€” specify both -mcall-sysv and -meabi options. two for one, slay
  • -mcall-sysv-noeabi โ€” specify both -mcall-sysv and -mno-eabi options.
  • -mcall-aixdesc โ€” on System V.4 and embedded PowerPC systems, compile code for the AIX operating system.
  • -mcall-linux โ€” on System V.4 and embedded PowerPC systems, compile code for the Linux-based GNU system. ๐Ÿง
  • -mcall-freebsd โ€” on System V.4 and embedded PowerPC systems, compile code for the FreeBSD operating system.
  • -mcall-netbsd โ€” on System V.4 and embedded PowerPC systems, compile code for the NetBSD operating system.
  • -mcall-openbsd โ€” on System V.4 and embedded PowerPC systems, compile code for the OpenBSD operating system.
  • -mtraceback=traceback_type โ€” pick the type of traceback table. Valid values for traceback_type are full, part, and no. full, part, or nope ๐Ÿ’…
  • -maix-struct-return โ€” return all structures in memory (as specified by the AIX ABI). every struct, straight to memory
  • -msvr4-struct-return โ€” return structures smaller than 8 bytes in registers (as specified by the SVR4 ABI).
  • -mabi=abi-type โ€” extend the current ABI with a particular extension, or remove such extension. Valid values are: altivec, no-altivec, ibmlongdouble, ieeelongdouble, elfv1, elfv2, and for AIX: vec-extabi, vec-default. ๐ŸŒˆ
  • -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 away from IEEE extended-precision, the compiler will issue a warning unless you use the -Wno-psabi option. Requires -mlong-double-128 to be enabled. > โš ๏ธ warning incoming, listen to it bestie.
  • -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 away from IBM extended-precision, the compiler will issue a warning unless you use the -Wno-psabi option. Requires -mlong-double-128 to be enabled. > โš ๏ธ same deal, do not ignore the warning fr fr.
  • -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. ๐Ÿ’€ > like, catastrophic icon behavior. don't.
  • -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. ๐Ÿ’€ > same warning, same drama.
  • -mgnu-attribute, -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. โœจ
  • -mprototype, -mno-prototype โ€” on System V.4 and embedded PowerPC systems, assume that all calls to variable argument functions are properly prototyped. Otherwise, the compiler has to insert an instruction before every non-prototyped call to set or clear bit 6 of the condition code register (CR), to indicate whether floating-point values are passed in the floating-point registers in case the function takes variable arguments. With -mprototype, only calls to prototyped variable argument functions set or clear the bit. one bit, so much drama ๐ŸŽ€
  • -msim โ€” on embedded PowerPC systems, assume that the startup module is called sim-crt0.o and that the standard C libraries are libsim.a and libc.a. This is the default for powerpc-*-eabisim configurations. ๐Ÿ‘‘
  • -mmvme โ€” on embedded PowerPC systems, assume the startup module is called crt0.o and the standard C libraries are libmvme.a and libc.a.
  • -mads โ€” on embedded PowerPC systems, assume the startup module is called crt0.o and the standard C libraries are libads.a and libc.a.
  • -myellowknife โ€” on embedded PowerPC systems, assume the startup module is called crt0.o and the standard C libraries are libyk.a and libc.a. yellowknife the name is sending me ๐Ÿ’›
  • -mvxworks โ€” on System V.4 and embedded PowerPC systems, specify that you're compiling for a VxWorks system.
  • -memb โ€” on embedded PowerPC systems, set the PPC_EMB bit in the ELF flags header to indicate that eabi extended relocations are used. ๐Ÿ”ง
  • -meabi, -mno-eabi โ€” on System V.4 and embedded PowerPC systems, do (-meabi) / do not (-mno-eabi) adhere to the Embedded Applications Binary Interface (EABI), which is a set of modifications to the System V.4 specifications. Selecting -meabi means the stack is aligned to an 8-byte boundary, a function __eabi is called from main to set up the EABI environment, and the -msdata option can use both r2 and r13 to point to two separate small data areas. Selecting -mno-eabi means the stack is aligned to a 16-byte boundary, no EABI initialization function is called from main, and the -msdata option only uses r13 to point to a single small data area. -meabi is on by default if you configured GCC using one of the powerpc*-*-eabi* options. ๐Ÿซถ
  • -msdata=eabi โ€” on System V.4 and embedded PowerPC systems, put small initialized const global and static data in the .sdata2 section, which is pointed to by register r2. Put small initialized non-const global and static data in the .sdata section, which is pointed to by register r13. Put small uninitialized global and static data in the .sbss section, which is adjacent to the .sdata section. -msdata=eabi is incompatible with the -mrelocatable option. -msdata=eabi also sets the -memb option. > โš ๏ธ incompatible means incompatible, don't do it.
  • -msdata=sysv โ€” on System V.4 and embedded PowerPC systems, put small global and static data in the .sdata section, which is pointed to by register r13. Put small uninitialized global and static data in the .sbss section, which is adjacent to the .sdata section. -msdata=sysv is incompatible with the -mrelocatable option. > โš ๏ธ same warning, same no-no.
  • -msdata=default, -msdata โ€” on System V.4 and embedded PowerPC systems, if -meabi is used, compile code the same as -msdata=eabi; otherwise compile code the same as -msdata=sysv. pick a lane, it picks for you โœจ
  • -msdata=data โ€” on System V.4 and embedded PowerPC systems, put small global data in the .sdata section. Put small uninitialized global data in the .sbss section. Do not use register r13 to address small data, however. This is the default behavior unless other -msdata options are used. ๐ŸŽ€
  • -msdata=none, -mno-sdata โ€” on embedded PowerPC systems, put all initialized global and static data in the .data section, and all uninitialized data in the .bss section.
  • -mreadonly-in-sdata โ€” put read-only objects in the .sdata section as well. This is the default. ๐Ÿ’–
  • -mblock-move-inline-limit=num โ€” inline all block moves (like calls to memcpy or structure copies) less than or equal to num bytes. The minimum value for num is 32 bytes on 32-bit targets and 64 bytes on 64-bit targets. The default value is target-specific. ๐ŸŒˆ
  • -mblock-compare-inline-limit=num โ€” generate non-looping inline code for all block compares (like calls to memcmp or structure compares) less than or equal to num bytes. If num is 0, all inline expansion (non-loop and loop) of block compare is disabled. The default value is target-specific. โญ
  • -mblock-compare-inline-loop-limit=num โ€” okay so this one says: go ahead and do an inline expansion using loop code for every block compare that's less than or equal to num bytes but bigger than the limit for the non-loop inline block compare expansion. If the block length isn't constant, at most num bytes get compared before memcmp is called in to handle the rest of the block. Default value? Target-specific, bestie. It's giving "ask your target". ๐ŸŽ€
  • -mstring-compare-inline-limit=num โ€” compare at most num string bytes with inline code. If the difference or the end of the string isn't found by the end of that inline compare, a call to strcmp or strncmp takes care of the rest of the comparison. Default is 64 bytes. โœจ
  • -G num โ€” on embedded PowerPC systems, this drops global and static items that are less than or equal to num bytes into the small data or BSS sections instead of the normal data or BSS section. By default, num is 8. The -G num switch also gets passed to the linker. And listen โ€” all modules should be compiled with the same -G num value. Consistency is the vibe. ๐Ÿ’…
  • -mregnames, -mno-regnames โ€” on System V.4 and embedded PowerPC systems, do (or don't) emit register names in the assembly language output using symbolic forms. Pick your fighter. ๐Ÿฆ‹
  • -mlongcall, -mno-longcall โ€” by default this assumes that all calls are far away, so a longer and more expensive calling sequence is required. Which, yeah, is needed for calls farther than 32 megabytes (33,554,432 bytes) from the current location. A short call gets generated if the compiler knows the call can't be that far away. You can override this setting with the shortcall function attribute, or with #pragma longcall(0).

Some linkers can detect out-of-range calls and generate glue code on the fly. On those systems, long calls are unnecessary and they generate slower code. As of this writing, the AIX linker can do this, and so can the GNU linker for PowerPC/64. The plan is to add this feature to the GNU linker for 32-bit PowerPC systems too.

On PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, GCC can generate long calls using an inline PLT call sequence (see -mpltseq). PowerPC with -mbss-plt and PowerPC64 ELFv1 (big-endian) do not support inline PLT calls.

On Darwin/PPC systems, #pragma longcall generates jbsr callee, L42, plus a branch island (glue code). Those two target addresses represent the callee and the branch island. The Darwin/PPC linker prefers the first address and generates a bl callee if the PPC bl instruction reaches the callee directly; otherwise the linker generates 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 to emit the glue for every direct call, and the Darwin linker decides whether to use it or discard it.

In the future, GCC may ignore all longcall specifications when the linker is known to generate glue. Future tea, iykyk. ๐Ÿ“

  • -mpltseq, -mno-pltseq โ€” implement (or don't 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 they're enabled by default if that support is detected when configuring GCC โ€” and, for 32-bit PowerPC, if GCC is configured with --enable-secureplt. Heads up: -mpltseq code and -mbss-plt 32-bit PowerPC relocatable objects may not be linked together. ๐Ÿซถ
  • -mtls-markers, -mno-tls-markers โ€” mark (or don't mark) calls to __tls_get_addr with a relocation specifying the function argument. That relocation lets the linker reliably associate the function call with the argument setup instructions for TLS optimization, which in turn lets GCC schedule the sequence better. Slay. โœจ
  • -mrecip, -mno-recip โ€” this option enables the use of reciprocal estimate and reciprocal square root estimate instructions with extra Newton-Raphson steps to increase precision, instead of doing a divide or a square root and divide for floating-point arguments. You should use -ffast-math when you're using -mrecip (or at least -funsafe-math-optimizations, -ffinite-math-only, -freciprocal-math and -fno-trapping-math). Ngl, note this: 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. So like, fast but slightly messy. ๐Ÿ’€
  • -mrecip=opt โ€” this controls which reciprocal estimate instructions may be used. opt is a comma-separated list of options, and any of them may be preceded by a ! to invert it:
    • all โ€” enable all estimate instructions.
    • default โ€” enable the default instructions, equivalent to -mrecip.
    • none โ€” disable all estimate instructions, equivalent to -mno-recip.
    • div โ€” enable the reciprocal approximation instructions for both single and double precision.
    • divf โ€” enable the single-precision reciprocal approximation instructions.
    • divd โ€” enable the double-precision reciprocal approximation instructions.
    • rsqrt โ€” enable the reciprocal square root approximation instructions for both single and double precision.
    • rsqrtf โ€” enable the single-precision reciprocal square root approximation instructions.
    • rsqrtd โ€” enable the double-precision reciprocal square root approximation instructions.

So for example, -mrecip=all,!rsqrtd enables all of the reciprocal estimate instructions except for the FRSQRTE, XSRSQRTEDP, and XVRSQRTEDP instructions, which are the ones handling the double-precision reciprocal square root calculations. Selective queen behavior. ๐Ÿ‘‘

  • -mrecip-precision, -mno-recip-precision โ€” assume (or don't assume) that the reciprocal estimate instructions provide higher-precision estimates than is mandated by the PowerPC ABI. Selecting -mcpu=power6, -mcpu=power7 or -mcpu=power8 automatically selects -mrecip-precision. The double-precision square root estimate instructions are not generated by default on low-precision machines, since they don't provide an estimate that converges after three steps. No cap. ๐ŸŒธ
  • -mveclibabi=type โ€” specifies the ABI type to use for vectorizing intrinsics using an external library. The only type supported at present is mass, which says to use IBM's Mathematical Acceleration Subsystem (MASS) libraries for vectorizing intrinsics using external libraries. GCC currently emits calls to acosd2, acosf4, acoshd2, acoshf4, asind2, asinf4, asinhd2, asinhf4, atan2d2, atan2f4, atand2, atanf4, atanhd2, atanhf4, cbrtd2, cbrtf4, cosd2, cosf4, coshd2, coshf4, erfcd2, erfcf4, erfd2, erff4, exp2d2, exp2f4, expd2, expf4, expm1d2, expm1f4, hypotd2, hypotf4, lgammad2, lgammaf4, log10d2, log10f4, log1pd2, log1pf4, log2d2, log2f4, logd2, logf4, powd2, powf4, sind2, sinf4, sinhd2, sinhf4, sqrtd2, sqrtf4, tand2, tanf4, tanhd2, and tanhf4 when generating code for power7. Both -ftree-vectorize and -funsafe-math-optimizations must also be enabled. And the MASS libraries must be specified at link time. Don't forget that part bestie, fr fr. ๐Ÿ”ฅ
  • -mfriz, -mno-friz โ€” generate (or don't generate) the friz instruction when the -funsafe-math-optimizations option is used to optimize rounding of floating-point values to 64-bit integer and back to floating point. The friz instruction does not return the same value if the floating-point number is too large to fit in an integer. ๐Ÿ™ˆ
  • -mpointers-to-nested-functions, -mno-pointers-to-nested-functions โ€” generate (or don't generate) code to load up the static chain register (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, the TOC value to be loaded in register r2, and the static chain value to be loaded in register r11. The -mpointers-to-nested-functions is on by default. And important: you cannot call through pointers to nested functions, or pointers to functions compiled in other languages that use the static chain, if you use -mno-pointers-to-nested-functions. So like, careful. ๐Ÿ’œ
  • -msave-toc-indirect, -mno-save-toc-indirect โ€” generate (or don't 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 isn't saved in the prologue, it gets saved just before the call through the pointer. The -mno-save-toc-indirect option is the default. ๐ŸŽ€
  • -mcompat-align-parm, -mno-compat-align-parm โ€” generate (or don't 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's compatible with functions compiled with older versions of GCC.

The -mno-compat-align-parm option is the default.

  • -mstack-protector-guard=guard, -mstack-protector-guard-reg=reg, -mstack-protector-guard-offset=offset, -mstack-protector-guard-symbol=symbol โ€” generate stack protection code using a canary at guard. Supported locations are global for a global canary, or tls for a per-thread canary in the TLS block (the default with GNU libc version 2.4 or later).

With that latter choice, the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which register to use as the 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. And -mstack-protector-guard-symbol=symbol overrides the offset with a symbol reference to a canary in the TLS block. โœจ

  • -mpcrel, -mno-pcrel โ€” generate (or don't generate) pc-relative addressing. The -mpcrel option requires that the medium code model (-mcmodel=medium) and prefixed addressing (-mprefixed) options are enabled. Gotta have both, no skipping. ๐Ÿ’–
  • -mprefixed, -mno-prefixed โ€” bestie, this one's giving address mode energy ๐Ÿ’ซ generate (or, with -mno-prefixed, don't generate) addressing modes that use prefixed load and store instructions. Fair warning tho: -mprefixed is not gonna work unless you've got -mcpu=power10 (or later) turned on. No power10, no prefixing, periodt.
  • -mmma, -mno-mma โ€” generate (or don't) the MMA instructions ๐Ÿงฎ. Same deal as above: the -mma option requires that -mcpu=power10 (or later) is enabled. It's giving "you need the vip pass to get in."
  • -mrop-protect, -mno-rop-protect โ€” generate (or don't generate) ROP protection instructions, but only when the target processor actually supports them ๐Ÿ™ˆ. Heads up tho: right now this option disables the shrink-wrap optimization, which is -fshrink-wrap. So like, you're trading one thing for another, iykyk.
  • -mprivileged, -mno-privileged โ€” generate (or don't) code that's gonna run in privileged state ๐Ÿ‘‘. Main character energy, literally.
  • -mblock-ops-unaligned-vsx, -mno-block-ops-unaligned-vsx โ€” generate (or don't) unaligned vsx loads and stores, specifically for the inline expansion of memcpy and memmove ๐ŸŒˆ.
  • --param rs6000-vect-unroll-limit= โ€” okay so the vectorizer checks in with target info to figure out whether unrolling the main vectorized loop would actually be worth it, and by how much. This parameter sets the upper bound of how much the vectorizer will unroll the main loop. Default value? Four. Slay โœจ.

๐ŸŒธ RX Options ๐ŸŒธ

These command-line options are the ones defined for RX targets, bestie:

  • -m64bit-doubles, -m32bit-doubles โ€” makes the double data type either 64 bits (-m64bit-doubles) or 32 bits (-m32bit-doubles) in size. The default is -m32bit-doubles. And no, that's not a typo โ€” RX floating-point hardware only works on 32-bit values, which is literally why the default is -m32bit-doubles. It's giving "the hardware said no ๐Ÿ’€."
  • -fpu, -nofpu โ€” enables (-fpu) or disables (-nofpu) 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, tho, so the FPU hardware isn't used for doubles if you're using the -m64bit-doubles option. RIP to your doubles.

Note: if the -fpu option is enabled, then -funsafe-math-optimizations is also enabled automatically. Why? Because the RX FPU instructions are themselves unsafe ๐Ÿ˜ญ. Not me being honest about it.
  • *-mcpu=name* โ€” picks the type of RX CPU you're targeting. Right now three types are supported: the generic RX600 and RX200 series hardware, plus the specific RX610 CPU. The default is RX600.

The only difference between RX600 and RX610 is that the RX610 does not support the MVTIPL instruction. That's it, that's the whole tea.

The RX200 series doesn't have a hardware floating-point unit, so -nofpu is enabled by default when you select this type. She's just built different (derogatory).

  • -mbig-endian-data, -mlittle-endian-data โ€” store data (but not code, bestie, keep your eyes on the fine print ๐Ÿ‘€) in the big-endian format. The default is -mlittle-endian-data, i.e. storing data in the little-endian format.
  • *-msmall-data-limit=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 the area is limited and it is up to the programmer to make sure the area doesn't overflow ๐Ÿซถ. Also, when the small data area is used, one of the RX's registers (usually r13) gets reserved for pointing to this area, so it's no longer available for the compiler to use. That could result in slower and/or larger code if variables get pushed onto the stack instead of being held in this register. It's giving "there are no free lunches."

Note: common variables (aka variables that haven't been initialized) and constants are not placed into the small data area, since they're assigned to other sections in the output executable.

The default value is zero, which disables this feature. And note: this feature is not enabled by default with higher optimization levels (-O2 etc) because of the potentially detrimental effects of reserving a register. It's up to the programmer to experiment and discover whether this feature actually benefits their program. See the description of the -mpid option for a description of how the actual register to hold the small data area pointer is chosen.

  • -msim, -mno-sim โ€” use the simulator runtime. The default is to use the libgloss board-specific runtime ๐Ÿฆ‹.
  • -mas100-syntax, -mno-as100-syntax โ€” when generating assembler output, use a syntax that's 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. Fussy little syntax, honestly.
  • *-mmax-constant-size=N* โ€” specifies the maximum size, in bytes, of a constant that can be used as an operand in a RX instruction. Even tho 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. So in some circumstances it can be beneficial to restrict the size of constants used in instructions ๐Ÿ“. Constants that are too big get placed into a constant pool instead and referenced via register indirection.

The value N can be between 0 and 4. A value of 0 (the default) or 4 means constants of any size are allowed.

  • -mrelax โ€” enable linker relaxation ๐Ÿ’…. Linker relaxation is a process where the linker tries to reduce the size of a program by finding shorter versions of various instructions. Disabled by default.
  • -mint-register=N โ€” specify the number of registers to reserve for fast interrupt handler functions. The value N can be between 0 and 4. A value of **1 means register r13 is reserved for the exclusive use of fast interrupt handlers. A value of 2 reserves r13 and r12. A value of 3 reserves r13, r12 and r11, and a value of 4 reserves r13 through r10. A value of 0, the default, doesn't reserve any registers. Zero, none, nada โœจ.
  • -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, since that makes the interrupt handlers faster ๐Ÿƒโ€โ™€๏ธ.
  • -mpid, -mno-pid โ€” enables 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 lets the location of constant data be determined at run time without requiring the executable to be relocated, which is a benefit for 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 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 on whether the -msmall-data-limit and/or the -mint-register command-line options are enabled. Starting with register r13 and proceeding downwards, registers are allocated first to satisfy the requirements of -mint-register, then -mpid and finally -msmall-data-limit. So it's totally possible for the small data area register to be r8 if both -mint-register=4 and -mpid are specified on the command line. Iconic, honestly.

By default this feature is not enabled. The default can be restored via the -mno-pid command-line option.

  • -mno-warn-multiple-fast-interrupts, -mwarn-multiple-fast-interrupts โ€” prevents GCC from issuing a warning message if it finds more than one fast interrupt handler while compiling a file. The default is to issue a warning for each extra fast interrupt handler found, since the RX only supports one such interrupt ๐Ÿšจ.
  • -mallow-string-insns, -mno-allow-string-insns โ€” enables or disables use of the string manipulation instructions SMOVF, SCMPU, SMOVB, SMOVU, SUNTIL SWHILE and also the RMPA instruction. These instructions may prefetch data, which is not safe to do if you're 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's 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 can't be disabled automatically. Instead it relies on the programmer to use the -mno-allow-string-insns option if their program accesses I/O space. You gotta do it yourself, bestie.

When the instructions are enabled, GCC defines the C preprocessor symbol __RX_ALLOW_STRING_INSNS__, otherwise it defines the symbol __RX_DISALLOW_STRING_INSNS__.

  • -mjsr, -mno-jsr โ€” use only (or not only) JSR instructions to access functions. This option can be used when code size exceeds the range of BSR instructions ๐Ÿ“ฆ. Note that -mno-jsr does not mean "don't use JSR" โ€” instead it means that any type of branch may be used. Read that twice, it trips people up.
Note: The generic GCC command-line option -ffixed-reg has special significance to the RX port when used with the interrupt function attribute. This attribute indicates a function intended to process fast interrupts. GCC makes sure it only uses the registers r10, r11, r12 and/or r13, and only provided that the normal use of the corresponding registers has been restricted via the -ffixed-reg or -mint-register command-line options. So many conditions, I know, but that's the vibe ๐Ÿ’œ.

๐Ÿ‘‘ S/390 and zSeries Options ๐Ÿ‘‘

These are the -m options defined for the S/390 and zSeries architecture. Let's go:

  • -mhard-float, -msoft-float โ€” use (or don't use) the hardware floating-point instructions and registers for floating-point operations. When -msoft-float is specified, functions in libgcc.a are used to perform floating-point operations. When -mhard-float is specified, the compiler generates IEEE floating-point instructions. This is the default โœจ.
  • -mhard-dfp, -mno-hard-dfp โ€” use (or don't use) the hardware decimal-floating-point instructions for decimal-floating-point operations. When -mno-hard-dfp is specified, functions in libgcc.a are used to perform decimal-floating-point operations. When -mhard-dfp is specified, the compiler generates decimal-floating-point hardware instructions. This is the default for -march=z9-ec or higher ๐ŸŽ€.
  • -mlong-double-64, -mlong-double-128 โ€” these switches control the size of the long double type. A size of 64 bits makes the long double type equivalent to the double type. This is the default ๐Ÿ’ซ.
  • -mbackchain, -mno-backchain โ€” bestie, this one decides whether the address of the caller's frame gets stored as a backchain pointer into the callee's stack frame (or not, if you pick the no version). Why would you want a backchain? So that debugging tools that do not understand DWARF call frame information can still figure out what's going on. When -mno-packed-stack is in effect, that backchain pointer lives at the bottom of the stack frame. When -mpacked-stack is in effect, the backchain gets placed into the topmost word of the 96/160 byte register save area. ๐Ÿ’…

Generally speaking, code compiled with -mbackchain is call-compatible with code compiled with -mno-backchain โ€” cute, right? โ€” however, if you actually want to use the backchain for debugging purposes, you usually need the whole binary built with -mbackchain. Also heads up: the combo of -mbackchain, -mpacked-stack and -mhard-float is not supported. And if you're building a linux kernel, use -msoft-float.

The default is to not maintain the backchain.

  • -mpacked-stack, -mno-packed-stack โ€” use (or don't use) the packed stack layout. When -mno-packed-stack is specified, the compiler uses all fields of the 96/160 byte register save area only for their default purpose, and unused fields still eat up stack space. When -mpacked-stack is specified, register save slots are densely packed at the top of the register save area, and unused space gets reused for other purposes โ€” which means more efficient use of the available stack space, slay. But when -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 -mpacked-stack is call-compatible with code generated with -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 -mpacked-stack. Also, note that the combination of -mbackchain, -mpacked-stack and -mhard-float is not supported. In order to build a linux kernel use -msoft-float.

The default is to not use the packed stack layout.

  • -msmall-exec, -mno-small-exec โ€” generate (or don't generate) code using the "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 "basr" instruction instead, which doesn't have this limitation.
  • -m64, -m31 โ€” when -m31 is specified, generate code compliant to the GNU/Linux for S/390 ABI. When -m64 is specified, generate code compliant to the GNU/Linux for zSeries ABI. This lets GCC, in particular, generate 64-bit instructions. For the s390 targets, the default is -m31, while the s390x targets default to -m64.
  • -mzarch, -mesa โ€” when -mzarch is specified, generate code using the instructions available on z/Architecture. When -mesa is specified, generate code using the instructions available on ESA/390. Note that -mesa is not possible with -m64. When generating code compliant to the GNU/Linux for S/390 ABI, the default is -mesa. When generating code compliant to the GNU/Linux for zSeries ABI, the default is -mzarch.
  • -mhtm, -mno-htm โ€” the -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 S/390 System z Built-in Functions. -mhtm is enabled by default when using -march=zEC12.
  • -mvx, -mno-vx โ€” when -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 .gnu_attribute command will be added to mark the resulting binary with the ABI used. -mvx is enabled by default when using -march=z13.
  • -mzvector, -mno-zvector โ€” the -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 vector to be used as a keyword to define vector type variables and arguments. vector is only available when GNU extensions are enabled. It will not be expanded when requesting strict standard compliance, e.g. with -std=c99. In addition to the GCC low-level builtins, -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, the header file vecintrin.h needs to be included. -mzvector is disabled by default.
  • -mmvcle, -mno-mvcle โ€” generate (or don't generate) code using the "mvcle" instruction to perform block moves. When -mno-mvcle is specified, use a "mvc" loop instead. This is the default unless optimizing for size.
  • -mdebug, -mno-debug โ€” print (or don't print) additional debug information when compiling. The default is to not print debug information.
  • *-march=cpu-type* โ€” generate code that runs on cpu-type, which is the name of a system representing a certain processor type. Possible values for cpu-type are z900/arch5, z990/arch6, z9-109, z9-ec/arch7, z10/arch8, z196/arch9, zEC12, z13/arch11, z14/arch12, z15/arch13, z16/arch14, and native.

The default is -march=z900.

Specifying native as cpu type can be used to select the best architecture option for the host processor. -march=native has no effect if GCC does not recognize the processor. ๐Ÿ™ˆ

  • *-mtune=cpu-type* โ€” tune to cpu-type everything applicable about the generated code, except for the ABI and the set of available instructions. The list of cpu-type values is the same as for -march. The default is the value used for -march.
  • -mtpf-trace, -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.
  • -mtpf-trace-skip, -mno-tpf-trace-skip โ€” generate code that changes (does not change) the default branch targets enabled by -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 -mtpf-trace.
  • -mfused-madd, -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.
  • *-mwarn-framesize=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's intended to identify functions that most probably cause a stack overflow. It's useful in an environment with limited stack size, e.g. the linux kernel.
  • -mwarn-dynamicstack โ€” emit a warning if the function calls "alloca" or uses dynamically-sized arrays. This is generally a bad idea with a limited stack size, ngl.
  • -mstack-guard=stack-guard โ€” *-mstack-size=stack-size* โ€” if these options are provided, the S/390 back end emits additional instructions in the function prologue that trigger a trap if the stack size is stack-guard bytes above the stack-size (remember that the stack on S/390 grows *downward). If the 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 *stack-size has to be greater than 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 stack-size. The stack-guard option can only be used in conjunction with stack-size. ๐Ÿ‘‘
  • *-mhotpatch=pre-halfwords*,post-halfwords โ€” if the hotpatch option is enabled, a "hot-patching" function prologue is generated for all functions in the compilation unit. The funtion label is prepended with the given number of two-byte NOP instructions (pre-halfwords, maximum 1000000). After the label, 2 * 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 "hotpatch" attribute.


โœจ SH Options โœจ

These -m options are defined for the SH implementations, bestie:

  • -m1 โ€” Generate code for the SH1.
  • -m2 โ€” Generate code for the SH2.
  • -m2e โ€” Generate code for the SH2e.
  • -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.
  • -m2a-single-only โ€” Generate code for the SH2a-FPU, in such a way that no double-precision floating-point operations are used.
  • -m2a-single โ€” Generate code for the SH2a-FPU assuming the floating-point unit is in single-precision mode by default.
  • -m2a โ€” Generate code for the SH2a-FPU assuming the floating-point unit is in double-precision mode by default.
  • -m3 โ€” Generate code for the SH3.
  • -m3e โ€” Generate code for the SH3e.
  • -m4-nofpu โ€” Generate code for the SH4 without a floating-point unit.
  • -m4-single-only โ€” Generate code for the SH4 with a floating-point unit that only supports single-precision arithmetic.
  • -m4-single โ€” Generate code for the SH4 assuming the floating-point unit is in single-precision mode by default.
  • -m4 โ€” Generate code for the SH4.
  • -m4-100 โ€” Generate code for SH4-100.
  • -m4-100-nofpu โ€” Generate code for SH4-100 in such a way that the floating-point unit is not used.
  • -m4-100-single โ€” Generate code for SH4-100 assuming the floating-point unit is in single-precision mode by default.
  • -m4-100-single-only โ€” codegen for the SH4-100, but locked in so that no double-precision floating-point ops ever happen. singles only bestie ๐Ÿ’…
  • -m4-200 โ€” make code for the SH4-200. that's it, that's the whole vibe โœจ
  • -m4-200-nofpu โ€” SH4-200 code, arranged so the floating-point unit does not get used at all. fp who? never heard of her ๐Ÿ’€
  • -m4-200-single โ€” SH4-200 code that assumes the FPU is in single-precision mode by default. manifesting single precision ๐ŸŽ€
  • -m4-200-single-only โ€” SH4-200, but arranged so that no double-precision floating-point operations are used. no doubles allowed in this house ๐Ÿšซ
  • -m4-300 โ€” generate code for the SH4-300 ๐Ÿฆ‹
  • -m4-300-nofpu โ€” SH4-300 code generated so the floating-point unit is not used. leaving the FPU on read ๐Ÿ™ˆ
  • -m4-300-single โ€” SH4-300 code, but in such a way that no double-precision floating-point operations are used.
  • -m4-300-single-only โ€” same deal for the SH4-300: absolutely zero double-precision floating-point operations, periodt ๐Ÿ‘‘
  • -m4-340 โ€” code for the SH4-340. and just so you know: no MMU, no FPU. bare minimum queen ๐Ÿ’–
  • -m4-500 โ€” code for the SH4-500 (again, no FPU). this one also passes -isa=sh4-nofpu to the assembler, so the assembler knows what's up โœจ
  • -m4a-nofpu โ€” code for the SH4al-dsp, or for a SH4a, generated in such a way that the floating-point unit is not used.
  • -m4a-single-only โ€” SH4a code, arranged so that no double-precision floating-point operations are used.
  • -m4a-single โ€” SH4a code assuming the floating-point unit is in single-precision mode by default ๐Ÿ’…
  • -m4a โ€” generate code for the SH4a. short, sweet, iconic ๐ŸŽ€
  • -m4al โ€” literally the same as -m4a-nofpu, except it implicitly passes -dsp to the assembler. heads up tho: GCC doesn't generate any DSP instructions at the moment. so, yk. it's giving promise ๐Ÿ’€
  • -mb โ€” compile code for the processor in big-endian mode.
  • -ml โ€” compile code for the processor in little-endian mode. (yes bestie, -mb and -ml, that's the whole naming scheme, we love a minimal queen ๐Ÿฆ‹)
  • -mdalign โ€” align doubles at 64-bit boundaries. โš ๏ธ but fr fr pay attention: this changes the calling conventions, which means some functions from the standard C library will not work unless you recompile it first with -mdalign. no cap, recompile first or suffer ๐Ÿ˜ญ
  • -mrelax โ€” shorten some address references at link time when possible. it does this by using the linker option -relax. tiny code, big slay โœจ
  • -mbigtable โ€” use 32-bit offsets in switch tables. the default is to use 16-bit offsets, so this is the โœจupgradeโœจ option.
  • -mbitops โ€” enable the use of bit manipulation instructions on the SH2A ๐Ÿ”ฅ
  • -mfmovd โ€” enable the use of the instruction fmovd. and bestie, go check -mdalign for the alignment constraints, they're connected ๐Ÿ‘€
  • -mrenesas โ€” comply with the calling conventions defined by Renesas ๐Ÿ’œ
  • -mno-renesas โ€” comply with the calling conventions defined for GCC before the Renesas conventions existed. this is the default for all targets of the SH toolchain, so if you didn't touch anything, congrats, you're already here ๐ŸŽ€
  • -mnomacsave โ€” mark the MAC register as call-clobbered, even if -mrenesas is given. yes even then. it's not listening ๐Ÿซถ
  • -mieee โ€” control the IEEE compliance of floating-point comparisons. this affects how it handles cases where the result of a comparison is unordered.
  • -mno-ieee โ€” the other half of that pair. by default -mieee is implicitly enabled. if -ffinite-math-only is enabled, -mno-ieee is implicitly set, which results in faster floating-point greater-equal and less-equal comparisons. and both implicit settings can be overridden by explicitly specifying either -mieee or -mno-ieee. so you always get the final say ๐Ÿ’…
  • -minline-ic_invalidate โ€” inline code to invalidate instruction cache entries after setting up nested function trampolines. okay so, the deets: this option has no effect if -musermode is in effect and the selected code generation option (e.g. -m4) doesn't allow the use of the icbi instruction. if the selected code generation option doesn't allow icbi and -musermode is not in effect, then the inlined code manipulates the instruction cache address array directly with an associative write. โš ๏ธ and that not only requires privileged mode at run time, it also fails if the cache line had been mapped via the TLB and has become unmapped. messy, be careful ๐Ÿ˜ญ
  • -misize โ€” dump instruction size and location in the assembly code. lil receipt for every instruction ๐Ÿงพโœจ
  • -mpadstruct โ€” this option is deprecated. it pads structures to multiple of 4 bytes, which is incompatible with the SH ABI. old and problematic, we don't stan ๐Ÿ™ˆ
  • -matomic-model=model โ€” sets the model of atomic operations, plus additional parameters, as a comma separated list. for details on the atomic built-in functions see __atomic Builtins. the supported models and parameters are:
    • none โ€” disable compiler generated atomic sequences and emit library calls for atomic operations. this is the default if the target is not sh*-*-linux*.
    • soft-gusa โ€” generate GNU/Linux compatible gUSA software atomic sequences for the atomic built-in functions. these generated sequences require extra support from the interrupt/exception handling code of the system, and they're only suitable for SH3* and SH4* single-core systems. this is enabled by default when the target is sh*-*-linux* and SH3* or SH4*. when the target is SH4A, this option also partially utilizes the hardware atomic instructions movli.l and movco.l to create more efficient code โ€” unless strict is specified ๐Ÿ‘€
    • soft-tcb โ€” generate software atomic sequences that use a variable in the thread control block. it's a variation of the gUSA sequences that can also be used on SH1* and SH2* targets. same deal: needs additional support from the interrupt/exception handling code of the system, and only suitable for single-core systems. when you use this model, the gbr-offset= parameter has to be specified as well ๐Ÿซถ
    • soft-imask โ€” generate software atomic sequences that temporarily disable interrupts by setting SR.IMASK = 1111. this model works only when the program runs in privileged mode and is only suitable for single-core systems. the good news: additional support from the interrupt/exception handling code of the system is not required. this model is enabled by default when the target is sh*-*-linux* and SH1* or SH2*.
    • hard-llcs โ€” generate hardware atomic sequences using the movli.l and 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. and for this model, additional support from the interrupt/exception handling code of the system is not required ๐Ÿ”ฅ
    • 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 soft-tcb model has been selected. for other models this parameter is ignored. the value you give must be an integer multiple of four and in the range 0-1020. math check bestie, 0-1020 and divisible by 4 ๐Ÿ“โœจ
    • strict โ€” this parameter prevents mixed usage of multiple atomic models, even if they're compatible, and makes the compiler generate atomic sequences of the specified model only. one model only, monogamy ๐Ÿ’…
  • -mtas โ€” generate the tas.b opcode for __atomic_test_and_set. โš ๏ธ but notice: 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 tas.b instruction. and on multi-core SH4A processors the tas.b instruction must be used with caution since it can result in data corruption for certain cache configurations. no cap, be careful with this one ๐Ÿ˜ญ
  • -mprefergot โ€” when generating position-independent code, emit function calls using the Global Offset Table instead of the Procedure Linkage Table. GOT > PLT, apparently โœจ
  • -musermode โ€” don't allow the compiler to generate privileged mode code. specifying -musermode also implies -mno-inline-ic_invalidate if the inlined code would not work in user mode. this is the default when the target is sh*-*-linux*. and if the target is SH1* or SH2*, -musermode has no effect, since there is no user mode. nothing to leave, bestie ๐Ÿฆ‹
  • -mno-usermode โ€” the flip side: allow the compiler to generate privileged mode code. pick your fighter ๐Ÿ’…
  • -multcost=number โ€” set the cost to assume for a multiply insn. multiply girlies, set your price ๐ŸŽ€
  • -mdiv=strategy โ€” set the division strategy to be used for integer division operations. strategy can be one of:
    • call-div1 โ€” calls a library function that uses the single-step division instruction 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.
    • 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 call-div1.
    • call-table โ€” calls a library function that uses a lookup table for small divisors and the 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 call-div1.

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 divs and divu instructions instead of library function calls. so many defaults, so little time ๐Ÿ’œ

  • -maccumulate-outgoing-args โ€” reserve space once for outgoing arguments in the function prologue rather than around each call. generally beneficial for performance and size โœจ it's also needed for unwinding, to avoid changing the stack frame around conditional code. lowkey a two-for-one ๐ŸŽ€
  • -mdivsi3_libfunc=name โ€” set the name of the library function used for 32-bit signed division to name. heads up: this only affects the name used in the call division strategies, and the compiler still expects the same sets of input/output/clobbered registers as if this option were not present. renaming the girl doesn't change her register requirements ๐Ÿ’…
  • -mfixed-range=register-range โ€” bestie, this tells the compiler to treat that register range as fixed registers, aka ones the register allocator is simply not allowed to touch ๐Ÿ’…. Super handy when you're compiling kernel code. You write a register range as two registers separated by a dash, and you can stack multiple ranges by separating them with a comma.
  • -mbranch-cost=num โ€” pretend num is the cost of a branch instruction. Bigger numbers = the compiler tries harder to generate branch-free code where it can. If you don't specify it, the value gets picked based on the processor type you're compiling for โœจ.
  • -mzdcbranch
  • -mno-zdcbranch โ€” assume (or don't assume, respectively) that the zero displacement conditional branch instructions bt and bf are fast ๐Ÿ”ฅ. With -mzdcbranch, the compiler prefers zero displacement branch code sequences. It's enabled by default when generating code for SH4 and SH4A, and you can explicitly turn it off with -mno-zdcbranch.
  • -mcbranch-force-delay-slot โ€” forces delay slots to be used for conditional branches, which means if it can't find a suitable instruction, it just stuffs the delay slot with a nop ๐Ÿ’€. By default this option is disabled. You'd enable it to work around hardware bugs, like the ones found in the original SH7055.
  • -mfused-madd
  • -mno-fused-madd โ€” generate code that uses (or doesn't use) the floating-point multiply and accumulate instructions. These get generated by default if hardware floating point is in play. Heads up though: the machine-dependent -mfused-madd option is now mapped to the machine-independent -ffp-contract=fast option, and -mno-fused-madd maps to -ffp-contract=off ๐Ÿซถ.
  • -mfsca
  • -mno-fsca โ€” allow or disallow the compiler from emitting the fsca instruction for sine and cosine approximations ๐ŸŒธ. -mfsca must be used together with -funsafe-math-optimizations. It's enabled by default when generating code for SH4A. Using -mno-fsca disables those sine and cosine approximations even if -funsafe-math-optimizations is in effect.
  • -mfsrra
  • -mno-fsrra โ€” allow or disallow the compiler from emitting the fsrra instruction for reciprocal square root approximations ๐ŸŒˆ. -mfsrra must be used in combination with -funsafe-math-optimizations and -ffinite-math-only. It's enabled by default when generating code for SH4A. Using -mno-fsrra disables reciprocal square root approximations even if -funsafe-math-optimizations and -ffinite-math-only are in effect.
  • -mpretend-cmove โ€” prefer zero-displacement conditional branches for conditional move instruction patterns ๐Ÿ‘‘. This can give you faster code on the SH4 processor.
  • -mfdpic โ€” generate code using the FDPIC ABI โœจ.

๐ŸŒž Solaris 2 Options ๐ŸŒž

These -m options are supported on Solaris 2, bestie:

  • -mclear-hwcap โ€” -mclear-hwcap tells the compiler to remove the hardware capabilities generated by the Solaris assembler ๐Ÿงน. You only need this when object files use ISA extensions that aren't supported by the current machine, but check at runtime whether or not to use them.
  • -mimpure-text โ€” -mimpure-text, used in addition to -shared, tells the compiler to not pass -z text to the linker when linking a shared object. With this option you can link position-dependent code into a shared object.

-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 -mimpure-text, you should compile all source code with -fpic or -fPIC.

These switches are supported in addition to the above on Solaris 2:

  • -pthreads โ€” this is a synonym for -pthread ๐Ÿ’–.

โœจ SPARC Options โœจ

These -m options are supported on the SPARC:

  • -mno-app-regs
  • -mapp-regs โ€” specify -mapp-regs to generate output using the global registers 2 through 4, which the SPARC SVR4 ABI reserves for applications ๐ŸŽ€. Like global register 1, each global register 2 through 4 is then treated as an allocable register that gets clobbered by function calls. This is the default.

To be fully SVR4 ABI-compliant at the cost of some performance loss, specify -mno-app-regs. You should compile libraries and system software with this option.

  • -mflat
  • -mno-flat โ€” with -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 get saved on the stack as needed.

With -mno-flat (the default), the compiler generates save/restore instructions (except for leaf functions). This is the normal operating mode.

  • -mfpu
  • -mhard-float โ€” generate output containing floating-point instructions. This is the default. ๐Ÿ’…
  • -mno-fpu
  • -msoft-float โ€” generate output containing library calls for floating point. โš ๏ธ 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 can't be done directly in cross-compilation โ€” you have to make your own arrangements to provide suitable library functions for cross-compilation. The embedded targets sparc-*-aout and sparclite-*-* do provide software floating-point support though ๐Ÿซถ.

-msoft-float changes the calling convention in the output file, so it's only useful if you compile all of a program with this option. In particular, you need to compile libgcc.a, the library that comes with GCC, with -msoft-float for this to work.

  • -mhard-quad-float โ€” generate output containing quad-word (long double) floating-point instructions ๐ŸŒŸ.
  • -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 -msoft-quad-float option is the default.

  • -mno-unaligned-doubles
  • -munaligned-doubles โ€” assume that doubles have 8-byte alignment. This is the default.

With -munaligned-doubles, GCC assumes that doubles have 8-byte alignment only if they're 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 ๐Ÿ“‰.

  • -muser-mode
  • -mno-user-mode โ€” do not generate code that can only run in supervisor mode ๐Ÿšซ. This is relevant only for the casa instruction emitted for the LEON3 processor. This is the default.
  • -mfaster-structs
  • -mno-faster-structs โ€” with -mfaster-structs, the compiler assumes that structures should have 8-byte alignment ๐Ÿ”ฅ. This enables the use of pairs of ldd and std instructions for copies in structure assignment, instead of twice as many ld and st pairs. However, the use of this changed alignment directly violates the SPARC ABI ๐Ÿ’€. So 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.
  • -mstd-struct-return
  • -mno-std-struct-return โ€” with -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 -mno-std-struct-return. This option has no effect in 64-bit mode.

  • -mlra
  • -mno-lra โ€” enable Local Register Allocation โœจ. This has been the default for SPARC since GCC 7, so you need to pass -mno-lra to get the old Reload.
  • -mcpu=cpu_type โ€” set the instruction set, register set, and instruction scheduling parameters for machine type cpu_type ๐Ÿ‘‘. Supported values for cpu_type are v7, cypress, v8, supersparc, hypersparc, leon, leon3, leon3v7, leon5, sparclite, f930, f934, sparclite86x, sparclet, tsc701, v9, ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7 and m8.

Native Solaris and GNU/Linux toolchains also support the value native, which selects the best architecture option for the host processor ๐ŸŒˆ. -mcpu=native has no effect if GCC doesn't recognize the processor.

Default instruction scheduling parameters are used for values that select an architecture and not an implementation. These are v7, v8, sparclite, sparclet, v9.

Here's a list of each supported architecture and their supported implementations ๐Ÿ’–:

  • v7 โ€” cypress, leon3v7
  • v8 โ€” supersparc, hypersparc, leon, leon3, leon5
  • sparclite โ€” f930, f934, sparclite86x
  • sparclet โ€” tsc701
  • v9 โ€” ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7, m8

By default (unless configured otherwise), GCC generates code for the V7 variant of the SPARC architecture ๐ŸŒธ. With -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 -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 -mcpu=supersparc, the compiler additionally optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and 2000 series.

With -mcpu=sparclite, GCC generates code for the SPARClite variant of the SPARC architecture. This adds the integer multiply, integer divide step and scan ("ffs") instructions which exist in SPARClite but not in SPARC-V7. With -mcpu=f930, the compiler additionally optimizes it for the Fujitsu MB86930 chip, which is the original SPARClite, with no FPU. With -mcpu=f934, the compiler additionally optimizes it for the Fujitsu MB86934 chip, which is the more recent SPARClite with FPU. ๐Ÿงš

With -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 ("ffs") instructions which exist in SPARClet but not in SPARC-V7. With -mcpu=tsc701, the compiler additionally optimizes it for the TEMIC SPARClet chip. โœจ

With -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 -mcpu=ultrasparc, the compiler additionally optimizes it for the Sun UltraSPARC I/II/IIi chips.
  • With -mcpu=ultrasparc3, the compiler additionally optimizes it for the Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.
  • With -mcpu=niagara, the compiler additionally optimizes it for Sun UltraSPARC T1 chips.
  • With -mcpu=niagara2, the compiler additionally optimizes it for Sun UltraSPARC T2 chips.
  • With -mcpu=niagara3, the compiler additionally optimizes it for Sun UltraSPARC T3 chips.
  • With -mcpu=niagara4, the compiler additionally optimizes it for Sun UltraSPARC T4 chips.
  • With -mcpu=niagara7, the compiler additionally optimizes it for Oracle SPARC M7 chips.
  • With -mcpu=m8, the compiler additionally optimizes it for Oracle M8 chips. ๐Ÿ’–

  • -mtune=cpu_type โ€” sets the instruction scheduling parameters for machine type cpu_type, but does not set the instruction set or register set that the option -mcpu=cpu_type does. Like, scheduling vibes only, bestie.

The same values for -mcpu=cpu_type can be used for -mtune=cpu_type, but the only useful values are those that select a particular CPU implementation. Those are cypress, supersparc, hypersparc, leon, leon3, leon3v7, leon5, f930, f934, sparclite86x, tsc701, ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7 and m8. With native Solaris and GNU/Linux toolchains, native can also be used. ๐Ÿฆ‹

  • -mv8plus, -mno-v8plus โ€” with -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.
  • -mvis, -mno-vis โ€” with -mvis, GCC generates code that takes advantage of the UltraSPARC Visual Instruction Set extensions. The default is -mno-vis.
  • -mvis2, -mno-vis2 โ€” with -mvis2, GCC generates code that takes advantage of version 2.0 of the UltraSPARC Visual Instruction Set extensions. The default is -mvis2 when targeting a cpu that supports such instructions, such as UltraSPARC-III and later. Setting -mvis2 also sets -mvis.
  • -mvis3, -mno-vis3 โ€” with -mvis3, GCC generates code that takes advantage of version 3.0 of the UltraSPARC Visual Instruction Set extensions. The default is -mvis3 when targeting a cpu that supports such instructions, such as niagara-3 and later. Setting -mvis3 also sets -mvis2 and -mvis. ๐Ÿ’…
  • -mvis4, -mno-vis4 โ€” with -mvis4, GCC generates code that takes advantage of version 4.0 of the UltraSPARC Visual Instruction Set extensions. The default is -mvis4 when targeting a cpu that supports such instructions, such as niagara-7 and later. Setting -mvis4 also sets -mvis3, -mvis2 and -mvis.
  • -mvis4b, -mno-vis4b โ€” with -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 -mvis4b when targeting a cpu that supports such instructions, such as m8 and later. Setting -mvis4b also sets -mvis4, -mvis3, -mvis2 and -mvis. ๐Ÿ˜ญ so many flags, but we love her
  • -mcbcond, -mno-cbcond โ€” with -mcbcond, GCC generates code that takes advantage of the UltraSPARC Compare-and-Branch-on-Condition instructions. The default is -mcbcond when targeting a CPU that supports such instructions, such as Niagara-4 and later.
  • -mfmaf, -mno-fmaf โ€” with -mfmaf, GCC generates code that takes advantage of the UltraSPARC Fused Multiply-Add Floating-point instructions. The default is -mfmaf when targeting a CPU that supports such instructions, such as Niagara-3 and later.
  • -mfsmuld, -mno-fsmuld โ€” with -mfsmuld, GCC generates code that takes advantage of the Floating-point Multiply Single to Double (FsMULd) instruction. The default is -mfsmuld when targeting a CPU supporting the architecture versions V8 or V9 with FPU except -mcpu=leon.
  • -mpopc, -mno-popc โ€” with -mpopc, GCC generates code that takes advantage of the UltraSPARC Population Count instruction. The default is -mpopc when targeting a CPU that supports such an instruction, such as Niagara-2 and later.
  • -msubxc, -mno-subxc โ€” with -msubxc, GCC generates code that takes advantage of the UltraSPARC Subtract-Extended-with-Carry instruction. The default is -msubxc when targeting a CPU that supports such an instruction, such as Niagara-7 and later. ๐ŸŒธ
  • -mfix-at697f โ€” enable the documented workaround for the single erratum of the Atmel AT697F processor (which corresponds to erratum #13 of the AT697E processor).
  • -mfix-ut699 โ€” enable the documented workarounds for the floating-point errata and the data cache nullify errata of the UT699 processor.
  • -mfix-ut700 โ€” enable the documented workaround for the back-to-back store errata of the UT699E/UT700 processor.
  • -mfix-gr712rc โ€” enable the documented workaround for the back-to-back store errata of the GR712RC processor. ๐Ÿซถ

These -m options are supported in addition to the above on SPARC-V9 processors in 64-bit environments:

  • -m32, -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.
  • -mcmodel=which โ€” set the code model to one of:
    • 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.
    • 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.
    • 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.
    • 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. ๐Ÿšซ
  • -mmemory-model=mem-model โ€” set the memory model in force on the processor to one of:
    • default โ€” the default memory model for the processor and operating system.
    • rmo โ€” Relaxed Memory Order
    • pso โ€” Partial Store Order
    • tso โ€” Total Store Order
    • sc โ€” Sequential Consistency

These memory models are formally defined in Appendix D of the SPARC-V9 architecture manual, as set in the processor's "PSTATE.MM" field. ๐Ÿ“–

  • -mstack-bias, -mno-stack-bias โ€” with -mstack-bias, GCC assumes that the stack pointer, and frame pointer if present, are offset by -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. ๐Ÿ’€ (the -2047 is not a typo, bestie, she's just like that)

โœจ Options for System V โœจ

These additional options are available on System V Release 4 for compatibility with other compilers on those systems:

  • -G โ€” create a shared object. It is recommended that -symbolic or -shared be used instead. ๐Ÿ‘€
  • -Qy โ€” identify the versions of each tool used by the compiler, in a ".ident" assembler directive in the output.
  • -Qn โ€” refrain from adding ".ident" directives to the output file (this is the default).
  • -YP,dirs โ€” search the directories dirs, and no others, for libraries specified with -l.
  • -Ym,dir โ€” look in the directory dir to find the M4 preprocessor. The assembler uses this option.

๐ŸŒˆ V850 Options ๐ŸŒˆ

These -m options are defined for V850 implementations:

  • -mlong-calls, -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.
  • -mno-ep, -mep โ€” do not optimize (do optimize) basic blocks that use the same index pointer 4 or more times to copy pointer into the "ep" register, and use the shorter "sld" and "sst" instructions. The -mep option is on by default if you optimize.
  • -mno-prolog-function, -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 -mprolog-function option is on by default if you optimize.
  • -mspace โ€” try to make the code as small as possible. At present, this just turns on the -mep and -mprolog-function options. tiny code era ๐ŸŽ€
  • -mtda=n โ€” put static or global variables whose size is n bytes or less into the tiny data area that register "ep" points to. The tiny data area can hold up to 256 bytes in total (128 bytes for byte references).
  • -msda=n โ€” put static or global variables whose size is n bytes or less into the small data area that register "gp" points to. The small data area can hold up to 64 kilobytes. โญ
  • -mzda=n โ€” bestie, this one shoves all your static and global variables that are n bytes or smaller into the first 32 kilobytes of memory. tiny vars, prime real estate ๐Ÿ’–
  • -mv850 โ€” tells GCC the target processor is the V850. that's it, that's the whole vibe โœจ
  • -mv850e3v5 โ€” target processor = V850E3V5. when you use this one, the preprocessor constant __v850e3v5__ gets defined ๐ŸŽ€
  • -mv850e2v4 โ€” target processor = V850E3V5. yeah. it says V850E3V5. this is an alias for the -mv850e3v5 option, no cap ๐Ÿ’…
  • -mv850e2v3 โ€” target processor = V850E2V3, and the preprocessor constant __v850e2v3__ is defined when you use it ๐Ÿฆ‹
  • -mv850e2 โ€” target processor = V850E2, and yes, the preprocessor constant __v850e2__ is defined ๐ŸŒธ
  • -mv850e1 โ€” target processor = V850E1. this one's generous: it defines both __v850e1__ and __v850e__ ๐Ÿ’–
  • -mv850es โ€” target processor = V850ES. an alias for -mv850e1, same energy ๐Ÿซถ
  • -mv850e โ€” target processor = V850E, and the preprocessor constant __v850e__ gets defined โœจ

okay so here's the tea: if none of -mv850, -mv850e, -mv850e1, -mv850e2, -mv850e2v3 or -mv850e3v5 are defined, then a default target processor is chosen and the relevant __v850*__ preprocessor constant gets defined. and the preprocessor constants __v850 and __v851__ are always defined, regardless of which processor variant is the target. iconic consistency ๐Ÿ‘‘

  • -mdisable-callt, -mno-disable-callt โ€” this option suppresses generation of the "CALLT" instruction for the v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850 architecture ๐Ÿ˜ค

it's enabled by default when the RH850 ABI is in use (see -mrh850-abi), and disabled by default when the GCC ABI is in use. and if "CALLT" instructions are being generated, then the C preprocessor symbol __V850_CALLT__ is defined ๐ŸŽ€

  • -mrelax, -mno-relax โ€” passes on (or does not pass on) the -mrelax command-line option to the assembler. just relaying the message fr fr ๐Ÿ“จ
  • -mlong-jumps, -mno-long-jumps โ€” disables (or re-enables) the generation of PC-relative jump instructions ๐ŸŒˆ
  • -msoft-float, -mhard-float โ€” disables (or re-enables) the generation of hardware floating point instructions. this one only matters when the target architecture is V850E2V3 or higher. if hardware floating point instructions are being generated then the C preprocessor symbol __FPU_OK__ is defined, otherwise the symbol __NO_FPU__ is defined ๐Ÿ’œ
  • -mloop โ€” enables the use of the e3v5 LOOP instruction. not enabled by default when the e3v5 architecture is selected, because its use is still experimental ๐Ÿ‘€
  • -mrh850-abi, -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:
    • Integer sized structures and unions are returned via a memory pointer rather than a register.
    • Large structures and unions (more than 8 bytes in size) are passed by value.
    • Functions are aligned to 16-bit boundaries.
    • The -m8byte-align command-line option is supported.
    • The -mdisable-callt command-line option is enabled by default. The -mno-disable-callt command-line option is not supported.

when this version of the ABI is enabled, the C preprocessor symbol __V850_RH850_ABI__ is defined โœจ

  • -mgcc-abi โ€” enables support for the old GCC version of the V850 ABI. with this version of the ABI the following rules apply:
    • Integer sized structures and unions are returned in register "r10".
    • Large structures and unions (more than 8 bytes in size) are passed by reference.
    • Functions are aligned to 32-bit boundaries, unless optimizing for size.
    • The -m8byte-align command-line option is not supported.
    • The -mdisable-callt command-line option is supported but not enabled by default.

when this version of the ABI is enabled, the C preprocessor symbol __V850_GCC_ABI__ is defined ๐Ÿฆ‹

  • -m8byte-align, -mno-8byte-align โ€” enables support for "double" and "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 -m8byte-align is in effect, the C preprocessor symbol __V850_8BYTE_ALIGN__ is defined ๐ŸŒธ
  • -mbig-switch โ€” generates code suitable for big switch tables. use this option only if the assembler/linker complain about out of range branches within a switch table โš ๏ธ
  • -mapp-regs โ€” this option causes r2 and r5 to be used in the code generated by the compiler. this setting is the default ๐Ÿ’…
  • -mno-app-regs โ€” this option causes r2 and r5 to be treated as fixed registers ๐Ÿ”’

๐ŸŒŸ VAX Options ๐ŸŒŸ

these -m options are defined for the VAX:

  • -munix โ€” do not output certain jump instructions ("aobleq" and so on) that the Unix assembler for the VAX cannot handle across long ranges ๐Ÿ™ˆ
  • -mgnu โ€” do output those jump instructions, on the assumption that the GNU assembler is being used ๐Ÿซถ
  • -mg โ€” output code for G-format floating-point numbers instead of D-format ๐Ÿ”ฅ
  • -mlra, -mno-lra โ€” enable Local Register Allocation. this is still experimental for the VAX, so by default the compiler uses standard reload ๐Ÿ‘‘

๐Ÿงš Visium Options ๐Ÿงš

  • -mdebug โ€” a program which performs file I/O and is destined to run on an MCM target should be linked with this option. it causes the libraries libc.a and libdebug.a to be linked. the program should be run on the target under the control of the GDB remote debugging stub ๐Ÿ›
  • -msim โ€” a program which performs file I/O and is destined to run on the simulator should be linked with this option. this causes libraries libc.a and libsim.a to be linked โœจ
  • -mfpu, -mhard-float โ€” generate code containing floating-point instructions. this is the default ๐Ÿ’–
  • -mno-fpu, -msoft-float โ€” generate code containing library calls for floating-point.
okay listen up, this one's important: -msoft-float changes the calling convention in the output file; therefore, it is only useful if you compile all of a program with this option. in particular, you need to compile libgcc.a, the library that comes with GCC, with -msoft-float in order for this to work ๐Ÿ˜ญ
  • -mcpu=cpu_type โ€” set the instruction set, register set, and instruction scheduling parameters for machine type cpu_type. supported values for cpu_type are mcm, gr5 and gr6.

mcm is a synonym of gr5, present for backward compatibility ๐ŸŽ€

by default (unless configured otherwise), GCC generates code for the GR5 variant of the Visium architecture.

with -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 ๐Ÿšš

  • -mtune=cpu_type โ€” set the instruction scheduling parameters for machine type cpu_type, but do not set the instruction set or register set that the option -mcpu=cpu_type would ๐ŸŒˆ
  • -msv-mode โ€” generate code for the supervisor mode, where there are no restrictions on the access to general registers. this is the default ๐Ÿ‘‘
  • -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 ๐Ÿšซ

๐Ÿ’œ VMS Options ๐Ÿ’œ

these -m options are defined for the VMS implementations:

  • -mvms-return-codes โ€” return VMS condition codes from "main". the default is to return POSIX-style condition (e.g. error) codes ๐Ÿซก
  • -mdebug-main=prefix โ€” flag the first routine whose name starts with prefix as the main routine for the debugger ๐Ÿ”
  • -mmalloc64 โ€” default to 64-bit memory allocation routines ๐Ÿ’พ
  • -mpointer-size=size โ€” set the default size of pointers. possible options for size are 32 or short for 32 bit pointers, 64 or long for 64 bit pointers, and no for supporting only 32 bit pointers. the later option disables "pragma pointer_size" ๐ŸŽฏ

๐ŸŒธ 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 ๐Ÿ’…

  • -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 __RTP__ ๐Ÿ”ฅ
  • -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 โš ๏ธ
  • -non-static โ€” link an RTP executable against shared libraries rather than static libraries. the options -static and -shared can also be used for RTPs; -static is the default ๐ŸŽ€
  • -Bstatic, -Bdynamic โ€” these options are passed down to the linker. they are defined for compatibility with Diab ๐Ÿค
  • -Xbind-lazy โ€” enable lazy binding of function calls. this option is equivalent to -Wl,-z,now and is defined for compatibility with Diab ๐Ÿ’ค
  • -Xbind-now โ€” disable lazy binding of function calls. this option is the default and is defined for compatibility with Diab โšก

๐Ÿ‘‘ x86 Options ๐Ÿ‘‘ (main character section, obviously)

these -m options are defined for the x86 family of computers:

  • -march=cpu-type โ€” generate instructions for the machine type cpu-type. and here's the difference, bestie: in contrast to -mtune=cpu-type, which merely tunes the generated code for the specified cpu-type, -march=cpu-type allows GCC to generate code that may not run at all on processors other than the one indicated. specifying -march=cpu-type implies -mtune=cpu-type, except where noted otherwise ๐Ÿ˜ฑ

the choices for cpu-type are:

  • native โ€” this selects the CPU to generate code for at compilation time by determining the processor type of the compiling machine. using -march=native enables all instruction subsets supported by the local machine (hence the result might not run on different machines). using -mtune=native produces code optimized for the local machine under the constraints of the selected instruction set ๐Ÿ–ฅ๏ธ
  • x86-64 โ€” a generic CPU with 64-bit extensions โœจ
  • x86-64-v2, x86-64-v3, x86-64-v4 โ€” these cpu-type picks hand you the matching micro-architecture level straight out of the x86-64 psABI. On ABIs that are not the x86-64 psABI, they still select the same CPU features that the x86-64 psABI documents for that particular micro-architecture level.

okay so heads up bestie: these cpu-type values have no matching -mtune setting of their own, so using -march with them just turns on generic tuning. Want something more specific? Flip on specific tuning with the -mtune=other-cpu-type option and an appropriate other-cpu-type value. ๐Ÿ’…

  • i386 โ€” the OG Intel i386 CPU.
  • i486 โ€” Intel i486 CPU. (fr, no scheduling is implemented for this chip. ๐Ÿ’€)
  • i586, pentium โ€” Intel Pentium CPU with no MMX support.
  • lakemont โ€” Intel Lakemont MCU, based on Intel Pentium CPU.
  • pentium-mmx โ€” Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
  • pentiumpro โ€” Intel Pentium Pro CPU.
  • i686 โ€” when you use it with -march, the Pentium Pro instruction set is what gets used, so the code runs on all i686 family chips. When you use it with -mtune, it means the same thing as generic.
  • pentium2 โ€” Intel Pentium II CPU, based on Pentium Pro core with MMX and FXSR instruction set support.
  • pentium3, pentium3m โ€” Intel Pentium III CPU, based on Pentium Pro core with MMX, FXSR and SSE instruction set support.
  • pentium-m โ€” Intel Pentium M; the low-power version of Intel Pentium III CPU with MMX, SSE, SSE2 and FXSR instruction set support. This is the one Centrino notebooks used. ๐ŸŽ€
  • pentium4, pentium4m โ€” Intel Pentium 4 CPU with MMX, SSE, SSE2 and FXSR instruction set support.
  • prescott โ€” improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2, SSE3 and FXSR instruction set support.
  • nocona โ€” improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and FXSR instruction set support.
  • core2 โ€” Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, CX16, SAHF and FXSR instruction set support.
  • nehalem, 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.
  • 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.
  • sandybridge, 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.
  • ivybridge, 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.
  • haswell, 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.
  • broadwell โ€” Intel Broadwell 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 and PREFETCHW instruction set support.
  • skylake โ€” Intel Skylake 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 and SGX instruction set support.
  • skylake-avx512 โ€” Intel Skylake Server 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, CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • alderlake, raptorlake, meteorlake, 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, 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.
  • arrowlake โ€” Intel Arrow Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, 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.
  • arrowlake-s, lunarlake โ€” Intel Arrow Lake S/Lunar Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, 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.
  • pantherlake โ€” Intel Panther Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, 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.
  • sapphirerapids, emeraldrapids โ€” Intel's Sapphire Rapids / Emerald Rapids server chips, 64-bit extensions and honestly the longest feature list you've ever seen in your life ๐Ÿ’€ she's giving maximalist:
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.
  • graniterapids โ€” Intel Granite Rapids, same energy as above but she went and added two more at the end โœจ:
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.
  • graniterapids-d โ€” Intel Granite Rapids D, and she said and also one more time ๐Ÿซถ (yes, AMX-COMPLEX gets her own spot at the end):
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.
  • bonnell, atom โ€” Intel Bonnell, the lil low-power baby ๐Ÿ“ short list, cozy:
Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support.
  • silvermont, slm โ€” Intel Silvermont, step two of the tiny-chip glow-up โœจ:
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.
  • goldmont โ€” Intel Goldmont, now with crypto and XSAVE-adjacent stuff unlocked ๐Ÿ”ฅ:
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.
  • goldmont-plus โ€” Goldmont Plus, same as Goldmont but she picked up PTWRITE, RDPID and SGX along the way ๐Ÿ’…:
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.
  • tremont โ€” Intel Tremont, the plus-plus version, now with GFNI-SSE in the mix ๐ŸŒธ:
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.
  • sierraforest โ€” Intel Sierra Forest, the efficiency-core girlies, and she is stacked ๐Ÿ’€:
Intel Sierra Forest CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, 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.
  • grandridge โ€” Intel Grand Ridge, and ngl her list is character for character the same as sierraforest ๐Ÿ˜ญ iconic twins, no notes:
Intel Grand Ridge CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, 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.
  • clearwaterforest โ€” Intel Clearwater Forest, and she showed up with SHA512, SM3, SM4, USER_MSR and PREFETCHI like a whole new personality ๐Ÿ‘‘:
Intel Clearwater Forest CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, 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.
  • knl โ€” Intel Knights Landing. Bestie, notice that MOVBE shows up twice in this list โ€” that's not a typo on my part, that's literally how it's written, and I am not touching it ๐Ÿซถ:
Intel Knights Landing 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, AVX512PF, AVX512ER, AVX512F, AVX512CD and PREFETCHWT1 instruction set support.
  • knm โ€” Intel Knights Mill, the KNL glow-up with AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ bolted on ๐Ÿ”ฅ:
Intel Knights Mill 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, AVX512PF, AVX512ER, AVX512F, AVX512CD and PREFETCHWT1, AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
  • k6 โ€” AMD K6, and her whole personality is MMX, periodt:
AMD K6 CPU with MMX instruction set support.
  • k6-2, k6-3 โ€” improved AMD K6 versions, now with MMX and 3DNow! ๐Ÿ’…:
Improved versions of AMD K6 CPU with MMX and 3DNow! instruction set support.
  • athlon, athlon-tbird โ€” AMD Athlon, riding in with MMX, 3dNOW!, enhanced 3DNow! and SSE prefetch instructions ๐ŸŒˆ:
AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow! and SSE prefetch instructions support.
  • athlon-4, athlon-xp, athlon-mp โ€” improved AMD Athlon, and now she has the full SSE instruction set, no crumbs:
Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow! and full SSE instruction set support.
  • k8, opteron, athlon64, athlon-fx โ€” AMD K8-core processors, covering the AMD Opteron, Athlon 64, and Athlon 64 FX chips. This one supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow! and the 64-bit instruction set extensions โœจ:
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.)
  • k8-sse3, opteron-sse3, athlon64-sse3 โ€” improved AMD K8 cores, now with SSE3 in the building ๐ŸŽ€:
Improved versions of AMD K8 cores with SSE3 instruction set support.
  • amdfam10, barcelona โ€” CPUs based on AMD Family 10h cores with x86-64. She supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit instruction set extensions ๐Ÿฆ‹:
CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit instruction set extensions.)
  • bdver1 โ€” AMD Family 15h cores with x86-64. 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 ๐Ÿ’œ:
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.)
  • bdver2 โ€” AMD Family 15h core based CPUs with x86-64. 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 ๐ŸŒธ:
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.)
  • bdver3 โ€” AMD Family 15h core based CPUs with x86-64, and she picked up FSGSBASE since last time ๐Ÿซถ:
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.)
  • bdver4 โ€” AMD Family 15h core based CPUs with x86-64. Now with BMI2, AVX2 and MOVBE joining the party ๐Ÿ”ฅ:
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.)
  • znver1 โ€” AMD Family 17h core based CPUs with x86-64. 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 ๐Ÿ’–:
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.)
  • znver2 โ€” AMD Family 17h core based CPUs with x86-64. Adds CLWB, RDPID and WBNOINVD to the znver1 set โœจ:
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.)
  • znver3 โ€” AMD Family 19h core based CPUs with x86-64. Now also supersets PKU, VPCLMULQDQ and VAES ๐Ÿ’…:
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.)
  • znver4 โ€” AMD Family 19h core based CPUs with x86-64, and she went full AVX-512 on us ๐Ÿ˜ญ the whole alphabet of AVX512 things plus GFNI:
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.)
  • 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.) ๐Ÿ’–
  • 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.) โœจ
  • 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.
  • winchip-c6 โ€” IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction set support.
  • winchip2 โ€” IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow! instruction set support. ๐Ÿฆ‹
  • c3 โ€” VIA C3 CPU with MMX and 3DNow! instruction set support. (No scheduling is implemented for this chip.)
  • c3-2 โ€” VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support. (No scheduling is implemented for this chip.)
  • c7 โ€” VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support. (No scheduling is implemented for this chip.)
  • samuel-2 โ€” VIA Eden Samuel 2 CPU with MMX and 3DNow! instruction set support. (No scheduling is implemented for this chip.)
  • nehemiah โ€” VIA Eden Nehemiah CPU with MMX and SSE instruction set support. (No scheduling is implemented for this chip.)
  • esther โ€” VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support. (No scheduling is implemented for this chip.)
  • eden-x2 โ€” VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support. (No scheduling is implemented for this chip.)
  • 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.)
  • nano โ€” Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support. (No scheduling is implemented for this chip.)
  • 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.)
  • 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.)
  • 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.)
  • 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.)
  • 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.)
  • 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 -march=lujiazui for performance reasons. ๐Ÿ™ˆ
  • 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.
  • geode โ€” AMD Geode embedded processor with MMX and 3DNow! instruction set support.

๐ŸŽ€ -mtune=cpu-type

Tune to cpu-type everything applicable about the generated code, except for the ABI and the set of available instructions. Bestie, hear me out โ€” while picking a specific 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 -march=cpu-type option. So like, if GCC is configured for i686-pc-linux-gnu then -mtune=pentium4 generates code that is tuned for Pentium 4 but still runs on i686 machines. It's giving "dress for the job you want but you can still show up to the old job." ๐Ÿ’…

The choices for cpu-type are the same as for -march. In addition, -mtune supports 2 extra choices for cpu-type:

  • 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 -mtune or -march option instead of -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. Not me warning you that your "reproducible" build is on a timer ๐Ÿ˜ญ

There is no -march=generic option because -march indicates the instruction set the compiler can use, and there is no generic instruction set applicable to all processors. In contrast, -mtune indicates the processor (or, in this case, collection of processors) for which the code is optimized. Periodt.

  • 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 -mtune or -march option instead of -mtune=intel. But, if you want your application performs better on both Haswell and Silvermont, 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 -march=intel option because -march indicates the instruction set the compiler can use, and there is no common instruction set applicable to all processors. In contrast, -mtune indicates the processor (or, in this case, collection of processors) for which the code is optimized. Same energy, different chip ๐Ÿ’€


๐Ÿงš -mcpu=cpu-type

A deprecated synonym for -mtune. She's retired, she's iconic, she's still answering the group chat. ๐Ÿ‘‘


๐ŸŒธ -mfpmath=unit

Generate floating-point arithmetic for selected unit unit. The choices for unit are:

  • 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 -ffloat-store for more detailed description. ๐Ÿซถ

This is the default choice for non-Darwin x86-32 targets.

  • 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 -march=cpu-type, -msse or -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 -ffast-math is enabled.

  • sse,387
  • sse+387
  • 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. ๐Ÿ’€

๐Ÿ’œ -masm=dialect

Output assembly instructions using selected dialect. Also affects which dialect is used for basic "asm" and extended "asm". Supported choices (in dialect order) are att or intel. The default is att. Darwin does not support intel. (RIP to Darwin intel stans, iykyk.)


๐ŸŽ€ -mieee-fp

๐ŸŽ€ -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. It's giving "yes she handles the edge case" energy โœจ


๐Ÿฆ‹ -m80387

๐Ÿฆ‹ -mhard-float

Generate output containing 80387 instructions for floating point.


๐Ÿฆ‹ -mno-80387

๐Ÿฆ‹ -msoft-float

Generate output containing library calls for floating point.

โš ๏ธ 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. No cap, GCC is not gonna hand you the libraries โ€” that's on you, bestie. ๐Ÿ’…

the tail of that last one, bestie: on machines where a function returns floating-point results in the 80387 register stack, some floating-point opcodes may still be emitted even if -msoft-float is used. yeah. rude but true. ๐Ÿ’€

  • -mno-fp-ret-in-387 โ€” do not use the FPU registers for function return values.

okay so the usual calling convention is that functions hand back float and double values in an FPU register, even when there's literally no FPU present. the whole idea is that the operating system is supposed to emulate an FPU for you. cute, right? ๐ŸŽ€

-mno-fp-ret-in-387 says nope to all that and makes those values come back in ordinary CPU registers instead.

  • -mno-fancy-math-387 โ€” some 387 emulators simply do not support the sin, cos and sqrt instructions for the 387. specify this option to avoid generating those instructions. ๐Ÿงš

heads up though: this option gets overridden when -march indicates that the target CPU always has an FPU, because then the instruction doesn't need emulation at all. also, these instructions are not generated unless you also use the -funsafe-math-optimizations switch. iykyk.

  • -malign-double, -mno-align-double โ€” these control whether GCC aligns double, long double, and long long variables on a two-word boundary or a one-word boundary. aligning double variables on a two-word boundary produces code that runs somewhat faster on a Pentium, at the expense of more memory. tradeoffs, bestie, always tradeoffs.

on x86-64, -malign-double is enabled by default. โœจ

Warning: if you use the -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. ๐Ÿ’…
  • -m96bit-long-double, -m128bit-long-double โ€” these switches control the size of the long double type. the x86-32 application binary interface specifies the size to be 96 bits, so -m96bit-long-double is the default in 32-bit mode.

modern architectures (Pentium and newer) prefer long double to be aligned to an 8- or 16-byte boundary. but in arrays or structures conforming to the ABI, that's just not possible. so specifying -m128bit-long-double aligns long double to a 16-byte boundary by padding the long double with an additional 32-bit zero. ๐Ÿฆ‹

in the x86-64 compiler, -m128bit-long-double is the default choice, since its ABI specifies that long double is aligned on a 16-byte boundary.

notice โ€” and this is important โ€” that neither of these options enables any extra precision over the x87 standard of 80 bits for a long double. periodt.

Warning: if you override the default value for your target ABI, this changes the size of structures and arrays containing long double variables, as well as modifying the function calling convention for functions taking long double. hence they are not binary-compatible with code compiled without that switch. ๐Ÿ˜ญ
  • -mlong-double-64, -mlong-double-80, -mlong-double-128 โ€” these switches control the size of the long double type too. a size of 64 bits makes the long double type equivalent to the double type โ€” that's the default for 32-bit Bionic C library. a size of 128 bits makes the long double type equivalent to the __float128 type โ€” that's the default for 64-bit Bionic C library.
Warning: if you override the default value for your target ABI, this changes the size of structures and arrays containing long double variables, as well as modifying the function calling convention for functions taking long double. hence they are not binary-compatible with code compiled without that switch. ๐Ÿ™ˆ
  • -malign-data=type โ€” control how GCC aligns variables. the supported values for type are: compat, which uses an increased alignment value compatible with GCC 4.8 and earlier; abi, which uses the alignment value as specified by the psABI; and cacheline, which uses an increased alignment value to match the cache line size. compat is the default. โœจ
  • -mlarge-data-threshold=threshold โ€” when -mcmodel=medium or -mcmodel=large is specified, data objects larger than threshold are placed in large data sections. the default is 65535.
  • -mrtd โ€” use a different function-calling convention, where functions that take a fixed number of arguments return with the ret num instruction, which pops their arguments while returning. this saves one instruction in the caller, since there's no need to pop the arguments there. ๐Ÿ’… efficient queen.

you can specify that an individual function is called with this calling sequence using the function attribute stdcall. you can also override the -mrtd option by using the function attribute cdecl.

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 printf); otherwise incorrect code is generated for calls to those functions. and in addition, seriously incorrect code results if you call a function with too many arguments. (normally, extra arguments are harmlessly ignored, but not here bestie.)

  • -mregparm=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 regparm.
Warning: if you use this switch, and num is nonzero, then you must build all modules with the same value, including any libraries. this includes the system libraries and startup modules. ๐ŸŒธ
  • -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 sseregparm.
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. ๐Ÿ”ฅ
  • -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. only use this option if you need to remain compatible with existing code produced by those previous compiler versions or older versions of GCC. ๐ŸŽ€
  • -mpc32, -mpc64, -mpc80 โ€” set 80387 floating-point precision to 32, 64 or 80 bits. when -mpc32 is specified, the significands of results of floating-point operations are rounded to 24 bits (single precision); -mpc64 rounds the significands of results of floating-point operations to 53 bits (double precision); and -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. but 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. ๐Ÿ˜ญ that's a real one.

  • -mdaz-ftz โ€” the flush-to-zero (FTZ) and denormals-are-zero (DAZ) flags in the MXCSR register are used to control floating-point calculations. SSE and AVX instructions, including scalar and vector instructions, could benefit from enabling the FTZ and DAZ flags when -mdaz-ftz is specified. don't set FTZ/DAZ flags when -mno-daz-ftz or -shared is specified โ€” -mdaz-ftz will set FTZ/DAZ flags even with -shared. ๐Ÿฆ‹
  • -mstackrealign โ€” realign the stack at entry. on the x86, the -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 force_align_arg_pointer, applicable to individual functions. โœจ
  • -mpreferred-stack-boundary=num โ€” attempt to keep the stack boundary aligned to a 2 raised to num byte boundary. if -mpreferred-stack-boundary is not specified, the default is 4 (16 bytes or 128 bits).
Warning: when generating code for the x86-64 architecture with SSE extensions disabled, -mpreferred-stack-boundary=3 can be used to keep the stack boundary aligned to an 8 byte boundary. since x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and intended to be used in a controlled environment where stack space is an 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 a 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 -mpreferred-stack-boundary=3, including any libraries. this includes the system libraries and startup modules. ๐Ÿ’€
  • -mincoming-stack-boundary=num โ€” assume the incoming stack is aligned to a 2 raised to num byte boundary. if -mincoming-stack-boundary is not specified, the one specified by -mpreferred-stack-boundary is used.

on Pentium and Pentium Pro, double and long double values should be aligned to an 8-byte boundary (see -malign-double) or suffer significant run time performance penalties. on Pentium III, the Streaming SIMD Extension (SSE) data type __m128 may not work properly if it is not 16-byte aligned. ๐ŸŒˆ

to ensure proper alignment of these 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. ๐Ÿซถ

okay so this extra alignment? yeah, it does consume extra stack space, and it generally increases code size too. ๐Ÿ’… Code that's sensitive to stack space usage โ€” think embedded systems and operating system kernels, the girlies who count every single byte โ€” may want to reduce the preferred alignment to -mpreferred-stack-boundary=2. periodt.


Now bestie, buckle up, because this next bit is a whole alphabet of CPU instruction sets. ๐ŸŽ€

-mmmx
-msse
-msse2
-msse3
-mssse3
-msse4
-msse4a
-msse4.1
-msse4.2
-mavx
-mavx2
-mavx512f
-mavx512pf
-mavx512er
-mavx512cd
-mavx512vl
-mavx512bw
-mavx512dq
-mavx512ifma
-mavx512vbmi
-msha
-maes
-mpclmul
-mclflushopt
-mclwb
-mfsgsbase
-mptwrite
-mrdrnd
-mf16c
-mfma
-mpconfig
-mwbnoinvd
-mfma4
-mprfchw
-mrdpid
-mprefetchwt1
-mrdseed
-msgx
-mxop
-mlwp
-m3dnow
-m3dnowa
-mpopcnt
-mabm
-madx
-mbmi
-mbmi2
-mlzcnt
-mfxsr
-mxsave
-mxsaveopt
-mxsavec
-mxsaves
-mrtm
-mhle
-mtbm
-mmwaitx
-mclzero
-mpku
-mavx512vbmi2
-mavx512bf16
-mavx512fp16
-mgfni
-mvaes
-mwaitpkg
-mvpclmulqdq
-mavx512bitalg
-mmovdiri
-mmovdir64b
-menqcmd
-muintr
-mtsxldtrk
-mavx512vpopcntdq
-mavx512vp2intersect
-mavx5124fmaps
-mavx512vnni
-mavxvnni
-mavx5124vnniw
-mcldemote
-mserialize
-mamx-tile
-mamx-int8
-mamx-bf16
-mhreset
-mkl
-mwidekl
-mavxifma
-mavxvnniint8
-mavxneconvert
-mcmpccxadd
-mamx-fp16
-mprefetchi
-mraoint
-mamx-complex
-mavxvnniint16
-msm3
-msha512
-msm4
-mapxf
-musermsr
-mavx10.1
-mavx10.1-256
-mavx10.1-512

These switches enable the use of instructions in the MMX, SSE, AVX512ER, AVX512CD, AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, SHA, AES, PCLMUL, CLFLUSHOPT, CLWB, FSGSBASE, PTWRITE, RDRND, F16C, FMA, PCONFIG, WBNOINVD, FMA4, PREFETCHW, RDPID, PREFETCHWT1, RDSEED, SGX, XOP, LWP, 3DNow!, enhanced 3DNow!, POPCNT, ABM, ADX, BMI, BMI2, LZCNT, FXSR, XSAVE, XSAVEOPT, XSAVEC, XSAVES, RTM, HLE, TBM, MWAITX, CLZERO, PKU, AVX512VBMI2, GFNI, VAES, WAITPKG, VPCLMULQDQ, AVX512BITALG, MOVDIRI, MOVDIR64B, AVX512BF16, ENQCMD, AVX512VPOPCNTDQ, AVX5124FMAPS, AVX512VNNI, AVX5124VNNIW, SERIALIZE, UINTR, HRESET, AMXTILE, AMXINT8, AMXBF16, KL, WIDEKL, AVXVNNI, AVX512-FP16, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AMX-FP16, PREFETCHI, RAOINT, AMX-COMPLEX, AVXVNNIINT16, SM3, SHA512, SM4, APX_F, USER_MSR, AVX10.1 or CLDEMOTE extended instruction sets. ๐Ÿ˜Œ Every single one of them has a matching -mno- option to turn that instruction use off again. slay.

These extensions are also available as built-in functions โ€” go peek at x86 Built-in Functions for the deets on which functions these switches enable and disable. ๐Ÿฆ‹

Wanna generate SSE/SSE2 instructions automatically from floating-point code (instead of 387 instructions)? That's -mfpmath=sse, bestie.

GCC depresses SSEx instructions when -mavx is used. Instead, it generates new AVX instructions, or AVX equivalence for all SSEx instructions, when needed. ๐Ÿ’…

These options enable GCC to use these extended instructions in generated code, even without -mfpmath=sse. 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. ๐Ÿ‘‘


  • -mdump-tune-features โ€” tells GCC to dump the names of the x86 performance tuning features and their default settings. You can then feed those names into -mtune-ctrl=feature-list. ๐ŸŽ€
  • -mtune-ctrl=feature-list โ€” fine-grain control over x86 code generation features. feature-list is a comma separated list of feature names. See also -mdump-tune-features. When specified, the feature is turned on if it is not preceded with ^, otherwise it's turned off. Heads up though: -mtune-ctrl=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. ๐Ÿ˜ญ
for real, that one is devs-only, don't come for me.
  • -mno-default โ€” instructs GCC to turn off all tunable features. See also -mtune-ctrl=feature-list and -mdump-tune-features.
  • -mcld โ€” instructs GCC to emit a 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 --enable-cld configure option. Generation of cld instructions can be suppressed with the -mno-cld compiler option in this case. โœจ
  • -mvzeroupper โ€” instructs GCC to emit a 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 zeroupper intrinsics. ๐Ÿ’œ
  • -mprefer-avx128 โ€” instructs GCC to use 128-bit AVX instructions instead of 256-bit AVX instructions in the auto-vectorizer.
  • -mprefer-vector-width=opt โ€” instructs GCC to use opt-bit vector width in instructions instead of default on the selected platform.
  • -mpartial-vector-fp-math โ€” 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 -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 -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 -mdaz-ftz to set denormals-are-zero (DAZ) flag in the MXCSR register. ๐ŸŒธ

This option is enabled by default.

  • -mmove-max=bits โ€” instructs GCC to set the maximum number of bits can be moved from memory to memory efficiently to bits. The valid bits are 128, 256 and 512.
  • -mstore-max=bits โ€” instructs GCC to set the maximum number of bits can be stored to memory efficiently to bits. The valid bits are 128, 256 and 512.
  • none โ€” No extra limitations applied to GCC other than defined by the selected platform.
  • 128 โ€” Prefer 128-bit vector width for instructions.
  • 256 โ€” Prefer 256-bit vector width for instructions.
  • 512 โ€” Prefer 512-bit vector width for instructions.
  • -mnoreturn-no-callee-saved-registers โ€” optimizes functions with noreturn attribute or _Noreturn specifier by not saving in the function prologue callee-saved registers which are used in the function (except for the BP register). This option can interfere with debugging of the caller of the noreturn function or any function further up in the call stack, so it is not enabled by default. ๐Ÿซถ
  • -mcx16 โ€” enables GCC to generate 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 __sync Builtins. However, for __atomic Builtins operating on 128-bit integers, a library call is always used. ๐Ÿ’…
  • -msahf โ€” enables generation of 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 LAHF and SAHF instructions which are supported by AMD64. These are load and store instructions, respectively, for certain status flags. In 64-bit mode, the SAHF instruction is used to optimize fmod, drem, and remainder built-in functions; see Other Builtins for details. ๐ŸŽ€
  • -mmovbe โ€” enables use of the movbe instruction to optimize byte swapping of four and eight byte entities.
  • -mshstk โ€” the -mshstk option enables shadow stack built-in functions from x86 Control-flow Enforcement Technology (CET). ๐ŸŒˆ
  • -mcrc32 โ€” enables built-in functions __builtin_ia32_crc32qi, __builtin_ia32_crc32hi, __builtin_ia32_crc32si and __builtin_ia32_crc32di to generate the crc32 machine instruction.
  • -mmwait โ€” enables built-in functions __builtin_ia32_monitor, and __builtin_ia32_mwait to generate the monitor and mwait machine instructions.
  • -mrecip โ€” enables use of RCPSS and RSQRTSS instructions (and their vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step to increase precision instead of DIVSS and SQRTSS (and their vectorized variants) for single-precision floating-point arguments. These instructions are generated only when -funsafe-math-optimizations is enabled together with -ffinite-math-only and -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 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS) already with -ffast-math (or the above option combination), and doesn't need -mrecip.

Also note that GCC emits the above sequence with additional Newton-Raphson step for vectorized single-float division and vectorized sqrtf(x) already with -ffast-math (or the above option combination), and doesn't need -mrecip. ๐Ÿ’–

  • -mrecip=opt โ€” bestie, this one decides which reciprocal estimate instructions GCC is allowed to pull up. opt is a comma-separated list of options, and any of them can get a ! in front to flip it to the opposite. The menu:
    • all โ€” turn on every estimate instruction. all of them. the whole buffet ๐Ÿ’…
    • default โ€” just the default set, which is literally the same thing as plain -mrecip.
    • none โ€” shut them all off, which is exactly -mno-recip.
    • div โ€” enable the approximation for scalar division.
    • vec-div โ€” enable the approximation for vectorized division.
    • sqrt โ€” enable the approximation for scalar square root.
    • vec-sqrt โ€” enable the approximation for vectorized square root.

So like, for example, -mrecip=all,!sqrt turns on every reciprocal approximation except square root. iconic.

  • -mveclibabi=type โ€” tells GCC which ABI type to use when it vectorizes intrinsics using an external library. The supported values for type are svml (for the Intel short vector math library) and acml (for the AMD math core library). Heads up though: to actually use this option, both -ftree-vectorize and -funsafe-math-optimizations have to be enabled, and an SVML- or ACML-ABI-compatible library has to be specified at link time. no shortcuts bestie.

Right now GCC emits calls to vmldExp2, vmldLn2, vmldLog102, vmldPow2, vmldTanh2, vmldTan2, vmldAtan2, vmldAtanh2, vmldCbrt2, vmldSinh2, vmldSin2, vmldAsinh2, vmldAsin2, vmldCosh2, vmldCos2, vmldAcosh2, vmldAcos2, vmlsExp4, vmlsLn4, vmlsLog104, vmlsPow4, vmlsTanh4, vmlsTan4, vmlsAtan4, vmlsAtanh4, vmlsCbrt4, vmlsSinh4, vmlsSin4, vmlsAsinh4, vmlsAsin4, vmlsCosh4, vmlsCos4, vmlsAcosh4 and vmlsAcos4 for the corresponding function type when -mveclibabi=svml is used, and __vrd2_sin, __vrd2_cos, __vrd2_exp, __vrd2_log, __vrd2_log2, __vrd2_log10, __vrs4_sinf, __vrs4_cosf, __vrs4_expf, __vrs4_logf, __vrs4_log2f, __vrs4_log10f and __vrs4_powf for the corresponding function type when -mveclibabi=acml is used. yeah it's a lot. she's thorough. ๐Ÿ’œ

  • -mabi=name โ€” generates code for the calling convention you name. The permissible values are sysv (the ABI used on GNU/Linux and other systems) and ms (the Microsoft ABI). Default behavior: it uses the Microsoft ABI when targeting Microsoft Windows, and the SysV ABI on every other system. You can control this for specific functions by using the function attributes ms_abi and sysv_abi. cute, right?
  • -mforce-indirect-call โ€” forces all calls to functions to be indirect. This is useful when you're using Intel Processor Trace, because it generates more precise timing information for function calls. โญ
  • -mmanual-endbr โ€” inserts the ENDBR instruction at function entry only via the cf_check function attribute. This is useful when used with the option -fcf-protection=branch to control ENDBR insertion at the function entry.
  • -mcet-switch โ€” so 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 cause a direct loss of hardening. But โ€” and this is the tea โ€” 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 being reachable via any indirect jumps.
  • -mcall-ms2sysv-xlogues โ€” because of differences in 64-bit ABIs, any Microsoft ABI function that calls a System V ABI function has to treat RSI, RDI and XMM6-15 as clobbered. By default, the code for saving and restoring these registers is emitted inline, which gives you pretty lengthy prologues and epilogues. Using -mcall-ms2sysv-xlogues emits prologues and epilogues that use stubs in the static portion of libgcc to do these saves and restores, so function size goes down at the cost of a few extra instructions. trade-offs, bestie.
  • -mtls-dialect=type โ€” generate code to access thread-local storage using the gnu or gnu2 conventions. gnu is the conservative default; gnu2 is more efficient, but it may add compile- and run-time requirements that can't be satisfied on all systems. ๐ŸŒธ
  • -mpush-args โ€” use PUSH operations to store outgoing parameters. This method is shorter and usually equally fast as the method using SUB/MOV operations, and it's enabled by default.
  • -mno-push-args โ€” the off switch. In some cases disabling it may improve performance because of improved scheduling and reduced dependencies.
  • -maccumulate-outgoing-args โ€” if enabled, the maximum amount of space required for outgoing arguments gets 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 isn't equal to 2. The drawback? A notable increase in code size. Also this switch implies -mno-push-args.
  • -mthreads โ€” supports thread-safe exception handling on MinGW. Programs that rely on thread-safe exception handling must compile and link all code with the -mthreads option. When compiling, -mthreads defines -D_MT; when linking, it links in a special thread helper library -lmingwthrd which cleans up per-thread exception-handling data. ๐Ÿงš
  • -mms-bitfields โ€” enable bit-field layout compatible with the native Microsoft Windows compiler.
  • -mno-ms-bitfields โ€” disable it. ๐Ÿ™ˆ

If 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. Especially when you're 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 x86 Variable Attributes and x86 Type Attributes.

The Microsoft structure layout algorithm is pretty simple, except for the bit-field packing. The padding and alignment of members of structures, and whether a bit-field can straddle a storage-unit boundary, are determined by these rules:

  1. 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.
  2. 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 aligned attribute or the 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:
offset % alignment_requirement == 0
  1. 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.

MSVC interprets zero-length bit-fields in the following ways:

  1. If a zero-length bit-field is inserted between two bit-fields that are normally coalesced, the bit-fields are not coalesced.

For example:

struct
 {
   unsigned long bf_1 : 12;
   unsigned long : 0;
   unsigned long bf_2 : 12;
 } t1;

The size of t1 is 8 bytes with the zero-length bit-field. If the zero-length bit-field were removed, t1's size would be 4 bytes.

  1. If a zero-length bit-field is inserted after a bit-field, foo, and the alignment of the zero-length bit-field is greater than the member that follows it, bar, bar is aligned as the type of the zero-length bit-field.

For example:

struct
 {
   char foo : 4;
   short : 0;
   char bar;
 } t2;

struct
 {
   char foo : 4;
   short : 0;
   double bar;
 } t3;

For t2, bar is placed at offset 2, rather than offset 1. Accordingly, the size of t2 is 4. For t3, the zero-length bit-field does not affect the alignment of bar or, as a result, the size of the structure.

Taking this into account, it's important to note the following:

  1. 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 a whole. For example, t2 has a size of 4 bytes, since the zero-length bit-field follows a normal bit-field, and is of type short.
  2. Even if a zero-length bit-field is not followed by a normal bit-field, it may still affect the alignment of the structure:
struct
 {
   char foo : 6;
   long : 0;
 } t4;

Here, t4 takes up 4 bytes.

  1. Zero-length bit-fields following non-bit-field members are ignored:
struct
 {
   char foo;
   long : 0;
   char bar;
 } t5;

Here, t5 takes up 2 bytes.

  • -mno-align-stringops โ€” do not align the destination of inlined string operations. This switch reduces code size and improves performance in the case where the destination is already aligned, but GCC doesn't know about it. ๐Ÿ˜ญ sneaky.
  • -minline-all-stringops โ€” by default GCC inlines string operations only when the destination is known to be aligned to at least a 4-byte boundary. This option enables more inlining and increases code size, but may improve performance of code that depends on fast memcpy and memset for short lengths. The option enables inline expansion of strlen for all pointer alignments. ๐Ÿฆ‹
  • -minline-stringops-dynamically โ€” for string ops where we literally don't know the size ahead of time, this does a run-time check: inline code for the small blocks, and a library call for the big ones. best of both worlds bestie โœจ
  • -mstringop-strategy=alg โ€” overrides the internal decision heuristic for which algorithm gets used when inlining string operations. the allowed values for alg are, and yes we're listing all of them:
    • rep_byte, rep_4byte, rep_8byte โ€” expand using the i386 rep prefix of the specified size. slay ๐Ÿ’…
    • byte_loop, loop, unrolled_loop โ€” expand into an inline loop.
    • libcall โ€” always use a library call. no thoughts, just vibes, just the library.
  • -mmemcpy-strategy=strategy โ€” overrides the internal decision heuristic for whether __builtin_memcpy should be inlined, and which inline algorithm to use when the expected size of the copy is known. strategy is a comma-separated list of alg:max_size:dest_align triplets. alg is specified in -mstringop-strategy, and max_size specifies the max byte size that inline algorithm alg is allowed for. for the last triplet, max_size must be -1. the max_size of the triplets in the list must be specified in increasing order (chronological order bestie, we love a sorted list ๐Ÿ“ˆ). the minimal byte size for alg is 0 for the first triplet, and max_size + 1 of the preceding range.
  • -mmemset-strategy=strategy โ€” same energy as -mmemcpy-strategy=, except it's the one controlling __builtin_memset expansion. twins fr fr ๐Ÿซถ
  • -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. note that the option -fomit-leaf-frame-pointer removes the frame pointer for leaf functions, which might make debugging harder. so, iconic for speed, a lil cursed for debugging ๐Ÿ˜ญ
  • -mtls-direct-seg-refs / -mno-tls-direct-seg-refs โ€” controls whether TLS variables may be accessed with offsets from the TLS segment register (%gs for 32-bit, %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.

  • -msse2avx / -mno-sse2avx โ€” specify that the assembler should encode SSE instructions with VEX prefix. the option -mavx turns this on by default.
  • -mfentry / -mno-fentry โ€” if profiling is active (-pg), put the profiling counter call before the prologue. note: on x86 architectures the attribute ms_hook_prologue isn't possible at the moment for -mfentry and -pg. ๐Ÿ™ˆ
  • -mrecord-mcount / -mno-record-mcount โ€” if profiling is active (-pg), generate a __mcount_loc section that contains pointers to each profiling call. this is useful for automatically patching and out calls.
  • -mnop-mcount / -mno-nop-mcount โ€” if profiling is active (-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 -mrecord-mcount.
  • -minstrument-return=type โ€” instrument function exit in -pg -mfentry instrumented functions with a call to the specified function. this only instruments true returns ending with ret, but not sibling calls ending with jump. valid types are none to not instrument, call to generate a call to __return__, or nop5 to generate a 5 byte nop. periodt.
  • -mrecord-return / -mno-record-return โ€” generate a __return_loc section pointing to all return instrumentation code.
  • -mfentry-name=name โ€” set the name of the __fentry__ symbol called at function entry for -pg -mfentry functions.
  • -mfentry-section=name โ€” set the name of the section to record -mrecord-mcount calls (default __mcount_loc).
  • -mskip-rax-setup / -mno-skip-rax-setup โ€” when generating code for the x86-64 architecture with SSE extensions disabled, -mskip-rax-setup can be used to skip setting up the RAX register when there are no variable arguments passed in vector registers.
Warning: since the RAX register is used to avoid unnecessarily saving vector registers on the stack when passing variable arguments, the impacts of this option are that callees may waste some stack space, misbehave, or jump to a random location. ๐Ÿ˜ญ GCC 4.4 or newer don't have those issues, regardless of the RAX register value. so if you're on anything modern you're chillin ๐Ÿ’œ
  • -m8bit-idiv / -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 the 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. tiny numbers, tiny math, big speedup โœจ
  • -mavx256-split-unaligned-load / -mavx256-split-unaligned-store โ€” split 32-byte AVX unaligned load and store.
  • -mstack-protector-guard=guard / -mstack-protector-guard-reg=reg / -mstack-protector-guard-offset=offset โ€” generate stack protection code using a canary at guard. supported locations are global for global canary, or tls for per-thread canary in the TLS block (the default). this option has effect only when -fstack-protector or -fstack-protector-all is specified.

with the latter choice, the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which segment register (%fs or %gs) to use as the 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. ๐ŸŽ€

  • -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. minimalism era ๐Ÿ’…
  • -mrelax-cmpxchg-loop โ€” when emitting a compare-and-swap loop for __sync Builtins and __atomic Builtins lacking a native instruction, optimize for the highly contended case by issuing an atomic load before the CMPXCHG instruction, and using the PAUSE instruction to save CPU power when restarting the loop. so considerate of the CPU's energy tbh ๐Ÿ”‹
  • -mindirect-branch=choice โ€” convert indirect call and jump with choice. the default is keep, which keeps indirect call and jump unmodified. thunk converts indirect call and jump to call and return thunk. thunk-inline converts indirect call and jump to inlined call and return thunk. 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 indirect_branch.

note that -mcmodel=large is incompatible with -mindirect-branch=thunk and -mindirect-branch=thunk-extern since the thunk function may not be reachable in the large code model. ๐Ÿ’€

note that -mindirect-branch=thunk-extern is compatible with -fcf-protection=branch since the external thunk can be made to enable control-flow check.

  • -mfunction-return=choice โ€” convert function return with choice. the default is keep, which keeps function return unmodified. thunk converts function return to call and return thunk. thunk-inline converts function return to inlined call and return thunk. 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 function_return.

note that -mindirect-return=thunk-extern is compatible with -fcf-protection=branch since the external thunk can be made to enable control-flow check.

note that -mcmodel=large is incompatible with -mfunction-return=thunk and -mfunction-return=thunk-extern since the thunk function may not be reachable in the large code model.

  • -mindirect-branch-register โ€” force indirect call and jump via register. no detours, straight through the register ๐Ÿƒโ€โ™€๏ธ
  • -mharden-sls=choice โ€” generate code to mitigate against straight line speculation (SLS) with choice. the default is none, which disables all SLS hardening. return enables SLS hardening for function returns. indirect-jmp enables SLS hardening for indirect jumps. all enables all SLS hardening. go big or go home bestie ๐Ÿ‘‘
  • -mindirect-branch-cs-prefix โ€” add a 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, to allow them to be replaced with lfence; call *%r8-r15 or lfence; jmp *%r8-r15 at run-time. very specific, very iconic.
  • -mapx-inline-asm-use-gpr32 โ€” for inline asm support with APX, by default the EGPR feature was disabled to prevent potential illegal instruction with EGPR occurring. to invoke egpr usage in inline asm, use the new compiler option -mapx-inline-asm-use-gpr32 and the user should ensure the instruction supports EGPR. not me telling you to double check your own work ๐Ÿ™ˆ
  • -mevex512 / -mno-evex512 โ€” enables/disables 512-bit vector. it will be default on if AVX512F is enabled. ๐Ÿ’…

these -m switches are supported in addition to the above on x86-64 processors in 64-bit environments. okay so now we're in the 64-bit girlies section ๐ŸŒˆ

  • -m32, -m64, -mx32, -m16, -miamcu โ€” generate code for a 16-bit, 32-bit or 64-bit environment.

the -m32 option sets int, long, and pointer types to 32 bits, and generates code that runs in 32-bit mode.

the -m64 option sets int to 32 bits and long and pointer types to 64 bits, and generates code for the x86-64 architecture. for Darwin only, the -m64 option also turns off the -fno-pic and -mdynamic-no-pic options.

the -mx32 option sets int, long, and pointer types to 32 bits, and generates code for the x86-64 architecture.

the -m16 option is the same as -m32, except for that it outputs the .code16gcc assembly directive at the beginning of the assembly output so that the binary can run in 16-bit mode.

the -miamcu option generates code which conforms to Intel MCU psABI. it requires the -m32 option to be turned on. no -m32, no -miamcu, that's the rule ๐Ÿ“

  • -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 -mno-red-zone disables this red zone. (and yes it's called a red zone, it's giving danger but it's actually fine ๐Ÿšจ)
  • -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. small but mighty ๐Ÿ’–
  • -mcmodel=kernel โ€” okay so this one's for kernel code, bestie. The kernel lives in the negative 2 GB of the address space, and this model has to be used for Linux kernel code. No exceptions, it's giving very specific energy. ๐Ÿ‘‘
  • -mcmodel=medium โ€” the medium model! Your program gets linked in the lower 2 GB of the address space, and small symbols get placed there too. But symbols bigger than -mlarge-data-threshold? Those get yeeted into large data or BSS sections and can live above 2GB. Programs can be statically or dynamically linked, so flexible queen behavior fr fr. โœจ
  • -mcmodel=large โ€” the large model, the main character who trusts nobody. This one makes no assumptions about addresses and sizes of sections. Live your truth. ๐ŸŒˆ
  • -maddress-mode=long โ€” generates code for long address mode. Only supported for 64-bit and x32 environments, and it's the default address mode for 64-bit environments. Slay.
  • -maddress-mode=short โ€” generates code for short address mode. Only supported for 32-bit and x32 environments, and it's the default address mode for 32-bit and x32 environments. Matching set, we love to see it. ๐Ÿ’…
  • -mneeded, -mno-needed โ€” emit the GNU_PROPERTY_X86_ISA_1_NEEDED GNU property for Linux target, which tells everyone the micro-architecture ISA level required to actually execute the binary. It's like a little name tag for your executable. ๐ŸŽ€
  • -mno-direct-extern-access โ€” without -fpic nor -fPIC, always use the GOT pointer to access external symbols. With -fpic or -fPIC, treat access to protected symbols as local symbols. The default is -mdirect-extern-access.
โš ๏ธ Warning: shared libraries compiled with -mno-direct-extern-access and executable compiled with -mdirect-extern-access may not be binary compatible if protected symbols are used in shared libraries and executable. Not a vibe. Be careful. ๐Ÿ’€
  • -munroll-only-small-loops โ€” controls conservative small loop unrolling. It is default enabled by O2, and unrolls loop with less than 4 insns by 1 time. Explicit -f[no-]unroll-[all-]loops would disable this flag to avoid any unintended unrolling behavior that user does not want. Respecting your boundaries, honestly. ๐Ÿซถ
  • -mlam=choice โ€” LAM (linear-address masking) allows special bits in the pointer to be used for metadata. The default is none. With u48, pointer bits in positions 62:48 can be used for metadata; with u57, pointer bits in positions 62:57 can be used for metadata. Sneaky little metadata pockets, iconic.

๐ŸชŸ x86 Windows Options ๐ŸชŸ

These additional options are available for Microsoft Windows targets:

  • -mconsole โ€” specifies that a console application is to be generated, by instructing the linker to set the PE header subsystem type required for console applications. Available for Cygwin and MinGW targets, and it's enabled by default on those targets. Default behavior, we stan.
  • -mcrtdll=library โ€” preprocess, compile or link with the specified C RunTime DLL library. This option adjusts the predefined macros "__CRTDLL__", "__MSVCRT__", "_UCRT" and "__MSVCRT_VERSION__" for the specified CRT library, chooses the start file for the CRT library, and links with the CRT library. Recognized CRT library names for the preprocessor are: "crtdll*", "msvcrt10*", "msvcrt20*", "msvcrt40*", "msvcr40*", "msvcrtd*", "msvcrt-os*", "msvcr70*", "msvcr71*", "msvcr80*", "msvcr90*", "msvcr100*", "msvcr110*", "msvcr120*" and "ucrt*". If this option is not specified then the default MinGW import library "msvcrt" is used for linking and no other adjustment for the preprocessor is done. MinGW import library "msvcrt" is just a symlink to (or a copy of) another MinGW CRT import library chosen during MinGW compilation. MinGW import library "msvcrt-os" is for the Windows system CRT DLL library "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. Available for MinGW targets. It's giving "don't ship this to prod," bestie. ๐Ÿ™ˆ
  • -mdll โ€” 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. Dynamic queen. ๐Ÿ’ซ
  • -mnop-fun-dllimport โ€” available for Cygwin and MinGW targets. It specifies that the "dllimport" attribute should be ignored. Not me pretending that attribute doesn't exist.
  • -mthreads โ€” available for MinGW targets. It specifies that MinGW-specific thread support is to be used. Threads but make it MinGW. ๐Ÿงต
  • -municode โ€” available for MinGW-w64 targets. It causes the "UNICODE" preprocessor macro to be predefined, and chooses Unicode-capable runtime startup code. Unicode rights, as it should be. ๐ŸŒ
  • -mwin32 โ€” 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. Macros only, she's just here for the preprocessor drama.
  • -mwindows โ€” 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. Windows with actual windows, lowkey meta. ๐ŸชŸโœจ
  • -fno-set-stack-executable โ€” 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. No API, no flag, no problem.
  • -fwritable-relocated-rdata โ€” available for MinGW and Cygwin targets. It specifies that relocated-data in read-only section is put into the ".data" section. This is necessary for older runtimes not supporting modification of ".rdata" sections for pseudo-relocation. Grandmacore runtimes get accommodations too. ๐ŸŽ€
  • -mpe-aligned-commons โ€” 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. Auto-detected and auto-enabled, she's self-sufficient.

See also under x86 Options for standard options.


๐ŸŒฉ๏ธ Xstormy16 Options ๐ŸŒฉ๏ธ

These options are defined for Xstormy16:

  • -msim โ€” choose startup files and linker script suitable for the simulator. Simulator mode, we go virtual. ๐ŸŽฎ

๐Ÿฆ‹ Xtensa Options ๐Ÿฆ‹

These options are supported for Xtensa targets:

  • -mconst16, -mno-const16 โ€” enable or disable use of "CONST16" instructions for loading constant values. The "CONST16" instruction is currently not a standard option from Tensilica. When enabled, "CONST16" instructions are always used in place of the standard "L32R" instructions. The use of "CONST16" is enabled by default only if the "L32R" instruction is not available. Conditional defaults, we love a plot twist.
  • -mfused-madd, -mno-fused-madd โ€” enable or disable use of fused multiply/add and multiply/subtract instructions in the floating-point option. This has no effect if the floating-point option is not also enabled. Disabling fused multiply/add and multiply/subtract instructions forces the compiler to use separate instructions for the multiply and add/subtract operations. This may be desirable in some cases where strict IEEE 754-compliant results are required: the fused multiply add/subtract instructions do not round the intermediate result, thereby producing results with more bits of precision than specified by the IEEE standard. Disabling fused multiply add/subtract instructions also ensures that the program output is not sensitive to the compiler's ability to combine multiply and add/subtract operations. Precision girlies, this one's for you. ๐Ÿ”ฌ
  • -mserialize-volatile, -mno-serialize-volatile โ€” when this option is enabled, GCC inserts "MEMW" instructions before "volatile" memory references to guarantee sequential consistency. The default is -mserialize-volatile. Use -mno-serialize-volatile to omit the "MEMW" instructions. Ordering, but make it enforced. ๐Ÿ’…
  • -mforce-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. Kernel privileges only, sorry bestie. ๐Ÿšซ
  • -mtext-section-literals, -mno-text-section-literals โ€” these options control the treatment of literal pools. The default is -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 -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. Keeping your constants close, emotionally available literals. ๐Ÿซ‚
  • -mauto-litpools, -mno-auto-litpools โ€” these options control the treatment of literal pools. The default is -mno-auto-litpools, which places literals in a separate section in the output file unless -mtext-section-literals is used. With -mauto-litpools the literals are interspersed in the text section by the assembler. Compiler does not produce explicit ".literal" directives and loads literals into registers with "MOVI" instructions instead of "L32R" to let the assembler do relaxation and place literals as necessary. This option allows the assembler to create several literal pools per function and assemble very big functions, which may not be possible with -mtext-section-literals. Big function energy, the assembler handles it. ๐Ÿ”ฅ
  • -mtarget-align, -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 -mtarget-align. These options do not affect the treatment of auto-aligned instructions like "LOOP", which the assembler always aligns, either by widening density instructions or by inserting NOP instructions. "LOOP" does what it wants, always has. ๐Ÿ’โ€โ™€๏ธ
  • -mlongcalls, -mno-longcalls โ€” okay so when this is on, GCC tells the assembler "bestie, pls translate direct calls into indirect ones" โ€” but only if it can't figure out that the target of a direct call is inside the range the call instruction allows. This translation typically kicks in for calls to functions in other source files. Specifically: the assembler turns a direct CALL instruction into an L32R followed by a CALLX. The default is -mno-longcalls. Use this in programs where the call target could potentially be out of range. โœจ
Heads up: this option is implemented in the assembler, NOT the compiler โ€” so the assembly code GCC generates still shows direct call instructions. Look at the disassembled object code to see the actual instructions. Also note the assembler uses an indirect call for every cross-file call, not just the ones that really are out of range. no cap ๐Ÿ˜ญ
  • -mabi=name โ€” generate code for the specified ABI. The permissible values are: call0, windowed. The default ABI is chosen by the Xtensa core configuration. ๐ŸŽ€
  • -mabi=call0 โ€” with this on, function parameters get passed in registers a2 through a7, registers a12 through a15 are caller-saved, and register a15 may be used as a frame pointer. When this version of the ABI is enabled, the C preprocessor symbol __XTENSA_CALL0_ABI__ gets defined. slay ๐Ÿ’…
  • -mabi=windowed โ€” with this on, function parameters get passed in registers a10 through a15, and the called function rotates the register window by 8 registers on entry so its arguments are found in registers a2 through a7. Register a7 may be used as a frame pointer. The register window is rotated 8 registers back upon return. When this version of the ABI is enabled, the C preprocessor symbol __XTENSA_WINDOWED_ABI__ gets defined. ๐Ÿฆ‹
  • -mextra-l32r-costs=n โ€” specify an extra cost of instruction RAM/ROM access for L32R instructions, measured in clock cycles. When optimizing for speed, this affects whether loading a constant from the literal pool using L32R or synthesizing the constant from a small one with a couple of arithmetic instructions. The default value is 0. โญ
  • -mstrict-align, -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 -mno-strict-align for cores that support both unaligned loads and stores in hardware, and -mstrict-align for all other cores. ๐ŸŒธ

๐Ÿงš zSeries Options ๐Ÿงš

These are listed under

๐ŸŒˆ ENVIRONMENT ๐ŸŒˆ

okay bestie, this part is the whole vibe check for how GCC behaves before it even looks at your flags ๐Ÿ’…. There's a bunch of environment variables that change how GCC operates โ€” some of them work by handing it directories or prefixes to search when it's hunting for files, and some just... set the whole compilation environment differently. โœจ

And before you get any ideas: you can also tell GCC where to search using options like -B, -I and -L. Those take precedence over places specified using environment variables, which in turn take precedence over those specified by the configuration of GCC. So the priority chain is literally options > env vars > whatever GCC was built with. no cap. ๐Ÿ‘‘


๐Ÿ’– LANG, LC_CTYPE, LC_MESSAGES, LC_ALL

These environment variables control the way that GCC uses localization information, which allows GCC to work with different national conventions. GCC inspects the locale categories LC_CTYPE and 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 en_GB.UTF-8 for English in the United Kingdom encoded in UTF-8. ๐Ÿฆ‹

The LC_CTYPE environment variable specifies character classification. GCC uses it to determine the character boundaries in a string; this is needed for some multibyte encodings that contain quote and escape characters that are otherwise interpreted as a string end or escape. it's giving "please don't chop my string in the wrong place" ๐Ÿ˜ญ

The LC_MESSAGES environment variable specifies the language to use in diagnostic messages. (yes, your compiler errors can speak French. iconic.)

If the LC_ALL environment variable is set, it overrides the value of LC_CTYPE and LC_MESSAGES; otherwise, LC_CTYPE and LC_MESSAGES default to the value of the LANG environment variable. If none of these variables are set, GCC defaults to traditional C English behavior. ๐Ÿ‡ฌ๐Ÿ‡ง


๐ŸŽ€ TMPDIR

If 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. so it's the group chat between compilation stages fr fr ๐Ÿ’ฌ


โœจ GCC_COMPARE_DEBUG

Setting GCC_COMPARE_DEBUG is nearly equivalent to passing -fcompare-debug to the compiler driver. See the documentation of this option for more details. (nearly, bestie, nearly โ€” go read the option docs.) ๐Ÿ™ˆ


๐Ÿ‘‘ GCC_EXEC_PREFIX

If 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 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 GCC_EXEC_PREFIX is prefix/lib/gcc/ where prefix is the prefix to the installed compiler. In many cases prefix is the value of "prefix" when you ran the configure script.

Other prefixes specified with -B take precedence over this prefix.

This prefix is also used for finding files such as 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 /usr/local/lib/gcc (more precisely, with the value of GCC_INCLUDE_DIR), GCC tries replacing that beginning with the specified prefix to produce an alternate directory name. Thus, with -Bfoo/, GCC searches foo/bar just before it searches the standard directory /usr/local/lib/bar. If a standard directory begins with the configured prefix then the value of prefix is replaced by GCC_EXEC_PREFIX when looking for header files. ๐ŸŒธ


๐Ÿฆ‹ COMPILER_PATH

The value of COMPILER_PATH is a colon-separated list of directories, much like PATH. GCC tries the directories thus specified when searching for subprograms, if it cannot find the subprograms using GCC_EXEC_PREFIX.


๐Ÿ’œ LIBRARY_PATH

The value of LIBRARY_PATH is a colon-separated list of directories, much like 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 GCC_EXEC_PREFIX. Linking using GCC also uses these directories when searching for ordinary libraries for the -l option (but directories specified with -L come first). ๐Ÿ“


๐ŸŒŸ LANG (yes, again โ€” she does double duty)

This variable is used to pass locale information to the compiler. One way in which this information is used is to determine the character set to be used when character literals, string literals and comments are parsed in C and C++. When the compiler is configured to allow multibyte characters, the following values for LANG are recognized:

C-JIS

Recognize JIS characters.

C-SJIS

Recognize SJIS characters.

C-EUCJP

Recognize EUCJP characters.

If LANG is not defined, or if it has some other value, then the compiler uses "mblen" and "mbtowc" as defined by the default locale to recognize and translate multibyte characters. ๐Ÿงš


๐Ÿ”ฅ GCC_EXTRA_DIAGNOSTIC_OUTPUT

If 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. -fdiagnostics-parseable-fixits and -fno-diagnostics-parseable-fixits take precedence over this environment variable. ๐Ÿ’…

fixits-v1

Emit parseable fix-it hints, equivalent to -fdiagnostics-parseable-fixits. In particular, columns are expressed as a count of bytes, starting at byte 1 for the initial column.

fixits-v2

As "fixits-v1", but columns are expressed as display columns, as per -fdiagnostics-column-unit=display.


Some additional environment variables affect the behavior of the preprocessor. ๐Ÿ‘€

๐ŸŽ€ CPATH, C_INCLUDE_PATH, CPLUS_INCLUDE_PATH, OBJC_INCLUDE_PATH

Each variable's value is a list of directories separated by a special character, much like PATH, in which to look for header files. The special character, "PATH_SEPARATOR", is target-dependent and determined at GCC build time. For Microsoft Windows-based targets it is a semicolon, and for almost all other targets it is a colon.

CPATH specifies a list of directories to be searched as if specified with -I, but after any paths given with -I options on the command line. This environment variable is used regardless of which language is being preprocessed.

The remaining environment variables apply only when preprocessing the particular language indicated. Each specifies a list of directories to be searched as if specified with -isystem, but after any paths given with -isystem options on the command line.

In all these variables, an empty element instructs the compiler to search its current working directory. Empty elements can appear at the beginning or end of a path. For instance, if the value of CPATH is ":/special/include", that has the same effect as

-I. -I/special/include

๐Ÿ’– DEPENDENCIES_OUTPUT

If this variable is set, its value specifies how to output dependencies for Make based on the non-system header files processed by the compiler. System header files are ignored in the dependency output.

The value of DEPENDENCIES_OUTPUT can be just a file name, in which case the Make rules are written to that file, guessing the target name from the source file name. Or the value can have the form file target, in which case the rules are written to file file using target as the target name.

In other words, this environment variable is equivalent to combining the options -MM and -MF, with an optional -MT switch too. slay, one env var doing the job of three flags. โœจ

๐ŸŒธ SUNPRO_DEPENDENCIES

This variable is the same as DEPENDENCIES_OUTPUT (see above), except that system header files are not ignored, so it implies -M rather than -MM. However, the dependence on the main input file is omitted. ๐Ÿ™ˆ

๐Ÿฆ‹ SOURCE_DATE_EPOCH

If this variable is set, its value specifies a UNIX timestamp to be used in replacement of the current date and time in the "__DATE__" and "__TIME__" macros, so that the embedded timestamps become reproducible. (reproducible builds girlies, this one's for you ๐Ÿซถ)

The value of SOURCE_DATE_EPOCH must be a UNIX timestamp, defined as the number of seconds (excluding leap seconds) since 01 Jan 1970 00:00:00 represented in ASCII; identical to the output of "date +%s" on GNU/Linux and other systems that support the %s extension in the "date" command.

The value should be a known timestamp such as the last modification time of the source or package and it should be set by the build process.


๐Ÿ’€ BUGS ๐Ÿ’€

For instructions on reporting bugs, see <http://bugzilla.redhat.com/bugzilla>. go tell them everything bestie, they wanna know. ๐Ÿ›


๐Ÿ“ FOOTNOTES ๐Ÿ“

  1. On some systems, gcc -shared needs to build supplementary stub code for constructors to work. On multi-libbed systems, 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. -shared suppresses the addition of startup code to alter the floating-point environment as done with -ffast-math, -Ofast or -funsafe-math-optimizations on some targets. ๐Ÿ˜ญ subtle defects are the WORST kind, do not skip the flags.

๐Ÿ‘€ SEE ALSO ๐Ÿ‘€

gpl(7), gfdl(7), fsf-funding(7), cpp(1), gcov(1), as(1), ld(1), gdb(1) and the Info entries for gcc, cpp, as, ld, binutils and gdb. the whole friend group, honestly. ๐Ÿซถ


๐ŸŒŸ AUTHOR ๐ŸŒŸ

See the Info entry for gcc, or <https://gcc.gnu.org/onlinedocs/gcc/Contributors.html>, for contributors to GCC. (yes, an entire crowd of people. main character energy, collectively. ๐Ÿ‘‘)


Copyright (c) 1988-2024 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.

okay that's the WHOLE page bestie, we made it to the end ๐Ÿฅณ this one shipped as gcc-14, dated 2026-07-24, and it's the GCC(1) man page itself. go forth, compile something iconic, and remember: read the docs, respect the precedence order, and hydrate. ๐Ÿ’–โœจ๐ŸŽ€๐Ÿฆ‹๐ŸŒธ๐Ÿ’…๐Ÿซถ

๐Ÿ“ฆ where this page comes from
  • fedora 43: gcc14-c++ 14.4.1-2.fc43 ยท GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND curl
  • ๐Ÿ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms