GCC(1)

GCC(1) โ€” GNU project C and C++ compiler โœจ๐Ÿ’…


๐Ÿ’– NAME ๐Ÿ’–

gcc โ€” GNU project C and C++ compiler, bestie! ๐Ÿซถ


๐Ÿฆ‹ SYNOPSIS ๐Ÿฆ‹

gcc [-c|-S|-E] [-std=standard]
    [-g] [-pg] [-Olevel]
    [-Wwarn...] [-Wpedantic]
    [-Idir...] [-Ldir...]
    [-Dmacro[=defn]...] [-Umacro]
    [-foption...] [-mmachine-option...]
    [-o outfile] [@file] infile...

Only the most useful options are listed here; see below for the remainder. g++ accepts mostly the same options as gcc. ๐Ÿ’–


๐ŸŒธ DESCRIPTION ๐ŸŒธ

When you invoke GCC, it normally does preprocessing, compilation, assembly and linking. The "overall options" allow you to stop this process at an intermediate stage. For example, the -c option says not to run the linker. Then the output consists of object files output by the assembler. ๐ŸŽ€

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. ๐Ÿ’…

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

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

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

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

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

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. ๐Ÿงš


๐Ÿ‘‘ OPTIONS ๐Ÿ‘‘

โœจ Option Summary โœจ

Here is a summary of all the options, grouped by type. Explanations are in the following sections. ๐Ÿ’–

๐ŸŽ€ 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
  • -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
  • --assemble
  • --compile
  • --dumpbase dumpbase
  • --dumpbase-ext auxdropsuf
  • --dumpdir dumppfx
  • --language=language
  • --output=file
  • --pass-exit-codes
  • --pipe
  • --preprocess
  • --verbose

๐ŸŒˆ 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
  • -fpermitted-flt-eval-methods=standard
  • -fplan9-extensions
  • -fsigned-bitfields
  • -funsigned-bitfields
  • -fsigned-char
  • -funsigned-char
  • -fstrict-flex-arrays[=n]
  • -fsso-struct=endianness
  • --ansi

๐Ÿ’œ C++ Language Options ๐Ÿ’œ

  • --compile-std-module
  • -fabi-compat-version=n
  • -fabi-version=n
  • -fno-access-control
  • -faligned-new=[n]
  • -fno-assume-sane-operators-new-delete
  • -fchar8_t
  • -fcheck-new
  • -fconcepts
  • -fconcepts-diagnostics-depth=n
  • -fconstexpr-depth=n
  • -fconstexpr-cache-depth=n
  • -fconstexpr-loop-limit=n
  • -fconstexpr-ops-limit=n
  • -fcontracts
  • -fcontract-evaluation-semantic=[ignore|observe|enforce|quick_enforce]
  • -fcontracts-conservative-ipa
  • -fcontract-checks-outlined
  • -fcontract-disable-optimized-checks
  • -fcontracts-client-check=[none|pre|all]
  • -fcontracts-definition-check=[on|off]
  • -fcoroutines
  • -fdiagnostics-all-candidates
  • -fno-elide-constructors
  • -fno-enforce-eh-specs
  • -fext-numeric-literals
  • -fno-gnu-keywords
  • -fno-immediate-escalation
  • -fno-implement-inlines
  • -fimplicit-constexpr
  • -fno-implicit-inline-templates
  • -fno-implicit-templates
  • -fmodule-header[=kind]
  • -fmodule-implicit-inline
  • -fno-module-lazy
  • -fmodule-mapper=specification
  • -fmodule-only
  • -fmodules
  • -fms-extensions
  • -fnew-inheriting-ctors
  • -fnew-ttp-matching
  • -fno-nonansi-builtins
  • -fnothrow-opt
  • -fno-operator-names
  • -fno-optional-diags
  • -fno-pretty-templates
  • -frange-for-ext-temps
  • -freflection
  • -fno-rtti
  • -fsized-deallocation
  • -fstrict-enums
  • -fstrong-eval-order[=kind]
  • -ftemplate-backtrace-limit=n
  • -ftemplate-depth=n
  • -fno-threadsafe-statics
  • -fuse-cxa-atexit
  • -fno-use-cxa-get-exception-ptr
  • -fno-weak
  • -nostdinc++
  • -fvisibility-inlines-hidden
  • -fvisibility-ms-compat
  • -flang-info-include-translate[=header]
  • -flang-info-include-translate-not
  • -flang-info-module-cmi[=module]
  • -stdlib=libstdc++,libc++
  • -Wabbreviated-auto-in-template-arg
  • -Wabi-tag
  • -Waligned-new[=kind]
  • -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-defaulted-function-deleted
  • -Wno-delete-incomplete
  • -Wdelete-non-virtual-dtor
  • -Wno-deprecated-array-compare
  • -Wdeprecated-copy
  • -Wdeprecated-copy-dtor
  • -Wno-deprecated-enum-enum-conversion
  • -Wno-deprecated-enum-float-conversion
  • -Wno-deprecated-literal-operator
  • -Wdeprecated-variadic-comma-omission
  • -Weffc++
  • -Wno-elaborated-enum-base
  • -Wno-exceptions
  • -Wno-expose-global-module-tu-local
  • -Wno-external-tu-local
  • -Wextra-semi
  • -Wno-global-module
  • -Wno-inaccessible-base
  • -Wno-inherited-variadic-ctor
  • -Wno-init-list-lifetime
  • -Winvalid-constexpr
  • -Winvalid-imported-macros
  • -Wno-invalid-offsetof
  • -Wno-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
  • -Wno-sfinae-incomplete
  • -Wstrict-null-sentinel
  • -Wno-subobject-linkage
  • -Wtemplates
  • -Wno-non-c-typedef-for-linkage
  • -Wno-non-template-friend
  • -Wold-style-cast
  • -Woverloaded-virtual
  • -Wno-pmf-conversions
  • -Wself-move
  • -Wsign-promo
  • -Wsized-deallocation
  • -Wsuggest-final-methods
  • -Wsuggest-final-types
  • -Wsuggest-override
  • -Wno-template-body
  • -Wno-template-id-cdtor
  • -Wtemplate-names-tu-local
  • -Wno-terminate
  • -Wno-vexing-parse
  • -Wvirtual-inheritance
  • -Wno-virtual-move-assign
  • -Wvolatile

๐Ÿฆ‹ 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

๐Ÿ’– OpenMP and OpenACC Options ๐Ÿ’–

  • -foffload=arg
  • -foffload-options=arg
  • -fopenacc
  • -fopenacc-dim=geom
  • -fopenmp
  • -fopenmp-simd
  • -fopenmp-target-simd-clone[=device-type]

๐ŸŒŸ 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]
  • -fdiagnostics-add-output=DIAGNOSTICS-OUTPUT-SPEC
  • -fdiagnostics-set-output=DIAGNOSTICS-OUTPUT-SPEC
  • -fno-diagnostics-json-formatting
  • -fno-diagnostics-show-option
  • -fno-diagnostics-show-caret
  • -fno-diagnostics-show-event-links
  • -fno-diagnostics-show-labels
  • -fno-diagnostics-show-line-numbers
  • -fno-diagnostics-show-cwe
  • -fno-diagnostics-show-rules
  • -fno-diagnostics-show-highlight-colors
  • -fno-diagnostics-show-nesting
  • -fno-diagnostics-show-nesting-locations
  • -fdiagnostics-show-nesting-levels
  • -fdiagnostics-minimum-margin-width=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]
  • -fdiagnostics-show-context[=depth]

โœจ Warning Options โœจ

okay bestie, welcome to the โœจ main event โœจ. this is the list of every single warning-ish flag this compiler will take, and yes, we're doing all of them, no skips, no shortcuts, no "and the rest" because that's not how we do things here. ๐Ÿ’…

a couple of these are not even -W flags, they're plain -f flags or -p/-- long options, and some of them are the -Wno- versions (the "bestie please stop yelling at me" variants). we're listing every one exactly as it is. periodt.

  • -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
  • -Wauto-profile
  • -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
  • -Wc23-c2y-compat
  • -Wc++-compat
  • -Wc++11-compat
  • -Wc++14-compat
  • -Wc++17-compat
  • -Wc++20-compat
  • -Wc++26-compat
  • -Wno-c++11-extensions
  • -Wno-c++14-extensions
  • -Wno-c++17-extensions
  • -Wno-c++20-extensions
  • -Wno-c++23-extensions
  • -Wcalloc-transposed-args
  • -Wcannot-profile
  • -Wcast-align
  • -Wcast-align=strict
  • -Wcast-function-type
  • -Wcast-qual
  • -Wchar-subscripts
  • -Wclobbered
  • -Wcomment
  • -Wcompare-distinct-pointer-types
  • -Wno-complain-wrong-lang
  • -Wconversion
  • -Wno-coverage-mismatch
  • -Wno-cpp
  • -Wdangling-else
  • -Wdangling-pointer
  • -Wdangling-pointer=n
  • -Wdate-time
  • -Wno-deprecated
  • -Wno-deprecated-declarations
  • -Wno-designated-init
  • -Wno-deprecated-openmp
  • -Wdisabled-optimization
  • -Wno-discarded-array-qualifiers
  • -Wno-discarded-qualifiers
  • -Wno-div-by-zero
  • -Wdouble-promotion
  • -Wduplicated-branches
  • -Wduplicated-cond
  • -Wempty-body
  • -Wno-endif-labels
  • -Wenum-compare
  • -Wenum-conversion
  • -Wenum-int-mismatch
  • -Werror
  • -Werror=*
  • -Wexpansion-to-defined
  • -Wfatal-errors
  • -Wflex-array-member-not-at-end
  • -Wfloat-conversion
  • -Wfloat-equal
  • -Wformat
  • -Wformat=2
  • -Wno-format-contains-nul
  • -Wno-format-diag
  • -Wno-format-extra-args
  • -Wformat-nonliteral
  • -Wformat-overflow=n
  • -Wformat-security
  • -Wformat-signedness
  • -Wformat-truncation=n
  • -Wformat-y2k
  • -Wframe-address
  • -Wframe-larger-than=byte-size
  • -Wno-free-nonheap-object
  • -Wheader-guard
  • -Wno-if-not-aligned
  • -Wno-ignored-attributes
  • -Wignored-qualifiers
  • -Wno-incompatible-pointer-types
  • -Whardened
  • -Wimplicit
  • -Wimplicit-fallthrough
  • -Wimplicit-fallthrough=n
  • -Wno-implicit-function-declaration
  • -Wno-implicit-int
  • -Winfinite-recursion
  • -Winit-self
  • -Winline
  • -Wno-int-conversion
  • -Wint-in-bool-context
  • -Wno-int-to-pointer-cast
  • -Wno-invalid-memory-model
  • -Winvalid-pch
  • -Winvalid-utf8
  • -Wno-unicode
  • -Wjump-misses-init
  • -Wkeyword-macro
  • -Wlarger-than=byte-size
  • -Wleading-whitespace=kind
  • -Wlogical-not-parentheses
  • -Wlogical-op
  • -Wlong-long
  • -Wno-lto-type-mismatch
  • -Wmain
  • -Wmaybe-uninitialized
  • -Wmemset-elt-size
  • -Wmemset-transposed-args
  • -Wmisleading-indentation
  • -Wmissing-attributes
  • -Wmissing-braces
  • -Wmissing-field-initializers
  • -Wmissing-format-attribute
  • -Wmissing-include-dirs
  • -Wmissing-noreturn
  • -Wmusttail-local-addr
  • -Wmaybe-musttail-local-addr
  • -Wno-missing-profile
  • -Wno-multichar
  • -Wmultistatement-macros
  • -Wnonnull
  • -Wnonnull-compare
  • -Wnormalized=[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-pragma-once-outside-header
  • -Wno-prio-ctor-dtor
  • -Wno-psabi
  • -Wredundant-decls
  • -Wrestrict
  • -Wno-return-local-addr
  • -Wreturn-type
  • -Wno-scalar-storage-order
  • -Wsequence-point
  • -Wshadow
  • -Wshadow=global
  • -Wshadow=local
  • -Wshadow=compatible-local
  • -Wno-shadow-ivar
  • -Wno-shift-count-negative
  • -Wno-shift-count-overflow
  • -Wshift-negative-value
  • -Wno-shift-overflow
  • -Wshift-overflow=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=attribute-name
  • -Wswitch
  • -Wno-switch-bool
  • -Wswitch-default
  • -Wswitch-enum
  • -Wno-switch-outside-range
  • -Wno-switch-unreachable
  • -Wsync-nand
  • -Wsystem-headers
  • -Wtautological-compare
  • -Wtrailing-whitespace
  • -Wtrailing-whitespace=kind
  • -Wtrampolines
  • -Wtrigraphs
  • -Wtrivial-auto-var-init
  • -Wno-tsan
  • -Wtype-limits
  • -Wundef
  • -Wuninitialized
  • -Wunknown-pragmas
  • -Wunsuffixed-float-constants
  • -Wunterminated-string-initialization
  • -Wunused
  • -Wunused-but-set-parameter
  • -Wunused-but-set-parameter=n
  • -Wunused-but-set-variable
  • -Wunused-but-set-variable=n
  • -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-as-null-pointer-constant
  • -Wzero-length-bounds
  • --all-warnings
  • --extra-warnings
  • --no-warnings
  • --pedantic
  • --pedantic-errors

see? we got through it. together. ๐Ÿซถ


๐Ÿ” Static Analyzer Options

okay so the static analyzer is like that one friend who reads your texts six times and notices you said "k" instead of "okay" ๐Ÿ’€. here's its whole little toolkit, the -fanalyzer stuff, all the -fdump-analyzer-* debug dumps, and the entire fleet of -Wno-analyzer-* warnings. every single one, in order, untouched:

  • -fanalyzer
  • -fanalyzer-assume-nothrow
  • -fanalyzer-call-summaries
  • -fanalyzer-checker=name
  • -fno-analyzer-feasibility
  • -fanalyzer-show-events-in-system-headers
  • -fno-analyzer-state-merge
  • -fno-analyzer-state-purge
  • -fno-analyzer-suppress-followups
  • -fanalyzer-transitivity
  • -fno-analyzer-undo-inlining
  • -fanalyzer-verbose-edges
  • -fanalyzer-verbose-state-changes
  • -fanalyzer-verbosity=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
  • -Wno-analyzer-throw-of-unexpected-type
  • -Wanalyzer-symbol-too-complex
  • -Wanalyzer-too-complex
  • -Wno-analyzer-undefined-behavior-ptrdiff
  • -Wno-analyzer-undefined-behavior-strtok
  • -Wno-analyzer-unsafe-call-within-signal-handler
  • -Wno-analyzer-use-after-free
  • -Wno-analyzer-use-of-pointer-in-stale-stack-frame
  • -Wno-analyzer-use-of-uninitialized-value
  • -Wno-analyzer-va-arg-type-mismatch
  • -Wno-analyzer-va-list-exhausted
  • -Wno-analyzer-va-list-leak
  • -Wno-analyzer-va-list-use-after-va-end
  • -Wno-analyzer-write-to-const
  • -Wno-analyzer-write-to-string-literal
not me listing every single tainted-* warning. the analyzer is thorough, bestie, that's the whole point. ๐Ÿ˜Œ

๐Ÿงš C and Objective-C-only Warning Options

these ones only show up for the C girlies and the Objective-C girlies ๐ŸŽ€. if you're a C++ main character, this section is not for you. sorry not sorry. here they all are:

  • -Wbad-function-cast
  • -Wdeprecated-non-prototype
  • -Wfree-labels
  • -Wmissing-declarations
  • -Wmissing-parameter-name
  • -Wmissing-parameter-type
  • -Wdeclaration-missing-parameter-type
  • -Wmissing-prototypes
  • -Wmissing-variable-declarations
  • -Wmultiple-parameter-fwd-decl-lists
  • -Wnested-externs
  • -Wold-style-declaration
  • -Wold-style-definition
  • -Wstrict-prototypes
  • -Wtraditional
  • -Wtraditional-conversion
  • -Wdeclaration-after-statement
  • -Wpointer-sign

๐Ÿ› Debugging Options

and now the debug section!! ๐Ÿ’œ this is where you tell the compiler "bestie, keep the receipts" โ€” all the -g flavours, the dwarf options, the split-dwarf stuff, the debug-prefix remapping, the struct-debug emission controls, var tracking, and --debug at the end. every one, exactly as written:

  • -g
  • -glevel
  • -gdwarf
  • -gdwarf-version
  • -gbtf
  • -gctf
  • -gctflevel
  • -gno-prune-btf
  • -ggdb
  • -gno-record-gcc-switches
  • -gstrict-dwarf
  • -gas-loc-support
  • -gas-locview-support
  • -gcodeview
  • -gcolumn-info
  • -gdwarf32
  • -gdwarf64
  • -gno-statement-frontiers
  • -gno-variable-location-views
  • -gvariable-location-views=incompat5
  • -ginternal-reset-location-views
  • -ginline-points
  • -gvms
  • -gz[=type]
  • -gsplit-dwarf
  • -gdescribe-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
  • -fvar-tracking-uninit
  • --debug
notice how many of these start with -gno- or -fno-? yeah. the "no" girlies are thriving in this section. ๐Ÿ’…

okay bestie, buckle UP โ€” this is the master list of every optimization knob GCC ships with. It's giving cosmic horror to-do list, but we're gonna vibe through it together. ๐Ÿ’…

Every single flag below is real and untouched, okay? I'm just here to hype you up while you scroll. โœจ


โœจ Optimization Options โœจ

Part one: the classics, the alignment girlies, and the early passes. ๐ŸŽ€

-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-profile-inlining
-fauto-inc-dec  -fbranch-probabilities -fcaller-saves
-fcombine-stack-adjustments  -fconserve-stack -ffold-mem-offsets
-fcompare-elim  -fcprop-registers  -fcrossjumping -fcse-follow-jumps
-fcse-skip-blocks  -fcx-fortran-rules -fcx-limited-range -fcx-method
-fdata-sections  -fdce  -fdelayed-branch
-fdelete-null-pointer-checks  -fdep-fusion  -fdevirtualize
-fdevirtualize-speculatively  -fdevirtualize-at-ltrans  -fdse

the alignment flags take that =n[:m:[n2[:m2]]] sandwich syntax โ€” yes, four nested layers, no I will not explain why, it's giving onion ๐Ÿง…


Part two: inlining, IPA drama, and the register allocator being a whole diva. ๐Ÿฆ‹

-fearly-inlining  -fexcess-precision=style -fexpensive-optimizations
-fext-dce -ffast-math  -ffat-lto-objects  -ffinite-loops
-ffinite-math-only  -ffloat-store -fforward-propagate
-ffp-contract=style  -ffp-int-builtin-inexact -ffunction-sections
-ffuse-ops-with-volatile-access -fgcse  -fgcse-after-reload
-fgcse-las  -fgcse-lm  -fgraphite-identity -fgcse-sm
-fhoist-adjacent-loads  -fif-conversion -fif-conversion2
-findirect-inlining -finline-atomics  -finline-functions
-finline-functions-called-once -finline-limit=n
-finline-small-functions -finline-stringops[=fn] -fipa-modref
-fipa-cp  -fipa-cp-clone -fipa-bit-cp  -fipa-vrp  -fipa-pta
-fipa-profile  -fipa-pure-const -fipa-reference
-fipa-reference-addressable  -fipa-reorder-for-locality -fipa-sra
-fipa-stack-alignment -fipa-icf  -fipa-icf-functions
-fipa-icf-variables -fira-algorithm=algorithm
-flate-combine-instructions  -flifetime-dse  -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

so many -fipa-* flags โ€” interprocedural analysis said "I'm the main character" and honestly? correct. ๐Ÿ‘‘


Part three: LTO, scheduling, and every -fno- that ever said "actually, don't". ๐ŸŒธ

-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=n -flto-toplevel-asm-heuristics
-flto-partition=alg  -flto-incremental=path
-flto-incremental-cache-size=n  -fmalloc-dce  -fmerge-all-constants
-fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves
-fmove-loop-invariants  -fmove-loop-stores  -fno-branch-count-reg
-fno-defer-pop  -fno-function-cse -fno-guess-branch-probability
-fno-inline  -fno-math-errno  -fno-peephole -fno-peephole2
-fno-printf-return-value  -fno-sched-interblock -fno-sched-spec
-fno-signed-zeros -fno-toplevel-reorder  -fno-trapping-math
-fno-zero-initialized-in-bss -fomit-frame-pointer  -foptimize-crc
-foptimize-sibling-calls -fpartial-inlining  -fpeel-loops
-fpredictive-commoning -fprefetch-loop-arrays -fprofile-correction
-fprofile-use  -fprofile-use=path  -fprofile-partial-training
-fprofile-values  -fprofile-reorder-functions -freciprocal-math

-fprofile-use=path vs -fprofile-use โ€” the bare one is the vibe, the =path one is when you need to be specific. iykyk. ๐Ÿ’…


Part four: the finale, where -O levels make their grand entrance. ๐Ÿ‘‘

-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
-fspeculatively-call-stored-functions  -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-cselim  -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 -O  -O0  -O1  -O2  -O3
-Os  -Ofast  -Og  -Oz  --optimize

THE -O LEVELS AT THE END, HELLO ๐ŸŽ‰ -O, -O0, -O1, -O2, -O3, -Os, -Ofast, -Og, -Oz, and --optimize โ€” the whole squad, assembled. periodt. ๐Ÿ’–


๐ŸŽ€ Program Instrumentation Options ๐ŸŽ€

this section is for when you wanna spy on your own program โ€” coverage, profiling, sanitizers, and stack protection. It's giving "who's watching me" but make it a compiler. ๐Ÿ‘€

-p  -pg  -fprofile-arcs  -coverage  -ftest-coverage
-fcondition-coverage -fpath-coverage -fprofile  -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
-fcf-protection -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]
--coverage --profile

note the -fsanitize-recover=style and -fsanitize-trap=style forms โ€” those =style bits are where you plug in the sanitizer name. Don't skip the =. ๐Ÿ™ˆ

-fstrub=disable, -fstrub=strict, -fstrub=relaxed, -fstrub=all, -fstrub=at-calls, -fstrub=internal โ€” the whole strub family, all six of them. ๐ŸŒˆ


๐Ÿ’œ Preprocessor Options ๐Ÿ’œ

the before-the-compiler-even-starts zone โ€” macros, includes, charsets, and dependency files. this is where #include girlies live. ๐Ÿงš

-C  -CC  -Dmacro[=defn] -dD  -dI  -dM  -dN  -dU -fdebug-cpp
-fdirectives-only  -fdollars-in-identifiers -fexec-charset=charset
-fextended-identifiers -finput-charset=charset
-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 --comments  --comments-in-macros
--define-macro=macro[=defn] --dependencies  --dump=letters
--imacros=file  --include=file --no-integrated-cpp
--no-line-commands --print-missing-file-dependencies --traditional
--traditional-cpp  --trigraphs  --trace-includes
--undefine-macro=macro --user-dependencies  --write-dependencies
--write-user-dependencies

yes, -M through -MT is a whole little family โ€” dependency-generation flags, all vibes, all real. ๐Ÿ“


๐Ÿฆ‹ Assembler Options ๐Ÿฆ‹

short and sweet, as it should be. โœจ

-Wa,option  -Xassembler option --for-assembler=option

๐ŸŒธ Linker Options ๐ŸŒธ

linking is the final boss โ€” static, shared, PIE, and every -static-lib* you could ever want. ๐Ÿ’…

object-file-name  -flink-libatomic  -fuse-ld=linker  -llibrary
-nostartfiles  -nodefaultlibs  -nolibc  -nostdlib  -nostdlib++ -e
entry -pie  -pthread  -r  -rdynamic -s  -static  -static-pie
-static-libgcc  -static-libstdc++ -static-libasan  -static-libhwasan
-static-liblsan -static-libtsan  -static-libubsan -shared
-shared-libgcc  -symbolic -T script  -Wl,option  -Xlinker option -u
symbol -Tbss=addr  -Tdata=addr  -Ttext=addr -N  -n  -t  -Z  -z
keyword --entry=entry  --for-linker=option --force-link=symbol
--no-standard-library --pie  --static  --static-pie  --symbolic

that object-file-name at the top is a placeholder, not a flag โ€” it just means "you can also just... put an object file there." iconic. ๐Ÿ‘‘


๐ŸŽ€ Directory Options ๐ŸŽ€

where does GCC look for stuff? this section, bestie. ๐Ÿงš

-Bprefix  -Idir  -I- -idirafter dir -imacros file  -imultilib dir
-imultiarch dir -iplugindir=dir  -iprefix file -iquote dir
-isysroot dir  -isystem dir -iwithprefix dir  -iwithprefixbefore dir
-Ldir  -no-canonical-prefixes  --no-sysroot-suffix -nostdinc
-nostdinc++ --embed-dir=dir  --embed-directory=dir --include-barrier
--include-directory=dir --include-directory-after=dir
--include-prefix=prefix --include-with-prefix=prefix
--include-with-prefix-after=prefix
--include-with-prefix-before=prefix --no-canonical-prefixes
--no-standard-includes --prefix=prefix  --sysroot=dir

yes, -I- is a real flag โ€” dash capital-I dash. it's giving chaos but it's legal. ๐Ÿ’€


๐Ÿ’– Code Generation Options ๐Ÿ’–

the deep magic โ€” register conventions, PIC/PIE, struct returns, visibility, and all the -fwrapv / -ftrapv drama. ๐Ÿซถ

-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
-fwrapv-pointer -fvisibility=[default|internal|hidden|protected]
-fstrict-volatile-bitfields  -fsync-libcalls
-fzero-init-padding-bits=value -Qy  -Qn

reminder bestie: -fpic and -fPIC are NOT the same, and -fpie and -fPIE are NOT the same either. case matters, always has. ๐Ÿ”ฅ


and that's the whole index of option lists, done and dusted โ€” every flag accounted for, nothing dropped, nothing invented. more coming, don't go anywhere. ๐Ÿ’œ

๐Ÿ› ๏ธ Developer Options ๐Ÿ› ๏ธ

okay bestie, deep breath ๐Ÿ’– this is the toolbox drawer where the compiler devs keep their little spyglasses โ€” the stuff that makes GCC show you what it's thinking, or hand you a path, or dump a whole phase to disk. it's giving "backstage pass" energy. every single one is listed below, exactly as written, no cap. copy them character for character, they are syntax not vibes ๐Ÿ’…

  • -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-internal-locations
  • -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-autofdo-gcov-version
  • -print-file-name=library
  • -print-libgcc-file-name
  • -print-multi-directory
  • -print-multi-lib
  • -print-multi-os-directory
  • -print-multiarch
  • -print-prog-name=program
  • -print-search-dirs
  • -Q
  • -print-sysroot
  • -print-sysroot-headers-suffix
  • -save-temps
  • -save-temps=cwd
  • -save-temps=obj
  • -specs=file
  • -time[=file]
  • --dump=letters
  • --print-autofdo-gcov-version
  • --print-file-name=library
  • --print-libgcc-file-file-name
  • --print-multi-directory
  • --print-multi-lib
  • --print-multi-os-directory
  • --print-multiarch
  • --print-prog-name=program
  • --print-search-dirs
  • --print-sysroot
  • --print-sysroot-headers-suffix
  • --save-temps
  • --specs=file
  • --param name=value
ngl, notice how some of these come in both a one-dash and a two-dash flavor? both are here, both stay here, don't @ me ๐Ÿ˜Œ

๐ŸŒ Target-Specific Options ๐ŸŒ

bestie, this is where it gets personal. every chip family has its own lil menu of -m flags, and if you're cross-compiling for one of these, you're gonna live in that section. it's a whole buffet ๐Ÿ“ all the families are below, in order, with every option intact.

๐ŸŒธ AArch64 Options ๐ŸŒธ

(AArch64 Options)

  • -mabi=name
  • -mbig-endian
  • -mlittle-endian
  • -menable-sysreg-checking
  • -mgeneral-regs-only
  • -mcmodel=tiny
  • -mcmodel=small
  • -mcmodel=large
  • -mstrict-align
  • -momit-leaf-frame-pointer
  • -mtls-dialect=desc
  • -mtls-dialect=traditional
  • -mtls-size=size
  • -mtp=name
  • -mfix-cortex-a53-835769
  • -mfix-cortex-a53-843419
  • -mlow-precision-recip-sqrt
  • -mlow-precision-sqrt
  • -mlow-precision-div
  • -mmax-vectorization
  • -mautovec-preference=name
  • -mpc-relative-literal-loads
  • -msign-return-address=scope
  • -mbranch-protection=features
  • -mharden-sls=opts
  • -march=name
  • -mcpu=name
  • -mtune=name
  • -moverride=string
  • -mstack-protector-guard=guard
  • -mstack-protector-guard-reg=sysreg
  • -mstack-protector-guard-offset=offset
  • -mtrack-speculation
  • -moutline-atomics
  • -mearly-ra
  • -mearly-ldp-fusion
  • -mlate-ldp-fusion
  • -mnarrow-gp-writes
  • -msve-vector-bits=bits

๐Ÿฆ‹ Adapteva Epiphany Options ๐Ÿฆ‹

(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
  • -mmay-round-for-trunc
  • -mfp-iarith
  • -mvect-double
  • -max-vect-align=num
  • -msplit-vecmove-early
  • -m1reg-reg

๐Ÿ’œ AMD GCN Options ๐Ÿ’œ

(AMD GCN Options)

  • -march=gpu
  • -mtune=gpu
  • -mgang-private-size=bytes
  • -msram-ecc=[on|off|any]
  • -mxnack=[on|off|any]
  • -Wopenacc-dims

โœจ ARC Options โœจ

(ARC Options)

  • -mbarrel-shifter
  • -mjli-always
  • -mcpu=cpu
  • -mA6
  • -mARC600
  • -mA7
  • -mARC700
  • -mdpfp
  • -mdpfp-compact
  • -mdpfp-fast
  • -mno-dpfp-lrsr
  • -mea
  • -mmul32x16
  • -mmul64
  • -matomic
  • -mnorm
  • -mspfp
  • -mspfp-compact
  • -mspfp-fast
  • -msimd
  • -msoft-float
  • -mswap
  • -mlock
  • -mswape
  • -mxy
  • -misize
  • -marclinux
  • -marclinux_prof
  • -mlong-calls
  • -mmedium-calls
  • -msdata
  • -mirq-ctrl-saved
  • -mrgf-banked-regs
  • -mlpc-width=width
  • -G num
  • -mvolatile-cache
  • -mtp-regno=regno
  • -mbitops
  • -mcmem
  • -munaligned-access
  • -mauto-modify-reg
  • -mno-brcc
  • -mcase-vector-pcrel
  • -mno-cond-exec
  • -mearly-cbranchsi
  • -mindexed-loads
  • -mlra-priority-none
  • -mlra-priority-compact
  • -mlra-priority-noncompact
  • -mmillicode
  • -msize-level=level
  • -mtune=cpu
  • -mmultcost=num
  • -mcode-density-frame
  • -mmpy-option=multo
  • -mdiv-rem
  • -mcode-density
  • -mll64
  • -mfpu=fpu
  • -mrf16
  • -mbranch-index

๐ŸŽ€ ARM Options ๐ŸŽ€

(ARM Options)

  • -mapcs-frame
  • -mapcs
  • -mabi=name
  • -mgeneral-regs-only
  • -mno-sched-prolog
  • -mlittle-endian
  • -mbig-endian
  • -mbe8
  • -mbe32
  • -mfloat-abi=name
  • -mfp16-format=name
  • -mthumb-interwork
  • -mcpu=name
  • -march=name
  • -mfpu=name
  • -mtune=name
  • -mstructure-size-boundary=n
  • -mabort-on-noreturn
  • -mlong-calls
  • -msingle-pic-base
  • -mpic-register=reg
  • -mpic-data-is-text-relative
  • -mnop-fun-dllimport
  • -mpoke-function-name
  • -mthumb
  • -marm
  • -mtpcs-frame
  • -mtpcs-leaf-frame
  • -mcaller-super-interworking
  • -mcallee-super-interworking
  • -mtp=name
  • -mtls-dialect=dialect
  • -mword-relocations
  • -mfix-cortex-m3-ldrd
  • -mfix-cortex-a57-aes-1742098
  • -mfix-cortex-a72-aes-1655431
  • -munaligned-access
  • -mslow-flash-data
  • -masm-syntax-unified
  • -mrestrict-it
  • -mpure-code
  • -mcmse
  • -mfix-cmse-cve-2021-35465
  • -mstack-protector-guard=guard
  • -mstack-protector-guard-offset=offset
  • -mfdpic
  • -mbranch-protection=features
  • -mvectorize-with-neon-quad
  • -mvectorize-with-neon-double

๐ŸŒˆ AVR Options ๐ŸŒˆ

(AVR Options)

  • -mmcu=mcu
  • -mabsdata
  • -maccumulate-args
  • -mcvt
  • -mbranch-cost=cost
  • -mfuse-add=level
  • -mfuse-move=level
  • -mfuse-move2
  • -mcall-prologues
  • -mgas-isr-prologues
  • -mint8
  • -mflmap
  • -mdouble=bits
  • -mlong-double=bits
  • -mno-call-main
  • -mn_flash=size
  • -mfract-convert-truncate
  • -mno-interrupts
  • -mmain-is-OS_task
  • -mrelax
  • -mpmem-wrap-around
  • -mrmw
  • -mstrict-X
  • -mtiny-stack
  • -mrodata-in-ram
  • -msplit-bit-shift
  • -msplit-ldst
  • -mshort-calls
  • -mskip-bug
  • -muse-nonzero-bits
  • -nodevicelib
  • -nodevicespecs
  • -Waddr-space-convert
  • -Wmisspelled-isr

๐Ÿ’– Blackfin Options ๐Ÿ’–

(Blackfin Options)

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

โญ C6X Options โญ

(C6X Options)

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

๐Ÿงš CRIS Options ๐Ÿงš

(CRIS Options)

  • -mcpu=cpu
  • -march=cpu
  • -mtune=cpu
  • -mmax-stackframe=n
  • -metrax4
  • -metrax100
  • -mpdebug
  • -mcc-init
  • -mno-side-effects
  • -mstack-align
  • -mdata-align
  • -mconst-align
  • -m32-bit
  • -m16-bit
  • -m8-bit
  • -mno-prologue-epilogue
  • -mbest-lib-options
  • -moverride-best-lib-options
  • -mtrap-using-break8
  • -mtrap-unaligned-atomic
  • -munaligned-atomic-may-use-library
  • -sim
  • -sim2
  • -mmul-bug-workaround

๐Ÿซถ C-SKY Options ๐Ÿซถ

(C-SKY Options)

  • -march=arch
  • -mcpu=cpu
  • -mbig-endian
  • -mlittle-endian
  • -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
  • -msched-prolog
  • -msim

๐ŸŽ  Cygwin and MinGW Options ๐ŸŽ 

(Cygwin and MinGW Options)

  • -mconsole
  • -mcrtdll=library
  • -mdll
  • -mnop-fun-dllimport
  • -mthreads
  • -municode
  • -mwin32
  • -mwindows
  • -fno-set-stack-executable
  • -fwritable-relocated-rdata
  • -mpe-aligned-commons
  • -muse-libstdc-wrappers

๐Ÿ“ Darwin Options ๐Ÿ“

(Darwin Options)

  • -all_load
  • -allowable_client
  • -arch name
  • -arch_errors_fatal
  • -asm_macosx_version_min=version
  • -bind_at_load
  • -bundle
  • -bundle_loader
  • -client_name
  • -compatibility_version
  • -current_version
  • -dead_strip
  • -dependency-file
  • -dylib_file
  • -dylinker
  • -dylinker_install_name
  • -dynamic
  • -dynamiclib
  • -exported_symbols_list
  • -fapple-kext
  • -fconstant-cfstrings
  • -ffix-and-continue
  • -filelist
  • -findirect-data
  • -flat_namespace
  • -force_cpusubtype_ALL
  • -force_flat_namespace
  • -framework name
  • -gfull
  • -gused
  • -headerpad_max_install_names
  • -iframework
  • -image_base
  • -init symbol-name
  • -install_name
  • -keep_private_externs
  • -matt-stubs
  • -mconstant-cfstrings
  • -mdynamic-no-pic
  • -mfix-and-continue
  • -mkernel
  • -mmacosx-version-min=version
  • -mone-byte-bool
  • -msymbol-stubs
  • -mtarget-linker[=]version
  • -nodefaultexport
  • -nodefaultrpaths
  • -pagezero_size
  • -preload
  • -read_only_relocs
  • -sectalign
  • -sectcreate
  • -seg_addr_table
  • -seg1addr
  • -segaddr
  • -segprot
  • -segs_read_only_addr
  • -segs_read_write_addr
  • -sub_library
  • -sub_umbrella
  • -twolevel_namespace
  • -twolevel_namespace_hints
  • -umbrella
  • -undefined
  • -unexported_symbols_list
  • -weak_framework name
  • -weak_reference_mismatches
  • -whatsloaded
  • -whyload
  • -F
  • -ObjC
  • -ObjC++
  • -Wnonportable-cfstrings

๐ŸŒŸ DEC Alpha Options ๐ŸŒŸ

(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
  • -msafe-bwa
  • -msafe-partial
  • -mfloat-vax
  • -mfloat-ieee
  • -mexplicit-relocs
  • -msmall-data
  • -mlarge-data
  • -msmall-text
  • -mlarge-text
  • -mmemory-latency=time
  • -mtls-kernel
  • -mtls-size=bitsize
  • -mlong-double-128
  • -mlong-double-64

๐Ÿ”ฅ eBPF Options ๐Ÿ”ฅ

(eBPF Options)

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

๐ŸŒผ FR30 Options ๐ŸŒผ

(FR30 Options)

  • -msmall-model
  • -mno-lsim

๐Ÿ’ซ FRV Options ๐Ÿ’ซ

(FRV Options)

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

๐Ÿฆ„ FT32 Options ๐Ÿฆ„

(FT32 Options)

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

๐Ÿง GNU/Linux Options ๐Ÿง

(GNU/Linux Options)

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

๐Ÿ€ H8/300 Options ๐Ÿ€

(H8/300 Options)

  • -mrelax
  • -mh
  • -ms
  • -mn
  • -msx
  • -ms2600
  • -mquickcall
  • -mslowbyte
  • -mexr
  • -mint32
  • -malign-300

HPPA Options (HPPA Options) ๐Ÿ’…

okay bestie, HPPA time! here's the whole squad, no cap:

  • -march=architecture-type
  • -mno-atomic-libcalls
  • -mcaller-copies
  • -mdisable-fpregs
  • -mdisable-indexing
  • -mordered
  • -mfast-indirect-calls
  • -mgas
  • -mgnu-ld
  • -mhp-ld
  • -mfixed-range=register-range
  • -mcoherent-ldcw
  • -mlinker-opt
  • -mlong-calls
  • -mlong-load-store
  • -mno-space-regs
  • -msoft-float
  • -mpa-risc-1-0
  • -mpa-risc-1-1
  • -mpa-risc-2-0
  • -mportable-runtime
  • -mschedule=cpu-type
  • -msoft-mult
  • -msio
  • -mwsio
  • -munix=unix-std
  • -nolibdld
  • -static
  • -threads

IA-64 Options (IA-64 Options) โœจ

IA-64 besties, this list is giving main character energy fr fr:

  • -mbig-endian
  • -mlittle-endian
  • -mgnu-as
  • -mgnu-ld
  • -mno-pic
  • -mvolatile-asm-stop
  • -mregister-names
  • -msdata
  • -mconstant-gp
  • -mauto-pic
  • -minline-float-divide-min-latency
  • -minline-float-divide-max-throughput
  • -mno-inline-float-divide
  • -minline-int-divide-min-latency
  • -minline-int-divide-max-throughput
  • -mno-inline-int-divide
  • -minline-sqrt-min-latency
  • -minline-sqrt-max-throughput
  • -mno-inline-sqrt
  • -mdwarf2-asm
  • -mearly-stop-bits
  • -mfixed-range=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-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 (LM32 Options) ๐Ÿฆ‹

LM32 cuties, here's your moment:

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

LoongArch Options (LoongArch Options) ๐ŸŒธ

LoongArch besties, this list is iconic, periodt:

  • -march=arch-type
  • -mtune=tune-type
  • -mabi=base-abi-type
  • -mfpu=fpu-type
  • -msimd=simd-type
  • -msoft-float
  • -msingle-float
  • -mdouble-float
  • -mlsx
  • -mlasx
  • -mbranch-cost=n
  • -maddr-reg-reg-cost=n
  • -mcheck-zero-division
  • -mbreak-code=code
  • -mcond-move-int
  • -mcond-move-float
  • -memcpy
  • -mstrict-align
  • -G num
  • -mmax-inline-memcpy-size=n
  • -mexplicit-relocs=style
  • -mexplicit-relocs
  • -mno-explicit-relocs
  • -mdirect-extern-access
  • -mcmodel=code-model
  • -mrelax
  • -mpass-mrelax-to-as
  • -mrecip
  • -mrecip=opt
  • -mfrecipe
  • -mdiv32
  • -mlam-bh
  • -mlamcas
  • -mld-seq-sa
  • -mscq
  • -mtls-dialect=opt
  • -mannotate-tablejump

LynxOS Options (LynxOS Options) ๐ŸŽ€

LynxOS besties, short and sweet:

  • -mshared
  • -mthreads
  • -mlegacy-threads

M32C Options (M32C Options) ๐Ÿ’–

M32C girlies, here you go:

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

M32R/D Options (M32R/D Options) โœจ

M32R/D squad, this is your vibe check:

  • -m32r2
  • -m32rx
  • -m32r
  • -mdebug
  • -malign-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

M680x0 Options (M680x0 Options) ๐Ÿฆ‹

M680x0 besties, look at this lineup, it ate:

  • -march=arch
  • -mcpu=cpu
  • -mtune=tune
  • -m68000
  • -m68020
  • -m68020-40
  • -m68020-60
  • -m68030
  • -m68040
  • -m68060
  • -m68302
  • -m68332
  • -m68851
  • -mcpu32
  • -mfidoa
  • -m5200
  • -m5206e
  • -m528x
  • -m5307
  • -m5407
  • -mcfv4e
  • -mbitfield
  • -mc68000
  • -mc68020
  • -mrtd
  • -mdiv
  • -mshort
  • -mhard-float
  • -m68881
  • -msoft-float
  • -mpcrel
  • -malign-int
  • -mstrict-align
  • -msep-data
  • -mshared-library-id=n
  • -mid-shared-library
  • -mxgot
  • -mxtls
  • -mlong-jump-table-offsets

MCore Options (MCore Options) ๐ŸŒธ

MCore besties, here's the whole menu:

  • -mhardlit
  • -mdiv
  • -mrelax-immediates
  • -mwide-bitfields
  • -m4byte-functions
  • -mcallgraph-data
  • -mslow-bytes
  • -mno-lsim
  • -mlittle-endian
  • -mbig-endian
  • -m210
  • -m340
  • -mstack-increment

MicroBlaze Options (MicroBlaze Options) ๐ŸŽ€

MicroBlaze girlies, this list is lowkey iconic:

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

MIPS Options (MIPS Options) ๐Ÿ’…

MIPS besties, this is a whole meal, no crumbs:

  • -EL
  • -EB
  • -mel
  • -meb
  • -march=arch
  • -mtune=arch
  • -mips1
  • -mips2
  • -mips3
  • -mips4
  • -mips32
  • -mips32r2
  • -mips32r3
  • -mips32r5
  • -mips32r6
  • -mips64
  • -mips64r2
  • -mips64r3
  • -mips64r5
  • -mips64r6
  • -mips16
  • -mmips16e2
  • -mflip-mips16
  • -minterlink-compressed
  • -minterlink-mips16
  • -mabi=abi
  • -mabicalls
  • -mshared
  • -mplt
  • -mxgot
  • -mgp32
  • -mgp64
  • -mfp32
  • -mfpxx
  • -mfp64
  • -mhard-float
  • -msoft-float
  • -mno-float
  • -msingle-float
  • -mdouble-float
  • -modd-spreg
  • -mabs=mode
  • -mnan=encoding
  • -mdsp
  • -mdspr2
  • -mmcu
  • -meva
  • -mvirt
  • -mxpa
  • -mcrc
  • -mginv
  • -mmicromips
  • -mmsa
  • -mloongson-mmi
  • -mloongson-ext
  • -mloongson-ext2
  • -mfpu=fpu-type
  • -msmartmips
  • -mpaired-single
  • -mdmx
  • -mips3d
  • -mmt
  • -mllsc
  • -mlong64
  • -mlong32
  • -msym32
  • -Gnum
  • -mno-local-sdata
  • -mno-extern-sdata
  • -mno-gopt
  • -membedded-data
  • -muninit-const-in-rodata
  • -mcode-readable=setting
  • -mno-data-in-code
  • -mcode-xonly
  • -msplit-addresses
  • -mexplicit-relocs
  • -mexplicit-relocs=release
  • -mno-check-zero-division
  • -mdivide-traps
  • -mdivide-breaks
  • -mno-load-store-pairs
  • -mstrict-align
  • -mno-unaligned-access
  • -mmemcpy
  • -mlong-calls
  • -mmad
  • -mimadd
  • -mno-fused-madd
  • -nocpp
  • -mfix-24k
  • -mfix-r4000
  • -mfix-r4400
  • -mfix-r5900
  • -mfix-r10000
  • -mfix-rm7000
  • -mfix-vr4120
  • -mfix-vr4130
  • -mfix-sb1
  • -mfix4300
  • -mr10k-cache-barrier=setting
  • -mflush-func=func
  • -mno-flush-func
  • -mbranch-cost=num
  • -mbranch-likely
  • -mcompact-branches=policy
  • -mno-fp-exceptions
  • -mvr4130-align
  • -msynci
  • -mno-lxc1-sxc1
  • -mno-madd4
  • -mno-relax-pic-calls
  • -mmcount-ra-address
  • -mframe-header-opt

MMIX Options (MMIX Options) โœจ

MMIX besties, here's the vibe:

  • -mlibfuncs
  • -mepsilon
  • -mabi=gnu
  • -mabi=mmixware
  • -mzero-extend
  • -mknuthdiv
  • -mtoplevel-symbols
  • -melf
  • -mbranch-predict
  • -mbase-addresses
  • -msingle-exit
  • -mset-data-start=address
  • -mset-program-start=address
  • -mno-set-program-start

MN10300 Options (MN10300 Options) ๐Ÿฆ‹

MN10300 cuties, this is your list:

  • -mmult-bug
  • -mno-mult-bug
  • -mam33
  • -mam33-2
  • -mam34
  • -mtune=cpu-type
  • -mno-return-pointer-on-d0
  • -mno-crt0
  • -mrelax
  • -mno-liw
  • -mno-setlb

Moxie Options (Moxie Options) ๐ŸŒธ

Moxie besties, short but slay:

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

MSP430 Options (MSP430 Options) ๐ŸŽ€

MSP430 girlies, this list is giving:

  • -msim
  • -masm-hex
  • -mmcu=name
  • -mlarge
  • -msmall
  • -mrelax
  • -mwarn-mcu
  • -mwarn-devices-csv
  • -mcode-region=where
  • -mdata-region=where
  • -muse-lower-region-prefix
  • -msilicon-errata=name[,name...]
  • -msilicon-errata-warn=name[,name...]
  • -mhwmult=type
  • -minrt
  • -mtiny-printf
  • -mmax-inline-shift=n

NDS32 Options (NDS32 Options) ๐Ÿ’–

NDS32 besties, look at this:

  • -mbig-endian
  • -mlittle-endian
  • -EB
  • -EL
  • -mabi=name
  • -mfloat-abi=name
  • -mreduced-regs
  • -mfull-regs
  • -malways-align
  • -malign-functions
  • -mfp-as-gp
  • -mcmov
  • -mhw-abs
  • -mext-perf
  • -mext-perf2
  • -mext-string
  • -mext-dsp
  • -mext-fpu-fma
  • -mext-fpu-sp
  • -mext-fpu-dp
  • -mv3push
  • -m16-bit
  • -mvh
  • -misr-vector-size=num
  • -misr-secure=num
  • -mcache-block-size=num
  • -march=arch
  • -mcpu=cpu
  • -mconfig-fpu=num
  • -mconfig-mul=type
  • -mconfig-register-ports=kind
  • -mcmodel=code-model
  • -mctor-dtor
  • -mrelax
  • -mrelax-hint
  • -msched-prolog-epilog
  • -mno-ret-in-naked-func
  • -malways-save-lp
  • -munaligned-access
  • -minline-asm-r15

Nvidia PTX Options (Nvidia PTX Options) โœจ

Nvidia PTX besties, this is your moment:

  • -m64
  • -march=arch
  • -misa=arch
  • -march-map=arch
  • -mptx=version
  • -mmainkernel
  • -moptimize
  • -msoft-stack
  • -msoft-stack-reserve-local=size
  • -muniform-simt
  • -mgomp

OpenRISC Options (OpenRISC Options) ๐Ÿฆ‹

OpenRISC girlies, here's the tea:

  • -mboard=name
  • -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 (PDP-11 Options) ๐ŸŒธ

PDP-11 besties, this list is iconic:

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

Picolibc Options (Picolibc Options) ๐ŸŽ€

Picolibc besties, short and sweet:

  • --oslib=library
  • --crt0=[none|minimal|hosted|semihost]
  • --printf=[d|f|l|i|m]
  • --scanf=[d|f|l|i|m]

PowerPC Options ๐Ÿ’…

See RS/6000 and PowerPC Options.


PRU Options (PRU Options) ๐Ÿ’–

PRU besties, here's your lineup:

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

RISC-V Options (RISC-V Options) ๐Ÿ”ฅ

RISC-V besties, this list is long but we ate:

  • -mbranch-cost=N-instruction
  • -mabi=ABI-string
  • -mfdiv
  • -mdiv
  • -mno-fence-tso
  • -misa-spec=ISA-spec-string
  • -march=[ISA|Profile|Profile_ISA|processor-string]
  • -mcpu=processor-string
  • -mtune=processor-string
  • -mpreferred-stack-boundary=num
  • -msmall-data-limit=N-bytes
  • -msave-restore
  • -mno-shorten-memrefs
  • -mstrict-align
  • -mscalar-strict-align
  • -mno-vector-strict-align
  • -mcmodel=medlow
  • -mcmodel=medany
  • -mcmodel=large
  • -mexplicit-relocs
  • -mrelax
  • -mriscv-attribute
  • -malign-data=type
  • -mbig-endian
  • -mlittle-endian
  • -mstack-protector-guard=guard
  • -mstack-protector-guard-reg=reg
  • -mstack-protector-guard-offset=offset
  • -mcsr-check
  • -momit-leaf-frame-pointer
  • -mmovcc
  • -mno-inline-atomics
  • -mno-inline-strlen
  • -mno-inline-strcmp
  • -mno-inline-strncmp
  • -mstringop-strategy=strategy
  • -mtls-dialect=desc
  • -mtls-dialect=trad
  • -mrvv-vector-bits=value
  • -mrvv-max-lmul=value
  • -madjust-lmul-cost
  • -mmax-vectorization
  • -mno-autovec-segment

RL78 Options (RL78 Options) ๐ŸŒˆ

RL78 besties, last but never least:

  • -msim
  • -mallregs
  • -mrelax
  • -mes0
  • -mmul=none
  • -mmul=g13
  • -mmul=g14
  • -mmul=rl78
  • -mcpu=g10
  • -mcpu=g13
  • -mcpu=g14
  • -mcpu=rl78
  • -mg10
  • -mg13
  • -mg14
  • -mrl78
  • -msave-mduc-in-interrupts

๐ŸŒธ RS/6000 and PowerPC Options ๐ŸŒธ

okay bestie, this is the whole RS/6000 + PowerPC roster, and I mean the whole thing, nobody got left at home:

-mcpu=cpu-type -mtune=cpu-type -mcmodel=code-model  -mprofile-kernel
-mpowerpc64 -maltivec -mpowerpc-gpopt  -mpowerpc-gfxopt  -mmfcrf
-mpopcntb  -mpopcntd -mfprnd  -mcmpb  -mhard-dfp -mfull-toc
-mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc -maix64  -maix32
-m64  -m32  -mxl-compat  -mpe -malign-power  -malign-natural
-msoft-float  -mhard-float  -mmultiple  -mupdate
-mavoid-indexed-addresses -mfused-madd  -mbit-align  -mbit-word
-mstrict-align  -mrelocatable  -mrelocatable-lib -mlittle
-mlittle-endian  -mbig  -mbig-endian -mdynamic-no-pic
-msingle-pic-base -mprioritize-restricted-insns=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
-msplit-patch-nops -mregnames  -mlongcall  -mpltseq  -mtls-markers
-mblock-move-inline-limit=num -mblock-compare-inline-limit=num
-mblock-compare-inline-loop-limit=num -mblock-ops-unaligned-vsx
-mstring-compare-inline-limit=num -misel  -mvsx  -mvrsave  -mmulhw
-mdlmzb  -mprototype -msim  -mmvme  -mads  -myellowknife  -memb
-meabi  -msdata -msdata=opt  -mreadonly-in-sdata  -mvxworks  -G num
-mrecip  -mrecip=opt  -mno-recip  -mrecip-precision -mveclibabi=type
-mfriz -mpointers-to-nested-functions  -msave-toc-indirect
-mpower8-fusion -mcrypto  -mhtm  -mquad-memory  -mquad-memory-atomic
-mcompat-align-parm -mfloat128  -mfloat128-hardware -mgnu-attribute
-mstack-protector-guard=guard  -mstack-protector-guard-reg=reg
-mstack-protector-guard-offset=offset  -mprefixed -mpcrel  -mmma
-mdense-math  -mrop-protect  -mprivileged -mno-splat-word-constant
-mno-splat-float-constant -mno-ieee128-constant
-mno-warn-altivec-long

periodt. that's the list, we don't skip โœจ


๐Ÿฆ‹ RX Options ๐Ÿฆ‹

the RX girlies get these:

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

๐Ÿ‘‘ S/390 and zSeries Options ๐Ÿ‘‘

mainframe main character energy, literally:

-mtune=cpu-type  -march=cpu-type -mhard-float  -msoft-float
-mhard-dfp -mlong-double-64  -mlong-double-128 -mbackchain
-mpacked-stack -msmall-exec  -mmvcle -m64  -m31  -mdebug  -mesa
-mzarch -mhtm  -mvx  -mzvector -mtpf-trace  -mtpf-trace-skip  -mmain
-mfused-madd  -mno-fused-madd -mwarn-framesize=framesize
-mwarn-dynamicstack -mstack-size=stack-size  -mno-stack-size
-mstack-guard=stack-guard  -mno-stack-guard
-mstack-protector-guard=guard -mstack-protector-guard-record
-mhotpatch=pre-halfwords,post-halfwords
-mno-pic-data-is-text-relative -mindirect-branch=choice
-mindirect-branch-jump=choice  -mindirect-branch-call=choice
-mfunction-return=choice -mfunction-return-mem=choice
-mfunction-return-reg=choice -mindirect-branch-table -mfentry
-mrecord-mcount  -mnop-mcount -mpreserve-args  -munaliged-symbols

๐ŸŽ€ SH Options ๐ŸŽ€

the SuperH buffet, all of it:

-m1  -m2  -m2e -m2a  -m2a-nofpu  -m2a-single
-m2a-single-only -m3  -m3e -m4  -m4-nofpu  -m4-single
-m4-single-only -m4-100  -m4-100-nofpu  -m4-100-single
-m4-100-single-only -m4-200  -m4-200-nofpu  -m4-200-single
-m4-200-single-only -m4-300  -m4-300-nofpu  -m4-300-single
-m4-300-single-only -m4-340  -m4-400  -m4-500 -m4a  -m4al
-m4a-nofpu  -m4a-single  -m4a-single-only -mb  -ml  -mdalign
-mrelax -mbigtable  -mbitops  -mfmovd  -mrenesas  -mnomacsave -mieee
-misize  -minline-ic_invalidate -mprefergot  -musermode
-multcost=number  -mdiv=strategy -mdivsi3_libfunc=name
-mfixed-range=register-range -maccumulate-outgoing-args
-matomic-model=atomic-model -mbranch-cost=num  -mzdcbranch
-mcbranch-force-delay-slot -mfsca  -mfsrra -mpretend-cmove  -mfdpic
-mtas  -mlra

๐ŸŒˆ Solaris 2 Options ๐ŸŒˆ

tiny section, big vibe:

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

โญ SPARC Options โญ

sun-kissed flags, incoming:

-mcpu=cpu-type -mtune=cpu-type
-mcmodel=code-model -mmemory-model=mem-model -m32  -m64  -mptr32
-mptr64  -mapp-regs -mfaster-structs  -mflat -mfpu  -mhard-float
-msoft-float -mhard-quad-float  -msoft-quad-float -mstack-bias
-mstd-struct-return -munaligned-doubles  -muser-mode -mv8plus  -mvis
-mvis2  -mvis3  -mvis3b  -mvis4  -mvis4b -mcbcond  -mfmaf  -mfsmuld
-mpopc  -msubxc -mfix-at697f  -mfix-ut699  -mfix-ut700
-mfix-gr712rc

๐Ÿ’… System V Options ๐Ÿ’…

just two, and they're both iconic:

-YP,paths  -Ym,dir

๐Ÿงš V850 Options ๐Ÿงš

-mlong-calls  -mep -mprolog-function
-mspace -mtda=n  -msda=n  -mzda=n -mv850  -mv850e3v5  -m850e2v4
-mv850e2v3 -mv850e2  -mv850e1  -mv850es  -mv850e -mdisable-callt
-mrelax  -mlong-jumps -msoft-float  -mhard-float  -mloop -mrh850-abi
-mghs  -mgcc-abi -m8byte-align  -mbig-switch  -mapp-regs
-msmall-sld -mno-strict-align  -mjump-tables-in-data-section

๐Ÿ“ VAX Options ๐Ÿ“

retro but make it serve:

-munix  -mgnu  -md  -md-float  -mg
-mg-float  -mlra -mvaxc-alignment  -mqmath

๐Ÿซถ Visium Options ๐Ÿซถ

-mdebug  -msim  -mfpu  -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  -mvthreads
-non-static  -Bstatic  -Bdynamic -Xbind-lazy  -Xbind-now

๐Ÿ”ฅ x86 Options ๐Ÿ”ฅ

okay this is THE one, the big one, the main character of machine options. no skips, no shortcuts, we're listing every single one because that's the assignment:

-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  -mieee-fp -mrtd  -malign-double
-mpreferred-stack-boundary=num -mincoming-stack-boundary=num -mcld
-mcx16  -msahf  -mmovbe  -mcrc32  -mmwait -mrecip  -mrecip=opt
-mvzeroupper  -mstv  -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
-mavx512cd  -mavx512vl -mavx512bw  -mavx512dq  -mavx512ifma
-mavx512vbmi  -msha  -maes -mpclmul  -mfsgsbase  -mrdrnd  -mf16c
-mfma  -mpconfig  -mwbnoinvd -mptwrite  -mclflushopt  -mclwb
-mxsavec  -mxsaves -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm
-mbmi  -mtbm  -mfma4  -mxop -madx  -mlzcnt  -mbmi2  -mfxsr  -mxsave
-mxsaveopt  -mrtm  -mhle  -mlwp -mmwaitx  -mclzero  -mpku  -mgfni
-mvaes  -mwaitpkg -mshstk  -mmanual-endbr  -mcet-switch
-mforce-indirect-call -mavx512vbmi2  -mavx512bf16  -menqcmd
-mvpclmulqdq  -mavx512bitalg  -mmovdiri  -mmovdir64b
-mavx512vpopcntdq -mavx512vnni  -mprfchw  -mrdpid -mrdseed  -msgx
-mavx512vp2intersect  -mserialize  -mtsxldtrk -mamx-tile  -mamx-int8
-mamx-bf16  -muintr  -mhreset -mavxvnni  -mamx-fp8  -mavx512fp16
-mavxifma  -mavxvnniint8 -mavxneconvert  -mcmpccxadd  -mamx-fp16
-mprefetchi  -mraoint -mamx-complex  -mavxvnniint16  -msm3  -msha512
-msm4  -mapxf -musermsr  -mavx10.1  -mavx10.2  -mamx-avx512
-mamx-tf32  -mmovrs -mamx-movrs  -mavx512bmm  -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
-mstack-arg-probe -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  -mrecord-return
-mfentry-name=name  -mfentry-section=name -mskip-rax-setup
-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  -mtls-dialect=type -mrelax-cmpxchg-loop
-mindirect-branch=choice  -mfunction-return=choice
-mindirect-branch-register  -mharden-sls=choice
-mindirect-branch-cs-prefix  -mapx-inline-asm-use-gpr32 -mgather
-mscatter -mneeded  -mno-direct-extern-access
-munroll-only-small-loops  -mdispatch-scheduler  -mlam=choice

ate. ๐Ÿ’…


๐ŸŒˆ x86 Windows Options ๐ŸŒˆ

See Cygwin and MinGW Options. that's it, that's the whole section, go look over there bestie ๐Ÿ‘€


โœจ Xstormy16 Options โœจ

one flag. one. and she's perfect:

-msim

๐Ÿฆ‹ Xtensa Options ๐Ÿฆ‹

-mconst16  -mforce-no-pic
-mno-serialize-volatile -mtext-section-literals  -mauto-litpools
-mno-target-align -mlongcalls  -mabi=abi-type
-mextra-l32r-costs=cycles  -mstrict-align

๐Ÿ’œ zSeries Options ๐Ÿ’œ

See S/390 and zSeries Options. yeah they're the same section, we already did it, scroll up boo ๐Ÿซถ


โœจ Options Controlling the Kind of Output โœจ

okay so compiling isn't one single thing, it's up to four stages, and they always go in this exact order, no queue-jumping:

  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 smooshes all the object files together โ€” both the ones it just compiled and the ones you handed it as input โ€” into an executable file. iconique โœจ

For any given input file, the file name suffix is what decides which kind of compilation happens:

  • 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. Note that 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. Note that you must link with the libobjc library to make an Objective-C++ program work. 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 needs preprocessing, bestie. Heads up tho: in .cxx the last two letters have to both be literally x. And .C means a literal capital C. Case matters, no cap. ๐Ÿ’…
  • file.mm, file.M โ€” Objective-C++ source that needs preprocessing.
  • file.mii โ€” Objective-C++ source that should not be preprocessed.
  • file.hh, file.H, file.hp, file.hxx, file.hpp, file.HPP, file.h++, file.tcc โ€” a C++ header file destined to become a precompiled header or an Ada spec. โœจ
  • file.f, file.for, file.ftn, file.fi โ€” fixed form Fortran source that should not be preprocessed.
  • file.F, file.FOR, file.fpp, file.FPP, file.FTN โ€” fixed form Fortran source that must be preprocessed (with the traditional preprocessor).
  • file.f90, file.f95, file.f03, file.f08, file.fii โ€” free form Fortran source that should not be preprocessed.
  • file.F90, file.F95, file.F03, file.F08 โ€” free form Fortran source that must be preprocessed (with the traditional preprocessor).
  • file.cob, file.COB, file.cbl, file.CBL โ€” COBOL source code.
  • file.go โ€” Go source code.
  • file.d โ€” D source code.
  • file.di โ€” a D interface file.
  • file.dd โ€” D documentation code (Ddoc).
  • file.ads โ€” an Ada source file holding a library unit declaration (so like, 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). These files also go by specs. ๐ŸŽ€
  • file.adb โ€” an Ada source file containing a library unit body (a subprogram or package body). These ones 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 gets treated this way. ๐Ÿซถ

You can also just tell the compiler the input language yourself with the -x option:

  • -x language, --language=language, --language language โ€” specify explicitly the language for the following input files (instead of letting the compiler pick a default off the file name suffix). This option applies to all following input files until the next -x option. The possible values for language are:
c  c-header  cpp-output
c++  c++-header  c++-system-header c++-user-header c++-cpp-output
c++-system-module
objective-c  objective-c-header  objective-c-cpp-output  objc-cpp-output
objective-c++  objective-c++-header  objective-c++-cpp-output
objc++-cpp-output
assembler  assembler-with-cpp
ada  adascil  adawhy
cobol
d
f77  f77-cpp-input  f95  f95-cpp-input
go
modula-2  modula-2-cpp-output
rust
algol68
lto
Quick reality check: -x does not imply any particular language standard, bestie. So like, -x f77 might still need -std=legacy for some older source codes. Don't come for me, it's just how it is. ๐Ÿ˜ญ
  • -x none โ€” turn off any specification of a language, so subsequent files get handled according to their file name suffixes (as if -x had never been used at all). Reset button energy. ๐Ÿฆ‹

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 -c, -S, or -E to say where gcc is supposed to stop. Note that some combos (for example, -x cpp-output -E) instruct gcc to do literally nothing at all. Iconic of it. ๐Ÿ’€

  • -c, --compile โ€” compile or assemble the source files, but do not link. The linking stage simply is not done. The final output is 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 that don't need compilation or assembly get ignored.

  • -S, --assemble โ€” stop after the stage of compilation proper; do not assemble. The output is an assembler code file for each non-assembler input file you 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 need compilation get ignored.

  • -E, --preprocess โ€” stop after the preprocessing stage; do not run the compiler proper. The output is preprocessed source code, and it goes to the standard output. โœจ

Input files that don't need preprocessing get ignored.

  • -o file, --output=file, --output file โ€” put the primary output in file. This applies to whatever sort of output is being produced, whether that's an executable file, an object file, an assembler file, or preprocessed C code.

If -o isn't specified, the default is: an executable file goes in a.out, the object file for source.suffix goes in source.o, its assembler file goes in source.s, a precompiled header file goes in source.suffix.gch, and all preprocessed C source goes on standard output.

Now even though -o only names the primary output, it also affects how auxiliary and dump outputs get named. See the examples below. Unless something overrides it, both auxiliary outputs and dump outputs land in the same directory as the primary output. In auxiliary outputs, the input file's suffix is replaced with the suffix of the auxiliary output file type; in dump outputs, the dump file's suffix 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 get 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 all of 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 are 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, --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 save-foo.i, compiles to save-foo.s (now an intermediate, thus an auxiliary output), and then assembles to the (implied) output file foo.o.

If this option is absent, 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) come with the input name suffix, and aux output files (those requested by other non-dump options, e.g. -save-temps, -gsplit-dwarf, -fcallgraph-info) come without it.

You can get similar suffix differentiation of dump and aux outputs for an 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.*. Notice 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, --dumpbase-ext auxdropsuf โ€” okay so when youโ€™re forming the name of an auxiliary output file (not a dump output, bestie, just aux), you drop the trailing auxdropsuf from dumpbase before appending any suffixes. If you donโ€™t specify this, it 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 when dumpbase is combined with dumppfx. โœจ
gcc foo.c -c -o dir/foo.o -dumpbase x-foo.c -dumpbase-ext .c ...

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

This 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, --dumpdir dumppfx โ€” when forming the name of an auxiliary or dump output file, use dumppfx as a prefix:
gcc -dumpdir pfx- -c foo.c ...

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

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

This outputs foo.o, with auxiliary outputs named foo.* because -save-temps=* overrides the dumppfx given by the earlier -dumpdir option. It does not matter that =obj is the default for -save-temps, nor that the output directory is implicitly the current directory. Dump outputs are named foo.c.*. ๐Ÿ’–

When compiling from multiple input files, if -dumpbase is specified, dumpbase, minus an auxdropsuf suffix, and a dash are appended to (or override, if containing any directory components) an explicit or defaulted dumppfx, so that each of the multiple compilations gets differently-named aux and dump outputs.

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

This outputs auxiliary dumps to dir/pfx-main-foo.* and dir/pfx-main-bar.*, appending dumpbase- to dumppfx. Dump outputs retain the input file suffix: dir/pfx-main-foo.c.* and dir/pfx-main-bar.c.*, respectively. Contrast with the single-input compilation:

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

That, 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.*. ๐ŸŽ€

When compiling and then linking from multiple input files, a defaulted or explicitly specified dumppfx also undergoes the dumpbase- transformation above (e.g. 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 is appended to the default dumppfx instead. Note, however, that unlike earlier cases of linking:

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

Does not append the output name main to dumppfx, because -dumpdir is explicitly specified. The 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, in order to avoid simply discarding a meaningful option. ๐Ÿ‘‘

When compiling and then linking from a single input file, the linker output base name will only be appended to the default dumppfx as above if it does not share the base name with the single input file name. This has been covered in single-input linking cases above, but not with an explicit -dumpdir that inhibits the combination, even if overridden by -save-temps=*:

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

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 is 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 overridden 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. ๐Ÿ’œ

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, --verbose โ€” Print (on standard error output) the commands executed to run the stages of compilation. Also print the version number of the compiler driver program and of the preprocessor and the compiler proper. literally the receipts of what gcc is doing, bestie ๐Ÿซถ
  • -### โ€” 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. no cap, itโ€™s giving dry-run for your shell scripts ๐Ÿ’€
  • --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. 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. so helpful, so iconic ๐ŸŽ€
  • --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. target-specific tea, spilling it per tool ๐Ÿ“
  • --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. ๐Ÿ’–

Thus 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. not me trying to invert everything and getting nothing back, bestie ๐Ÿ’€

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. periodt, the plain --help wins ๐Ÿ’œ

If the -Q option shows up on the command line before the --help= option, then the descriptive text that --help= shows gets changed. Instead of describing the options it's displaying, it tells you whether each option is enabled, disabled, or set to a specific value (assuming the compiler knows that at the point where the --help= option is used). vibe check on your whole build config, bestie ๐Ÿ’…

Here's 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 you can 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

peak detective energy fr fr ๐Ÿ”


  • --version โ€” Displays the version number and copyrights of the invoked GCC. the receipts, the lore, the whole origin story ๐Ÿ“œ
  • -pass-exit-codes, --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. internal compiler error my beloathed ๐Ÿ˜ญ
  • -pipe, --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. GNU assembler stays unbothered, iconic behavior โœจ
  • -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 .... putting your compiler in a little harness, we love a controlled experiment ๐ŸŽ€

  • -ffile-prefix-map=old=new โ€” When compiling files residing in directory old, record any references to them in the result of the compilation as if the files resided in directory new instead. Specifying this option is equivalent to specifying all the individual -f*-prefix-map options. This can be used to make reproducible builds that are location independent. Directories referenced by directives are not affected by these options. See also -fmacro-prefix-map, -fdebug-prefix-map, -fprofile-prefix-map and -fcanon-prefix-map. reproducible builds are the moment, no cap ๐Ÿซถ
  • -fcanon-prefix-map โ€” For the -f*-prefix-map options, normally comparison of old prefix against the filename that would be normally referenced in the result of the compilation is done using textual comparison of the prefixes, or ignoring character case for case insensitive filesystems and considering slashes and backslashes as equal on DOS based filesystems. The -fcanon-prefix-map causes such comparisons to be done on canonicalized paths of old and the referenced filename. canonicalized path is the glow-up ๐Ÿ’…
  • -fplugin=name.so โ€” Load the plugin code in file name.so, assumed to be a shared object to be dlopen'd by the compiler. The base name of the shared object file is used to identify the plugin for the purposes of argument parsing (See -fplugin-arg-name-key=value below). Each plugin should define the callback functions specified in the Plugins API. yes bestie, we're doing dlopen, we're loading the whole plugin era ๐Ÿฆ‹
  • -fplugin-arg-name-key=value โ€” Define an argument called key with a value of value for the plugin called name. plugin wants a lil snack, plugin gets a lil snack ๐Ÿ“
  • -fdump-ada-spec[-slim] โ€” For C and C++ source and include files, generate corresponding Ada specs.
  • -fada-spec-parent=unit โ€” In conjunction with -fdump-ada-spec[-slim] above, generate Ada specs as child units of parent unit.
  • -fdump-go-spec=file โ€” For input files in any language, generate corresponding Go declarations in file. This generates Go "const", "type", "var", and "func" declarations which may be a useful way to start writing a Go interface to code written in some other language. cross-language friendship bracelet energy ๐ŸŒˆ
  • @file โ€” Read command-line options from file. The options 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 in 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. The file may itself contain additional @file options; any such options will be processed recursively. it's giving inception, it's giving turtles all the way down ๐Ÿข


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; preprocessed C++ files use the suffix .ii; and C++20 module interface units sometimes use .ixx, .cppm, .cxxm, .c++m, or .ccm. so many suffixes bestie, they're all valid, they're all slaying ๐Ÿ’…

GCC recognizes files with these names and compiles them as C++ programs even if you call the compiler the same way as for compiling C programs (usually with the name gcc). sneaky but make it fashion โœจ

However, 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++. g++ is the main character here, honestly ๐Ÿ‘‘

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. mix and match, build your own adventure ๐Ÿฆ‹


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: dialect check, bestie, what era of C are we in today ๐Ÿ’…

  • -ansi, --ansi โ€” In C mode, this is equivalent to -std=c90. In C++ mode, it is equivalent to -std=c++98. old school but make it official ๐Ÿ“œ
  • -std= โ€” Determine the language standard. This option is currently only supported when compiling C or C++. only C and C++ for now, don't get any ideas ๐Ÿ™ˆ

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. the pedantic flag really said "I'm watching you" ๐Ÿ‘€

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

  • c90
  • c89
  • iso9899:1990
    • Support 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/projects/c-status.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. glow-up with the same bones ๐Ÿ’…
  • c23
  • c2x
  • iso9899:2024
    • ISO C23, the 2023 revision of the ISO C standard (published in 2024). The name c2x is deprecated.
  • c2y
    • The next version of the ISO C standard, still under development. The support for this version is experimental and incomplete. she's not done cooking, do not eat ๐Ÿ“
  • 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.
  • gnu23
  • gnu2x
    • GNU dialect of ISO C23. This is the default for C code. The name gnu2x is deprecated. the default! the moment! the icon! ๐Ÿ‘‘
  • gnu2y
    • The next version of the ISO C standard, still under development, plus GNU extensions. The support for this version is experimental and incomplete. The name gnu2x is deprecated. note: the manpage literally says that, bestie, we're just passing it along fr fr ๐Ÿซถ
  • 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. heads up bestie, the name c++1y is deprecated ๐Ÿ™ˆ
    • gnu++14, gnu++1y โ€” GNU dialect of -std=c++14. the name gnu++1y is deprecated too.
    • c++17, c++1z โ€” the 2017 ISO C++ standard plus amendments. and yes, c++1z is deprecated.
    • gnu++17, gnu++1z โ€” GNU dialect of -std=c++17. gnu++1z? deprecated, sorry babe.
    • c++20, c++2a โ€” the 2020 ISO C++ standard plus amendments. C++20 modules support is still experimental and needs to be switched on with the -fmodules option. the name c++2a is deprecated.
    • gnu++20, gnu++2a โ€” GNU dialect of -std=c++20. โœจ This is the default for C++ code. โœจ C++20 modules support is still experimental and needs -fmodules to turn it on. the name gnu++2a is deprecated.
    • c++23, c++2b โ€” the 2023 ISO C++ standard plus amendments (published in 2024, iconic behaviour tbh). Support is experimental, and could change in incompatible ways in future releases. the name c++2b is deprecated.
    • gnu++23, gnu++2b โ€” GNU dialect of -std=c++23. Support is experimental, and could change in incompatible ways in future releases. the name gnu++2b is deprecated.
    • 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. ๐Ÿ’€
    • gnu++2c, gnu++26 โ€” GNU dialect of -std=c++2c. Support is highly experimental, and will almost certainly change in incompatible ways in future releases. ๐Ÿ’€

  • -aux-info filename โ€” writes prototyped declarations to filename for every function declared and/or defined in a translation unit, header-file ones included. ๐Ÿซถ Real talk tho: in any language that isn't C, this option is silently ignored.

On top of the declarations themselves, the file spills the tea in comments: where each declaration came from (source file and line), whether it was implicit, prototyped or unprototyped (I, N for new or O for old โ€” that's the first character after the line number and the colon), and whether it came from a declaration or a definition (C or F, in the next character). And for function definitions? You also get a K&R-style list of arguments followed by their declarations, tucked inside comments, after the declaration. ๐Ÿ˜Œ

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

In C++, "inline" is a standard keyword and this switch does not affect it. What you probably want instead is the -fno-gnu-keywords flag, which kills "typeof" but leaves "asm" and "inline" alone. In C99 mode (-std=c99 or -std=gnu99), this switch only touches 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. ๐ŸŽ€

  • -fno-builtin
  • -fno-builtin-function โ€” don't recognize built-in functions that don't start with __builtin_ as a prefix. ๐Ÿšซ

GCC normally generates special code to handle certain built-in functions more efficiently โ€” for instance, calls to "alloca" may become single instructions that adjust the stack directly, and calls to "memcpy" may become inline copy loops. The resulting code is often smaller and faster, but since the function calls no longer appear as such, you cannot set a breakpoint on those calls, and you cannot change the behaviour of the functions by linking with a different library. On top of that, when a function is recognized as built-in, GCC may use info about it to warn you about problems with calls to it, or to generate even more efficient code, even if the resulting code still contains calls to that function. Example: warnings show up with -Wformat for bad calls to "printf" when "printf" is built in, and "strlen" is known not to modify global memory.

With the -fno-builtin-function option, only the built-in function is disabled. function must not begin with __builtin_. If you name a function that isn't built-in in this version of GCC, the option is ignored. And btw there is no corresponding -fbuiltin-function option โ€” so if you wanna enable built-in functions selectively while using -fno-builtin or -ffreestanding, just define macros like:

#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++. ๐Ÿ’€
  • -ffreestanding โ€” assert that compilation targets a freestanding environment. This implies -fno-builtin. A freestanding environment is one where 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.
  • -fgimple โ€” enable parsing of function definitions marked with "__GIMPLE". This is an experimental feature that allows unit testing of GIMPLE passes. โœจ
  • -fgnu-tm โ€” when you pass -fgnu-tm, 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).

  • -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 behaviour). 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. ๐Ÿ”

  • -fhosted โ€” assert that compilation targets a hosted environment. This implies -fbuiltin. A hosted environment is one where the entire standard library is available, and where "main" has a return type of "int". Examples are nearly everything except a kernel. ๐ŸŒˆ This is equivalent to -fno-freestanding.
  • -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. ๐Ÿ™…โ€โ™€๏ธ
  • -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 type 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.

  • *-fpermitted-flt-eval-methods=style* โ€” ISO/IEC TS 18661-3 defines new permissible values for "FLT_EVAL_METHOD" that indicate that operations and constants with a semantic type that is an interchange or extended format should be evaluated to the precision and range of that type. These new values are a superset of those permitted under C99/C11, which does not specify the meaning of other positive values of "FLT_EVAL_METHOD". Because of that, code conforming to C11 may not have been written expecting the possibility of the new values. ๐Ÿ˜ฌ

-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" as appropriate.

The default when in a standards compliant mode (-std=c11 or similar) is -fpermitted-flt-eval-methods=c11. The default when 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. This involves figuring out what resources provided by other source files will be required to compile the source, as well as what resources are provided by the source. This info can then be used to add required dependencies between compilation rules of dependent sources based on their contents, rather than requiring that info to be reflected within the build tools as well. ๐Ÿง 

  • *-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. Note that 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.
  • *-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. This is only supported for C, not C++.

  • -fsigned-bitfields, -funsigned-bitfields, -fno-signed-bitfields, -fno-unsigned-bitfields โ€” these bad boys decide whether a bit-field is signed or unsigned when the declaration is out here being vague and using neither "signed" nor "unsigned" ๐Ÿ’…. Default? Signed. Because consistency is the vibe: basic integer types like int are signed types, so we keep the family together, periodt.

  • -fsigned-char, -funsigned-char โ€” -fsigned-char lets the type char be signed, exactly like signed char. -funsigned-char lets it be unsigned, like unsigned char. Two sides of the same coin, bestie ๐Ÿช™

Lowkey important identity crisis lore: -fsigned-char is equivalent to -fno-unsigned-char, which is literally just the negative form of -funsigned-char. And -fno-signed-char is equivalent to -funsigned-char. Yes queen, the negations are all connected, it's giving tangled earphone wires ๐Ÿ˜ญ

Every target GCC supports has a default for what char should be, and it's usually written down in that target's processor-specific ABI document. So it's either like unsigned char by default, or like signed char by default. No in-between, no main character chaos.

Ideally a portable program should ALWAYS use signed char or unsigned char when it actually depends on the signedness of an object. That's the correct, slay, grown-up move. But bestie, so many programs out here were written using plain char and just expecting it to be signed, or expecting it to be unsigned, depending on whatever machine they were born on ๐Ÿ’€ These options are the glow-up: they let you make such a program work with the opposite default.

And one more thing that will not be up for debate: 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 not one of them, it just acts like one. Method acting, honestly ๐ŸŽญ


  • -fstrict-flex-arrays (C and C++ only), -fstrict-flex-arrays=level (C and C++ only) โ€” this controls when we 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 setting. At that level, a trailing array is treated as a flexible array member only when it is declared as a flexible array member per C99 standard onwards. No shortcuts, no exceptions, we are strict.

The negative form -fno-strict-flex-arrays is equivalent to -fstrict-flex-arrays=0, which is the least strict. In this case, all trailing arrays of structures are treated as flexible array members. Chaos mode, but make it legal.

There are two more levels in between 0 and 3, and they exist to support older code that uses the GCC zero-length array extension ([0]) or one-element array as flexible array members ([1]). Respect the elders ๐Ÿซถ

  • When level is 1, the trailing array is treated as a flexible array member when it is declared as either [], [0], or [1].
  • When level is 2, the trailing array is treated as a flexible array member when it is declared as either [], or [0].

You can control this behavior for a specific trailing array field of a structure by using the variable attribute strict_flex_array attribute. Yes, per-field control, because we love a bespoke treatment ๐Ÿ’–

Also: the -fstrict_flex_arrays option interacts with the -Wstrict-flex-arrays option. They talk, they gossip, they coordinate.


  • -fsso-struct=endianness โ€” sets 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). Not supported for C++. Sorry C++ girlies, this one's not for you ๐Ÿ™ˆ
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, actually not compatible. Do not play with this casually, bestie, this is not a vibe check you want to fail ๐Ÿ˜ญ

โœจ Options Controlling C++ Dialect โœจ

Okay so this section is all about the command-line options that are only meaningful for C++ programs ๐Ÿ’œ You can still use most of the GNU compiler options no matter what language your program is in โ€” language is not a personality, options are flexible like that. 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. See, teamwork ๐ŸŒˆ

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

Here is a list of options that are only for compiling C++ programs ๐Ÿ‘‘


  • --compile-std-module โ€” builds the compiled module interfaces for the <bits/stdc++.h> header unit and the std and std.compat modules before compiling any source files explicitly specified on the command line. This is intended to be useful for building simple programs that use import std; with a single command. One command, one dream, slay ๐ŸŽ€

  • -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 are fixed. It's the "we're doing our best" version, and honestly? Same.
    • Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
    • Version 2 is the version of the C++ ABI that first appeared in G++ 3.4, and was the default through G++ 4.9.
    • Version 3 corrects an error in mangling a constant address as a template argument.
    • Version 4, which first appeared in G++ 4.5, implements a standard mangling for vector types.
    • Version 5, which first appeared in G++ 4.6, corrects the mangling of attribute const/volatile on function pointer types, decltype of a plain decl, and use of a function parameter in the declaration of another parameter.
    • Version 6, which first appeared in G++ 4.7, corrects the promotion behavior of C++11 scoped enums and the mangling of template argument packs, const/static_cast, prefix ++ and --, and a class scope function used as a template argument.
    • Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a builtin type and corrects the mangling of lambdas in default argument scope.
    • Version 8, which first appeared in G++ 4.9, corrects the substitution behavior of function types with function-cv-qualifiers.
    • Version 9, which first appeared in G++ 5.2, corrects the alignment of 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. Oopsie, we don't talk about that one ๐Ÿ’€
    • Version 13, which first appeared in G++ 8.2, fixes the accidental change in version 12. Redemption arc complete โœจ
    • 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 appeared in G++ 13, fixes manglings of lambdas that have additional context.
    • Version 19, which first appeared in G++ 14, fixes manglings of structured bindings to include ABI tags, handling of cv-qualified [[no_unique_address]] members, and adds mangling of C++20 constraints on function templates.
    • Version 20, which first appeared in G++ 15, fixes manglings of lambdas in static data member initializers.
    • Version 21, which first appeared in G++ 16, fixes unnecessary captures in noexcept lambdas (c++/119764), layout of a base class with all explicitly defaulted constructors (c++/120012), and mangling of class and array objects with implicitly zero-initialized non-trailing subobjects (c++/121231).

See also -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. It's the "fix it in post" of compiler options ๐ŸŽฌ

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. So many little negotiations happening behind the scenes, it's giving group project ๐Ÿ˜ญ


  • -fno-access-control โ€” turns off all access checking. All of it. Gone. This switch is mainly useful for working around bugs in the access control code. private? Never heard of her ๐Ÿ’…

  • -faligned-new, -faligned-new=alignment โ€” enables support for C++17 new of types that require more alignment than void* ::operator new(std::size_t) provides. A numeric argument such as -faligned-new=32 can be used to specify how much alignment (in bytes) is provided by that function, but few users will need to override the default of alignof(std::max_align_t). Respect the default, it knows what it's doing ๐Ÿซถ

This flag is enabled by default for -std=c++17.

  • -fno-assume-sane-operators-new โ€” okay bestie, gather round, this one's a whole saga about new and delete ๐Ÿซถ

So the C++ standard says you're allowed to replace the global "new", "new[]", "delete" and "delete[]" operators โ€” even though honestly a ton of C++ programs just never do that and vibe with the implementation-provided version. And the standard also lets the compiler skip those calls entirely when they come from new or delete expressions (and yeah, same energy is assumed when "__builtin_operator_new" or "__builtin_operator_delete" functions get used). This option is your little remote control for some optimizations around those calls.

With the -fassume-sane-operators-new-delete option, GCC is allowed to assume that calls to the replaceable global operators from new or delete expressions, or from "__builtin_operator_new" or "__builtin_operator_delete" calls, don't read or modify any global variables or variables whose address could escape to the operators (that's global state; except for "errno" for the "new" and "new[]" operators). This unlocks most optimizations across those calls, and it's literally what the implementation-provided operators satisfy โ€” unless "malloc" implementation details are observable in the code, or unless "malloc" hooks are used. But it might not be satisfied if a program replaces those operators. This behavior is on by default, no cap. โœจ

With the -fno-assume-sane-operators-new-delete option, GCC must assume all these calls โ€” whether they come from new or delete expressions or get called directly โ€” may read and write global state, unless proven otherwise (like, say, when GCC compiles their implementation). Use this one if those operators are or may be replaced and your code needs to expect that behavior.

  • -fchar8_t, -fno-char8_t โ€” turn on support for "char8_t" as adopted for C++20 ๐ŸŽ€ This includes a brand 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 lets functions 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 it 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;
Heads up bestie: the change to the types of UTF-8 string and character literals introduces incompatibilities with ISO C++11 and later standards. Like, the code below is well-formed under ISO C++11 but ill-formed once -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 even trying to modify the storage allocated ๐ŸŒธ This check is normally unnecessary, because the C++ standard says "operator new" only returns 0 if it's declared throw(), and in that case the compiler always checks the return value anyway, 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 โ€” 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, could additionally be enabled by -fconcepts-ts. The option -fconcepts-ts was deprecated in GCC 14 and removed in GCC 15; users are expected to convert their code to C++20 concepts. Rip to the TS era. ๐Ÿ™ˆ

  • -fconcepts-diagnostics-depth=n โ€” set the maximum error replay depth during recursive diagnosis of a constraint satisfaction failure. The default is 1.
  • -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. It's 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. Science! ๐Ÿงช
  • -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 the 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 support for the C++ Contracts feature, as specified in the C++26 working draft (N5003) ๐Ÿ‘‘

On violation of an enforced or observed contract (peep -fcontract-evaluation-semantic below), a violation handler is called; the standard library provides a default handler that emits information about the contract that failed.

Users can replace the default violation handler by defining:

void
handle_contract_violation (const std::contracts::contract_violation&);
  • -fcontract-evaluation-semantic=semantic โ€” set the semantic with which contracts will be evaluated to semantic.

Available values for the evaluation mode are:

  • "ignored" โ€” the contract checks will be elided, with no checking added at either compile or runtime.
  • "observed" โ€” the contract checks are performed (at runtime) and, if one fails, a handler is called that allows actions such as logging or emitting run-time warnings. When the handler returns, the execution of the code will continue. At compile-time the checks are performed for "constexpr" evaluations, in this case a diagnostic is emitted if the check fails.
  • "enforce" โ€” the contract checks are performed and the handler is called if one fails. When the handler returns the execution of the code is terminated preventing it from continuing past the failed case. At compile-time the checks are applied to "constexpr" and, if one fails, the program is ill-formed; an error will be emitted.
  • "quick_enforce" โ€” the contract checks are performed (at runtime) and, if one fails, the execution is terminated immediately (without calling any handler). At compile-time there is no difference in behaviour between this option and the "enforce" case, since no handler is invoked at compile time.
  • -fcontracts-conservative-ipa โ€” this prevents inter-procedural analysis from taking action when the body of an inline function is visible in a given TU. This allows for the case that contract evaluation conditions are permitted to differ between TUs, which means such actions would be potentially incorrect.
  • -fcontract-checks-outlined โ€” by default, contract checks for "pre" and "post" condition checks are expanded in-line into function bodies. This option causes a small function to be created instead (containing the checks) that is called in the relevant position. This permits different criteria to be applied to the compilation of the checking and the remainder of the function body. Cute little function. ๐ŸŽ€
  • -fcontract-disable-optimized-checks โ€” when "pre" and "post" condition checks are outlined (using -fcontract-checks-outlined), this option disables the optimisation steps for those functions which can avoid unwanted elision of checking steps.
  • -fcontracts-client-check=mode โ€” this option enables insertion of checks at call sites (caller-side checking).

The value of mode determines which contract checks are made:

  • "none" โ€” no caller/client side checking (default)
  • "pre" โ€” preconditions are checked at the caller/client side.
  • "all" โ€” both pre and post-conditions are checked at the caller/client side.
  • -fcontracts-definition-check=mode โ€” this option introduces the ability to disable callee/definition-side checks, which are otherwise enabled by default when the contracts feature is active.

The variable mode has the values "on" and "off".

  • -fcoroutines โ€” turns on support for the C++ coroutines extension ๐Ÿ’ซ. With -std=c++20 and above, coroutines are straight-up part of the language standard, so -fcoroutines defaults to on.
  • -fdiagnostics-all-candidates โ€” lets the C++ front end spill all the candidates when overload resolution fails ๐Ÿซถ, even when the thing that got picked is a deleted function.
  • -fdump-lang-, -fdump-lang-switch, -fdump-lang-switch-options, -fdump-lang-switch-options=filename โ€” these ones control dumping of C++-specific information ๐Ÿ’…. The options and filename bits act exactly like the -fdump-tree option describes. These switch values are accepted:
    • all โ€” enable all of the below, periodt ๐Ÿ‘‘
    • class โ€” dump class hierarchy information. Virtual table information is emitted unless slim is specified.
    • module โ€” dump module information. The options lineno (locations), graph (reachability), blocks (clusters), uid (serialization), alias (mergeable), asmname (Elrond), eh (mapper) & vops (macros) may provide additional information.
    • raw โ€” dump the raw internal tree data.
    • tinst โ€” dump the sequence of template instantiations, indented to show the depth of recursion. The lineno option adds the source location where the instantiation was triggered, and the details option also dumps pre-instantiation substitutions such as those performed during template argument deduction.

Lines in the .tinst dump start with I for an instantiation, S for another substitution, and R[IS] for the reopened context of a deferred instantiation.

  • -fno-elide-constructors โ€” okay so the C++ standard allows an implementation to skip creating a temporary that's 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 makes G++ 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 it 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. Not me telling you to be careful ๐Ÿšจ.
  • -fextern-tls-init, -fno-extern-tls-init โ€” the C++11 and OpenMP standards allow thread_local and threadprivate variables to have dynamic (runtime) initialization. To support this, any use of such a variable goes through a wrapper function that performs any necessary initialization. When the use and definition of the variable are in the same translation unit, this overhead can be optimized away, but when the use is in a different translation unit there's significant overhead even if the variable doesn't actually need dynamic initialization ๐Ÿ˜ญ. If the programmer can be sure that no use of the variable in a non-defining TU needs to trigger dynamic initialization (either because the variable is statically initialized, or a use of the variable in the defining TU will be executed before any uses in another TU), they can avoid this overhead with the -fno-extern-tls-init option.

On targets that support symbol aliases, the default is -fextern-tls-init. On targets that do not support symbol aliases, the default is -fno-extern-tls-init.

  • -ffold-simple-inlines, -fno-fold-simple-inlines โ€” permit the C++ frontend to fold calls to std::move, std::forward, std::addressof, std::to_underlying and std::as_const โœจ. In contrast to inlining, this means no debug information will be generated for such calls. Since these functions are rarely interesting to debug, this flag is enabled by default unless -fno-inline is active.
  • -fno-gnu-keywords โ€” do not recognize typeof as a keyword, so that code can use this 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 โ€” do not enable immediate function escalation whereby certain functions can be promoted to consteval, as specified in P2564R3 ๐Ÿ“œ. 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);
}

compiles in C++20: f is an immediate-escalating function (due to the auto it is a function template and is declared constexpr) and id(t) is an immediate-escalating expression, so f is promoted to consteval ๐Ÿ‘‘. Consequently, the call to id(t) is in an immediate context, so doesn't have to produce a constant (that is the mechanism allowing consteval function composition). However, with -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 rejects the code ๐Ÿ™ˆ.

This option is turned on by default; it is only effective in C++20 mode or later.

  • -fimplicit-constexpr โ€” make inline functions implicitly constexpr, if they satisfy the requirements for a constexpr function ๐ŸŒˆ. This option can be used in C++14 mode or later. This can result in initialization changing from dynamic to static and other optimizations. Lowkey a glow-up for your init code.
  • -fno-implicit-templates โ€” never emit code for non-inline templates that are instantiated implicitly (i.e. by use); only emit code for explicit instantiations. If you use this option, you must take care to structure your code to include all the necessary explicit instantiations to avoid getting undefined symbols at link time โš ๏ธ.
  • -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. This causes linker errors if these functions are not inlined everywhere they are called ๐Ÿ’€.
  • -fmodules, -fno-modules โ€” enable support for C++20 modules ๐Ÿฆ‹. The -fno-modules is usually not needed, as that is the default. Even though this is a C++20 feature, it is not currently implicitly enabled by selecting that standard version.
  • -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 ๐Ÿšจ. (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 ๐Ÿ’….
  • -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.
  • -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 ๐ŸŽ€. 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 ๐Ÿ’€.
  • -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 โ€” okay so by default, when an error message is like "bestie something went wrong" about a specialization of a function template, the compiler prints the whole template signature plus the template arguments and any typedefs or typenames in there (so you get void f(T) [with T = int] instead of just void f(int)) so you can actually tell which template is the problem. And when the error is about a specialization of a class template, it leaves out any template arguments that match the default template arguments for that template. But if either of those behaviors is making the error message more confusing instead of less (rude), you hit -fno-pretty-templates and both of them get turned off. ๐Ÿ’…
  • -frange-for-ext-temps โ€” turns on lifetime extension of C++ range-based for temporaries. With -std=c++23 and above this is literally part of the language standard, so the temporaries' lifetime gets extended until the end of the loop by default anyway. This option lets you have that behavior in earlier versions of the standard too. ๐Ÿฆ‹
  • -freflection โ€” enable experimental C++26 Reflection. it's giving "future tech, handle with care" โœจ
  • -fno-rtti โ€” disables generating info 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 with this flag. Note that exception handling uses the same information, but G++ generates it as needed. Also: the dynamic_cast operator can still be used for casts that don't require run-time type information, i.e. casts to void * or to unambiguous base classes. ๐Ÿ‘‘
Mixing code compiled with -frtti and code 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. so like, don't mix them, bestie, that's the vibe check failing. ๐Ÿ’€
  • -fsized-deallocation โ€” enables 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. And the flag -Wsized-deallocation warns about places that might want to add a definition. ๐ŸŽ€

  • -fstrict-enums โ€” lets the compiler 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. so yeah, if you're out here casting random ints into enums, this one's not for you. ๐Ÿ™ˆ
  • -fstrong-eval-order
  • -fstrong-eval-order=kind โ€” evaluates member access, array subscripting, and shift expressions in left-to-right order, and evaluates assignment in right-to-left order, as adopted for C++17. -fstrong-eval-order is equivalent to -fstrong-eval-order=all, and is enabled by default with -std=c++17 or later. ๐Ÿ”ฅ
    • -fstrong-eval-order=some enables just the ordering of member access and shift expressions, and is the default for C++ dialects prior to C++17.
    • -fstrong-eval-order=none is equivalent to -fno-strong-eval-order.
  • -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. ๐Ÿ“
  • -ftemplate-depth=n โ€” set the maximum instantiation depth for template classes to n. A limit on the template instantiation depth is needed to detect endless recursions during template class instantiation. ANSI/ISO C++ conforming programs must not rely on a maximum depth greater than 17 (changed to 1024 in C++11). The default value is 900, as the compiler can run out of stack space before hitting 1024 in some situations. ๐Ÿ’€
  • -fno-threadsafe-statics โ€” do not emit the extra code to use the routines specified in the C++ ABI for thread-safe initialization of local statics. You can use this option to reduce code size slightly in code that doesn't need to be thread-safe. lowkey a size-optimization slay, but only if you're single-threaded fr. ๐Ÿงš
  • -fuse-cxa-atexit โ€” register destructors for objects with static storage duration with the __cxa_atexit function rather than the atexit function. This option is required for fully standards-compliant handling of static destructors, but only works if your C library supports __cxa_atexit. ๐ŸŒธ
  • -fno-use-cxa-get-exception-ptr โ€” don't use the __cxa_get_exception_ptr runtime routine. This causes std::uncaught_exception to be incorrect, but is necessary if the runtime routine is not available. โš ๏ธ
  • -fvisibility-inlines-hidden โ€” this switch declares that the user does not attempt to compare pointers to inline functions or methods where the addresses of the two functions are taken in different shared objects.

The effect of this is that GCC may, effectively, mark inline methods with __attribute__ ((visibility ("hidden"))) so that they do not appear in the export table of a DSO and do not require a PLT indirection when used within the DSO. Enabling this option can have a dramatic effect on load and link times of a DSO as it massively reduces the size of the dynamic export table when the library makes heavy use of templates. โœจ

The behavior of this switch is not quite the same as marking the methods as hidden directly, because it does not affect static variables local to the function or cause the compiler to deduce that the function is defined in only one shared object.

You may mark a method as having a visibility explicitly to negate the effect of the switch for that method. For example, if you do want to compare pointers to a particular inline method, you might mark it as having default visibility. Marking the enclosing class with explicit visibility has no effect. ๐Ÿ‘‘

Explicitly instantiated inline methods are unaffected by this option as their linkage might otherwise cross a shared library boundary.

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

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

  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 is better to use -fvisibility=hidden and export those classes that are intended to be externally visible. Unfortunately it is possible for code to rely, perhaps accidentally, on the Visual Studio behavior. ๐Ÿ˜ญ

Among the consequences of these changes are that static data members of the same type with the same name but defined in different shared objects are different, so changing one does not change the other; and that pointers to function members defined in different shared objects may not compare equal. When this flag is given, it is a violation of the ODR to define types with the same name differently.

  • -fno-weak โ€” do not use weak symbol support, even if it is provided by the linker. By default, G++ uses weak symbols if they are available.
This option exists only for testing, and should not be used by end-users; it results in inferior code and has no benefits. This option may be removed in a future release of G++. bestie, this is a "do not touch" situation, fr fr. ๐Ÿšซ๐Ÿ’€
  • -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 these suffixes are treated as C++11 user-defined literal numeric suffixes. This is on by default for all pre-C++11 dialects and all GNU dialects: -std=c++98, -std=gnu++98, -std=gnu++11, -std=gnu++14. This option is 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 note 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. ๐ŸŒˆ

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 does not have that ABI tag. See C++ Attributes for more information about ABI tags. โญ
  • -Wno-abbreviated-auto-in-template-arg โ€” disable the error for an auto placeholder type used within a template argument list to declare a C++20 abbreviated function template, e.g.
void f(S<auto>);

like, it turns the "no bestie you can't do that" off. ๐Ÿ™ˆ

ok so real talk: this one is a warning about a feature that got proposed in the Concepts TS but never made it into C++20 ๐Ÿ˜ญ in the standard, a placeholder in a parameter declaration has to show up as a decl-specifier. you can also downgrade this error to a warning with -fpermissive or -Wno-error=abbreviated-auto-in-template-arg.

-Wcomma-subscript (C++ and Objective-C++ only) ๐Ÿ’…

ok bestie so this one yells at you when you use a comma expression inside a subscripting expression. this usage got deprecated in C++20 and it's getting removed in C++23 โ€” but wait, plot twist: a comma expression wrapped in "( )" is NOT deprecated, she's fine, she's thriving. example time:

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 actually 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 you can turn off with -Wno-comma-subscript.

  • Enabled by default with -std=c++20 unless -Wno-deprecated, and after -std=c++23 regardless of -Wno-deprecated.
  • Before -std=c++20, it's enabled with explicit -Wdeprecated.
heads up queen: this warning is upgraded to an error by -pedantic-errors in C++23 mode or later. no cap. ๐Ÿ‘‘

-Wctad-maybe-unsupported (C++ and Objective-C++ only) ๐Ÿฆ‹

warns when you're doing class template argument deduction (CTAD) on a type with no explicitly written deduction guides. this warning is basically like "bestie... CTAD only succeeded here because the compiler synthesized the implicit deduction guides, which might not be what the programmer actually intended ๐Ÿ‘€".

certain style guides only allow CTAD on types that specifically "opt-in" โ€” like, on types that are designed to support CTAD. you can shush this warning 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) ๐ŸŽ€

warns 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. it's giving "locked out of my own house" energy ๐Ÿ˜ญ

also warns if there are no non-private methods, and there's at least one private member function that isn't a constructor or destructor.


-Wdangling-reference (C++ and Objective-C++ only) ๐Ÿ’€

warns when a reference is bound to a temporary whose lifetime has ended. bestie that reference is dangling, she's gone, she's a ghost ๐Ÿ‘ป. 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. literally undefined behavior territory fr fr

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

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; that is, the class is a non-union class that has a pointer data member and a trivial destructor. โœจ

the warning can be disabled by using the "gnu::no_dangling" attribute.

this warning is enabled by -Wextra.

-Wdelete-non-virtual-dtor (C++ and Objective-C++ only) ๐Ÿ”ฅ

warns when "delete" is used to destroy an instance of a class that has virtual functions and non-virtual destructor. it is UNSAFE to delete an instance of a derived class through a pointer to a base class if the base class does not have a virtual destructor. like, do not do this, bestie, it's a trap ๐Ÿ’…

this warning is enabled by -Wall.

-Wdeprecated-copy (C++ and Objective-C++ only) ๐ŸŒธ

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

-Wdeprecated-copy-dtor (C++ and Objective-C++ only) ๐ŸŽ€

similar to -Wdeprecated-copy, but also deprecate if the class has a user-provided destructor. same vibe, extra rule, we love consistency โœจ


-Wno-deprecated-enum-enum-conversion (C++ and Objective-C++ only) ๐Ÿฆ‹

disables 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. 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 or -Wdeprecated.


-Wno-deprecated-enum-float-conversion (C++ and Objective-C++ only) ๐ŸŒˆ

disables 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. 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 or -Wdeprecated.


-Wdeprecated-literal-operator (C++ and Objective-C++ only) ๐Ÿ’…

warns that the declaration of a user-defined literal operator with a space before the suffix is deprecated. this warning is enabled by default in C++23, or with explicit -Wdeprecated. no space, bestie, we don't do spaces here ๐Ÿ˜ค

string operator "" _i18n(const char*, std::size_t); // deprecated
string operator ""_i18n(const char*, std::size_t); // preferred

-Wdeprecated-variadic-comma-omission (C++ and Objective-C++ only) โญ

warns that omitting a comma before the varargs "..." at the end of a function parameter list is deprecated. this warning is enabled by default in C++26, or with explicit -Wdeprecated.

void f1(int...); // deprecated
void f1(int, ...); // preferred
template <typename ...T>
void f2(T...); // ok
template <typename ...T>
void f3(T......); // deprecated

-Wno-elaborated-enum-base ๐Ÿงš

for C++11 and above, warns 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.
yes bestie, that last line literally says undefined behavior. we do NOT play with dangling pointers in this house ๐Ÿ’€

-Winvalid-constexpr ๐Ÿ‘‘

warns 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. iconic loophole behavior honestly โœจ

This warning is enabled as a pedantic warning by default in C++20 and earlier. But in C++23? It can be turned on with -Winvalid-constexpr, and then it's just a regular ordinary warning, no big deal. Like:

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 โ€” double-checks that every single imported macro definition is actually valid by the time compilation wraps up โœจ. It's not on by default, because figuring this out needs extra processing (the compiler is not doing allat for free, bestie). It's lowkey handy when you're prepping sets of header-units and you want to make sure the macros stay consistent.
  • -Wno-literal-suffix (C++ and Objective-C++ only) โ€” tells GCC not to warn when a string or character literal is followed by a ud-suffix that doesn't start with an underscore. As a conforming extension, GCC treats those suffixes as separate preprocessing tokens so that old code using formatting macros from <inttypes.h> keeps working. 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. And why do we care? Because 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 get diagnosed by default, because the standard said so. A narrowing conversion from a constant produces an error, and a narrowing conversion from a non-constant produces a warning, but -Wno-narrowing just suppresses the diagnostic entirely. Note that this does not affect the meaning of well-formed code; narrowing conversions are still considered ill-formed in SFINAE contexts. No cap.

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) โ€” warns 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. The compiler knows things, okay? ๐Ÿ”ฅ
  • -Wnoexcept-type (C++ and Objective-C++ only) โ€” warns 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.

For 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) โ€” warns when the destination of a call to a raw memory function like 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) โ€” warns 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. Prefer the glow-up option, bestie ๐Ÿ’…
  • -Wregister (C++ and Objective-C++ only) โ€” warns 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) โ€” warns when the order of member initializers given in the code does not match the order in which they must be executed. For instance:
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, emitting a warning to that effect. This warning is enabled by -Wall.

  • -Wno-pessimizing-move (C++ and Objective-C++ only) โ€” this warning warns when a call to std::move prevents copy elision. A typical scenario when copy elision can occur is when returning in a function with a class return type, when the expression being returned is the name of a non-volatile automatic object, and is not a function parameter, and has the same type as the function return type.
struct T {
...
};
T fn()
{
  T t;
  ...
  return std::move (t);
}

But in this example, the std::move call prevents copy elision. Not the move being helpful, it's giving sabotage ๐Ÿ˜ญ

This warning is enabled by -Wall.

  • -Wno-redundant-move (C++ and Objective-C++ only) โ€” this warning warns about redundant calls to std::move; that is, when a move operation would have been performed even without the std::move call. This happens because the compiler is forced to treat the object as if it were an rvalue in certain situations such as returning a local variable, where copy elision isn't applicable. Consider:
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 warning warns when a C++ range-based for-loop is creating an unnecessary copy. This can happen when the range declaration is not a reference, but probably should be. For example:
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. Every. Single. Iteration. ๐Ÿ’€

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, like, one of the effective C++ recommendations bestie ๐Ÿ’…. BUT the check gets extended โ€” it also warns you when an accessible non-polymorphic base class is missing a virtual destructor. So it's giving extra thorough, no cap.

Fair warning โœ‹: when you pick this option, know that the standard library headers do NOT obey all these guidelines. So use grep -v to filter out those warnings, or you'll be drowning in them ๐Ÿ˜ญ.

  • -Wno-exceptions (C++ and Objective-C++ only) โ€” turns off the warning for when an exception handler gets shadowed by another handler ๐Ÿ™ˆ. That kind of shadowing can literally point out that your exception handlers are in the wrong order, so it's a real one.
  • -Wsfinae-incomplete (C++ and Objective-C++ only) โ€” warns about a class that's found to be incomplete, OR a function with auto return type whose return type hasn't been deduced yet, in a context where that causes substitution failure instead of an error โ€” and then the class or function gets defined later in the translation unit ๐Ÿซ . Why is this a problem? Because template instantiations or concept checks could have different results depending on whether they first occur before or after the definition. Messy.

This warning is enabled by default โœจ. And -Wsfinae-incomplete=2 adds a warning right at the point of substitution failure, which makes it way easier to track down the problems the default mode flagged ๐Ÿ‘‘

  • -Wstrict-null-sentinel (C++ and Objective-C++ only) โ€” warns about using an uncasted "NULL" as a sentinel ๐Ÿ‘€. When you compile only with GCC, this is a valid sentinel, because "NULL" is defined as "__null". And even though it's a null pointer constant and not an actual null pointer, it's guaranteed to be the same size as a pointer ๐Ÿ’…. BUT โ€” this use is not portable across different compilers. So iykyk.
  • -Wno-non-c-typedef-for-linkage (C++ and Objective-C++ only) โ€” disables the pedwarn for unnamed classes with a typedef name for linkage purposes that contain C++ specific members, base classes, default member initializers, or lambda expressions โ€” including those on nested member classes ๐ŸŽ€.
typedef struct {
  int a; // non-static data members are ok
  struct T { int b; }; // member classes too
  enum E { E1, E2, E3 }; // member enumerations as well
  int c = 42; // default member initializers are not ok
  struct U : A { int c; }; // classes with base classes are not ok
  typedef int V; // typedef is not ok
  using W = int; // using declaration is not ok
  decltype([](){}) x; // lambda expressions not ok
} S;

In all of these cases, the tag name S should be added after the struct keyword. Periodt.

  • -Wno-non-template-friend (C++ and Objective-C++ only) โ€” disables warnings when non-template friend functions are declared inside a template ๐ŸŒธ. Back in very old versions of GCC that predate the ISO standard implementation, declarations like friend int foo(int), where the friend's name is an unqualified-id, could be interpreted as a particular specialization of a template function ๐Ÿ˜ต. The warning exists to diagnose those compatibility problems โ€” and it's enabled by default.
  • -Wold-style-cast (C++ and Objective-C++ only) โ€” warns when an old-style (C-style) cast to a non-void type is used inside 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 aren't 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. And 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 into a plain pointer ๐Ÿ™ˆ.
  • -Wsign-promo (C++ and Objective-C++ only) โ€” warns when overload resolution picks 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. So, standards said so ๐Ÿ’….
  • -Wtemplates (C++ and Objective-C++ only) โ€” warns when a primary template declaration is encountered ๐ŸŽ€. Some coding rules disallow templates, and this can be used to enforce that rule. The warning is inactive inside a system header file, like the STL, so you can still use the STL ๐Ÿฆ‹. You 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
}

The related option -Wmismatched-dealloc diagnoses mismatches involving allocation and deallocation functions other than "operator new" and "operator delete" ๐Ÿ’œ.

-Wmismatched-new-delete is included in -Wall โœจ.

  • -Wmismatched-tags (C++ and Objective-C++ only) โ€” warns for declarations of structs, classes, and class templates and their specializations with a class-key that doesn't match either the definition or the first declaration if no definition is provided ๐Ÿ‘€.

For example, the declaration of "struct Object" in the argument list of "draw" triggers the warning. To avoid it, either remove the redundant class-key "struct" or replace it with "class" to match its definition:

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

It is not wrong to declare a class with the class-key "struct" as the example above shows. The -Wmismatched-tags option is intended to help achieve a consistent style of class declarations ๐ŸŽ€. In code that's meant to be portable to Windows-based compilers, the warning helps prevent unresolved references due to the difference in the mangling of symbols declared with different class-keys ๐ŸŒธ. The option can be used either on its own or in conjunction with -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 may be used to enforce that rule. The warning is inactive inside a system header file, like the STL, so you can still use the STL ๐Ÿฆ‹. You may also define classes that indirectly use multiple inheritance.
  • -Wvirtual-inheritance โ€” warns when a class is defined with a virtual direct base class โœจ. Some coding rules disallow multiple inheritance, and this may be used to enforce that rule. The warning is inactive inside a system header file, like the STL, so you can still use the STL ๐ŸŒˆ. 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 because 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 may be used to enforce that rule. The warning is inactive inside a system header file, like the STL, so you can still use the STL ๐Ÿฆ‹. You may also use using directives and qualified names.
  • -Wno-template-body (C++ and Objective-C++ only) โ€” disables diagnosing errors when parsing a template, and instead issues an error only upon instantiation of the template ๐Ÿ‘€. This flag can also be used to downgrade such errors into warnings with Wno-error= or -fpermissive.
  • -Wno-template-id-cdtor (C++ and Objective-C++ only) โ€” disables the warning about the use of simple-template-id as the declarator-id of a constructor or destructor, which became invalid in C++20 via DR 2237 ๐Ÿšจ. For example:
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 โœจ.

  • -Wtemplate-names-tu-local โ€” bestie, this one yells at you when a template body is hiding an exposure of a translation-unit-local entity. So like, usually referring to a translation-unit-local entity (think: an internal linkage declaration) inside something that gets emitted into a module's CMI? That's an error. But plot twist โ€” inside the initializer of a variable, or in the body of a non-inline function, that's not an exposure, so no error, no drama. ๐Ÿ’…

Why do we care tho? Because this can make variable or function templates accidentally become unusable if they reference such an entity โ€” other translation units that import the template will literally never be able to instantiate it. ๐Ÿ˜ญ This warning tries to catch cases where that might happen. And if you have an explicit instantiation? The warning goes silent. Periodt.

This flag is enabled by -Wextra.

  • -Wno-expose-global-module-tu-local โ€” okay so exposing a translation-unit-local entity from a module interface is invalid, because it may cause ODR violations and show up as link errors or other unexpected behaviour. The audacity. ๐Ÿ™ˆ BUT โ€” so many existing libraries declare TU-local entities in their interface, and dodging those exposures can be genuinely hard sometimes.

As an extension, GCC allows exposures of internal variables and functions that were declared in the global module fragment. This warning tells you when such an invalid exposure has happened, and you can silence it using diagnostic pragmas โ€” either at the site of the exposure, or at the point of declaration of the internal declaration. This also applies to export using declarations naming such entities. โœจ

When you combine it with -Wtemplate-names-tu-local, GCC will also warn about non-exposure references to TU-local entities in template bodies. Those templates can still be instantiated in other TUs, but the above risks regarding exposures of translation-unit-local entities still apply.

This warning is enabled by default, and is upgraded to an error by -pedantic-errors.

  • -Wno-external-tu-local โ€” warns when you name a TU-local entity outside of the translation unit it was declared in. Such declarations get ignored during name lookup. This can happen when performing ADL from a template declared in the same TU as the internal function:
export module M;
template <typename T> void foo(T t) {
  bar(t);
}
struct S {} s;
static void bar(S) {}  // internal linkage

// instantiating foo(s) from outside this TU can see ::bar,
// but naming it there is ill-formed.

You can work around this by making bar attached to the global module, using extern "C++". ๐Ÿซถ

This warning is enabled by default, and is upgraded to an error by -pedantic-errors.

  • -Wno-terminate (C++ and Objective-C++ only) โ€” disables the warning about a throw-expression that will immediately result in a call to terminate. bye bestie ๐Ÿ’€
  • -Wno-vexing-parse (C++ and Objective-C++ only) โ€” warns about the most vexing parse syntactic ambiguity. The way that a declaration can look like a variable definition but the C++ language requires it to be interpreted as a function declaration?? iconic cursed behaviour honestly. 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 โ€” like, it can suggest removing the parentheses or using braces instead. so helpful fr fr.

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. Because such a conversion function will never be called. it's giving useless, no cap. ๐Ÿ“
  • -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
    • structured bindings of a volatile-qualified type

This usage was deprecated in C++20. ๐Ÿ’€

Enabled by default with -std=c++20. Before -std=c++20, enabled with explicit -Wdeprecated.

  • -Waligned-new
  • -Waligned-new=[none|global|all] โ€” warns about a new-expression of a type that requires greater alignment than the 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. so thorough, we love to see it.

  • -Wno-placement-new
  • -Wplacement-new=n โ€” warns about placement new expressions with undefined behavior, like constructing an object in a buffer that's smaller than the type of the object. The disrespect!! ๐Ÿ˜ญ For example, the placement new expression below gets 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. 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.
  • -Wno-defaulted-function-deleted (C++ and Objective-C++ only) โ€” warns when an explicitly defaulted function is deleted by the compiler. That can occur when the function's declared type does not match the type of the function that would have been implicitly declared. This warning is enabled by default. ๐Ÿ˜ญ
  • -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. There are various contexts in which an extra semicolon can occur. One is a semicolon after in-class function definitions, which is valid in all C++ dialects (and is never a pedwarn):
struct S {
  void foo () {};
};

Another is an extra semicolon at namespace scope, which has been allowed since C++11 (therefore is a pedwarn in C++98):

struct S {
};
;

And yet another is an extra semicolon in class definitions, which has been allowed since C++11 (therefore is a pedwarn in C++98):

struct S {
  int a;
  ;
};
  • -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. rude of it, honestly. ๐ŸŽ€
  • -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. main character energy, choosing chaos. ๐ŸŒˆ

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 โ€” Warn about types with virtual methods where code quality would be improved if the type were declared with the C++11 "final" specifier, or, if possible, declared in an anonymous namespace. This allows GCC to more aggressively devirtualize the polymorphic calls. This warning is more effective with link-time optimization, where the information about the class hierarchy graph is more complete.
  • -Wsuggest-final-methods โ€” Warn about virtual methods 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. This warning is more effective with link-time optimization, where the information about the class hierarchy graph is more complete. It is recommended to first consider suggestions of -Wsuggest-final-types and then rebuild with new annotations.
  • -Wsuggest-override โ€” Warn about overriding virtual functions that are not marked with the "override" keyword.
  • -Wno-conversion-null (C++ and Objective-C++ only) โ€” Do not warn for conversions between NULL and non-pointer types. -Wconversion-null is enabled by default.

โœจ Options Controlling Objective-C and Objective-C++ Dialects โœจ

(NOTE: This manual does not describe the Objective-C and Objective-C++ languages themselves.

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

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

  • -fobjc-direct-dispatch โ€” Allow fast jumps to the message dispatcher. On Darwin this is accomplished via the comm page.
  • -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.
  • -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.
  • -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.
  • -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.
  • -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.
  • -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.
  • -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.
  • -Wobjc-root-class <span style="color:hotpink">(Objective-C and Objective-C++ only, bestie)</span> โ€” warns you if a class interface is out here with no superclass ๐Ÿ’€. Like, most classes are gonna inherit from NSObject (or Object, yk), so that's the norm. But if you're intentionally declaring a root class? Just mark the interface with __attribute__((objc_root_class)) and the warning goes bye-bye โœจ.
  • -Wselector <span style="color:hotpink">(Objective-C and Objective-C++ only)</span> โ€” warns you when the compiler finds multiple methods of different types hanging out under the same selector during compilation ๐Ÿ‘€. The check happens on the list of methods in the final stage of compilation. It also runs a check for every selector that shows up in a @selector(...) expression, if a matching method for it got found during compilation. But here's the tea ๐Ÿซ– โ€” because these checks only scan the method table at the very end of compilation, you get no warnings at all if the final stage never happens. Like if an error pops up earlier, or you're using -fsyntax-only. So basically, no final stage, no vibes check.
  • -Wstrict-selector-match <span style="color:hotpink">(Objective-C and Objective-C++ only)</span> โ€” warns if there are multiple methods with different argument and/or return types for a given selector, when you try to send a message with that selector to a receiver of type id or Class. And when this flag is off (which is the default, lowkey), the compiler just skips those warnings if the differences it found are all confined to types that share the same size and alignment ๐Ÿค.
  • -Wundeclared-selector <span style="color:hotpink">(Objective-C and Objective-C++ only)</span> โ€” warns if a @selector(...) expression is referring to a selector that was never declared ๐Ÿ˜ญ. A selector counts as undeclared if no method with that name got declared before the @selector(...) expression โ€” either explicitly in an @interface or @protocol declaration, or implicitly in an @implementation section. And this option is on immediate mode: it does its checks the second it finds a @selector(...) expression, whereas -Wselector waits until the final stage of compilation ๐Ÿข. It also enforces the coding style convention that methods and selectors have to be declared before you use them. Periodt ๐Ÿ’….
  • -print-objc-runtime-info โ€” generates a C header describing the largest structure that's passed by value, if there even is one ๐Ÿ“.

Options Controlling OpenMP and OpenACC ๐Ÿงตโœจ

GCC supports OpenMP extensions to C, C++, and Fortran with the -fopenmp option ๐Ÿ’–. And similarly, OpenACC extensions are supported in all three languages with -fopenacc. Slay.

  • -foffload=disable
  • -foffload=default
  • -foffload=target-list โ€” tells the compiler which OpenMP and OpenACC offload targets it should generate code for ๐ŸŽฏ. The default behavior (which is the same as -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 comma-separated list of offload targets you specify.

Offload targets get specified in GCC's internal target-triplet format, iykyk. You can run the compiler with -v to show the list of configured offload targets under OFFLOAD_TARGET_NAMES ๐Ÿ‘€.

  • -foffload-options=options
  • -foffload-options=target-triplet-list=options โ€” with -foffload-options=options, GCC passes the options you gave to the compilers for all enabled offloading targets ๐Ÿ“ข. You can scope options to just one specific target (or a few) 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 โ€” enables handling of OpenACC directives #pragma acc in C/C++ and !$acc in free-form Fortran, plus !$acc, c$acc and *$acc in fixed-form Fortran ๐ŸŒŠ. This option implies -pthread, and therefore it's only supported on targets that have support for -pthread. No pthread, no OpenACC, sorry bestie ๐Ÿ˜”.
  • -fopenacc-dim=geom โ€” specifies default compute dimensions for parallel offload regions that don't explicitly specify them ๐Ÿ“. The geom value is a triple of :-separated sizes, in order: <span style="color:purple">gang</span>, <span style="color:purple">worker</span>, and <span style="color:purple">vector</span>. A size can be omitted, and then a target-specific default value gets used ๐ŸŽ€.
  • -fopenmp โ€” enables handling of OpenMP directives #pragma omp, [[omp::decl(...)]], [[omp::directive(...)]], and [[omp::sequence(...)]] in C/C++ ๐Ÿ”ฅ. In Fortran, it enables !$omp and the conditional compilation sentinel !$. In fixed source form Fortran, those sentinels can also start with c or *.

This option implies -pthread, so again, only supported on targets that support -pthread. And -fopenmp implies -fopenmp-simd too ๐Ÿ‘‘.

  • -fopenmp-simd โ€” enables handling of OpenMP's simd, declare simd, declare reduction, assume, ordered, scan and loop directive, plus combined or composite directives with simd as a 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 just ignored, not today satan ๐Ÿ™ˆ. Unless -fopenmp is additionally specified, the loop region binds to the current task region, independent of the specified bind clause.
  • -fopenmp-target-simd-clone
  • -fopenmp-target-simd-clone=device-type โ€” on top of generating SIMD clones for functions marked with the declare simd directive, GCC also generates clones for functions marked with the OpenMP declare target directive that are suitable for vectorization when this option is in effect ๐Ÿงฌ. The device-type may be one of none, host, nohost, and any, which correspond to keywords for the device_type clause of the declare target directive; clones get generated for the intersection of devices specified. -fopenmp-target-simd-clone is equivalent to -fopenmp-target-simd-clone=any, and -fno-openmp-target-simd-clone is equivalent to -fopenmp-target-simd-clone=none.

At -O2 and higher (but not -Os or -Og), this optimization defaults to -fopenmp-target-simd-clone=nohost; otherwise it's disabled by default ๐ŸŽš๏ธ.


Options to Control Diagnostic Messages Formatting ๐Ÿ’ฌ๐ŸŽจ

So traditionally, diagnostic messages have been formatted with zero regard for the output device's aspect (like its width, and stuff ๐Ÿ™„). You can use the options below to control the formatting algorithm for diagnostic messages โ€” like how many characters per line, how often source location info should be reported, all of that. Note that some language front ends may just... not honor these options ๐Ÿ’€.

  • -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 shows up on a single line. That's the default for all front ends, no cap.
Heads up bestie โ€” 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 ๐Ÿซถ.
  • -fdiagnostics-plain-output โ€” requests that diagnostic output look as plain as possible ๐Ÿ˜, which can be useful when running dejagnu or other utilities that need to parse diagnostics output and prefer it to stay more stable over time. -fdiagnostics-plain-output is currently 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 -fno-diagnostics-show-event-links -fno-diagnostics-show-nesting. And in the future, if GCC changes the default appearance of its diagnostics, the corresponding option to disable the new behavior gets added to this list ๐Ÿ‘€.
  • -fdiagnostics-show-location=once โ€” only meaningful in line-wrapping mode ๐Ÿ“Ž. Tells the diagnostic messages reporter to emit source location info once; meaning, if a 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 on the subsequent continuation lines. This is the default behavior โœจ.
  • -fdiagnostics-show-location=every-line โ€” only meaningful in line-wrapping mode ๐Ÿ“Ž. Tells the diagnostic messages reporter to emit the same source location information (as a prefix) for the physical lines that result from breaking a message that's too long to fit on one line. Every line, every time ๐Ÿ’….
  • -fdiagnostics-color[=WHEN]
  • -fno-diagnostics-color โ€” use color in diagnostics ๐ŸŒˆ. WHEN is never, always, or auto. The default depends on how the compiler was configured, and 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 standard error is a terminal, and when it's 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 get interpreted by the terminal or terminal emulator. (See the section in the documentation of your text terminal for permitted values and their meanings as character attributes.) These substring values are integers in decimal representation and can be concatenated with semicolons. Common values to concatenate include 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\
highlight-a=01;32:highlight-b=01;34

so like, decoding that whole vibe: 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. If you set GCC_COLORS to the empty string, boom, colors are gone. โœจ And here's every capability you can mess with:

  • "error=" โ€” the SGR substring for error: markers.
  • "warning=" โ€” the SGR substring for warning: markers.
  • "note=" โ€” the SGR substring for note: markers.
  • "path=" โ€” the SGR substring for colorizing paths of control-flow events as printed via -fdiagnostics-path-format=, like the identifiers of individual events and the lines showing interprocedural calls and returns.
  • "range1=" โ€” the SGR substring for the first additional range.
  • "range2=" โ€” the SGR substring for the second additional range.
  • "locus=" โ€” the SGR substring for location info, like file:line or file:line:column etc.
  • "quote=" โ€” the SGR substring for info printed inside quotes.
  • "fnname=" โ€” the SGR substring for names of C++ functions.
  • "targs=" โ€” the SGR substring for C++ function template parameter bindings.
  • "fixit-insert=" โ€” the SGR substring for fix-it hints suggesting text to be inserted or replaced.
  • "fixit-delete=" โ€” the SGR substring for fix-it hints suggesting text to be deleted.
  • "diff-filename=" โ€” the SGR substring for filename headers within generated patches.
  • "diff-hunk=" โ€” the SGR substring for the starts of hunks within generated patches.
  • "diff-delete=" โ€” the SGR substring for deleted lines within generated patches.
  • "diff-insert=" โ€” the SGR substring for inserted lines within generated patches.
  • "type-diff=" โ€” the SGR substring for highlighting mismatching types within template arguments in the C++ frontend.
  • "valid=" โ€” the SGR substring for highlighting valid elements within text art diagrams.
  • "invalid=" โ€” the SGR substring for highlighting invalid elements within text art diagrams.
  • "highlight-a=", "highlight-b=" โ€” SGR substrings for contrasting two different things inside diagnostics, like a pair of mismatching types. Peep -fdiagnostics-show-highlight-colors for more.

๐Ÿฆ‹ -fdiagnostics-urls[=WHEN]

Bestie, this one embeds URLs right into your diagnostics using escape sequences. ๐Ÿซถ So like, when -fdiagnostics-show-option spits out text showing the command-line option that controls a diagnostic, GCC can embed a URL pointing at the docs for that option. Iconic.

WHEN is one of never, always, or auto. auto makes GCC use URL escape sequences only when the standard error is a terminal, and only when it's not running inside an emacs shell or any graphical terminal that's known to be incompatible with this feature โ€” see below. ๐Ÿ‘€

The default depends on how the compiler was 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 compiler's environment, or never if neither are. โœจ

But heads up โ€” even with -fdiagnostics-urls=always, the behavior still depends 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 isn't set, use TERM_URLS as a fallback. Note: ST is an ANSI escape sequence, string terminator ESC \, and BEL is an ASCII character, CTRL-G, that usually sounds like a beep. ๐Ÿ””

At this time GCC also tries to detect 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. You can skip this check with -fdiagnostics-urls=always.

๐Ÿ™ˆ -fno-diagnostics-show-option

By default, every 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.

-fno-diagnostics-show-caret

By default, every diagnostic emitted includes the original source line and a caret ^ indicating the column. This option suppresses that info. The source line gets truncated to n characters if the -fmessage-length=n option is given. When the output goes to the terminal, the width is limited to the width given by the COLUMNS environment variable or, if that's not set, to the terminal width.

-fno-diagnostics-show-labels

By default, when printing source code (via -fdiagnostics-show-caret), diagnostics can label ranges of source code with pertinent info, like the types of expressions:

            printf ("foo %s bar", long_i + long_j);
                         ~^       ~~~~~~~~~~~~~~~
                          |              |
                          char *         long int

This option suppresses the printing of these labels (in the example above, the vertical bars and the "char *" and "long int" text).

By default, when printing execution paths (via -fdiagnostics-path-format=inline-events), GCC will print lines connecting related events, like the line connecting events 1 and 2 in:

            3 |   if (p)
              |       ^
              |       |
              |       (1) following `false' branch (when `p' is NULL)... ->-+
              |                                                             |
              |                                                             |
              |+------------------------------------------------------------+
            4 ||    return 0;
            5 ||  return *p;
              ||         ~
              ||         |
              |+-------->(2) ...to here
              |          (3) dereference of NULL `p'

This option suppresses the printing of such connector lines. โœ‚๏ธ

-fno-diagnostics-show-cwe

Diagnostic messages can optionally have an associated [CWE](https://cwe.mitre.org/index.html) identifier. GCC itself only provides that kind of metadata for some of the -fanalyzer diagnostics. GCC plugins may also provide diagnostics with such metadata. By default, if this info is present, it gets printed with the diagnostic. This option suppresses the printing of this metadata.

-fno-diagnostics-show-rules

Diagnostic messages can optionally have rules associated with them, like from a coding standard or a specification. GCC itself doesn't do this for any of its diagnostics, but plugins may do so. By default, if this info is present, it gets printed with the diagnostic. This option suppresses the printing of this metadata.

-fno-diagnostics-show-highlight-colors

GCC can use color for emphasis and contrast when printing diagnostic messages and quoting your source. ๐ŸŒˆ

For example, in

        demo.c: In function `test_bad_format_string_args':
        ../../src/demo.c:25:18: warning: format `%i' expects argument of type `int', but argument 2 has type `const char *' [-Wformat=]
           25 |   printf("hello %i", msg);
              |                 ~^   ~~~
              |                  |   |
              |                  int const char *
              |                 %s
  • the %i and "int" in the message and the "int" in the quoted source are colored using "highlight-a" (bold green by default), and
  • the "const char *" in the message and in the quoted source are both colored using "highlight-b" (bold blue by default).

The intent is to draw your eyes to the relationships between the various aspects of the diagnostic message and the source, using color to group related elements and distinguish between mismatching ones. ๐Ÿ‘‘

This extra colorization is enabled by default if color printing is enabled (as per -fdiagnostics-color=), but it can be separately disabled via -fno-diagnostics-show-highlight-colors.

-fno-diagnostics-show-line-numbers

By default, when printing source code (via -fdiagnostics-show-caret), a left margin is printed showing line numbers. This option suppresses that left margin.

-fdiagnostics-minimum-margin-width=width

This option controls the minimum width of the left margin printed by -fdiagnostics-show-line-numbers. It defaults to 6.

-fdiagnostics-show-context[=depth] / -fno-diagnostics-show-context

With this option, the compiler might print the interesting control flow chain that guards the basic block of the statement which has the warning. depth is the maximum depth of the control flow chain. Currently, the list of the impacted warning options includes: -Warray-bounds, -Wstringop-overflow, -Wstringop-overread, -Wstringop-truncation, and -Wrestrict. More warning options might be added to this list in future releases. ๐Ÿ‘€ The forms -fdiagnostics-show-context and -fno-diagnostics-show-context are aliases for -fdiagnostics-show-context=1 and -fdiagnostics-show-context=0, respectively.

-fdiagnostics-parseable-fixits

Emit fix-it hints in a machine-parseable format, suitable for consumption by IDEs. For each fix-it, a line gets printed after the relevant diagnostic, starting with the string fix-it:. For example:

        fix-it:"test.c":{45:3-45:21}:"gtk_widget_show_all"

okay so the location is written as a half-open range โ€” think of it as a count of bytes, and the counting starts at byte 1 for that very first column. ๐Ÿ’… so in the little example up above, bytes 3 through 20 of line 45 of "test.c" are exactly the ones getting swapped out for the given string:

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

and bestie, the filename and the replacement string both do the escape thing: backslash becomes "\\", tab becomes "\t", newline becomes "\n", double quotes become "\"", and any non-printable characters get written as octal (so a vertical tab is "\013", cute right?). ๐ŸŽ€

if the replacement string is empty, that means the given range is justโ€ฆ gone, removed, deleted, evaporated. โœจ and if the range is empty (like 45:3-45:3), that means the string gets inserted at that exact position. slay.


  • -fdiagnostics-generate-patch โ€” prints fix-it hints to stderr in unified diff format, and it does this after any diagnostics are printed. it's giving patch file energy. for example:
--- test.c
+++ test.c
@ -42,5 +42,5 @

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

lowkey important: the diff may or may not be colorized, and it follows the exact same rules as diagnostics do (peep -fdiagnostics-color for that whole situation). ๐ŸŽจ

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

and when you turn this flag on, you get a whole tree-like structure showing which parts are common and which parts differ, like:

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

the parts that differ get highlighted with color ("double" and "float" in this case). so you can literally see the drama. ๐Ÿ˜ญ

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

but specifying the -fno-elide-type flag suppresses that behavior โ€” no more hiding the details, we're showing everything. and heads up: this flag also affects the output of the -fdiagnostics-show-template-tree flag. they're besties, they move together. ๐Ÿซถ

  • -fdiagnostics-path-format=KIND โ€” picks how to print paths of control-flow events for diagnostics that have such a path attached to them. KIND can be none, separate-events, or inline-events, and inline-events is the default. ๐Ÿ’…
    • none means: don't print diagnostic paths at all. silence, peace, nothing. ๐Ÿ™ˆ
    • separate-events means: print a separate "note" diagnostic for each event inside the diagnostic. for 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" right inside 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, those same events as above might come out looking like:

  '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

and interprocedural control flow gets shown by grouping the events by stack frame, using indentation to show how those stack frames are nested, pushed, and popped. so you can literally watch the call stack doing its thing. ๐Ÿ”ฅ

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 that come with a diagnostic. ๐Ÿซถ

if this option is provided, then 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. so much context, we love to see it.

this is intended for use by GCC developers and plugin developers when debugging diagnostics that report interprocedural control flow. 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. sometimes less is more, bestie.
  • -fdiagnostics-column-unit=UNIT โ€” picks the units for the column number. this affects traditional diagnostics (in the absence of -fno-show-column). ๐Ÿ“

the default UNIT, display, counts the number of display columns each character occupies. this can be bigger than the number of bytes needed to encode that character (tabs, looking at you), or it can be smaller (multibyte characters, hello). for example: the character "GREEK SMALL LETTER PI (U+03C0)" occupies one display column, and its UTF-8 encoding needs two bytes. meanwhile the character "SLIGHTLY SMILING FACE (U+1F642)" occupies two display columns, and its UTF-8 encoding needs four bytes. see? different. ๐Ÿ˜Œ

setting UNIT to byte changes the column number to the raw byte count in all cases, exactly the way GCC traditionally output it prior to version 11.1.0. throwback. โœจ

  • -fdiagnostics-column-origin=ORIGIN โ€” picks the origin for column numbers, i.e. which column number gets assigned to that first column. the default value of 1 matches traditional GCC behavior and also the GNU style guide (so it's giving very much "correct and proper"). some utilities might perform better with an origin of 0; any non-negative value may be specified. you do you. ๐Ÿ’…
  • -fdiagnostics-escape-format=FORMAT โ€” when GCC prints pertinent source lines for a diagnostic, it normally just tries to print the source bytes directly. but some diagnostics are about encoding issues in the source file โ€” malformed UTF-8, or issues with Unicode normalization, that kind of chaos. those diagnostics get flagged so GCC will escape any 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 will be displayed 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>, which shows you the underlying encoding of non-ASCII Unicode characters. for the example above, this is what gets printed:

before<CF><80><BF>after

no cap, that's the raw tea right there. ๐Ÿ“

  • -fdiagnostics-text-art-charset=CHARSET โ€” some diagnostics can contain "text art" diagrams: visualizations made out of text, meant 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 entirely.
  • the ascii value makes sure such diagrams are pure ASCII ("ASCII art"). retro vibes.
  • the unicode value allows for conservative use of unicode drawing characters (box-drawing characters and friends).
  • the emoji value goes even further and 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. so if your terminal is feeling plain, that's why. ๐Ÿ™ˆ

  • -fno-diagnostics-show-nesting โ€” bestie, some GCC diagnostics are lowkey shaped like a little tree ๐ŸŒณ of nested sub-diagnostics, especially when C++ templates are doing the absolute most during instantiation.

By default GCC uses indentation and bullet points in its text output to show that nesting structure, moves location info onto separate lines so the shape is clearer, and yeets redundant repeated info. Iconic behavior, honestly.

Choosing -fno-diagnostics-show-nesting suppresses that indentation, reformatting, and elision, restoring an older look for the diagnostics. It's giving retro, not necessarily giving better.

  • -fno-diagnostics-show-nesting-locations โ€” when fdiagnostics-show-nesting is enabled, file names and line- and column- numbers get displayed on separate lines from the messages. You can turn that location info off entirely with -fno-diagnostics-show-nesting-locations. This option exists for use by GCC developers, for writing DejaGnu test cases. No cap, it's a dev-tool thing ๐Ÿ’….
  • -fdiagnostics-show-nesting-levels โ€” when fdiagnostics-show-nesting is enabled, use fdiagnostics-show-nesting-levels to also display numbers showing the depth of the nesting. This option exists for use by GCC developers for debugging nested diagnostics, but may be of use to plugin authors. So if you're writing plugins, this one is for you ๐Ÿซถ.
  • -fdiagnostics-format=FORMAT โ€” select a different format for printing diagnostics. FORMAT is text, sarif-stderr or sarif-file.

Using this option replaces any additional "output sinks" added by -fdiagnostics-add-output=, or that set by -fdiagnostics-set-output=.

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. Very demure, very structured โœจ.

  • -fdiagnostics-add-output=DIAGNOSTICS-OUTPUT-SPEC โ€” add an additional "output sink" for emitting diagnostics.

DIAGNOSTICS-OUTPUT-SPEC should specify a scheme, optionally followed by : and one or more KEY=VALUE pairs, in this form:

<SCHEME>
<SCHEME>:<KEY>=<VALUE>
<SCHEME>:<KEY>=<VALUE>,<KEY2>=<VALUE2>

etc.

Schemes, keys, or values with a name prefixed experimental may change or be removed without notice. Keys can be per-scheme, or related to GCC as a whole.

SCHEME can be:

  • text โ€” emit diagnostics to stderr using GCC's classic text output format.

Supported keys for the text scheme are:

  • color=[yes|no] โ€” override colorization settings from -fdiagnostics-color for this text output.
  • show-nesting=[yes|no] โ€” enable a mode that emphasizes hierarchical relationships within diagnostics messages, as per -fdiagnostics-show-nesting. Defaults to yes.
  • show-nesting-locations=[yes|no] โ€” if show-nesting=yes, then by default locations are shown; set this key to no to disable printing such locations. This exists for use by GCC developers, for writing DejaGnu test cases.
  • show-nesting-levels=[yes|no] โ€” this is a debugging option for use with show-nesting=yes. Set this key to yes to print explicit nesting levels in the output. This exists for use by GCC developers.
  • sarif โ€” emit diagnostics to a file in SARIF format.

Supported keys for the sarif scheme are:

  • file=FILENAME โ€” specify the filename to write the SARIF output to, potentially with a leading absolute or relative path. If not specified, it defaults to source.sarif.
  • serialization=[json] โ€” specify the serialization format to use when writing out the SARIF. Currently this can only be json, but is present as an extension point for experimenting with other serializations.
  • version=[2.1|2.2-prerelease] โ€” specify the version of SARIF to use for the output. If not specified, defaults to 2.1. 2.2-prerelease uses an unofficial draft of the future SARIF 2.2 specification and should only be used for experimentation in this release.

There is also this key intended for use by GCC developers, rather than end-users, and subject to change or removal without notice:

  • state-graphs=[yes|no] โ€” this is a debugging feature and defaults to no. If state-graphs=yes, then attempt to capture detailed state information from -fanalyzer in the generated SARIF.
  • experimental-html โ€” emit diagnostics to a file in HTML format. This scheme is experimental, and may go away in future GCC releases. The keys and details of the output are also subject to change. ๐Ÿ™ˆ

Supported keys for the experimental-html scheme are:

  • css=[yes|no] โ€” add an embedded <style> to the generated HTML. Defaults to yes.
  • file=FILENAME โ€” specify the filename to write the HTML output to, potentially with a leading absolute or relative path. If not specified, it defaults to source.html.
  • javascript=[yes|no] โ€” add an embedded <script> to the generated HTML providing a barebones UI for viewing results. Defaults to yes.

There are also these keys intended for use by GCC developers, rather than end-users, and subject to change or removal without notice:

  • show-state-diagrams=[yes|no] โ€” this is a debugging feature and defaults to no. If show-state-diagrams=yes, then attempt to use dot to generate SVG diagrams in the generated HTML, visualizing the state at each event in a diagnostic path. These are visible by pressing j and k to single-step forward and backward through events. Enabling this option will slow down HTML generation.
  • show-graph-dot-src=[yes|no] โ€” this is a debugging feature and defaults to no. If show-graph-dot-src=yes then if show-state-diagrams=yes, the generated state diagrams will also show the .dot source input to GraphViz used for the diagram.
  • show-graph-sarif=[yes|no] โ€” this is a debugging feature and defaults to no. If show-graph-sarif=yes then if show-state-diagrams=yes, the generated state diagrams will also show a SARIF representation of the state.

As well as scheme-specific keys, the following GCC-related key is usable on sinks of any scheme:

  • cfgs=[yes|no] โ€” if cfgs=yes for a sink, then GCC will attempt to send information to that sink about the control flow graphs for the functions it is compiling. Text sinks ignore the information. SARIF sinks will add the graphs within theRun.graphs. HTML sinks will generate SVG displaying the graphs. The precise form of the information is subject to change without notice.

For example,

-fdiagnostics-add-output=sarif:version=2.1,file=foo.2.1.sarif
-fdiagnostics-add-output=sarif:version=2.2-prerelease,file=foo.2.2.sarif

would add a pair of outputs, each writing to a different file, using versions 2.1 and 2.2 of the SARIF standard respectively.

In EBNF:

<diagnostics-output-specifier> = <diagnostics-output-name>
                                   | <diagnostics-output-name>, ":", <key-value-pairs>;

<diagnostics-output-name> = "text" | "sarif" | "experimental-html";

<key-value-pairs> = <key-value-pair>
                      | <key-value-pair> "," <key-value-pairs>;

<key-value-pair> = <key> "=" <value>;

<key> = ? string without a '=' ? ;
<value> = ? string without a ',' ? ;
  • -fdiagnostics-set-output=DIAGNOSTICS-OUTPUT-SPEC โ€” this works in a similar way to -fdiagnostics-add-output= except that instead of adding an additional "output sink" for diagnostics, it replaces all existing output sinks, such as from -fdiagnostics-format=, -fdiagnostics-add-output=, or a prior call to -fdiagnostics-set-output=. It's giving "out with the old, in with the new" ๐Ÿ’….
  • -fno-diagnostics-json-formatting โ€” by default, when JSON is emitted for diagnostics (via -fdiagnostics-format=sarif-stderr or -fdiagnostics-format=sarif-file), GCC will add newlines and indentation to visually emphasize the hierarchical structure of the JSON.

Use -fno-diagnostics-json-formatting to suppress this whitespace. It must be passed before the option it is to affect.

This is intended for compatibility with tools that do not expect the output to contain newlines, such as that emitted by older GCC releases. So if your tool is dramatic about newlines, this is your bestie ๐Ÿซถ.


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. They're like your friend gently saying "bestieโ€ฆ maybe don't?" ๐ŸŽ€

The following language-independent options do not enable specific warnings but control the kinds of diagnostics produced by GCC.

  • -fsyntax-only โ€” check the code for syntax errors, but don't do anything beyond that. It's the vibe check of compilers: just look, no touch ๐Ÿ‘€.
  • -fmax-errors=n โ€” limits the maximum number of error messages to n, at which point GCC bails out rather than attempting to continue processing the source code. If n is 0 (the default), there is no limit on the number of error messages produced. If -Wfatal-errors is also specified, then -Wfatal-errors takes precedence over this option. So if you set both, -Wfatal-errors is the main character ๐Ÿ‘‘.
  • -w --no-warnings โ€” inhibit all warning messages. Not a single warning. Silence. ๐Ÿคซ
  • -Werror โ€” turn all warnings into errors. Every warning is now a problem. No more "it's just a warning" excuses, bestie ๐Ÿ’€.
  • -Werror= โ€” turn the specified warning into an error. The specifier for a warning is appended; for example -Werror=switch turns the warnings controlled by -Wswitch into errors. This switch takes a negative form, to be used to 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.)

Note that specifying -Werror=foo automatically implies -Wfoo. However, -Wno-error=foo does not imply anything. Asymmetrical, but that's the tea โ˜•.

  • -Wfatal-errors โ€” bestie, this is the impatient one ๐Ÿ’… the second the compiler hits an error it aborts compilation right there instead of trying to keep going and printing further error messages. One error, we're out, bye โœจ

okay so, big picture on warnings before we dive into the specific ones ๐Ÿซถ

You can request many specific warnings with options beginning with -W, for example -Wunused-variable to request warnings on declarations of variables that are never used. And every single one of these specific warning options also has a negative form beginning with -Wno- to turn off warnings โ€” for example -Wno-unused-variable. This manual lists only one of the two forms, whichever is not the default. (iykyk, they don't wanna waste space on the boring half ๐Ÿ˜Œ)

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, like -Wall and -Wextra, turn on other options, like -Wunused, which may turn on further options, like -Wunused-variable. It's giving nesting dolls ๐ŸŽ€

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. And options enabled or disabled via pragmas take effect as if they appeared at the end of the command line. Periodt.

When an unrecognized warning option is requested (e.g., -Wunknown-warning), GCC gives an error stating that the option is not recognized. ๐Ÿ’€

However โ€” plot twist โ€” 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. Honestly? Iconic backwards-compat move ๐ŸŒˆ

The effectiveness of some warnings depends on optimizations also being enabled. For example, -Wsuggest-final-types is more effective with link-time optimization. Some other warnings may not be issued at all unless optimization is enabled. While optimization in general improves the efficacy of warnings about control and data-flow problems, in some cases it may also cause false positives. ๐Ÿ™ˆ (the duality of compiler, fr fr)


  • -Wpedantic, -pedantic, --pedantic โ€” the strict-ISO hall monitor ๐Ÿ‘‘

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, --pedantic-errors โ€” same energy, but now it's an ERROR ๐Ÿ”ฅ

Give an error whenever the base standard (see -Wpedantic) requires a diagnostic, in some cases where there is undefined behavior at compile-time and in some other cases that do not prevent compilation of programs that are valid according to the standard. This is not equivalent to -Werror=pedantic: the latter option is unlikely to be useful, as it only makes errors of the diagnostics that are controlled by -Wpedantic, whereas this option also affects required diagnostics that are always enabled or controlled by options other than -Wpedantic.

If you want the required diagnostics that are warnings by default to be errors instead, but don't also want to enable the -Wpedantic diagnostics, you can specify -pedantic-errors -Wno-pedantic (or -pedantic-errors -Wno-error=pedantic to enable them but only as warnings).

Some required diagnostics are errors by default, but can be reduced to warnings using -fpermissive or their specific warning option, e.g. -Wno-error=narrowing.

Some diagnostics for non-ISO practices are controlled by specific warning options other than -Wpedantic, but are also made errors by -pedantic-errors. For instance:

  • -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 โ€” the "okay bestie, we'll let it slide" option ๐Ÿซถ

Downgrade some required diagnostics about nonconformant code from errors to warnings. Thus, using -fpermissive allows some nonconforming code to compile. Some C++ diagnostics are controlled only by this flag, but it also downgrades some C and C++ diagnostics that have their own flag:

  • -Wabbreviated-auto-in-template-arg (C++ and Objective-C++ only)
  • -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)
  • -Wtemplate-body (C++ and Objective-C++ only)

The -fpermissive option is the default for historic C language modes (-std=c89, -std=gnu89, -std=c90, -std=gnu90). old school, no rules, vibes only ๐Ÿ’€

  • -Wall, --all-warnings โ€” the main character of warning flags ๐Ÿ‘‘โœจ

This enables all the warnings about constructions that some users consider questionable, and that are easy to avoid (or modify to prevent the warning), even in conjunction with macros. This also enables some language-specific warnings described in 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

Note that some warning flags are not implied by -Wall. Some of them warn about constructions that users generally do not consider questionable, but which occasionally you might wish to check for; others warn about constructions that are necessary or hard to avoid in some cases, and there is no simple way to modify the code to suppress the warning. Some of them are enabled by -Wextra but many of them must be enabled individually. ๐Ÿ˜Œ

  • -Wextra, --extra-warnings โ€” the lil sequel to -Wall ๐ŸŽ€

This enables some extra warning flags that are not enabled by -Wall. (This option used to be called -W. The older name is still supported, but the newer name is more descriptive.) glow-up, honestly โœจ

โ€ฆand the list keeps going, bestie, because -Wextra is not done with you yet:

  • -Wabsolute-value โ€” only for C/ObjC โœจ
  • -Walloc-size ๐ŸŽ€
  • -Wcalloc-transposed-args ๐Ÿฆ‹
  • -Wcast-function-type ๐Ÿ’œ
  • -Wclobbered ๐ŸŒธ
  • -Wdangling-reference โ€” C++ only ๐Ÿ˜ญ
  • -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-name โ€” C/ObjC only ๐Ÿ“
  • -Wmissing-parameter-type โ€” C/ObjC only ๐Ÿงš
  • -Wold-style-declaration โ€” C/ObjC only ๐Ÿ’œ
  • -Wmultiple-parameter-fwd-decl-lists โ€” 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 ๐ŸŒˆ
  • -Wunterminated-string-initialization โ€” C/ObjC only โญ
  • -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)

Okay so this one is the ABI gossip girl ๐Ÿ’… It warns you about code that's affected by ABI changes. That includes code that might not play nice with the vendor-neutral C++ ABI, and the psABI for whatever particular target you're on. Those latter warnings are also controlled separately by -Wpsabi, which -Wabi implies. iykyk.

Since G++ now defaults to updating the ABI with each major release, normally -Wabi warns only 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. But -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.

ngl bestie, even though 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. And there may also be cases where warnings are emitted even though the code that is generated is compatible. It's giving "we tried our best." ๐Ÿ˜ญ

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 mangling a function type with function-cv-qualifiers, the un-qualified function type was incorrectly treated as a substitution candidate.

This was fixed in -fabi-version=8, the default for GCC 5.1.

  • decltype(nullptr) incorrectly had an alignment of 1, leading to unaligned accesses. Note that this did not affect the ABI of a function with a nullptr_t parameter, as parameters have a minimum alignment.

This was fixed in -fabi-version=9, the default for GCC 5.2.

  • Target-specific attributes that affect the identity of a type, such as ia32 calling conventions on a function type (stdcall, regparm, etc.), did not affect the mangled name, leading to name collisions when function pointers were used as template arguments.

This was fixed in -fabi-version=10, the default for GCC 6.1.


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

-Wpsabi enables warnings about processor-specific ABI changes, like changes in alignment requirements or how function arguments are passed. ๐Ÿ‘€ On several targets โ€” including AArch64, ARM, x86, MIPS, RS6000/PowerPC, and S/390 โ€” these details have changed between different versions of GCC and/or different versions of the C or C++ language standards in ways that affect binary compatibility of compiled code. With -Wpsabi, GCC can detect potentially incompatible usages and warn you about them. iconic behaviour fr.

-Wpsabi is enabled by default, and is also implied by -Wabi. ๐Ÿ’…


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

Warn if an array subscript has type char. This is a common cause of error, as programmers often forget that this type is signed on some machines. ๐Ÿ˜ญ @xref{Characters implementation}, and char type signedness.

This warning is enabled by -Wall. When enabled, the warning is given regardless of whether char is unsigned by default on the target, and it is also not affected by the -fsigned-char or -funsigned-char options. ๐Ÿ’…


-Wno-coverage-mismatch

Warn if feedback profiles do not match when 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 cannot 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

Warn if -fcondition-coverage is used and an expression have too many terms and GCC gives up coverage. Coverage is given up when there are more terms in the conditional than there are bits in a gcov_type_unsigned. This warning is enabled by default. โœจ


-Wno-coverage-too-many-paths

Warn if -fpath-coverage is used and a function has too many paths and GCC gives up coverage. Giving up is controlled by -fpath-coverage-limit. This warning is enabled by default. ๐ŸŒˆ


-Wno-coverage-invalid-line-number

Warn in case a function ends earlier than it begins due to an invalid linenum macros. The warning is emitted only with --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)

Suppress warning messages emitted by #warning directives. ๐Ÿคซ


-Wdouble-promotion (C, C++, Objective-C and Objective-C++ only)

Give 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 is 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. not the sneaky literal catching you off guard ๐Ÿ˜ญ


-Wduplicate-decl-specifier (C and Objective-C only)

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


  • -Wformat, -Wformat=n โ€” bestie this one is the format-string bodyguard ๐Ÿ’… it checks your calls to printf and scanf and friends to make sure the arguments you hand over actually have types that fit the format string you wrote, and that the conversions in that format string even make sense. That covers the standard functions plus anything with format attributes, across the printf, scanf, strftime and strfmon families (yes strfmon is an X/Open extension, not in the C standard, iykyk) โ€” or other target-specific families. Which functions get checked without you having specified format attributes depends on the standard version you picked, and those attribute-less checks get switched off by -ffreestanding or -fno-builtin.

The formats are checked against the format features that GNU libc version 2.2 supports โœจ that's all of ISO C90 and C99, plus stuff from the Single Unix Specification and some BSD and GNU extensions. Other library implementations might not support all of it, and GCC will not warn you about features that go beyond a particular library's limits. That said, if you use -Wpedantic together with -Wformat, you do get warnings about format features that aren't in the standard version you selected โ€” just not for strfmon formats, because those aren't in any version of the C standard, periodt.

  • -Wformat=1, -Wformat โ€” okay so -Wformat is literally the same as -Wformat=1, and -Wno-format is the same as -Wformat=0. And because -Wformat also checks for null format arguments on several functions, it also implies -Wnonnull. Some bits of this level of checking can be turned off with: -Wno-format-contains-nul, -Wno-format-diag, -Wno-format-extra-args, and -Wno-format-zero-length. Oh and -Wformat is enabled by -Wall ๐ŸŽ€
  • -Wformat=2 โ€” turns on -Wformat plus extra checks. Right now it's equivalent to -Wformat -Wformat-nonliteral -Wformat-security -Wformat-y2k. The whole combo meal, no cap.
  • -Wno-format-contains-nul โ€” if -Wformat is on, this stops the warnings about format strings that contain NUL bytes.
  • -Wno-format-diag โ€” if -Wformat is on, this stops the warnings about format strings that just aren't suitable for GCC diagnostics.
  • -Wno-format-extra-args โ€” if -Wformat is on, this stops warnings about extra arguments to a printf or scanf format function. The C standard says those extra args just get ignored anyway ๐Ÿซถ

But here's the tea: when the unused arguments sit between used arguments that use $ operand number specifications, warnings are normally still given, because the implementation can't know what type to pass to va_arg to skip over them. However, for scanf formats this option suppresses the warning if all the unused arguments are pointers, since the Single Unix Specification says those unused arguments are allowed. Slay, a loophole.

  • -Wformat-overflow, -Wformat-overflow=level โ€” warns about calls to formatted I/O functions like sprintf and vsprintf that might overflow the destination buffer ๐Ÿ˜ญ when the exact number of bytes written by a format directive can't be figured out at compile-time, it gets estimated with heuristics that depend on the level argument and on optimization. Turning optimization on usually makes the warning more accurate, but it can also cause false positives. Vibe check accordingly.
    • -Wformat-overflow, -Wformat-overflow=1 โ€” level 1, the one -Wformat enables, plays it safe and only warns about calls that most likely overflow the buffer. At this level, numeric arguments with unknown values are assumed to be one, and strings of unknown length are assumed to be empty. Numeric arguments known to be bounded to a subrange of their type, or string arguments whose output is bounded either by the directive's precision or by a finite set of string literals, are assumed to take the value in the range that produces the most bytes on output. For example, the sprintf call below gets diagnosed because even with both a and b equal to zero, the terminating NUL character ('\0') that the function appends to the destination buffer will be written past its end. Bumping the buffer size by a single byte is enough to dodge the warning โ€” though it may not be enough to dodge the actual overflow ๐Ÿ‘€
void f (int a, int b)
{
  char buf [13];
  sprintf (buf, "a = %i, b = %i\n", a, b);
}
  • -Wformat-overflow=2 โ€” level 2 also warns 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 can't be assumed bounded โ€” neither by the directive's precision, nor by a finite set of string literals they might evaluate to, nor by the character array they might point to โ€” are assumed to be 1 character long.

At level 2, the call in the example above gets diagnosed again, but this time because with a equal to a 32-bit INT_MIN the first %i directive writes some of its digits past the end of the destination buffer. To make the call safe no matter what those two variables are, the destination buffer has to be at least 34 bytes. GCC even includes the minimum buffer size in an informational note after the warning ๐Ÿฅฐ

An alternative to growing the buffer is to constrain the range of formatted values. You can bound the maximum length of string arguments by specifying the precision in the format directive. And when numeric arguments can be assumed bounded by less than the precision of their type, picking an appropriate length modifier for the format specifier shrinks 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 brings the maximum required buffer size down 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 on, this stops warnings about zero-length formats. And fr fr, the C standard says zero-length formats are allowed, so it's fine.
  • -Wformat-nonliteral โ€” if -Wformat is on, also warn when the format string isn't a string literal and therefore can't be checked โ€” unless the format function takes its format arguments as a va_list.
  • -Wformat-security โ€” if -Wformat is on, also warn about uses of format functions that could be security problems ๐Ÿšจ right now this warns about calls to printf and scanf functions where the format string isn't a string literal and there are no format arguments, like printf (foo);. That can be a security hole if the format string came from untrusted input and contains %n. (Currently this is a subset of what -Wformat-nonliteral warns about, but future warnings may get added to -Wformat-security that aren't in -Wformat-nonliteral.) Iconic behaviour, honestly.
  • -Wformat-signedness โ€” if -Wformat is on, also warn when the format string wants an unsigned argument and the argument is signed, and vice versa. The way it catches the sign flip ๐Ÿ’…
  • -Wformat-truncation, -Wformat-truncation=level โ€” warns about calls to formatted I/O functions like snprintf and vsnprintf that might truncate the output ๐Ÿ˜ญ when the exact number of bytes written by a format directive can't be determined at compile-time, it's estimated with heuristics depending on the level argument and on optimization. Turning optimization on usually makes the warning more accurate but can also cause false positives. Except where noted otherwise, this option uses the same logic as -Wformat-overflow.
    • -Wformat-truncation, -Wformat-truncation=1 โ€” level 1, the one -Wformat enables, plays it safe and only warns about calls to bounded functions whose return value is unused and that will most likely truncate the output.
    • -Wformat-truncation=2 โ€” level 2 also warns about calls to bounded functions whose return value is used and that might truncate given an argument of sufficient length or magnitude. The glow-up.
  • -Wformat-y2k โ€” if -Wformat is on, also warn about strftime formats that may only yield a two-digit year. Not the millennium bug catching us lacking again ๐Ÿ™ˆ
  • -Wnonnull โ€” warns 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 -Wno-nonnull.

  • -Wnonnull-compare โ€” warns when you compare an argument marked with the nonnull function attribute against null inside the function. Bestie it literally said it can't be null, why are we checking ๐Ÿ˜ญ

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

  • -Wnull-dereference โ€” warns if the compiler spots paths that trigger erroneous or undefined behavior by dereferencing a null pointer ๐Ÿ’€ this option is only active when -fdelete-null-pointer-checks is active, which is enabled by optimizations in most targets. How precise the warnings are depends on the optimization options you used.
  • -Wno-musttail-local-addr โ€” stops the warnings about passing a pointer (or in C++, a reference) to a local variable or label as an argument of a musttail call. Those variables go out of scope before the tail call instruction, so it's giving harmless.
  • -Wmaybe-musttail-local-addr โ€” warns when the address of a local variable can escape into a musttail call, unless it already goes out of scope before that musttail call.
int foo (int *);
int
bar (int *x)
{
  if (x[0] == 1)
    {
      int a = 42;
      foo (&a);
      /* Without the musttail attribute this call would not
         be tail called, because address of the a variable escapes
         and the second foo call could dereference it.  With the attribute
         the local variables are assumed to go out of scope immediately
         before the tail call instruction and the compiler warns about
         this.  */
      [[gnu::musttail]] return foo (nullptr);
    }
  else
    {
      {
        int a = 42;
        foo (&a);
      }
      /* The a variable isn't already in scope, so even when it
         escaped, even without musttail attribute it would be
         undefined behavior to dereference it and the compiler could
         turn this into a tail call.  No warning is diagnosed here.  */
      [[gnu::musttail]] return foo (nullptr);
    }
}

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


-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. iykyk ๐Ÿฆ‹

For instance, in the example below the compiler cannot elide copies from both v1 and v2, so it elides neither. it's giving "we tried and failed, bestie" ๐Ÿ˜ญ

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


-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. they're a package deal, fr fr ๐ŸŽ€

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.


-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. short and sweet ๐Ÿ’…


-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 and C23 provide 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. glow up, bestie โœจ

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. gone, deleted, no more ๐Ÿ‘‹
  • -Wimplicit-fallthrough=1 โ€” matches .* regular expression, any comment is used as fallthrough comment. free-for-all energy
  • -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:
    • -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]*)?
  • -Wimplicit-fallthrough=4 โ€” case sensitively matches one of the following regular expressions:
    • -fallthrough
    • @fallthrough@
    • lint -fallthrough[ \t]*
    • [ \t]*FALLTHR(OUGH|U)[ \t]*
  • -Wimplicit-fallthrough=5 โ€” doesn't recognize any comments as fallthrough comments, only attributes disable the warning. strict mode activated ๐Ÿ˜ค

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)

Control if warnings triggered by the warn_if_not_aligned attribute should be issued. These warnings are enabled by default. โœจ


-Wignored-qualifiers ๐Ÿท๏ธ (C and C++ only)

Warn if the return type of a function has a type qualifier such as const. For ISO C such a type qualifier has no effect, since the value returned by a function is not an lvalue. it literally does nothing, bestie ๐Ÿ’€

For C++, the warning is only emitted for scalar types or void. ISO C prohibits qualified void return types on function definitions, so such 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 option controls warnings when an attribute is ignored. This is 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 ๐ŸŽฌ

Warn 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. main character energy, literally ๐Ÿ‘‘

This warning is enabled by default in C++ and is enabled by either -Wall or -Wpedantic.

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


-Wmisleading-indentation ๐Ÿซฃ (C and C++ only)

Warn 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. the code is lying to your eyeballs, bestie ๐Ÿ˜ญ

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). tabs vs spaces, the eternal war ๐Ÿ’…

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

okay so real talk โ€” this warning does not get issued after a #line directive, because that's basically the universal signal for "bestie, this code was generated by a machine, don't @ me", and fr you can't make any assumptions about the layout of the file that the directive points to. This warning is enabled by -Wall in C and C++. ๐Ÿซถ

  • -Wmissing-attributes โ€” warns when a function declaration is missing one or more attributes that a related function is declared with, and whose absence could lowkey mess with the correctness or efficiency of the generated code. For example, the warning fires for declarations of aliases that use attributes to specify less restrictive requirements than their targets do. Honestly? That's usually a potential optimization opportunity sitting right there. By contrast, the -Wattribute-alias=2 option handles warnings issued when the alias is more restrictive than the target, which could lead to incorrect code generation. ๐Ÿ‘€ The attributes it considers include alloc_align, alloc_size, cold, const, hot, leaf, malloc, nonnull, noreturn, nothrow, pure, returns_nonnull, and returns_twice.

In C++, the warning fires 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, suppress, slay.)

And btw, you can use the copy attribute to slap the same set of attributes onto a declaration as another declaration has, without explicitly listing every single attribute out. This attribute can be applied to declarations of functions, variables, or types. See Common Attributes. โœจ

-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 gets diagnosed, because it's 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 isn't fully bracketed. In the example below, the initializer for a is not fully bracketed, but the one 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 doesn't exist. ๐Ÿซฅ This option is disabled by default for C, C++, Objective-C and Objective-C++. For Fortran, it's partially enabled by default, only warning for -I and -J. (just those two, bestie, that's it.)
  • -Wno-missing-profile โ€” this one controls warnings about missing feedback profiles when you're using the -fprofile-use option. It diagnoses those cases where a brand-new function or a brand-new file got added between compiling with -fprofile-generate and compiling with -fprofile-use, without regenerating the profiles. In those cases, the profile feedback data files literally don't contain any profile feedback info for the newly added function or file respectively. Also, when profile count data (.gcda) files get removed, GCC can't use any profile feedback information at all. In all these cases, warnings get issued to let you know that a profile generation step is due, bestie. ๐Ÿšจ Ignoring the warning can result in poorly optimized code, no cap. You can use -Wno-missing-profile to disable the warning, but this is not recommended โ€” only do it when non-existent profile data is justified.
seriously, don't just silence this one for the vibes. only when non-existent profile data is justified, periodt.
  • -Wmismatched-dealloc โ€” warns for calls to deallocation functions with pointer arguments that came back 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 it's 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 example below, 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 look like they're guarded by a clause like if, else, for, switch, or while, but where only the first statement is actually guarded after the macro gets expanded. ๐Ÿซ 

For example:

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

will increment y unconditionally, not just when c holds. The way you usually fix this is 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, like when there's an assignment in a context where a truth value is expected, or when operators are nested in a way that people often get confused about precedence-wise. ๐Ÿ’…

It also warns if a comparison like x<=y<=z shows up โ€” that's equivalent to (x<=y ? 1 : 0) <= z, which is a different interpretation from the one in ordinary mathematical notation. (math girlies, I'm so sorry ๐Ÿ˜ญ)

It also warns for dangerous uses of the GNU extension to ?: with the 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 about 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) โ€” this warning warns when a value is moved to itself with std::move. Such a std::move typically has no effect, bestie. ๐Ÿ™ˆ
struct T {
...
};
void fn()
{
  T t;
  ...
  t = std::move (t);
}

This warning is enabled by -Wall.

  • -Wsequence-point โ€” warns about code that may have undefined semantics because it violates the sequence point rules in the C and C++ standards. ๐Ÿšจ

The C and C++ standards define the order in which expressions in a C/C++ program get evaluated in terms of sequence points, which represent a partial ordering between the execution of parts of the program: those executed before the sequence point, and those executed after it. These occur after the evaluation of a full expression (one which is not part of a larger expression), after the evaluation of the first operand of a &&, ||, ? : or , (comma) operator, before a function is called (but after the evaluation of its arguments and the expression denoting the called function), and in certain other places. Other than as expressed by the sequence point rules, the order of evaluation of subexpressions of an expression is not specified. All these rules describe only a partial order rather than a total order, since, for example, if two functions are called within one expression with no sequence point between them, the order in which the functions are called is not specified. However, the standards committee have ruled that function calls do not overlap. ๐Ÿค

It's not specified when, between sequence points, modifications to the values of objects take effect. Programs whose behavior depends on this have undefined behavior; the C and C++ standards specify that:

"Between the previous and next sequence point an object shall have its stored value modified at most once by the evaluation of an expression. Furthermore, the prior value shall be read only to determine the value to be stored."

If a program breaks these rules, the results on any particular implementation are entirely unpredictable. ๐Ÿ’€

Examples of code with undefined behavior are a = a++;, a[n] = b[n++] and a[i++] = i;. Some more complicated cases aren't diagnosed by this option, and it may give an occasional false positive result, but in general it's been found fairly effective at detecting this sort of problem in programs.

The C++17 standard will define the order of evaluation of operands in more cases: in particular it requires that the right-hand side of an assignment be evaluated before the left-hand side, so the above examples are no longer undefined. But this option will still warn about them, to help people avoid writing code that's 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 โ€” bestie, this one's about return statements being messy ๐Ÿ’…. It yells at you when a function that does not return void has a return with no expression in it. And it also yells when a function whose return type is void has a return with an expression โ€” unless that expression's type is also void. But as a GNU extension, that second case is lowkey accepted without any warning unless you're using -Wpedantic. Sneaky, right?
Also, fr fr: trying to use the return value of a non-void function that isn't main and that just flows off the end by reaching the closing curly brace that terminates the function? That's undefined. Not a vibe. ๐Ÿ˜ญ

This warning is specific to C and is enabled by default. In C99 and later language dialects, it's treated as an error. You can downgrade it to a warning with -fpermissive (along with other warnings), or, just for this one warning, with -Wno-error=return-mismatch.

  • -Wreturn-type โ€” warn whenever a function is defined with a return type that defaults to int (unless -Wimplicit-int is active, because that one 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. (C++ said "I'm not even gonna wait for you to misuse it" ๐Ÿ’€)

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 โ€” warn if you're left shifting 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. It's giving levels, so let's go:
    • -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. Slay, wrapping. โœจ
    • -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 โ€” warn 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 that do not correspond to enumerators also provoke warnings when this option is used, unless the enumeration is marked with the flag_enum attribute. This warning is enabled by -Wall.
  • -Wswitch-default โ€” warn whenever a switch statement does not have a default case. no default?? caught. ๐Ÿ•ต๏ธ
  • -Wswitch-enum โ€” warn 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 that do not correspond to enumerators also provoke warnings when this option is used, unless the enumeration is marked with the flag_enum attribute. The only difference between -Wswitch and this option is that this option gives a warning about an omitted enumeration code even if there is a default label. ๐Ÿ‘‘
  • -Wno-switch-bool โ€” do not 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 is outside of its respective type range. This warning is enabled by default for C and C++ programs.
  • -Wno-switch-unreachable โ€” do not warn when a switch statement contains statements between the controlling expression and the first case label, which will never be executed. Like, ever. 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) โ€” warn when __sync_fetch_and_nand and __sync_nand_and_fetch built-in functions are used. These functions changed semantics in GCC 4.4, so yeah, they're a little sus historically. ๐Ÿ™ˆ
  • -Wtrivial-auto-var-init โ€” warn when -ftrivial-auto-var-init cannot initialize the automatic variable. A common situation is an automatic variable that is declared between the controlling expression and the first case label of a switch statement.
  • -Wunused-but-set-parameter โ€” -Wunused-but-set-parameter is the same as -Wunused-but-set-parameter=3 and -Wno-unused-but-set-parameter is the same as -Wunused-but-set-parameter=0.
  • -Wunused-but-set-parameter=n โ€” warn whenever a function parameter is assigned to, but otherwise unused (aside from its declaration). like bestie you literally set it and never looked at it again ๐Ÿ’€

To suppress this warning use the unused attribute.

-Wunused-but-set-parameter=0 disables the warning. With -Wunused-but-set-parameter=1 all uses except initialization and left hand side of assignment which is not further used disable the warning. With -Wunused-but-set-parameter=2 additionally uses of parameter in ++ and -- operators don't count as uses. And finally with -Wunused-but-set-parameter=3 additionally uses in parm @= rhs outside of rhs don't count as uses. See -Wunused-but-set-variable=n option for examples.

This -Wunused-but-set-parameter=3 warning is also enabled by -Wunused together with -Wextra.

  • -Wunused-but-set-variable โ€” -Wunused-but-set-variable is the same as -Wunused-but-set-variable=3 and -Wno-unused-but-set-variable is the same as -Wunused-but-set-variable=0.
  • -Wunused-but-set-variable=n โ€” warn whenever a local variable is assigned to, but otherwise unused (aside from its declaration). This -Wunused-but-set-variable=3 warning is enabled by -Wall.

To suppress this warning use the unused attribute.

-Wunused-but-set-variable=0 disables the warning. With -Wunused-but-set-variable=1 all uses except initialization and left hand side of assignment which is not further used disable the warning. With -Wunused-but-set-variable=2 additionally uses of variable in ++ and -- operators don't count as uses. And finally with -Wunused-but-set-variable=3 additionally uses in parm @= rhs outside of rhs don't count as uses.

This -Wunused-but-set-variable=3 warning is also enabled by -Wunused, which is enabled by -Wall.

Here's the whole โœจaestheticโœจ demo, annotated and everything:

        void foo (void)
        {
          int a = 1; // B<-Wunused-variable> warning
          int b = 0; // Warning for <n> >= 1
          b = 1; b = 2;
          int c = 0; // Warning for <n> >= 2
          ++c; c--; --c; c++;
          int d = 0; // Warning for <n> >= 3
          d += 4;
          int e = 0; // No warning, cast to void
          (void) e;
          int f = 0; // No warning, f used
          int g = f = 5;
          (void) g;
          int h = 0; // No warning, preincrement result used
          int i = ++h;
          (void) i;
          int j = 0; // No warning, postdecrement result used
          int k = j--;
          (void) k;
          int l = 0; // No warning, l used
          int m = l |= 2;
          (void) m;
        }
  • -Wunused-function โ€” warn whenever a static function is declared but not defined or a non-inline static function is unused. This warning is enabled by -Wall.
  • -Wunused-label โ€” warn whenever a label is declared but not used. This warning is enabled by -Wall. (a label nobody visits?? the disrespect ๐Ÿ˜ญ)

To suppress this warning use the unused attribute.

  • -Wunused-local-typedefs (C, Objective-C, C++ and Objective-C++ only) โ€” warn when a typedef locally defined in a function is not used. This warning is enabled by -Wall.
  • -Wunused-parameter โ€” warn 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 โ€” do not warn if a caller of a function marked with attribute warn_unused_result does not use its return value. The default is -Wunused-result.
  • -Wunused-variable โ€” warn whenever a local or static variable is unused aside from its declaration. This option implies -Wunused-const-variable=1 for C, but not for C++. This warning is enabled by -Wall.

To suppress this warning use the unused attribute.

  • -Wunused-const-variable
  • -Wunused-const-variable=n โ€” warn whenever a constant static variable is unused aside from its declaration.

To suppress this warning use the unused attribute.

  • -Wunused-const-variable=1 โ€” warn about unused static const variables defined in the main compilation unit, but not about static const variables declared in any header included.

-Wunused-const-variable=1 is enabled by either -Wunused-variable or -Wunused for C, but not for C++. In C this declares variable storage, but in C++ this is not an error since const variables take the place of #defines. iykyk ๐ŸŒธ

  • -Wunused-const-variable=2 โ€” this level ALSO snitches on unused constant static variables in headers (but not system headers, they're exempt bestie). It's literally the same as the short form -Wunused-const-variable. Important: you have to ask for this level explicitly in both C and C++ because cleaning up every single included header can be... a lot. ๐Ÿ’€
  • -Wunused-value โ€” warns whenever a statement computes a result that's explicitly not used. Wanna silence it? Cast that unused expression to void, done. This catches expression-statements, and the left-hand side of a comma expression that has no side effects. So like, x[i,j] gets you a warning, but x[(void)i,j] doesn't. Sneaky. ๐Ÿ˜Œ

This warning is enabled by -Wall.

  • -Wunused โ€” the โœจcombinedโœจ version of all the -Wunused options above, EXCEPT the ones that are documented as needing to be specified explicitly. So not everything everything, okay?

If you want a warning about an unused function parameter, you have two paths: either specify -Wextra -Wunused (and heads up, -Wall implies -Wunused), or separately specify -Wunused-parameter and/or -Wunused-but-set-parameter.

Also -Wunused only turns on -Wunused-const-variable=1 rather than -Wunused-const-variable, and only for C, not C++. Don't ask, that's just the vibe. ๐Ÿ’…

  • -Wuse-after-free (C, Objective-C, C++ and Objective-C++ only)
  • -Wuse-after-free=n โ€” warns about uses of pointers to dynamically allocated objects that got rendered indeterminate by a call to a deallocation function. ๐Ÿซ  This warning is on at all optimization levels, but ngl it might give you different results with optimization than without. And -Wuse-after-free is equivalent to -Wuse-after-free=1.
    • -Wuse-after-free=1 โ€” at level 1 it only tries to catch unconditional uses of pointers made indeterminate by a deallocation call, or by a successful call to realloc โ€” regardless of whether that call actually moved the memory around. This includes double-free calls, plus uses in arithmetic and relational expressions. Tiny lil note: even though uses of indeterminate pointers in equality (or inequality) expressions are undefined, they 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. As at level 2, uses in equality (or inequality) expressions are not diagnosed. So like, check it โ€” the second call to free in this function gets 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 โ€” level 3 goes even harder and also diagnoses uses of indeterminate pointers in equality expressions. Every use of an indeterminate pointer is undefined, but equality tests sometimes pop up after realloc calls as a way to check whether the object got relocated to a different address. They get diagnosed at a separate level so you can gradually transition legacy code to safe alternatives. Example โ€” the equality test in this function gets 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);
}

Wanna dodge the warning at this level? Store offsets into allocated memory instead of pointers. That way you don't have to fix up your stored pointers after reallocation. Genius, honestly. ๐Ÿง โœจ

  • -Wuse-after-free=2 is included in -Wall.
  • -Wuseless-cast (C, Objective-C, C++ and Objective-C++ only) โ€” warns when an expression gets cast to its own type. ๐ŸŽ€ This warning does not fire when a class object is converted to a non-reference type, because that's a legit 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 gets used without being initialized. In C++ it also warns if a non-static reference or non-static const member shows up in a class without constructors. ๐Ÿ‘€

Also: passing a pointer (or in C++, a reference) to an uninitialized object into a const-qualified argument of a built-in function that's known to read the object also gets diagnosed here. (For ordinary functions, -Wmaybe-uninitialized is what fires instead.)

Wanna warn about code that uses a variable's uninitialized value in its own initializer? Use -Winit-self.

These warnings happen for individual uninitialized elements of structure, union or array variables, AND for variables that are uninitialized as a whole. They do not happen for variables or elements declared volatile. And because these warnings depend on optimization, the exact variables or elements that get flagged depend on your precise optimization options and which version of GCC you're running. ๐Ÿ˜ตโ€๐Ÿ’ซ

Also note: there might be no warning about a variable that's only used to compute a value that itself is never used โ€” because those computations can get deleted by data flow analysis before the warnings even print.

In C++, this warning also flags using uninitialized objects in member-initializer-lists. Like, GCC warns about b being uninitialized in this lil snippet:

struct A {
  int a;
  int b;
  A() : a(b) { }
};
  • -Wno-invalid-memory-model โ€” this one 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. Example: since __atomic_store and __atomic_store_n are only defined for the relaxed, release, and sequentially consistent memory orders, this code gets 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's a path from function entry to a use of the object where it IS initialized, but some other paths leave it uninitialized, the compiler emits a warning if it can't prove those uninitialized paths never run at runtime. ๐Ÿฆ‹

Also, passing a pointer (or in C++, a reference) to an uninitialized object into a const-qualified function argument gets diagnosed here too. (-Wuninitialized is what fires for built-in functions known to read the object.) Annotating the function with attribute access (none) says "hey, this argument isn't used to access the object" and dodges the warning.

Heads up: these warnings are only possible in optimizing compilation, because otherwise GCC isn't tracking variable state. On the flip side, -Wmaybe-uninitialized is known to stay quiet in many situations (false negatives ๐Ÿ˜ญ) because optimizations exploit the undefinedness of uninitialized uses, like constant propagation.

These warnings are optional because GCC might not be able to tell when your code is correct despite it looking wrong. Here's one example of how that happens:

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

If y is always 1, 2 or 3, then x is always initialized โ€” but GCC doesn't know that. To shut the warning up, you need a default case with assert(0) or similar code. ๐Ÿซถ

This option also warns when a non-volatile automatic variable might get changed by a call to longjmp. The compiler only sees the calls to setjmp. It can't know where longjmp will be called; fr fr, a signal handler could call it at any point in the code. So you might get a warning even when there's genuinely no problem, because longjmp can't actually be called at the spot that would cause one.

You can dodge some spurious warnings by declaring 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 shows up that GCC doesn't understand. If this command-line option is used, warnings get issued even 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 โ€” don't warn about misuses of pragmas, like incorrect parameters, invalid syntax, or conflicts between pragmas. See also -Wunknown-pragmas.
  • -Wno-pragma-once-outside-header โ€” don't warn when #pragma once is used in a file that isn't a header file, like a main file.
  • -Wno-prio-ctor-dtor โ€” don't warn if a priority from 0 to 100 is used for a constructor or destructor. The constructor and destructor attributes let you assign a priority to the constructor/destructor to control its order of execution before main is called or after it returns. The priority values must be greater than 100, because the compiler reserves priority values between 0โ€“100 for the implementation. ๐Ÿ‘‘

  • -Wstrict-aliasing โ€” bestie this one only wakes up when -fstrict-aliasing is active, okay? It clocks code that might be breaking the strict aliasing rules the compiler is out here using to optimize. Heads up though: it does not catch every case, it just tries to catch the more common pitfalls. It's part of -Wall, and it's literally the same as -Wstrict-aliasing=3.
  • -Wstrict-aliasing=n โ€” same deal, only active when -fstrict-aliasing is active, warns about code that might break those strict aliasing rules. Higher levels = higher accuracy (fewer false positives). Higher levels also = more effort, kinda like how -O levels work. And -Wstrict-aliasing is equivalent to -Wstrict-aliasing=3, no cap.

Level 1: Most aggressive, quick, least accurate. Lowkey useful when higher levels don't warn but -fstrict-aliasing is still breaking your code, because it has very few false negatives. But it has so many false positives. It warns for all pointer conversions between possibly incompatible types, even if they're 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 option is 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. Ngl, 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, fr.

An optimization that assumes signed overflow doesn't occur is perfectly safe if the values of the variables involved are such that overflow never actually happens. So this warning can easily give a false positive: a warning about code that isn't 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. 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 code that can be statically determined to cause buffer overflows or memory overruns, like calls to "memcpy" and "strcpy" that overflow the destination buffer. The optional argument is one greater than the type of Object Size Checking to perform to determine the size of the destination. That argument is meaningful only for string functions that operate on character arrays; raw memory functions like "memcpy" always use type-zero Object Size Checking.

The option also warns for calls that specify a size in excess of the largest possible object or at most "SIZE_MAX / 2" bytes.

It produces the best results with optimization enabled, but it 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, such as "__builtin___memcpy_chk", which can perform run-time checking if the access cannot be identified as safe at compile time.

For example, the option issues a warning for the "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
}

The effect of this option is not limited to string or memory manipulation functions. In this example, a warning is diagnosed because a 1-element array is passed to a function requiring at least a 4-element array argument:

void f (int[static 4]);

void g (void)
{
  int *p = (int *) malloc (1 * sizeof(int));
  f (p);   // 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);
}

okay so another one for the collection, bestie ๐Ÿ’… โ€” when you call strncpy like this, all that lands in d is the characters before the terminating NUL, and the NUL itself never gets appended to the end. Assuming the result of strncpy is necessarily a NUL-terminated string is a super common mistake, so GCC calls it out. And if your result genuinely isn't supposed to be NUL-terminated? Just call memcpy instead and the warning goes away, easy ๐Ÿซถ

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

Next vibe ๐ŸŒธ โ€” in this one, the strncpy call uses the size of the destination buffer as the bound. If the length of the source string is equal to or greater than that size, the copy is not going to be NUL-terminated, so yeah, diagnosed too. Want to dodge the warning? Specify sizeof buf - 1 as the bound and set the last element of the buffer to NUL. periodt โœจ

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

And if you've got a character array that's meant to store a sequence of bytes with no terminating NUL? no stress โ€” annotate that array with attribute nonstring and this warning minds its own business ๐Ÿ™ˆ. BUT โ€” heads up, those arrays are not suitable arguments to functions that expect NUL-terminated strings. To help catch accidental misuse of them, GCC issues warnings unless it can prove the use is safe. iykyk ๐Ÿ’€

-Wstrict-flex-arrays (C and C++ only)

Warns you about improper usages of flexible array members ๐Ÿ’… โ€” judged by the level of the strict_flex_array (level) attribute attached to the trailing array field of a structure if that attribute's available, and otherwise by the level of the option -fstrict-flex-arrays=level. Important: -Wstrict-flex-arrays only does anything when level is greater than 0. so lowkey a no-op below that, bestie.

  • When level=1, warnings are issued for a trailing array reference of a structure that have 2 or more elements, if the trailing array is referenced as a flexible array member.
  • When level=2, on top of everything in 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 everything in level=2, extra warnings are issued for a trailing zero-length array reference of a structure, if the array is referenced as a flexible array member.
This option is more effective when -ftree-vrp is active (which is the default for -O2 and above), but some warnings may be diagnosed even without optimization. so like, it still shows up sometimes ๐Ÿฆ‹

-Wsuggest-attribute=attribute-name

Warns for cases where adding an attribute may be beneficial ๐ŸŒˆ. The attribute-names currently supported are all listed right here:

-Wsuggest-attribute=pure
-Wsuggest-attribute=const
-Wsuggest-attribute=noreturn
-Wmissing-noreturn
-Wsuggest-attribute=malloc
-Wsuggest-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 (in the case of pure and const) if it can't prove that the function returns normally. A function returns normally if it doesn't contain an infinite loop or return abnormally by throwing, calling abort, or trapping. This analysis requires option -fipa-pure-const, which is enabled by default at -O and higher โ€” and higher optimization levels improve the accuracy of the analysis. slay โœจ

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

Warn about function pointers that might be candidates for format attributes ๐ŸŽ€. Note these are only possible candidates, not absolute ones. GCC guesses that function pointers with format attributes that are 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 respectively 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, not a done deal. GCC guesses that format attributes might be appropriate for any function that calls a function like vprintf or vscanf, but this might not always be the case, and some functions for which format attributes are appropriate may not be detected. it's giving "best effort", fr fr ๐Ÿ˜ญ

-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 leads to a call to another cold function โ€” like wrappers of C++ throw or fatal error reporting functions leading to abort. very specific, very iconic ๐Ÿ’…


-Walloc-size

Warns 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 ๐Ÿซถ โ€” and yes, that includes the built-in forms of the functions aligned_alloc, alloca, calloc, malloc, and realloc. all the classics ๐Ÿ’€

-Walloc-zero

Warns about calls to allocation functions decorated with attribute alloc_size that specify zero bytes ๐Ÿ˜ญ โ€” including the built-in forms of aligned_alloc, alloca, calloc, malloc, and realloc. Why care? Because the behavior of these functions when called with a zero size differs among implementations (and in the case of realloc has been deprecated), so relying on it may result in subtle portability bugs and should be avoided. no cap ๐Ÿ™ˆ

-Wcalloc-transposed-args

Warns about calls to allocation functions decorated with attribute alloc_size with two arguments, which use sizeof operator as the earlier size argument and don't use it as the later size argument ๐Ÿฆ‹. This is a coding style warning, bestie โ€” nothing's on fire.

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

And if having sizeof in the earlier argument and not the latter is genuinely intentional? You can suppress the warning by using calloc (sizeof (struct S) + 0, n) or calloc (1 * sizeof (struct S), 4) or by using sizeof in the later argument as well. periodt ๐Ÿ’…

-Walloc-size-larger-than=byte-size

Warns 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

Disables -Walloc-size-larger-than= warnings ๐Ÿ™ˆ. The option is equivalent to -Walloc-size-larger-than=SIZE_MAX or larger. same energy, different spelling โœจ

-Walloca

This option warns on all uses of alloca in the source ๐Ÿ’€. every single one. it's giving watchful parent, and honestly? iconic.

-Wauto-profile

Output warnings about auto-profile inconsistencies ๐ŸŒˆ.

-Wcannot-profile

Warn when profiling instrumentation was requested, but could not be applied to a certain function ๐Ÿ˜ญ.

-Walloca-larger-than=byte-size

This one 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 โ€” and arguments of non-integer types are considered unbounded even if they look like they're constrained to the expected range. the audacity ๐Ÿ’…

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 ๐Ÿซถ. However, if -Walloca-larger-than=500 were passed, the compiler would emit a warning. caught ๐Ÿซข

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

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 ๐Ÿ˜ณ. sneaky.

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

Disables -Walloca-larger-than= warnings ๐Ÿ™ˆ. The 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 -Wconversion
  c = c + 1; // only warns with -Warith-conversion
}

two lines, two totally different warning energies, and that's the whole point ๐Ÿ’–

  • -Warray-bounds, -Warray-bounds=n โ€” bestie, this one clocks you when you go out of bounds with subscripts or offsets into arrays. It's enabled by -Wall, and it's way more effective when -ftree-vrp is active (which it is by default for -O2 and above) โ€” but a subset of instances still get flagged even with no optimization at all. ๐Ÿ’…

Okay so by default, the trailing array of a structure gets 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 ([]),
  • a GCC zero-length array extension ([0]),
  • or a one-element array ([1]).

Which means โ€” and this is the tea โ€” out of bounds subscripts or offsets into zero-length arrays or one-element arrays are not warned by default. ๐Ÿ™ˆ

You can add the option -fstrict-flex-arrays or -fstrict-flex-arrays=level to control how this option treats a 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 is enabled by -Wall; higher levels are not, and must be explicitly requested.
  • -Warray-bounds=2 โ€” this warning level also warns about the intermediate results of pointer arithmetic that may yield out of bounds values. Heads up though: this warning level may give a larger number of false positives and is deactivated by default. ๐Ÿ˜ญ
  • -Wunterminated-string-initialization (C and Objective-C only) โ€” warns about character arrays initialized as unterminated character sequences with a string literal, unless the declaration being initialized has the "nonstring" attribute. Like, for example:
char arr[3] = "foo"; /* Warning.  */
char arr2[3] __attribute__((nonstring)) = "bar"; /* No warning.  */

This warning is enabled by -Wextra. And if -Wc++-compat is enabled, the warning has slightly different wording and warns even if the declaration being initialized has the "nonstring" warning, as in C++ such initializations are an error. ๐Ÿซถ

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

  • -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 vibe: 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.

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. The -Wvla-parameter option triggers warnings for similar inconsistencies involving Variable Length Array arguments.

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. periodt. ๐Ÿ’–

  • -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.
    • -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".

-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. These characters can flip left-to-right writing direction into right-to-left (and vice versa), which can cause confusion between the logical order and visual order.
Okay this one is genuinely dangerous, no cap โ€” for instance, it may seem that a piece of code is not commented out, whereas it in fact is. ๐Ÿ’€

There are three levels of warning supported by GCC. The default is -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. โœจ

  • -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. ๐Ÿ˜ญ

  • -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 warns for conditional operators:

int i = x ? *p : *p;
  • -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) { ... }

like bestie we just checked that. ๐Ÿ™ˆ

  • -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. ๐Ÿ’€
  • -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.
  • -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. ๐Ÿ‘‘

  • -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. ๐Ÿฆ‹

Quick recap bestie: in C99 and beyond, GCC is like "girl that's an error ๐Ÿ’€". You can downgrade it to a lil warning with -fpermissive (that's a whole bundle of errors getting softened, jsyk), or if you ONLY wanna fix this one diva, use -Wno-error=int-conversion. And heads up โ€” -pedantic-errors upgrades this warning right back up to an error. The audacity, honestly. ๐Ÿ˜ญ

  • -Wzero-as-null-pointer-constant โ€” screams at you when you use a literal 0 as a null pointer constant. Like bestie, we have nullptr now, it's giving โœจโœจ
  • -Wzero-length-bounds โ€” warns about accessing elements of zero-length array members that might overlap with other members of the same object. Declaring interior zero-length arrays is so discouraged because accessing them is straight-up undefined behaviour. It's giving cursed energy fr fr.

Okay so look at this โ€” the first two stores in bad get diagnosed because the array elements overlap with the members that come after, b and c. The third store gets caught by -Warray-bounds instead because it's beyond the bounds of the whole enclosing object. Sneaky little thing.

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
}

Also! -Wzero-length-bounds gets enabled by -Warray-bounds, so it comes along for the ride. ๐ŸŽ€

  • -Wno-div-by-zero โ€” do NOT warn about integer division by zero at compile time. Floating-point division by zero? Also not warned about, because apparently that's a whole legitimate way of getting infinities and NaNs. It's not a bug, it's a feature, slay ๐Ÿ’…
  • -Wsystem-headers โ€” prints warning messages for stuff found in system header files. Normally those warnings are suppressed because the assumption is they usually don't indicate real problems and would just make the compiler output harder to read (valid tbh). But using this command-line option tells GCC to emit warnings from system headers as if they happened in your code. However!! Note that using -Wall together with this option does not warn about unknown pragmas in system headers โ€” for that you gotta ALSO use -Wunknown-pragmas. Two icons working together, no cap.
  • -Wtautological-compare โ€” warns if a self-comparison always evaluates to true or false. It catches all kinds of oopsies 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) { ... }

will always be false. Ma'am. Why. ๐Ÿ™ˆ

This warning is enabled by -Wall.

  • -Wtrailing-whitespace
  • -Wtrailing-whitespace=kind โ€” warns about trailing whitespace at the end of lines, including inside comments, but NOT including trailing whitespace inside raw string literals (those get a pass ๐Ÿซถ). -Wtrailing-whitespace is equivalent to -Wtrailing-whitespace=blanks and only warns about trailing space and horizontal tab characters. -Wtrailing-whitespace=any warns about those PLUS trailing form feed or vertical tab characters. -Wno-trailing-whitespace or -Wtrailing-whitespace=none disables the warning โ€” and that's the default, bestie. This is a coding style warning, just so you know. โœจ
  • -Wleading-whitespace=kind โ€” warns about style issues in leading whitespace, but NOT about the amount of indentation. Some projects use coding styles where only spaces are used for indentation, others use only tabs, others use zero or more tabs (for multiples of -ftabstop=n) followed by zero or fewer than n spaces. Nobody's judging... okay maybe a little. ๐Ÿ‘€

No warning is emitted on lines that contain solely whitespace (although a -Wtrailing-whitespace= warning might be emitted), and no warnings are emitted inside raw string literals. Warnings ARE also emitted for leading whitespace inside multi-line comments.

  • -Wleading-whitespace=spaces warns about leading whitespace other than spaces, for projects that wanna indent just by spaces.
  • -Wleading-whitespace=tabs warns about leading whitespace other than horizontal tabs, for projects that wanna indent just by horizontal tabs.
  • -Wleading-whitespace=blanks warns about leading whitespace other than spaces and horizontal tabs, OR about horizontal tab after a space in the leading whitespace, OR about n or more consecutive spaces in leading whitespace (where n is the argument of -ftabstop=n, 8 by default).
  • -Wleading-whitespace=none disables the warning โ€” and that's the default.

This is a coding style warning, periodt.

  • -Wtrampolines โ€” warns about trampolines generated for pointers to nested functions. Okay so what IS a trampoline? It's a small piece of data or code that gets created at run time on the stack when the address of a nested function is taken, and it's used to call the nested function indirectly. For some targets, it's made up of data only and thus needs no special treatment (iconic, low maintenance). But for most targets, it's made up of code, which means the stack has to be made executable for the program to work properly. Which is, um, a security conversation for another day bestie ๐Ÿ˜ญ
  • -Wfloat-equal โ€” warns 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. And if that's what you're doing, 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, don't even get me started).

In particular, instead of testing for equality, you should check whether the two values have ranges that overlap. And that's done with the relational operators! So equality comparisons are probably mistaken. It's giving ๐Ÿšฉ

  • -Wtraditional (C and Objective-C only) โ€” warns about certain constructs that behave differently in traditional vs ISO C. Also warns about ISO C constructs that have no traditional C equivalent, and/or problematic constructs that should just be avoided entirely. The full 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. Different eras, different rules.
    • 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. So -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 that traditional C doesn't understand by indenting them. And some traditional implementations don't even recognize #elif, so this option suggests avoiding it altogether. Dodged.
    • 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, okurrr.) Note that 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. She's smart like that. ๐Ÿงš
    • A function declared external in one block and then used after the end of the block.
    • A switch statement that has an operand of type long.
    • A non-static function declaration that 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. Rude of it honestly.
    • 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. She knows when to mind her business ๐Ÿ’…
  • -Wtraditional-conversion (C and Objective-C only) โ€” warns if a prototype causes a type conversion that's 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 it's the same as the default promotion. โœจ
  • -Wdeclaration-after-statement (C and Objective-C only) โ€” warns 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. The old heads are shaking their heads, ngl.
This warning is upgraded to an error by -pedantic-errors.
  • -Wshadow โ€” warns 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 gets 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 also includes ALL instances of local shadowing. Which means -Wno-shadow=local and -Wno-shadow=compatible-local get ignored when -Wshadow is used. Same as -Wshadow=global. She said what she said. ๐Ÿ‘‘

  • -Wno-shadow-ivar (Objective-C only) โ€” bestie, this one's just vibes for the Obj-C girlies: it says don't warn when a local variable shadows an instance variable inside an Objective-C method. That's it, that's the whole flag. ๐Ÿ’…
  • -Wshadow=global โ€” warn about any shadowing at all. Literally the exact same energy as plain -Wshadow. Same flag, different outfit. โœจ
  • -Wshadow=local โ€” warn when a local variable shadows another local variable <em>or</em> a parameter. The classic. ๐ŸŽ€
  • -Wshadow=compatible-local โ€” okay so this one is picky in the best way: it warns when a local variable shadows another local variable or parameter whose type is compatible with the shadowing variable's type. And in C++, "type compatible" here means the shadowing variable's type can be converted to the shadowed variable's type. ๐Ÿฆ‹

The whole reason this flag exists (on top of -Wshadow=local) is the idea that when a local shadows another one of an incompatible type, it's most likely intentional, not a bug or a typo. Witness this absolute serve of an example:

for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
{
  for (int i = 0; i < N; ++i)
  {
    ...
  }
  ...
}

Since the two i variables up there have incompatible types, turning on only -Wshadow=compatible-local emits no warning. And 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 anyway. So using this flag instead of -Wshadow=local can possibly reduce the number of warnings triggered by intentional shadowing. ๐Ÿซถ

Heads up though: this also means that shadowing const char *i by char *i does not emit a warning.

Also, this warning is enabled by -Wshadow=local too. โœจ

  • -Wlarger-than=byte-size โ€” warn whenever an object is defined whose size exceeds byte-size. And fun fact: -Wlarger-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-larger-than. ๐Ÿ’ซ

It also warns 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. And those warnings? They can only be disabled by -Wno-larger-than. No other way, periodt.

  • -Wno-larger-than โ€” disables -Wlarger-than= warnings. This option is equivalent to -Wlarger-than=SIZE_MAX or larger. โœจ
  • -Wframe-larger-than=byte-size โ€” warn if the size of a function frame exceeds byte-size. Now listen, the computation done to determine the stack frame size is approximate and not conservative, so the actual requirements may be somewhat greater than byte-size even if you don't get a warning. ๐Ÿ™ˆ

On top of that, any space allocated via alloca, variable-length arrays, or related constructs is not included by the compiler when determining whether or not to issue a warning. So don't @ it for missing stuff.

-Wframe-larger-than=PTRDIFF_MAX is enabled by default. Warnings controlled by the option can be disabled either by specifying a byte-size of SIZE_MAX or more, or by -Wno-frame-larger-than. ๐Ÿ’–

  • -Wno-frame-larger-than โ€” disables -Wframe-larger-than= warnings. Equivalent to -Wframe-larger-than=SIZE_MAX or larger. โœจ
  • -Wfree-nonheap-object โ€” warn when attempting to deallocate an object that was either not allocated on the heap, or by using a pointer that was not returned from a prior call to the corresponding allocation function. ๐Ÿšจ

For example, because the call to stpcpy returns a pointer to the terminating nul character and not to the beginning of the object, the call to free below gets diagnosed:

void f (char *p)
{
  p = stpcpy (p, "abc");
  // ...
  free (p);   // warning
}

And yes, -Wfree-nonheap-object is included in -Wall. ๐Ÿ‘‘

  • -Wstack-usage=byte-size โ€” warn if the stack usage of a function might exceed byte-size. The computation done to determine the stack usage is conservative. Any space allocated via alloca, variable-length arrays, or related constructs is included by the compiler when determining whether or not to issue a warning. ๐Ÿ“

The message matches the output of -fstack-usage, and it comes in three flavours:

  1. If the stack usage is fully static but exceeds the specified amount, it's:
warning: stack usage is 1120 bytes
  1. If the stack usage is (partly) dynamic but bounded, it's:
warning: stack usage might be 1648 bytes
  1. 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. Warnings controlled by the option can be disabled either by specifying a byte-size of SIZE_MAX or more, or by -Wno-stack-usage. ๐Ÿ’œ

  • -Wno-stack-usage โ€” disables -Wstack-usage= warnings. Equivalent to -Wstack-usage=SIZE_MAX or larger. โœจ
  • -Wunsafe-loop-optimizations โ€” warn if the loop cannot be optimized because the compiler cannot assume anything on the bounds of the loop indices. And with -funsafe-loop-optimizations, it warns if the compiler makes such assumptions. Lowkey chaotic, highkey useful. ๐Ÿ”ฅ
  • -Wno-pedantic-ms-format (MinGW targets only) โ€” when used in combination with -Wformat and -pedantic without GNU extensions, this option 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. Windows girlies, this one's for you. ๐ŸŽ€
  • -Wpointer-arith โ€” warn about anything that depends on the "size of" a function type or of void. Because 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. ๐Ÿ’…
This warning is upgraded to an error by -pedantic-errors. So like, careful bestie.
  • -Wno-pointer-compare โ€” do not warn if a pointer is compared with a zero character constant. Because usually that means the pointer was meant to be dereferenced. Like:
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 โ€” disable warnings about unsupported features in ThreadSanitizer. ThreadSanitizer does not support std::atomic_thread_fence and can report false positives. That's the whole tea. ๐Ÿซ–
  • -Wtype-limits โ€” warn if a comparison is always true or always false due to the limited range of the data type, but do not warn for constant expressions. For example, warn if an unsigned variable is compared against zero with < or >=. This warning is also enabled by -Wextra. ๐ŸŒธ
  • -Wabsolute-value (C and Objective-C only) โ€” warn for calls to standard functions that compute the absolute value of an argument when a more appropriate standard function is available. For example, calling 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 is also enabled by -Wextra. ๐Ÿ’–

  • -Wcomment, -Wcomments โ€” warn 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 โ€” warn 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 โ€” warn if an undefined identifier is evaluated in an #if directive. Such identifiers are replaced with zero. Simple as that. ๐Ÿ’ซ
  • -Wexpansion-to-defined โ€” warn 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 โ€” warn 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 โ€” do 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) โ€” warn when a function call is cast to a non-matching type. For example, warn if a call to a function returning an integer type is cast to a pointer type. That's just asking for trouble, fr fr. ๐Ÿ’€
  • -Wc90-c99-compat (C and Objective-C only) โ€” warn about features not present in ISO C90, but present in ISO C99. For instance, warn about use of variable length arrays, 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) โ€” warn 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) โ€” bestie, these two are the SAME warning, and the second name is deprecated, so maybe stop using it ๐Ÿ’€

It yells at you about features that aren't in ISO C11 but ARE in ISO C23. Like what? Omitting the string in _Static_assert, using [[]] syntax for attributes, decimal floating-point types, that whole crew. This option does not care what standards mode you're in โ€” it's independent. And warnings get disabled inside the expression that follows __extension__ (that thing is a lil force field, iykyk).

When you're not compiling in C23 mode, these warnings get upgraded to errors by -pedantic-errors. So like, not a vibe check anymore, an actual fail.
  • -Wc23-c2y-compat (C and Objective-C only)
  • -Wc23-c2y-compat (C and Objective-C only) โ€” yeah they listed it twice, iconic of them ๐Ÿซถ

Warns about features not present in ISO C23 but present in ISO C2Y. Example: _Generic selecting with a type name instead of an expression. Independent of standards mode again, and warnings are disabled in the expression following __extension__.

Not compiling in C2Y mode? Then -pedantic-errors upgrades these to errors. Periodt.
  • -Wc++-compat (C and Objective-C only) โ€” clocks ISO C constructs that live outside the common subset of ISO C and ISO C++. Like asking for an implicit conversion from void * to a pointer to a non-void type. C++ girlies could never ๐Ÿ’…
  • -Wc++11-compat (C++ and Objective-C++ only) โ€” warns about C++ constructs whose meaning differs between ISO C++ 1998 and ISO C++ 2011. The classic: identifiers that were just identifiers in 1998 but became keywords in 2011. This one turns on -Wnarrowing and is enabled by -Wall โœจ
  • -Wc++14-compat (C++ and Objective-C++ only) โ€” C++ constructs whose meaning shifted between ISO C++ 2011 and ISO C++ 2014. Enabled by -Wall.
  • -Wc++17-compat (C++ and Objective-C++ only) โ€” C++ constructs whose meaning shifted between ISO C++ 2014 and ISO C++ 2017. Enabled by -Wall.
  • -Wc++20-compat (C++ and Objective-C++ only) โ€” C++ constructs whose meaning shifted between ISO C++ 2017 and ISO C++ 2020. Enabled by -Wall.
  • -Wc++26-compat (C++ and Objective-C++ only) โ€” C++ constructs whose meaning shifted between ISO C++ 2023 and the upcoming ISO C++ 2026. Enabled by -Wall. Future-proofing, we love to see it ๐ŸŒˆ

โœจ the "no, actually, don't warn" era โœจ

  • -Wno-c++11-extensions (C++ and Objective-C++ only) โ€” do NOT warn about C++11 constructs in code being compiled with an older C++ standard. And heads up: even without this option, some C++11 constructs only get diagnosed if -Wpedantic is used.
  • -Wno-c++14-extensions (C++ and Objective-C++ only) โ€” same energy, C++14 constructs, older standard. Some C++14 constructs still only get diagnosed with -Wpedantic.
  • -Wno-c++17-extensions (C++ and Objective-C++ only) โ€” C++17 constructs, older standard, no warnings. Some C++17 constructs only get diagnosed with -Wpedantic.
  • -Wno-c++20-extensions (C++ and Objective-C++ only) โ€” C++20 constructs, older standard, silence. Some C++20 constructs only get diagnosed with -Wpedantic.
  • -Wno-c++23-extensions (C++ and Objective-C++ only) โ€” C++23 constructs, older standard, hush. Some C++23 constructs only get diagnosed with -Wpedantic.
  • -Wno-c++26-extensions (C++ and Objective-C++ only) โ€” C++26 constructs, older standard, mute. Some C++26 constructs only get diagnosed with -Wpedantic.

  • -Wcast-qual โ€” warns whenever a pointer gets cast in a way that removes a type qualifier from the target type. Example: casting a const char * to a plain old char *. Rude.

It also warns when a cast introduces a type qualifier in an unsafe way. Like casting char ** to const char ** โ€” unsafe, and here's the receipt:

/* 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 โ€” warns whenever a pointer is cast so the required alignment of the target goes up. Example: char * cast to int * on machines where ints can only be accessed at two- or four-byte boundaries.

Warn whenever a pointer is cast such that the required alignment of the target is increased. For example, warn if a char * is cast to an int * regardless of the target machine.

  • -Wcast-function-type โ€” warns when a function pointer is cast to an incompatible function pointer. Details, because bestie you know I don't gatekeep:
    • 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.
    • Type qualifiers are ignored too.
    • The function type void (*) (void) is special and matches everything โ€” you can use it to suppress this warning.
    • In a cast involving pointer to member types, this warning fires whenever the type cast changes the pointer to member type.

Enabled by -Wextra โœจ

  • -Wcast-user-defined โ€” warns when a cast to reference type doesn't involve a user-defined conversion that the programmer might expect to be called. Look:
struct A { operator const int&(); } a;
auto r = (int&)a; // warning

This warning is enabled by default.

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

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

This warning is upgraded to an error by -pedantic-errors in C++11 mode or later. No take-backs.
  • -Wclobbered โ€” warns for variables that might get changed by longjmp or vfork. Also enabled by -Wextra. longjmp really said "surprise" ๐Ÿ˜ญ
  • -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 invoke a single compiler driver for multiple source files written in different languages, like:
$ 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.

This option can also disable warnings like cc1plus: note: CTF debug info requested, but not supported for 'GNU C++20' frontend โ€” produced by -gctf or -gsctf for unsupported languages. Goodbye, noise ๐ŸŽ€

  • -Wcompare-distinct-pointer-types (C and Objective-C only) โ€” warns if pointers of distinct types are compared without a cast. Enabled by default.
  • -Wconversion โ€” warns for implicit conversions that may alter a value. What counts:
    • 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)

What does not warn: 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 with -Wno-sign-conversion.

For C++, it also warns for confusing overload resolution for user-defined conversions, and for conversions that never use a type conversion operator: conversions to void, the same type, a base class, or a reference to them. Warnings about signed/unsigned conversions are disabled by default in C++ unless -Wsign-conversion is explicitly enabled.

Warnings about conversion from arithmetic on a small type back to that type are only given with -Warith-conversion.
  • -Wdangling-else โ€” warns about constructions where there could be confusion about which if statement an else branch belongs to. Here's the drama:
{
  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's often not what the programmer expected, as the indentation above makes painfully clear. When this confusion is possible, GCC issues a warning when this flag is specified.

To kill the warning, add explicit braces around the innermost if so there's no way the else can belong to the enclosing if. Like this:

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

This warning is enabled by -Wparentheses. Slay, mystery solved ๐Ÿ’…

  • -Wdangling-pointer
  • -Wdangling-pointer=n โ€” warns about uses of pointers (or C++ references) to objects with automatic storage duration after their lifetime has ended. That includes local variables declared in nested blocks, compound literals, and other unnamed temporary objects. It also warns about storing the address of such objects in escaped pointers. Enabled at all optimization levels, but might 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 โ€” okay bestie, at level 2 the warning also diagnoses conditional uses of dangling pointers, not just unconditional ones. ๐Ÿ’€โœจ

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

This example triggers the warning at level 1; the address of the unnamed temporary is unconditionally referenced outside of its scope. no cap.

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 macros __TIME__, __DATE__ or __TIMESTAMP__ are encountered, because they might prevent bitwise-identical reproducible compilations. ๐Ÿ•ฐ๏ธโœจ
  • -Wempty-body โ€” warn if an empty body occurs in an if, else or do while statement. This warning is also enabled by -Wextra. ๐Ÿซฅ
  • -Wno-endif-labels โ€” do not warn about stray tokens after #else and #endif. ๐Ÿšซ๐Ÿท๏ธ
  • -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. ๐Ÿ”
  • -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) โ€” warn if a goto statement or a switch statement jumps forward across the initialization of a variable, or jumps backward to a label after the variable has been initialized. This only warns about variables that are initialized when they are declared. This warning is only supported for C and Objective-C; in C++ this sort of branch is an error in any case. ๐Ÿฆ˜

-Wjump-misses-init is included in -Wc++-compat. It can be disabled with the -Wno-jump-misses-init option.

  • -Wsign-compare โ€” warn when a comparison between signed and unsigned values could produce an incorrect result when the signed value is converted to unsigned. In C++, this warning is also enabled by -Wall. In C, it is also enabled by -Wextra. โš–๏ธ
  • -Wsign-conversion โ€” warn for implicit conversions that may change the sign of an integer value, like assigning a signed integer expression to an unsigned integer variable. An explicit cast silences the warning. In C, this option is enabled also by -Wconversion. ๐Ÿ”„
  • -Wflex-array-member-not-at-end (C and C++ only) โ€” warn when a structure containing a C99 flexible array member as the last field is not at the end of another structure. This warning warns e.g. about
struct flex  { int length; char data[]; };
struct mid_flex { int m; struct flex flex_data; int n; };
  • -Wfloat-conversion โ€” warn for implicit conversions that reduce the precision of a real value. This includes conversions from real to integer, and from higher precision real to lower precision real values. This option is also enabled by -Wconversion. ๐ŸŒŠ
  • -Wno-scalar-storage-order โ€” do not warn on suspicious constructs involving reverse scalar storage order. ๐Ÿ™…
  • -Wsizeof-array-div โ€” warn about divisions of two sizeof operators when the first one is applied to an array and the divisor does not equal the size of the array element. In such a case, the computation will not yield the number of elements in the array, which is likely what the user intended. This warning warns e.g. about
int fn ()
{
  int arr[10];
  return sizeof (arr) / sizeof (short);
}

This warning is enabled by -Wall. ๐Ÿ“

  • -Wsizeof-pointer-div โ€” warn for suspicious divisions of two sizeof expressions that divide the pointer size by the element size, which is the usual way to compute the array size but won't work out correctly with pointers. This warning warns e.g. about sizeof (ptr) / sizeof (ptr[0]) if ptr is not an array, but a pointer. This warning is enabled by -Wall. ๐Ÿ“
  • -Wsizeof-pointer-memaccess โ€” warn for suspicious length parameters to certain string and memory built-in functions if the argument uses sizeof. This warning triggers for example for memset (ptr, 0, sizeof (ptr)); if ptr is not an array, but a pointer, and suggests a possible fix, or about memcpy (&foo, ptr, sizeof (&foo));. -Wsizeof-pointer-memaccess also warns about calls to bounded string copy functions like strncat or strncpy that specify as the bound a sizeof expression of the source array. For example, in the following function the call to strncat specifies the size of the source string as the bound. That is almost certainly a mistake and so the call is diagnosed. ๐Ÿง 
void make_file (const char *name)
{
  char path[PATH_MAX];
  strncpy (path, name, sizeof path - 1);
  strncat (path, ".text", sizeof ".text");
  ...
}

The -Wsizeof-pointer-memaccess option is enabled by -Wall.

  • -Wno-sizeof-array-argument โ€” do not warn when the sizeof operator is applied to a parameter that is declared as an array in a function definition. This warning is enabled by default for C and C++ programs. ๐Ÿšซ
  • -Wmemset-elt-size โ€” warn for suspicious calls to the memset built-in function, if the first argument references an array, and the third argument is a number equal to the number of elements, but not equal to the size of the array in memory. This indicates that the user has omitted a multiplication by the element size. This warning is enabled by -Wall. ๐Ÿงฎ
  • -Wmemset-transposed-args โ€” warn for suspicious calls to the memset built-in function where the second argument is not zero and the third argument is zero. For example, the call memset (buf, sizeof buf, 0) is diagnosed because memset (buf, 0, sizeof buf) was meant instead. The diagnostic is only emitted if the third argument is a literal zero. Otherwise, if it is an expression that is folded to zero, or a cast of zero to some type, it is far less likely that the arguments have been mistakenly transposed and no warning is emitted. This warning is enabled by -Wall. ๐Ÿ”„
  • -Waddress โ€” warn about suspicious uses of address expressions. These include comparing the address of a function or a declared object to the null pointer constant such as in
void f (void);
void g (void)
{
  if (!f)   // warning: expression evaluates to false
    abort ();
}

comparisons of a pointer to a string literal, such as in

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, such as in

void f (const int *p, int i)
{
  return p + i == NULL;
}

Such uses typically indicate a programmer error: the address of most functions and objects necessarily evaluates to true (the exception are weak symbols), so their use in a conditional might indicate missing parentheses in a function call or a missing dereference in an array expression. The subset of the warning for object pointers can be suppressed by casting the pointer operand to an integer type such as intptr_t or uintptr_t. Comparisons against string literals result in unspecified behavior and are not portable, and suggest the intent was to call strcmp. The warning is suppressed if the suspicious expression is the result of macro expansion. -Waddress warning is enabled by -Wall. ๐Ÿšจ

  • -Wno-address-of-packed-member โ€” do not warn when the address of packed member of struct or union is taken, which usually results in an unaligned pointer value. This is enabled by default. ๐Ÿ“ฆ
  • -Wlogical-op โ€” warn about suspicious uses of logical operators in expressions. This includes using logical operators in contexts where a bitwise operator is likely to be expected. Also warns when the operands of a logical operator are the same:
extern int a;
if (a < 0 && a < 0) { ... }
  • -Wlogical-not-parentheses โ€” warn about logical not used on the left hand side operand of a comparison. This option does not warn if the right operand is considered to be a boolean expression. Its purpose is to detect suspicious code like the following:
int a;
...
if (!a > 1) { ... }

Okay so bestie, you can hush this one up by wrapping the LHS in parentheses:

if ((!a) > 1) { ... }

This warning is enabled by -Wall.

  • -Waggregate-return โ€” screams at you if any function that returns a struct or a union gets defined or called. (And in languages where you can return an array, that also sets off the alarm. ๐Ÿšจ)
  • -Wno-aggressive-loop-optimizations โ€” turns OFF the warning the compiler gives you when it spots undefined behavior in a loop with a constant number of iterations. Heads up: -Waggressive-loop-optimizations is on by default, so this is you telling it to chill. ๐Ÿ’…
  • -Wno-attributes โ€” turns OFF the warning for an unexpected __attribute__, like attributes it doesn't recognize, or function attributes slapped onto variables, etc. Important: this does not stop errors from incorrect use of attributes it does support. ๐Ÿ™…โ™€๏ธ

Warnings about ill-formed uses of standard attributes get upgraded to errors by -pedantic-errors.

Also, with -Wno-attributes=, you can silence warnings about unknown scoped attributes (in C++11 and C23). Like, -Wno-attributes=vendor::attr kills the warning for this declaration:

[[vendor::attr]] void f();

And you can turn off warnings for every attribute in a whole namespace using -Wno-attributes=vendor::, which stops warnings for both of these:

[[vendor::safe]] void f();
[[vendor::unsafe]] void f2();
Note that -Wno-attributes= does not imply -Wno-attributes. Keep them separate, bestie, they're not a package deal. ๐Ÿ’€
  • -Wno-builtin-declaration-mismatch โ€” turns off the warning you get when a built-in function is declared with an incompatible signature or as a non-function, or when a built-in declared with a type that has no prototype gets called with arguments whose promoted types don't match what the function expects. When -Wextra is in play, it also warns when a built-in function that takes arguments is declared without a prototype. The -Wbuiltin-declaration-mismatch warning is on by default. The fix, diva, is to include the right header so the prototypes of built-in functions are in scope. โœจ

For example, the call to memset below gets diagnosed because the function wants a size_t 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 โ€” don't warn when certain built-in macros get redefined. This suppresses warnings for redefinition of __TIMESTAMP__, __TIME__, __DATE__, __FILE__, and __BASE_FILE__.
  • -Wkeyword-macro โ€” warns if a keyword is defined as a macro, or undefined. For C++, identifiers with special meaning and standard attribute identifiers get diagnosed too. This one's enabled by default for C++26 when -Wpedantic is on, and it emits a pedwarn in that case. ๐Ÿ‘‘
  • -Wfree-labels (C and Objective-C only) โ€” warns if a label is applied to a non-statement, or shows up at the end of a compound statement. C23 and later dialects of C allow labels like that, and they're available as a GCC extension in every other dialect. ๐Ÿฆ‹

This warning is also enabled by -Wc11-c23-compat. And if you're building for a C version before C23, -pedantic-errors turns it into an error.

  • -Wheader-guard โ€” warns if a valid preprocessor header multiple-inclusion guard has a #define directive right after the #ifndef or #if !defined directive for the guard, where that #define defines a different macro from the guard macro with a similar name, the actual multiple inclusion guard macro isn't defined at the corresponding #ifndef directive at the end of the header, and the #define directive defines an object-like macro with an empty definition. In that case it's usually just a misspelled guard name โ€” either in the #ifndef / #if !defined directive or in the #define that follows it. This warning is enabled by -Wall. ๐Ÿ˜ญ
  • -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 allowed without a warning if it's preceded by a declaration that does specify the argument types.)
  • -Wold-style-declaration (C and Objective-C only) โ€” warns about obsolescent usages in a declaration, per the C Standard. Like, warns if storage-class specifiers such as static aren't the first things in a declaration. Also enabled by -Wextra. ๐Ÿ’€
  • -Wold-style-definition (C and Objective-C only) โ€” warns if an old-style function definition is used. You get a warning even if there's a previous prototype. A definition using () is not considered old-style in C23 mode, because there it's equivalent to (void) โ€” but for older standards it totally counts as old-style.
  • -Wmultiple-parameter-fwd-decl-lists (C and Objective-C only) โ€” warns if more than one list of forward declarations of parameters shows up in a function prototype. Also enabled by -Wextra.
  • -Wdeprecated-non-prototype (C and Objective-C only) โ€” warns if a function declared with an empty parameter list () gets called with one or more arguments, or if a function definition with one or more parameters shows up after a declaration like that. Both cases are errors in C23 and later dialects of C. ๐Ÿšฉ

This warning is also enabled by -Wc11-c23-compat.

  • -Wmissing-parameter-name (C and Objective-C only) โ€” warns if a function definition omits a parameter name and only gives its type. You can use that to document that a parameter goes unused in the definition. It's part of C23 and later dialects of C, and available as a GCC extension in all other dialects. ๐ŸŽ€

This warning is also enabled by -Wc11-c23-compat. It gets turned into an error if you're building for a C version before C23 with -pedantic-errors.

  • -Wmissing-parameter-type (C and Objective-C only) โ€” a function parameter is 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) โ€” don't warn if a function declaration has a parameter name with no type. Declarations like that give you no function prototype and 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. You can downgrade that error to a warning with -fpermissive (along with certain other errors), or just for this one error with -Wno-error=declaration-missing-parameter-type.

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

  • -Wmissing-prototypes (C and Objective-C only) โ€” warns if a global function is defined without a previous prototype declaration. You get this warning even if the definition itself provides a prototype. Use it to sniff out global functions that don't have a matching prototype declaration in a header file. Not valid for C++, bestie, because every function declaration there provides a prototype and a non-matching declaration declares an overload instead of conflicting with an earlier declaration. Use -Wmissing-declarations to find missing declarations in C++. ๐Ÿ”
  • -Wmissing-variable-declarations (C and Objective-C only) โ€” warns if a global variable is defined without a previous declaration. Use it to find 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. It does that even if the definition itself provides a prototype. Use it to catch global functions that aren't declared in header files. In C, no warnings are issued for functions with previous non-prototype declarations โ€” use -Wmissing-prototypes for those. In C++, no warnings are issued for function templates, inline functions, or functions in anonymous namespaces. ๐Ÿ’…
  • -Wmissing-field-initializers โ€” warns if a structure's initializer is missing some fields. Like, 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 doesn't warn about designated initializers, so this tweak doesn't trigger anything:

struct s { int f, g, h; };
struct s x = { .f = 3, .g = 4 };

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++ โ€” it doesn't warn about the empty { } initializer:

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 appearing 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 the user meant to write:

bool satisfied = requires { requires C<T> };

so that satisfied is only true if concept C is satisfied for type T.

You can disable this warning with -Wno-missing-requires.

  • -Wno-missing-template-keyword โ€” the member access tokens ., -> and :: must be followed by the template keyword when 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 those, wrap the expression in parentheses. For example, the following 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 โ€” bestie, do NOT warn when someone busts out a multicharacter constant like 'FOOF'. Usually those are just a typo in the user's code, because they have implementation-defined values and you should not be using them in portable code. ๐Ÿซ 
  • -Wnormalized=[none|id|nfc|nfkc] โ€” okay so in ISO C and ISO C++, two identifiers are different if they're different sequences of characters. But sometimes when you use characters outside the basic ASCII set, you can have two different character sequences that look exactly the same. ๐Ÿ’€ To avoid that confusion, the ISO 10646 standard sets out some normalization rules which, when applied, make two sequences that look the same turn into the same sequence. GCC can warn you if you're using identifiers that haven't been normalized โ€” and this option controls that warning.

There are four levels of warning supported by GCC:

  • The default is -Wnormalized=nfc, which warns about any identifier that's not in the ISO 10646 "C" normalized form, NFC. NFC is the recommended form for most uses, and it's equivalent to just -Wnormalized.

Unfortunately there are some characters allowed in identifiers by ISO C and ISO C++ that, when turned into NFC, are not allowed in identifiers. That is, there's literally 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. But 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 once 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 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 that contains the letter O because it might be confused with the digit 0, so it's not the default โ€” but it may 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. ๐Ÿ™ˆ

In C++, explicitly specifying -Wdeprecated also enables warnings about some features that are deprecated in later language standards, specifically -Wcomma-subscript, -Wvolatile, -Wdeprecated-enum-float-conversion, -Wdeprecated-enum-enum-conversion, -Wdeprecated-literal-operator, and -Wdeprecated-variadic-comma-omission.

  • -Wno-deprecated-declarations โ€” do not warn about uses of functions, variables, or types marked as deprecated by using the "deprecated" attribute.
  • -Wno-deprecated-openmp โ€” do not warn about deprecated OpenMP code.
  • -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 โ€” warn about potentially suboptimal choices related to OpenACC parallelism.
  • -Wno-openmp โ€” warn about suspicious OpenMP code.
  • -Wopenmp-simd โ€” warn if the vectorizer cost model overrides the OpenMP simd directive set by user. The -fsimd-cost-model=unlimited option can be used to relax the cost model. ๐ŸŒˆ
  • -Woverride-init (C and Objective-C only) โ€” warn if an initialized field without side effects is overridden when using designated initializers.

This warning is included in -Wextra. To get 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 โ€” warn if a structure is given the packed attribute, but the packed attribute has no effect on the layout or size of the structure. Such structures may be mis-aligned for little benefit. For instance, in this code, the variable "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 was fixed in GCC 4.4 but the change can lead to differences in the structure layout. GCC informs you when the offset of such a field has changed in GCC 4.4. For example there'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) โ€” warn if a structure field with explicitly specified alignment in a packed struct or union is misaligned. For example, a warning will be issued on "struct S", 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 โ€” warn if padding is included in a structure, either to align an element of the structure or to align the whole structure. Sometimes when this happens it's possible to rearrange the fields of the structure to reduce the padding and so make the structure smaller. ๐ŸŽ€
  • -Wredundant-decls โ€” warn if anything is declared more than once in the same scope, even in cases where multiple declaration is valid and changes nothing.
  • -Wrestrict โ€” warn when an object referenced by a "restrict"-qualified parameter (or, in C++, a "__restrict"-qualified parameter) is aliased by another argument, or when copies between such objects overlap. For example, the call to the "strcpy" function below attempts to truncate the string by replacing its initial characters with the last four. However, because the call writes the terminating NUL into "a[4]", the copies overlap and the call is diagnosed. ๐Ÿ˜ญ
        void foo (void)
        {
          char a[] = "abcd1234";
          strcpy (a, a + 4);
          ...
        }

The -Wrestrict option detects some instances of simple overlap even without optimization but works best at -O2 and above. It is included in -Wall. ๐Ÿ”ฅ

  • -Wnested-externs (C and Objective-C only) โ€” warn if an "extern" declaration is encountered within a function.
  • -Winline โ€” warn if a function that is declared as inline cannot be inlined. Even with this option, the compiler does not warn about failures to inline functions declared in system headers. ๐Ÿ™ˆ

The compiler uses a variety of heuristics to determine whether or not to inline a function. For example, the compiler takes into account the size of the function being inlined and the amount of inlining that's already been done in the current function. Therefore, seemingly insignificant changes in the source program can cause the warnings produced by -Winline to appear or disappear. It's giving โœจchaosโœจ honestly.

  • -Winterference-size
  • -Wno-interference-size โ€” warn about questionable uses of the C++17 "constexpr" variables "std::hardware_destructive_interference_size" and "std::hardware_constructive_interference_size". ๐Ÿ’…

These variables are 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, these variables are given values 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). ๐Ÿซถ

If ABI stability is important, such as if the use is in a header for a library, you should probably not use the hardware interference size variables at all.

These warnings are enabled by default. If you're confident that your use of these variables doesn't affect ABI outside a single build of your project, you can turn off the warning with -Wno-interference-size.

  • -Wint-in-bool-context โ€” warn for suspicious use of integer values where boolean values are expected, such as conditional expressions (?:) using non-boolean integer constants in boolean context, like "if (a <= b ? 2 : 3)". Or left shifting of signed integers in boolean context, like "for (a = 0; 1 << a; a++);". Likewise for all kinds of multiplications regardless of the data type. This warning is enabled by -Wall. ๐Ÿ‘‘
  • -Wno-int-to-pointer-cast โ€” suppress warnings from casts to pointer type of an integer of a different size. In C++, casting to a pointer type of smaller size is an error. Wint-to-pointer-cast is enabled by default. ๐Ÿ’…

  • -Wno-pointer-to-int-cast (C and Objective-C only) โ€” shuts off the warnings you get when you cast a pointer into an integer type of a different size. bestie the pointer does not fit, that's the whole tea ๐Ÿซ–
  • -Winvalid-pch โ€” yells at you if a precompiled header shows up in the search path but cannot be used. it's right there and it's useless, it's giving expired gift card ๐Ÿ’€
  • -Winvalid-utf8 โ€” warns when it finds an invalid UTF-8 character. this one is on by default for C++23 if -finput-charset=UTF-8 is used, and it gets upgraded into a full-on error with -pedantic-errors.
  • -Wno-unicode โ€” don't diagnose invalid forms of delimited or named escape sequences that are treated as separate tokens. Wunicode is enabled by default. โœจ
  • -Wlong-long โ€” warns if the long long type gets used. this gets switched on by either -Wpedantic or -Wtraditional in ISO C90 and C++98 modes. wanna mute it? use -Wno-long-long.
heads up: this warning gets upgraded to an error by -pedantic-errors.
  • -Wvariadic-macros โ€” warns if variadic macros are used in ISO C90 mode, or if the GNU alternate syntax is used in ISO C99 mode. enabled by either -Wpedantic or -Wtraditional. to hush it, use -Wno-variadic-macros.
  • -Wno-varargs โ€” don't warn about questionable usage of the macros that handle variable arguments, like va_start. these warnings are on by default.
  • -Wvector-operation-performance โ€” warns if a vector operation isn't implemented via the SIMD capabilities of the architecture. mainly useful for performance tuning. a vector operation can be implemented three ways, and here's the lore: "piecewise" means the scalar operation is done on every single vector element; "in parallel" means the vector operation is implemented using scalars of a wider type, which normally is more performance efficient; and "as a single scalar" means the vector fits into a scalar type. ๐Ÿ’…
  • -Wvla โ€” warns if a variable-length array is used in the code. -Wno-vla stops the -Wpedantic warning about the variable-length array.
this warning gets upgraded to an error by -pedantic-errors.
  • -Wvla-larger-than=_byte-size_ โ€” with this one on, the compiler warns about declarations of variable-length arrays whose size is either unbounded, or bounded by an argument that lets the array size go past _byte-size_ bytes. works similar to how -Walloca-larger-than=_byte-size_ works, but for variable-length arrays instead.

ngl, GCC might optimize small variable-length arrays of a known value into plain arrays, so this warning might not even trigger for those. ๐Ÿ™ˆ

-Wvla-larger-than=PTRDIFF_MAX is enabled by default, but it's 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. it's 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 turns on detection of out-of-bounds accesses to those parameters via warnings like -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 fires for these redeclarations because the first one lets an array of any size be passed to f while the second one specifies that the array argument must have at least n elements. plus, calling f with the associated VLA bound parameter in excess of the actual VLA bound triggers a warning too:

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. 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 looks like the code meant exponentiation. specifically, the warning happens 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. ๐Ÿ˜ญ

you can silence this warning by converting one of the operands to hexadecimal, or by compiling with -Wno-xor-used-as-pow.

  • -Wdisabled-optimization โ€” warns if a requested optimization pass is disabled. ngl this warning doesn't generally mean anything is wrong with your code; it just means GCC's optimizers couldn't handle the code effectively. often the problem is 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.
  • -Wpointer-sign (C and Objective-C only) โ€” warns for pointer argument passing or assignment with different signedness. only supported for C and Objective-C. it's implied by -Wall and by -Wpedantic, which you can disable with -Wno-pointer-sign.
this warning gets upgraded to an error by -pedantic-errors.
  • -Wstack-protector โ€” this one is only active when -fstack-protector is active. it warns about functions that are not protected against stack smashing. ๐Ÿ›ก๏ธ
  • -Woverlength-strings โ€” warns about string constants longer than the "minimum maximum" length specified in the C standard. modern compilers generally allow string constants way longer than the standard's minimum limit, but very portable programs should avoid using longer strings.

the limit applies after string constant concatenation, and does not count the trailing NUL. in C90 the limit was 509 characters; in C99 it was raised to 4095. C++98 does not specify a normative minimum maximum, so we don't diagnose overlength strings in C++.

implied by -Wpedantic, and can be disabled with -Wno-overlength-strings.

  • -Wunsuffixed-float-constants (C and Objective-C only) โ€” issues a warning for any floating constant that doesn't have a suffix. when used together with -Wsystem-headers it also warns about such constants in system header files. this can be useful when preparing code to use with the FLOAT_CONST_DECIMAL64 pragma from the decimal floating-point extension to C99.
  • -Wno-lto-type-mismatch โ€” during the link-time optimization, don't warn about type mismatches in global declarations from different compilation units. requires -flto to be enabled. enabled by default.
  • -Wno-designated-init (C and Objective-C only) โ€” suppresses warnings when a positional initializer is used to initialize a structure that has been marked with the designated_init attribute.

โœจ Options That Control Static Analysis โœจ

  • -fanalyzer โ€” this option turns on a static analysis of program flow which looks for "interesting" interprocedural paths through the code, and issues warnings for problems found on them.

bestie, this analysis is much more expensive than other GCC warnings. ๐Ÿ˜ญ

in technical terms, it performs coverage-guided symbolic execution of the code being compiled. it is neither sound nor complete: it can have false positives and false negatives. it's a bug-finding tool, not a tool for proving program correctness.

the analyzer is only suitable for use on C code in this release.

enabling this option effectively enables the following warnings:

-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-throw-of-unexpected-type
-Wanalyzer-undefined-behavior-ptrdiff
-Wanalyzer-undefined-behavior-strtok
-Wanalyzer-unsafe-call-within-signal-handler
-Wanalyzer-use-after-free
-Wanalyzer-use-of-pointer-in-stale-stack-frame
-Wanalyzer-use-of-uninitialized-value
-Wanalyzer-va-arg-type-mismatch -Wanalyzer-va-list-exhausted
-Wanalyzer-va-list-leak -Wanalyzer-va-list-use-after-va-end
-Wanalyzer-write-to-const -Wanalyzer-write-to-string-literal

this option is only available if GCC was configured with analyzer support enabled.

  • -Wanalyzer-symbol-too-complex โ€” if -fanalyzer is enabled, the analyzer uses various heuristics to attempt to track the state of memory, but these can be defeated by sufficiently complicated code. ๐Ÿงš

By default, the analysis just silently gives up on tracking the values of expressions once they blow past some internal limit, and then it downgrades those expressions to a fuzzy, imprecise representation. If that happens, -Wanalyzer-symbol-too-complex will yell at you about it. ๐Ÿ’…

  • -Wanalyzer-too-complex โ€” so if -fanalyzer is on, the analyzer is out here using a bunch of heuristics trying to explore the control flow and data flow of your program, right? But likeโ€ฆ sufficiently messy code can just defeat all of that. ๐Ÿ˜ญ By default the analysis silently stops when the code is too complicated for the analyzer to fully explore and it hits an internal limit. This option is the one that warns you when that happens. fr fr.
  • -Wno-analyzer-allocation-size โ€” this warning needs -fanalyzer, which is what enables it; to turn it off, use -Wno-analyzer-allocation-size. This diagnostic warns about 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 โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-deref-before-check to disable it. This one warns about paths through the code where a pointer gets checked for NULL after it's already been dereferenced โ€” which is giving "bestie that pointer could have been NULL the whole time." ๐Ÿ’€ Cases like that mean the NULL check is either redundant, or it needs to get moved to before the dereference.

This diagnostic also treats values passed to a function argument marked with __attribute__((nonnull)) as requiring a non-NULL value, so it will complain if you check such values for NULL after returning from that function call.

Also? This diagnostic is unlikely to show up at all when any level of optimization is enabled, because GCC's optimization logic will typically consider those NULL checks redundant and just optimize them away before the analyzer ever "sees" them. So yeah โ€” turn optimization off if you're trying to trigger this one. โœจ

  • -Wno-analyzer-double-fclose โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-double-fclose to disable it. Warns about 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 โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-double-free to disable it. Warns about 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 โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-exposure-through-output-file to disable it. Warns about paths through the code where a security-sensitive value gets written to an output file โ€” think 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 one needs 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. It warns about "infoleaks" โ€” paths through the code where uninitialized values get copied across a security boundary, like code inside an OS kernel copying a partially-initialized struct on the stack over 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 โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-fd-access-mode-mismatch to disable it. Warns about paths through code where a read is attempted on a write-only file descriptor, or the other way around. ๐Ÿซ 

It 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 where 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 โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-fd-double-close to disable it. Warns about 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 โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-fd-leak to disable it. Warns about paths through code where an open file descriptor gets 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 โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-fd-phase-mismatch to disable it. Warns about 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. Not me skipping steps in the lifecycle ๐Ÿ˜ญ

See CWE-666: Operation on Resource in Wrong Phase of Lifetime (https://cwe.mitre.org/data/definitions/666.html).

  • -Wno-analyzer-fd-type-mismatch โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-fd-type-mismatch to disable it. Warns about paths through code where an operation is attempted on the wrong type of file descriptor. For example, it'll warn on attempts to use socket operations on a file descriptor obtained via open, or when attempting to use a stream socket operation on a datagram socket. ๐Ÿซ 
  • -Wno-analyzer-fd-use-after-close โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-fd-use-after-close to disable it. Warns about paths through code where a read or write is called on a closed file descriptor. ๐Ÿ’€

It also warns for paths through code where a function with attribute fd_arg (N) or fd_arg_read (N) or fd_arg_write (N) is called with a closed file descriptor at referenced argument N.

  • -Wno-analyzer-fd-use-without-check โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-fd-use-without-check to disable it. Warns about paths through code where a file descriptor is used without being checked for validity. ๐Ÿšจ

It also warns for paths through code 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 โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-file-leak to disable it. Warns about paths through the code where a <stdio.h> FILE * stream object gets leaked. ๐Ÿ˜ฌ

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 โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-free-of-non-heap to disable it. Warns about paths through the code where free is called on a non-heap pointer โ€” like an on-stack buffer, or a global. ๐Ÿ’…

See CWE-590: Free of Memory not on the Heap (https://cwe.mitre.org/data/definitions/590.html).

  • -Wno-analyzer-imprecise-fp-arithmetic โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-imprecise-fp-arithmetic to disable it. Warns about paths through the code where floating-point arithmetic is used in places where precise computation is needed. As of right now, this diagnostic only warns on use of floating-point operands inside the calculation of an allocation size. โœจ
  • -Wno-analyzer-infinite-loop โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-infinite-loop to disable it. This diagnostic warns about paths through the code which appear to lead to an infinite loop. ๐Ÿ”

Specifically, the analyzer will issue this warning when it "sees" a loop in which:

  • 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's 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 about the above case because if opcode ever matches none of the cases, the switch will follow the implicit default case, which makes the body of the loop a "no-op" with cpu_state.pc unchanged โ€” so it uses the same value of opcode on all subsequent iterations, leading to an infinite loop. bestie it's literally just vibing forever ๐Ÿ˜ญ

See CWE-835: Loop with Unreachable Exit Condition ('Infinite Loop') (https://cwe.mitre.org/data/definitions/835.html).

  • -Wno-analyzer-infinite-recursion โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-infinite-recursion to disable it.

okay so this diagnostic is the analyzer's "bestieโ€ฆ are you stuck in a loop?" radar, and it warns about paths through your code that appear to lead to infinite recursion. ๐Ÿ’€

Here's the tea on how it actually works: when the analyzer "sees" a recursive call, it compares the state of memory at the entry to the new frame against the state at the entry to the previous frame of that same function on the stack. If nothing in memory appears to be changing, it fires the warning. But the second it does see changes to parameters or globals, it assumes those changes will lead to the recursion terminating, and the warning gets suppressed. ๐Ÿซถ

Bestie, important: this diagnostic is likely to miss cases of infinite recursion that get converted to iteration by the optimizer before the analyzer ever "sees" them. So if you're trying to trigger this thing, disable optimization. Fr fr. โœจ

And compare it with -Winfinite-recursion, which hands you a similar diagnostic but is implemented in a completely different way. Same goal, different vibe. ๐ŸŒธ

See CWE-674: Uncontrolled Recursion (https://cwe.mitre.org/data/definitions/674.html).


  • -Wno-analyzer-jump-through-null โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-jump-through-null to disable it.

This diagnostic warns for paths through the code where a NULL function pointer gets called. Which is, obviously, not the move. ๐Ÿ’€

  • -Wno-analyzer-malloc-leak โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-malloc-leak to disable it.

This diagnostic warns for paths through the code where a pointer allocated via an allocator gets leaked โ€” and by "an allocator" we mean either malloc, or any function marked with the attribute malloc. Memory justโ€ฆ vibing out there forever, un-freed. ๐Ÿ˜ญ

See CWE-401: Missing Release of Memory after Effective Lifetime (https://cwe.mitre.org/data/definitions/401.html).

  • -Wno-analyzer-mismatching-deallocation โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-mismatching-deallocation to disable 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 that pointer value in the first place. It'll call out mismatches between free, scalar delete and vector delete[], plus anything marked as an allocator/deallocator pair using the attribute malloc. Pairing them up wrong? Not slay. ๐Ÿ™ˆ

See CWE-762: Mismatched Memory Management Routines (https://cwe.mitre.org/data/definitions/762.html).

  • -Wno-analyzer-out-of-bounds โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-out-of-bounds to disable it.

This diagnostic warns for paths through the code where a buffer is definitely read or written out-of-bounds. It applies to cases where the analyzer can determine a constant offset, and to accesses past the end of a buffer that also has a constant capacity. On top of that, it does limited checking for accesses past the end when the offset and the capacity are both symbolic. ๐Ÿ”ฅ

See CWE-119: Improper Restriction of Operations within the Bounds of a Memory Buffer (https://cwe.mitre.org/data/definitions/119.html).

For the cases where the analyzer is able to, it will emit a text art diagram visualizing the spatial relationship between the memory region the analyzer predicts would be accessed and the range of memory that's actually valid to access: whether they overlap, are touching, are close or far apart; which one comes before or after in memory; the relative sizes involved; the direction of the access (read vs write); and in some cases, the values of the data involved. It's giving crime scene reconstruction ngl. ๐ŸŽ€

This diagram can be suppressed using -fdiagnostics-text-art-charset=none.

  • -Wno-analyzer-overlapping-buffers โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-overlapping-buffers to disable 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.

Specifically, the diagnostic occurs on calls to the following functions:

  • memcpy
  • strcat
  • strcpy

โ€ฆfor cases where the buffers are known to overlap. Bestie, that's undefined behavior territory, we do not go there. ๐Ÿ’…

  • -Wno-analyzer-possible-null-argument โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-possible-null-argument to disable it.

This diagnostic warns for paths through the code where a possibly-NULL value is passed to a function argument marked with __attribute__((nonnull)) โ€” y'know, the ones that require a non-NULL value. ๐Ÿ˜ญ

See CWE-690: Unchecked Return Value to NULL Pointer Dereference (https://cwe.mitre.org/data/definitions/690.html).

  • -Wno-analyzer-possible-null-dereference โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-possible-null-dereference to disable it.

This diagnostic warns for paths through the code where a possibly-NULL value gets dereferenced. ๐Ÿ’€

See CWE-690: Unchecked Return Value to NULL Pointer Dereference (https://cwe.mitre.org/data/definitions/690.html).

  • -Wno-analyzer-null-argument โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-null-argument to disable 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. Yeah, we knew. And we did it anyway. ๐Ÿ™ˆ

See CWE-476: NULL Pointer Dereference (https://cwe.mitre.org/data/definitions/476.html).

  • -Wno-analyzer-null-dereference โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-null-dereference to disable it.

This diagnostic warns for paths through the code where a value known to be NULL is dereferenced. No guessing here, bestie, the analyzer already knows. ๐Ÿ˜ญ

See CWE-476: NULL Pointer Dereference (https://cwe.mitre.org/data/definitions/476.html).

  • -Wno-analyzer-putenv-of-auto-var โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-putenv-of-auto-var to disable it.

This diagnostic warns for paths through the code where a call to putenv is passed a pointer to an automatic variable or an on-stack buffer. That stack frame is gonna evaporate, bestie, and your env var goes with it. ๐Ÿฆ‹

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 warning requires -fanalyzer, which enables it; use -Wno-analyzer-shift-count-negative to disable it.

This diagnostic warns for paths through the code where a shift is attempted with a negative count. It's analogous to the -Wshift-count-negative diagnostic implemented in the C/C++ front ends, but this one is implemented based on analyzing interprocedural paths, rather than merely parsing the syntax tree. That said โ€” the analyzer does not prioritize detection of such paths, so false negatives are more likely relative to other warnings. ๐Ÿซถ

  • -Wno-analyzer-shift-count-overflow โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-shift-count-overflow to disable it.

This diagnostic warns for paths through the code where a shift is attempted with a count greater than or equal to the precision of the operand's type. It's analogous to the -Wshift-count-overflow diagnostic implemented in the C/C++ front ends, but again, this one is implemented based on analyzing interprocedural paths, rather than merely parsing the syntax tree. And again: the analyzer does not prioritize detection of such paths, so false negatives are more likely relative to other warnings. โญ

  • -Wno-analyzer-stale-setjmp-buffer โ€” This warning requires -fanalyzer, which enables it; use -Wno-analyzer-stale-setjmp-buffer to disable it.

This diagnostic warns for paths through the code where longjmp is called to rewind to a jmp_buf relating to a setjmp call in a function that has already returned.

Here's why that's cursed: when setjmp is called on a jmp_buf to record a rewind location, it records the stack frame. That stack frame becomes invalid when the function containing the setjmp call returns. Trying to rewind to it via longjmp would reference a stack frame that no longer exists, and it would likely lead to a crash (or worse). ๐Ÿ’€

  • -Wno-analyzer-tainted-allocation-size โ€” This warning requires -fanalyzer which enables it; use -Wno-analyzer-tainted-allocation-size to disable it.

This diagnostic warns for paths through the code where a value that could be under an attacker's control is used as the size of an allocation without being sanitized โ€” meaning an attacker could inject an excessively large allocation and potentially cause a denial of service attack. ๐Ÿ˜ญ

See CWE-789: Memory Allocation with Excessive Size Value (https://cwe.mitre.org/data/definitions/789.html).

  • -Wno-analyzer-tainted-assertion โ€” This warning requires -fanalyzer which enables it; use -Wno-analyzer-tainted-assertion to disable it.

This diagnostic warns for paths through the code where a value that could be under an attacker's control is used as part of a condition without being first sanitized, and that condition guards a call to a function marked with the attribute noreturn (such as the function __builtin_unreachable). Functions like that typically indicate abnormal termination of the program โ€” assertion failure handlers, for instance. For example:

assert (some_tainted_value < SOME_LIMIT);

In such cases:

  • when assertion-checking is enabled: an attacker could trigger a denial of service by injecting an assertion failure ๐Ÿซ 
  • when assertion-checking is disabled, such as by defining NDEBUG, an attacker could inject data that subverts the process, since it presumably violates a precondition that is being assumed by the code. ๐Ÿ’€

Note that when assertion-checking is disabled, the assertions are typically removed by the preprocessor before the analyzer has a chance to "see" them, so this diagnostic can only generate warnings on builds in which assertion-checking is enabled.

For the purpose of this warning, any function marked with the attribute noreturn is considered as a possible assertion failure handler, including __builtin_unreachable. Note that these functions are sometimes removed by the optimizer before the analyzer "sees" them. Hence optimization should be disabled when attempting to trigger this diagnostic.

See CWE-617: Reachable Assertion (https://cwe.mitre.org/data/definitions/617.html).

The warning can also report problematic constructions such as

...and it's like, lowkey the vibes here are:

switch (some_tainted_value) {
case 0:
  /* [...etc; various valid cases omitted...] */
  break;

default:
  __builtin_unreachable (); /* BUG: attacker can trigger this  */
}

even though technically that's not actually an assertion failure, bestie. Just saying. ๐Ÿ™ˆ


  • -Wno-analyzer-tainted-array-index โ€” this one needs -fanalyzer to be on (that's what turns it on in the first place), so hit it with -Wno-analyzer-tainted-array-index to make it shut up.

It warns you about paths through your code where a value that could be under some attacker's control gets used as an array index without being sanitized first โ€” meaning an attacker could sneak in 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 is what enables it; use -Wno-analyzer-tainted-divisor to turn it off.

Warns about paths through the code where a value that could be under an attacker's control is used as the divisor in a division or modulus operation without being sanitized, so an attacker could inject a division-by-zero. ๐Ÿ’€

See CWE-369: Divide By Zero (https://cwe.mitre.org/data/definitions/369.html).

  • -Wno-analyzer-tainted-offset โ€” needs -fanalyzer, which is what enables it; use -Wno-analyzer-tainted-offset to disable it.

Warns about paths through the code where a value that could be under an attacker's control is 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 is what enables it; use -Wno-analyzer-tainted-size to disable it.

Warns about paths through the code where a value that could be under an attacker's control is used as the size of an operation like memset 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-throw-of-unexpected-type โ€” needs -fanalyzer, which is what enables it; use -Wno-analyzer-throw-of-unexpected-type to disable it. Heads up tho: dynamic exception specifications only exist in C++14 and earlier, so this is a legacy-era situation. ๐Ÿซถ

Warns about paths through the code where an exception gets thrown from a function with a dynamic exception specification, and the exception doesn't comply with that specification.

  • -Wno-analyzer-undefined-behavior-ptrdiff โ€” this one needs -fanalyzer, which enables it; use -Wno-analyzer-undefined-behavior-ptrdiff to disable it.

Warns about paths through the code where a pointer subtraction happens and the pointers refer to different chunks of memory. That kind of code is leaning on undefined behavior, because pointer subtraction is only defined when both pointers point within (or just after) the same array. ๐Ÿšจ

See CWE-469: Use of Pointer Subtraction to Determine Size (https://cwe.mitre.org/data/definitions/469.html).

  • -Wno-analyzer-undefined-behavior-strtok โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-undefined-behavior-strtok to disable it.

Warns about paths through the code 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. Not cute, 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 through the code 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 through the code where a pointer is used after a deallocator was called on it: either free, or a deallocator referenced by attribute malloc.

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 through the code where a pointer gets dereferenced that points to a variable 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 through the code where the analyzer catches an attempt to use va_arg to extract a value passed to a variadic call, but using a type that doesn't match the type of the expression passed to the call.

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 through the code where the analyzer catches an attempt to use va_arg to access the next value passed to a variadic call, but all the values in the va_list have already been consumed. nothing left in the tank bestie ๐Ÿ“

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 through the code where the analyzer catches that va_start or va_copy was called on a va_list without a matching 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 through the code 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.

Warns about paths through the code where the analyzer catches an attempt to write through a pointer to a const object. But fr, the analyzer doesn't prioritize detecting those paths, so false negatives are more likely here compared to other warnings.

  • -Wno-analyzer-write-to-string-literal โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-write-to-string-literal to disable it.

Warns about paths through the code where the analyzer catches an attempt to write through a pointer to a string literal. Same deal tho: the analyzer doesn't prioritize detecting these paths, so false negatives are more likely relative to other warnings.

  • -Wno-analyzer-use-of-uninitialized-value โ€” needs -fanalyzer, which enables it; use -Wno-analyzer-use-of-uninitialized-value to disable it.

Warns about paths through the code where an uninitialized value is used. ๐Ÿ˜ญ

See CWE-457: Use of Uninitialized Variable (https://cwe.mitre.org/data/definitions/457.html).


The analyzer just knows how these memory-management functions behave, hardcoded in, no cap:

  • 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

It also knows these ones for working with file descriptors:

  • open
  • close
  • creat
  • dup, dup2 and dup3
  • isatty
  • pipe, and pipe2
  • read
  • write
  • socket, bind, listen, accept, and connect

And these 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 these ones too, periodt:

  • 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

On top of all that, a whole bunch of functions with an __analyzer_ prefix have special meaning to the analyzer, and those are described over in the GCC Internals manual. Various internal parameters, settable via --param, are used to control the exploration โ€” those are documented in the GCC Internals manual too. ๐Ÿฆ‹

The following options control the analyzer.

  • -fanalyzer-assume-nothrow โ€” okay so default behavior first: if -fexceptions is on, the analyzer is gonna assume that calling any function without the nothrow attribute could throw an exception. Which sounds helpful โ€” it can help sniff out execution paths that leak because exceptions yeeted themselves right past the clean-up code. But ๐Ÿ’€ it can also give you false positives when you're using headers where the author didn't bother adding the nothrow attribute.

So if you flip -fanalyzer-assume-nothrow on, the analyzer assumes external functions do not throw exceptions. Lowkey useful for cutting down the "noise" from the analyzer when you've got -fexceptions enabled on C code, but be careful โ€” it could hide real issues if something the C code calls actually can raise an exception.

  • -fanalyzer-call-summaries โ€” simplify the interprocedural analysis by computing the effect of certain calls instead of exploring every single path through the function from the callsite to each possible return. No cap, it's a time-saver.

If it's enabled, call summaries are only used for functions that have more than one call site and are sufficiently complicated. โœจ

  • -fanalyzer-checker=name โ€” restrict the analyzer to run just the named checker, and enable it. One checker, main character energy, everybody else sit down. ๐Ÿ’…
  • -fanalyzer-debug-text-art-headings โ€” this one's for analyzer developers. If enabled, the analyzer adds extra annotations to any diagrams it generates. ๐ŸŽจ
  • -fno-analyzer-feasibility โ€” also for analyzer developers.

By default the analyzer double-checks 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 โ€” does nothing. Preserved for backward compatibility. That's it, that's the whole option. ๐Ÿ’€
  • -fanalyzer-show-duplicate-count โ€” analyzer developers, this one's yours: if multiple diagnostics have been detected as duplicates of each other, it emits a note when reporting the best diagnostic, telling you the number of additional diagnostics that got suppressed by the deduplication logic. Receipts for the ones you never saw. ๐Ÿงพ
  • -fanalyzer-show-events-in-system-headers โ€” by default the analyzer emits simplified diagnostics paths by hiding events that are fully located within a system header. With -fanalyzer-show-events-in-system-headers, those events are no longer suppressed. ๐Ÿ™ˆโžก๏ธ๐Ÿ‘€
  • -fno-analyzer-simplify-supergraph โ€” analyzer developers only.

By default, the analyzer does a bunch of simplifications to the program supergraph before analyzing it. With -fno-analyzer-simplify-supergraph you can suppress that simplification, for debugging issues with it.

  • -fno-analyzer-state-merge โ€” analyzer developers only, part two.

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 gets suppressed, for debugging state-handling issues.

  • -fno-analyzer-state-purge โ€” analyzer developers only, part three.

By default the analyzer tries to simplify analysis by purging aspects of state at a program point that appear to no longer be relevant โ€” like the values of locals that aren't accessed later in the function and that aren't relevant to leak analysis.

With -fno-analyzer-state-purge that purging gets suppressed, for debugging state-handling issues.

  • -fno-analyzer-suppress-followups โ€” analyzer developers only, part four.

By default the analyzer stops exploring an execution path after it hits certain diagnostics, so it doesn't accidentally dump a whole cascade of follow-up diagnostics on you. 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 those diagnostics โ€” which can help when debugging issues in the analyzer, or for microbenchmarks for detecting undefined behavior. ๐Ÿ”ฅ

  • -fanalyzer-transitivity โ€” this one enables transitivity of constraints within the analyzer. Math girlies rise. ๐Ÿ“
  • -fno-analyzer-undo-inlining โ€” analyzer developers only, part five.

-fanalyzer runs relatively late compared to other code analysis tools, and some optimizations have already been applied to the code by then. In particular, function inlining may have occurred, which means the interprocedural execution paths emitted by the analyzer can contain function frames that don't correspond to the ones in the original source code.

By default the analyzer tries to reconstruct the original function frames and emit events showing the inlined calls. With -fno-analyzer-undo-inlining, that attempt to reconstruct the original frame info can be disabled โ€” which may help when debugging issues in the analyzer.

  • -fanalyzer-verbose-edges โ€” analyzer developers only, part six. It enables more verbose, lower-level detail in the descriptions of control flow within diagnostic paths. Spill the details, bestie.
  • -fanalyzer-verbose-state-changes โ€” analyzer developers only, part seven. It enables more verbose, lower-level detail in the descriptions of events relating to state machines within diagnostic paths.
  • -fanalyzer-verbosity=level โ€” this one controls how complex the control flow paths emitted for analyzer diagnostics get to be. Pick your level, queen ๐Ÿ‘‘.

The level can be one of:

  1. 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. (Both receipts, side by side. ๐Ÿงพ๐Ÿงพ)
  2. As per the previous level, but also show events for the entry to each function.
  3. As per the previous level, but also show events relating to control flow that are significant to triggering the issue โ€” e.g. true path taken at a conditional.

This level is the default. โญ

  1. As per the previous level, but show all control flow events, not just the significant ones.
  2. This level is intended for analyzer developers; it adds various other events intended for debugging the analyzer.
  • -fdump-analyzer โ€” dump internal details about what the analyzer is doing to file.analyzer.txt. Note that -fdump-analyzer-stderr overrides this option. ๐Ÿ“„
  • -fdump-analyzer-stderr โ€” dump internal details about what the analyzer is doing to stderr. This option overrides -fdump-analyzer. ๐Ÿซถ
  • -fdump-analyzer-callgraph โ€” dump a representation of the call graph suitable for viewing with GraphViz to file.callgraph.dot. ๐Ÿ“Š
  • -fdump-analyzer-exploded-graph โ€” dump 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. ๐ŸŒˆ
  • -fdump-analyzer-exploded-nodes โ€” emit diagnostics showing where nodes in the "exploded graph" are in relation to the program source. ๐Ÿ“
  • -fdump-analyzer-exploded-nodes-2 โ€” dump a textual representation of the "exploded graph" to file.eg.txt. ๐Ÿ“
  • -fdump-analyzer-exploded-nodes-3 โ€” dump a textual representation of the "exploded graph" to one dump file per node, to file.eg-id.txt. Heads up: this is typically a large number of dump files. ๐Ÿ˜ญ
  • -fdump-analyzer-exploded-paths โ€” dump a textual representation of the "exploded path" for each diagnostic to file.idx.kind.epath.txt.
  • -fdump-analyzer-feasibility โ€” dump internal details about the analyzer's search for feasible paths. The details get written in a form suitable for viewing with GraphViz to filenames of the form file.*.fg.dot, file.*.tg.dot, and file.*.fpath.txt.
  • -fdump-analyzer-infinite-loop โ€” dump internal details about the analyzer's search for infinite loops. โ™พ๏ธ The details get written in a form suitable for viewing with GraphViz to filenames of the form file.*.infinite-loop.dot.
  • -fdump-analyzer-json โ€” dump a compressed JSON representation of analyzer internals to file.analyzer.json.gz. Fair warning: the precise format is subject to change. ๐Ÿ™ˆ
  • -fdump-analyzer-state-purge โ€” as per -fdump-analyzer-supergraph, dump a representation of the "supergraph" suitable for viewing with GraphViz, but annotate the graph with info on what state will be purged at each node. The graph is written to file.state-purge.dot. ๐Ÿงน
  • -fdump-analyzer-supergraph โ€” dump representations of the "supergraph" suitable for viewing with GraphViz to file.supergraph.index.kind.dot. These show all of the control flow graphs in the program, at various stages of the analysis. And yeah โ€” the precise set of dumps and what they show is subject to change.
  • -fdump-analyzer-untracked โ€” emit custom warnings with internal details intended for analyzer developers. ๐Ÿ› ๏ธ

๐Ÿ› Options for Debugging Your Program ๐Ÿ›

So to tell GCC to emit extra info for a debugger to snack on, in almost all cases you just need to add -g to your other options. Periodt. Some debug formats can co-exist (like DWARF with CTF) as long as you enable each of them explicitly by adding the respective command line option to your other options. ๐Ÿ’…

GCC lets you use -g with -O. And ngl, the shortcuts optimized code takes can be occasionally surprising: some variables you declared may not exist at all; flow of control may briefly move somewhere you did not expect; 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 โ€” which is what makes it reasonable to use the optimizer for programs that might have bugs.

If you're not using some other optimization option, consider using -Og with -g. Here's why: with no -O option at all, some compiler passes that collect information useful for debugging don't run at all, so -Og may give you a better debugging experience. โœจ

  • -g, --debug โ€” produce debugging information in the operating system's native format (stabs, COFF, XCOFF, or DWARF). GDB can work with this debugging information. ๐Ÿซถ

On most systems that use stabs format, -g turns on extra debugging info that only GDB can use. Bestie, that extra stuff makes GDB debugging lowkey amazing, but it's also giving "other debuggers will crash or straight-up refuse to read the program" ๐Ÿ’€. So if you wanna control for certain whether that extra info gets generated, use -gvms (peek below ๐Ÿ‘‡).

  • -ggdb โ€” spit out debugging info made for GDB. That means "use the most expressive format available" โ€” DWARF, stabs, or the native format if neither of those is supported โ€” including GDB extensions whenever it's even possible. โœจ
  • -gdwarf, -gdwarf-version โ€” produce debugging info in DWARF format (if that's supported, bestie). The value of version can be 2, 3, 4 or 5, and the default 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. ๐Ÿ‘‘

Not me reminding you that with DWARF Version 2, some ports require and always use some non-conflicting DWARF 3 extensions in the unwind tables. That's just the vibe, okay?

Version 4 may require GDB 7.0 and -fvar-tracking-assignments for maximum benefit. Version 5 requires GDB 8.0 or higher. No cap. ๐Ÿซถ

GCC no longer supports DWARF Version 1, which is substantially different from 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. It's giving legacy-naming chaos, honestly. ๐ŸŽ€

  • -gbtf โ€” request BTF debug info. BTF is the default debugging format for the eBPF target. On other targets, like x86, BTF debug info can be generated along with DWARF debug info when both debug formats are enabled explicitly via their respective command line options. Two formats, one compilation, iconic. ๐Ÿ’…
  • -gprune-btf, -gno-prune-btf โ€” prune BTF information before emission. When pruning, only type information for types used by global variables and file-scope functions will be emitted. If you're compiling for the BPF target with BPF CO-RE enabled, type information will also be emitted for types used in BPF CO-RE relocations. Plus, struct and union types which are only referred to via pointers from members of other struct or union types shall be pruned and replaced with BTF_KIND_FWD, as though those types were only present in the input as forward declarations.

This option substantially reduces the size of the produced BTF information, but at a significant loss in the amount of detailed type information. It's primarily useful when compiling for the BPF target, to minimize the size of the resulting object, and to eliminate BTF information which is not immediately relevant to the BPF program loading process.

This option is enabled by default for the BPF target when generating BTF information. ๐Ÿ”ฅ

  • -gctf, -gctflevel โ€” request CTF debug info and use level to say how much CTF debug info should be produced. If -gctf is specified without a value for level, the default level of CTF debug info is 2.

CTF debug info can be generated along with DWARF debug info when both of the debug formats are enabled explicitly via their respective command line options. Slay, double format. ๐ŸŒˆ

  • Level 0 produces no CTF debug info at all. Thus, -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 โ€” produce debugging info in Alpha/VMS debug format (if that's supported). This is the format used by DEBUG on Alpha/VMS systems.
  • -gcodeview โ€” produce debugging info in CodeView debug format (if that's supported). This is the format used by Microsoft Visual C++ on Windows. Windows besties, this one's for you. ๐Ÿ’œ
  • -glevel, -ggdblevel, -gvmslevel โ€” request debugging info and also use level to specify how much information. The default level is 2. Okay so here's the level lore:
    • Level 0 produces no debug info at all. Thus, -g0 negates -g. Bye bye debug info ๐Ÿ‘‹
    • Level 1 produces minimal information, enough for making backtraces in parts of the program that you don't plan to debug. This includes descriptions of functions and external variables, and line number tables, but no information about local variables.
    • Level 2 is the normal setting to produce debuggable code. The debug output includes all the information from level 1, plus information about local variables and typedefs to allow stepping through code and examining its state. For C++ code, additional information is also emitted to assist in debugging namespace, class, and template functions. This is the main character setting, fr fr. โญ
    • 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. Last one wins, periodt.

Heads up bestie: -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 info for all symbols. Completionist energy. ๐Ÿ’–
  • -femit-class-debug-always โ€” instead of emitting debugging information for a C++ class in only one object file, emit it in all object files using the class. This option should be used only with debuggers that are unable to handle the way GCC normally emits debugging information for classes โ€” because using this option increases the size of debugging information by as much as a factor of two. Two times the debug info, so use it wisely. ๐Ÿ˜ญ
  • -fno-merge-debug-strings โ€” direct the linker to not merge together strings in the debugging information that are identical in different object files. Merging is not supported by all assemblers or linkers. Merging decreases the size of the debug 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 be used to replace a build-time path with an install-time path in the debug info. It can also be used to change an absolute path to a relative path by using . 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 โ€” run 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 information). โœจ

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 โ€” annotate assignments to user variables early in the compilation and attempt to carry the annotations over throughout the compilation all the way to the end, in an attempt to improve debug info while optimizing. Use of -gdwarf-4 is recommended along with it.

It can be enabled even if var-tracking is disabled, in which case annotations are created and maintained, but discarded at the end. By default, this flag is enabled together with -fvar-tracking, except when selective scheduling is enabled. Not me pointing out the exception, but like, the exception exists. ๐Ÿ‘€

  • -fvar-tracking-uninit, -fno-var-tracking-uninit โ€” perform variable tracking and also mark uninitialized variables in the debug info. This flag is enabled by default by -fvar-tracking; it also implies -fvar-tracking. To do variable tracking without marking uninitialized variables, use -fvar-tracking -fno-var-tracking-uninit. ๐ŸŽ€
  • -gsplit-dwarf โ€” if DWARF debugging information is enabled, separate as much debugging information as possible into a separate output file with the extension .dwo. This option allows the build system to avoid linking files with debug information. To be useful, this option requires a debugger capable of reading .dwo files. So like, don't do it for funsies, okay? ๐Ÿฆ‹
  • -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. Big format, small format, choose your fighter. ๐Ÿ’…
  • -gdescribe-dies โ€” add description attributes to some DWARF DIEs that have no name attribute, such as artificial variables, external references and call site parameter DIEs. Giving unnamed things a little name tag, how cute. ๐ŸŒธ
  • -gpubnames โ€” generate DWARF .debug_pubnames and .debug_pubtypes sections.
  • -ggnu-pubnames โ€” generate .debug_pubnames and .debug_pubtypes sections in a format suitable for conversion into a GDB index. This option is only useful with a linker that can produce GDB index version 7. iykyk. ๐Ÿ‘‘
  • -gno-pubnames โ€” don't generate DWARF .debug_pubnames and .debug_pubtypes sections. Simple as that. ๐Ÿ™…
  • -fdebug-types-section โ€” when using DWARF Version 4 or higher, type DIEs can be put into their own .debug_types section instead of making them part of the .debug_info section. It's more efficient to put them in a separate comdat section since the linker can then remove duplicates. But not all DWARF consumers support .debug_types sections yet and on some objects .debug_types produces larger instead of smaller debugging information. The plot twist nobody asked for. ๐Ÿ˜ญ
  • -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's enabled by default. See also -frecord-gcc-switches for another way of storing compiler options into the object file. โœจ

  • -gstrict-dwarf โ€” no glow-ups allowed bestie ๐Ÿ’… this one says you can't use extensions from a DWARF standard version later than whatever you picked with -gdwarf-version. On most targets, using non-conflicting DWARF extensions from later standard versions is totally allowed โ€” but not with this flag on. Periodt.
  • -gno-strict-dwarf โ€” okay so this is the chill one ๐Ÿฆ‹ it allows using extensions of later DWARF standard version than selected with -gdwarf-version.
  • -gas-loc-support โ€” 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. It's enabled by default if, at GCC configure time, the assembler is found to support such directives. โœจ
  • -gno-as-loc-support โ€” forces GCC to generate DWARF2+ line number tables internally, if DWARF2+ line number tables are to be generated. DIY energy, no assembler help ๐ŸŽ€
  • -gas-locview-support โ€” tells the compiler that the assembler supports "view" assignment and reset assertion checking in ".loc" directives. Enabled by default if, at GCC configure time, the assembler is found to support them. ๐ŸŒธ
  • -gno-as-locview-support โ€” forces 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 one 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. It's 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 causes the compiler to emit the line number table, which generally makes them somewhat less compact. The augmented line number tables and location lists are fully backward-compatible, so they can be consumed by debug information consumers that are not aware of these augmentations โ€” but they won't derive any benefit from them either ๐Ÿ™ˆ

This is enabled by default when outputting DWARF 2 debug information at the normal level, as long as there is assembler support, -fvar-tracking-assignments is enabled and -gstrict-dwarf is not. When assembler support is not available, this may still be enabled, but it forces GCC to output internal line number tables, and if -ginternal-reset-location-views is not enabled, that most certainly leads to silently mismatching location views. ๐Ÿ˜ญ

There is a proposed representation for view numbers that is not backward compatible with the location list format introduced in DWARF 5, that can be enabled with -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. ๐Ÿ’€

  • -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 instruction length estimates, which isn't always the case, and it may cause incorrect view lists to be generated silently when using an assembler that does not support location view lists. The GNU assembler flags any such error as a "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), zlib (use zlib compression in ELF gABI format), or zstd (use zstd compression in ELF gABI format). If the linker doesn't support writing compressed debug sections, the option is rejected. Otherwise, if the assembler does not support them, -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. ๐Ÿงช

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

Without any optimization option, the compiler's goal is to reduce the cost of compilation and to make debugging produce the expected results. Statements are independent: if you stop the program with a breakpoint between statements, you can then assign a new value to any variable or change the program counter to any other statement in the function and get exactly the results you expect from the source code. no surprises, no chaos, just vibes ๐ŸŽ€

Turning on optimization flags makes the compiler attempt to improve the performance and/or code size at the expense of compilation time and possibly the ability to debug the program. it's giving tradeoffs, bestie ๐Ÿ’…

The compiler performs optimization based on the knowledge it has of the program. Compiling multiple files at once to a single output file mode allows the compiler to use information gained from all of the files when compiling each of them. ๐Ÿ‘‘

Not all optimizations are controlled directly by a flag. Only optimizations that have a flag are listed in this section. ๐Ÿ™ˆ

Most optimizations are completely disabled at -O0 or if an -O level is not set on the command line, even if individual optimization flags are specified. Similarly, -Og suppresses many optimization passes. โญ

Depending on which target you're on and how GCC was built, you might get a slightly different set of optimizations turned on at each -O level than the ones listed right here. Wanna know the actual tea? ๐Ÿ‘€ Just run GCC with -Q --help=optimizers and it'll tell you exactly which optimizations are live at each level. Fr fr, it's the receipts. ๐Ÿงพ


โœจ The -O Levels: Pick Your Vibe โœจ

๐ŸŽ€ -O, -O1, --optimize

Optimize, bestie. ๐Ÿ’… Optimizing your compilation takes a little more time and a lot more memory for a big function, but it's so worth it.

With -O, the compiler tries to shrink your code size and execution time, without doing any of the optimizations that eat up a ton of compilation time.

-O is the recommended optimization level for large machine-generated code โ€” it's the sensible balance between compile time and memory use. Higher levels go harder with optimizations that have greater algorithmic complexity than -O does.

-O turns on these 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 -fivopts -fmerge-constants
-fmove-loop-invariants -fmove-loop-stores -fomit-frame-pointer
-freorder-blocks -fshrink-wrap -fshrink-wrap-separate
-fsplit-wide-types -fssa-backprop -fssa-phiopt -ftree-bit-ccp
-ftree-ccp -ftree-ch -ftree-coalesce-vars -ftree-copy-prop
-ftree-dce -ftree-dominator-opts -ftree-dse -ftree-forwprop
-ftree-fre -ftree-phiprop -ftree-pta -ftree-scev-cprop -ftree-sink
-ftree-slsr -ftree-sra -ftree-ter -funit-at-a-time

๐Ÿ”ฅ -O2

Optimize even more. ๐Ÿš€ GCC goes and does nearly all the supported optimizations that don't involve a space-speed tradeoff. Compared to -O, this bumps up both your compilation time and how fast the generated code runs.

-O2 turns on everything from -O1, plus these extra flags:

-falign-functions  -falign-jumps -falign-labels  -falign-loops
-fcaller-saves -fcode-hoisting -fcrossjumping -fcse-follow-jumps
-fcse-skip-blocks -fdelete-null-pointer-checks -fdep-fusion
-fdevirtualize  -fdevirtualize-speculatively
-fexpensive-optimizations -ffinite-loops -fgcse  -fgcse-lm
-fhoist-adjacent-loads -finline-functions -finline-small-functions
-findirect-inlining -fipa-bit-cp  -fipa-cp  -fipa-icf -fipa-ra
-fipa-sra  -fipa-vrp -fisolate-erroneous-paths-dereference
-flra-remat -foptimize-crc -foptimize-sibling-calls
-foptimize-strlen -fpartial-inlining -fpeephole2
-freorder-blocks-algorithm=stc -freorder-blocks-and-partition
-freorder-functions -frerun-cse-after-loop -fschedule-insns
-fschedule-insns2 -fsched-interblock  -fsched-spec
-fspeculatively-call-stored-functions -fstore-merging
-fstrict-aliasing -fthread-jumps -ftree-builtin-call-dce
-ftree-loop-vectorize -ftree-pre -ftree-slp-vectorize
-ftree-switch-conversion  -ftree-tail-merge -ftree-vrp
-fvect-cost-model=very-cheap
๐Ÿšจ Okay heads up, bestie โ€” please clock the warning under -fgcse about invoking -O2 on programs that use computed gotos. Don't skip it. ๐Ÿ’€

๐Ÿ‘‘ -O3

Optimize yet more. -O3 turns on everything from -O2 and these extra flags on top:

-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 results you actually expect. This is the default. โœจ

At -O0, GCC completely disables most optimization passes โ€” they don't run even if you explicitly enable them on the command line, or even if -Q --help=optimizers lists them as enabled by default. The thing is, lots of the optimizations GCC does depend on code analysis or canonicalization passes that only -O turns on, so running individual optimization passes all by themselves wouldn't even be useful. It's giving "no point, bestie". ๐Ÿ™ˆ


๐Ÿ“ -Os

Optimize for size. ๐ŸŽ€ -Os enables all the -O2 optimizations except the ones that often make your code bigger:

-falign-functions  -falign-jumps -falign-labels  -falign-loops
-fprefetch-loop-arrays  -freorder-blocks-algorithm=stc

It also enables -finline-functions, makes the compiler tune for code size instead of execution speed, and does even more optimizations that are designed to shrink your code. Iconic. ๐Ÿ’…


๐ŸŒˆ -Ofast

Disregard strict standards compliance. ๐Ÿ˜ค -Ofast enables all -O3 optimizations, plus 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 also turns off -fsemantic-interposition.


๐Ÿฆ‹ -Og

Optimize while keeping the debugging experience in mind. ๐Ÿซถ -Og should be your optimization level of choice for the standard edit-compile-debug cycle โ€” it offers a reasonable blend of optimization, fast compilation, and a good debugging experience, especially for code with a high abstraction penalty. In contrast to -O0, it enables -fvar-tracking-assignments and -fvar-tracking, which handle debug information in the prologue and epilogue of functions better than -O0 does.

Like -O0, -Og completely skips a bunch of optimization passes so that the individual options controlling them have no effect. Otherwise, -Og enables all -O1 optimization flags except the ones known to greatly 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 might actually increase the number of instructions executed โ€” if those instructions take fewer bytes to encode. ๐Ÿ“ -Oz behaves similarly to -Os, including enabling most -O2 optimizations.


๐ŸŒธ Pro tip, bestie: if you use multiple -O options, with or without level numbers, the last such option is the one that's effective. Last one wins, periodt.

Options of the form -fflag specify machine-independent flags. Most flags have both a positive and a negative form โ€” the negative form of -ffoo is -fno-foo. In the list below, only one of the forms is shown, the one you'd typically use. You can figure out the other form by either removing no- or adding it. Easy math. โœจ

The following options control specific optimizations. They're either activated by the -O options or related to ones that are. Use these flags in those rare cases when you're feeling like "fine-tuning" the optimizations being performed. ๐ŸŽ€


๐Ÿงš -fno-defer-pop

For machines that have to pop arguments after a function call, this makes them always pop the arguments as soon as each function returns. At levels -O1 and higher, -fdefer-pop is the default โ€” that lets the compiler let arguments pile up on the stack across several function calls and then pop them all at once. ๐Ÿ’…


โญ -fforward-propagate

Perform a forward propagation pass on RTL. This pass tries to combine two instructions and checks if the result can be simplified. If loop unrolling is active, two passes get performed, and the second one is scheduled after loop unrolling.

This option is enabled by default at optimization levels -O1, -O2, -O3, -Os.


๐ŸŒธ -favoid-store-forwarding, -fno-avoid-store-forwarding

Many CPUs will stall for many cycles when a load partially depends on previous smaller stores. ๐Ÿ˜ญ This pass tries to catch those cases and dodge the penalty by changing the order of the load and the store, and then fixing up the loaded value.

Disabled by default.


๐ŸŽ€ -ffp-contract=style

  • -ffp-contract=off disables floating-point expression contraction.
  • -ffp-contract=fast enables floating-point expression contraction, like forming fused multiply-add operations if the target has native support for them.
  • -ffp-contract=on enables floating-point expression contraction if it's 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), and -ffp-contract=fast otherwise.


๐Ÿ”ฅ -ffp-int-builtin-inexact

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

The default is -fno-fp-int-builtin-inexact, which disallows the exception from being raised, unless C17 or an earlier 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 still be raised if the library implementation doesn't follow TS 18661. ๐Ÿซ 


๐Ÿฆ‹ -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 โ€” and on many targets it also frees up an extra register. ๐ŸŽ‰

On some targets this flag has no effect, because the standard calling sequence always uses a frame pointer, so it just 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-crc

Detect loops that are calculating CRC (doing polynomial long division) and swap them out for a faster implementation. It detects 8, 16, 32, and 64 bit CRC, with a constant polynomial without the leading 1 bit, for both bit-forward and bit-reversed cases. If the target supports a CRC instruction and the polynomial used in the source code matches the polynomial used in the CRC instruction, it generates that CRC instruction. Otherwise, if the target supports a carry-less-multiplication instruction, it generates the CRC using that; otherwise it generates a table-based CRC.

Enabled by default at -O2 and higher. โœจ


๐Ÿ’œ -foptimize-sibling-calls

Optimize sibling and tail recursive calls. ๐ŸŒ€

  • -foptimize-strlen โ€” bestie this one is so satisfying</p> โœจ it optimizes a bunch of standard C string functions (think strlen, strchr, strcpy) plus their _FORTIFY_SOURCE counterparts, and turns them into faster alternatives.

Enabled at levels -O2, -O3.

  • -finline-atomics / -fno-inline-atomics โ€” inlines __atomic operations whenever a lock-free instruction sequence is actually available. ๐Ÿฆ‹ This optimization is enabled by default.
  • -finline-stringops[=fn] โ€” expands memory and string operations (for now, only memset) inline, even when the length is variable or big enough that it would require looping. This is most useful alongside -ffreestanding and -fno-builtin.

In some circumstances it lets the compiler generate code that takes advantage of known alignment and length multipliers โ€” but lowkey, even then it may be less efficient than optimized runtime implementations, and it can grow code size so much that even a less performant but shared implementation runs faster thanks 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.

  • -finline-small-functions โ€” integrates functions into their callers when their body is smaller than the expected function call code (so the overall size of the program gets smaller ๐ŸŽ€). The compiler heuristically decides which functions are simple enough to be worth integrating this way. This inlining applies to all functions, even those not declared inline.

Enabled at levels -O2, -O3, -Os.

  • -findirect-inlining โ€” also inlines indirect calls that are discovered to be known at compile time thanks to previous inlining. This option only has any effect when inlining itself is turned on by the -finline-functions or -finline-small-functions options.

Enabled at levels -O2, -O3, -Os.

  • -finline-functions โ€” considers all functions for inlining, even if they're not declared inline. The compiler heuristically decides which functions are worth integrating this way.

If all calls to a given function are integrated, and the function is declared static, then the function is normally not output as assembler code in its own right.

Enabled at levels -O2, -O3, -Os. Also enabled by -fprofile-use and -fauto-profile.

  • -finline-functions-called-once โ€” considers all static functions called once for inlining into their caller, even if they're not marked inline. If a call to a given function is integrated, then the function is not output as assembler code in its own right. ๐Ÿ’…

Enabled at levels -O1, -O2, -O3 and -Os, but not -Og.

  • -fearly-inlining โ€” inlines functions marked by always_inline, plus functions whose body seems smaller than the function call overhead, early โ€” before doing -fprofile-generate instrumentation and the real inlining pass. Doing this makes profiling significantly cheaper and usually makes inlining faster on programs that have large chains of nested wrapper functions.

Enabled by default.

  • -fipa-sra โ€” performs interprocedural scalar replacement of aggregates, removal of unused parameters, and replacement of parameters passed by reference with parameters passed by value. ๐ŸŒˆ

Enabled at levels -O2, -O3 and -Os.

  • -finline-limit=n โ€” by default, GCC limits the size of functions that can be inlined. This flag allows coarse control of that limit. n is the size of functions that can be inlined, in number of pseudo instructions.

Inlining is actually controlled by a number of internal parameters, which are documented in the GCC Internals manual and should not normally be set directly.

Note: there may be no value to -finline-limit that results in default behavior.
Note: "pseudo instruction" represents, in this particular context, 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. ๐Ÿ˜ญ
  • -fno-keep-inline-dllexport โ€” this is a more fine-grained version of -fkeep-inline-functions, which applies only to functions that are declared using the dllexport attribute or declspec.
  • -fkeep-inline-functions โ€” in C, emits static functions that are declared inline into the object file, even if the function has been inlined into all of its callers. This switch does not affect functions using the extern inline extension in GNU C90. In C++, it emits any and all inline functions into the object file.
  • -fkeep-static-functions โ€” emits static functions into the object file, even if the function is never used. ๐Ÿซถ
  • -fkeep-static-consts โ€” emits 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 โ€” attempts 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 โ€” attempts to merge identical constants and identical variables. ๐Ÿ‘‘

This option implies -fmerge-constants. In addition to -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. ๐Ÿ’€

  • -fmodulo-sched โ€” performs swing modulo scheduling immediately before the first scheduling pass. This pass looks at innermost loops and reorders their instructions by overlapping different iterations.
  • -fmodulo-sched-allow-regmoves โ€” performs more aggressive SMS-based modulo scheduling, with register moves allowed. Setting this flag deletes certain anti-dependence edges, 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 โ€” disables 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.

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. ๐Ÿ™ˆ

The default is -ffunction-cse

  • -ffuse-ops-with-volatile-access โ€” allow limited optimization of operations with volatile memory access when doing so does not change the semantics outlined in

The default is -ffuse-ops-with-volatile-access

  • -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 except in Ada.

  • -fthread-jumps โ€” performs 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. ๐Ÿฆ‹

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, splits the registers apart and allocates 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 splits 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), scans 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 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-runs common subexpression elimination after loop optimizations are performed.

Enabled at levels -O2, -O3, -Os.

  • -fgcse โ€” performs 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 โ€” turn this on and global common subexpression elimination will try to move loads that are only killed by stores into themselves. Translation bestie: a loop that's got a load/store sequence in it can get rewritten so the load happens outside the loop and only a copy/store stays inside. ๐Ÿ’…

It's enabled by default whenever -fgcse is enabled. periodt.

  • -fgcse-sm โ€” with this on, a store motion pass runs after global common subexpression elimination. That pass tries to move stores out of loops. Pair it with -fgcse-lm and loops holding a load/store sequence can become a load before the loop plus a store after the loop. iconic.

Not enabled at any optimization level, jsyk.

  • -fgcse-las โ€” when enabled, the global common subexpression elimination pass kills off redundant loads that come after stores to the same memory location (both partial and full redundancies, we love range).

Not enabled at any optimization level.

  • -fgcse-after-reload โ€” enable this and a redundant load elimination pass runs after reload, purely to clean up redundant spilling. it's giving janitor energy ๐Ÿงน

Enabled by -O3, -fprofile-use and -fauto-profile.

  • -faggressive-loop-optimizations โ€” tells the loop optimizer to use language constraints to derive bounds for how many iterations a loop runs. This assumes loop code doesn't invoke undefined behavior โ€” like, no signed integer overflows, no out-of-bound array accesses, none of that. ๐Ÿ™ˆ Those iteration bounds then guide loop unrolling, peeling, and loop exit test optimizations. Enabled by default.
  • -funconstrained-commons โ€” tells the compiler that variables declared in common blocks (e.g. Fortran) might later be overridden with longer trailing arrays. This blocks certain optimizations that depend on knowing the array bounds.
  • -fcrossjumping โ€” do the cross-jumping transformation, which unifies equivalent code and saves code size. Heads up though: the resulting code may or may not actually perform better than without cross-jumping. no promises bestie ๐Ÿ˜ญ

Enabled at levels -O2, -O3, -Os.

  • -fauto-inc-dec โ€” combine increments or decrements of addresses with memory accesses. This pass is always skipped on architectures lacking the instructions to support it. Enabled by default at -O1 and higher on architectures that do support this.
  • -fdce โ€” perform dead code elimination (DCE) on RTL. Enabled by default at -O1 and higher.
  • -fdse โ€” perform dead store elimination (DSE) on RTL. Enabled by default at -O1 and higher.
  • -fif-conversion โ€” try to transform conditional jumps into branch-less equivalents. That includes 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 โ€” use conditional execution (where available) to transform conditional jumps into branch-less equivalents.

Enabled at levels -O1, -O2, -O3, -Os, but not with -Og.

  • -fdeclone-ctor-dtor โ€” the C++ ABI requires multiple entry points for constructors and destructors: one for a base subobject, one for a complete object, and one for a virtual destructor that calls operator delete afterwards. For a hierarchy with virtual bases, the base and complete variants are clones โ€” meaning two copies of the function. ๐Ÿ˜ญ With this option, those base and complete variants get changed into thunks that call a common implementation. deduplication slay.

Enabled by -Os.

  • -fdelete-null-pointer-checks โ€” assume programs cannot safely dereference null pointers, and that no code or data element lives 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 null pointer checks โ€” those analyses assume a memory access to address zero always results in a trap, so if a pointer is checked after it's already been dereferenced, it can't be null.
Note however that 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 AVR and MSP430, this option is completely disabled.

Passes that use the dataflow information are enabled independently at different optimization levels.

  • -fdevirtualize โ€” try 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 โ€” try to convert calls to virtual functions into speculative direct calls. Based on the type inheritance graph analysis, figure out the set of likely targets for a given call. If that set is small โ€” preferably of size 1 โ€” change 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. ๐Ÿ”„
  • -fdevirtualize-at-ltrans โ€” stream extra info needed for aggressive devirtualization when running the link-time optimizer in local transformation mode. This enables more devirtualization but significantly increases the size of streamed data. For this reason it's disabled by default. ๐Ÿ’€
  • -fexpensive-optimizations โ€” perform a number of minor optimizations that are relatively expensive.

Enabled at levels -O2, -O3, -Os.

  • -fext-dce
  • -fno-ext-dce โ€” perform dead code elimination on zero and sign extensions, with special dataflow analysis.
  • -free โ€” try to remove redundant extension instructions. 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 object's lifetime are dead once 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 object's lifetime, you can use this flag to disable that 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 โ€” try to decrease register pressure through register live range shrinkage. 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's 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 โ€” use IRA to evaluate register pressure in the code hoisting pass when deciding whether 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 โ€” use IRA to evaluate register pressure in loops when deciding whether to move loop invariants. This option usually generates 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 โ€” disable sharing of stack slots used for saving call-used hard registers living through a call. Each hard register gets its own separate stack slot, and as a result function stack frames are larger. ๐Ÿ“ฆ
  • -fno-ira-share-spill-slots โ€” disable sharing of stack slots allocated for pseudo-registers. Each pseudo-register that doesn't get a hard register gets its own separate stack slot, and as a result function stack frames are larger.
  • -flra-remat โ€” enable CFG-sensitive rematerialization in LRA. Instead of loading values of spilled pseudos, LRA tries to rematerialize (recalculate) values if it's profitable. ๐Ÿ’ธ

Enabled at levels -O2, -O3, -Os.

  • -fdelayed-branch โ€” if supported for the target machine, try 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 โ€” bestie, if the target machine supports it</p>, this tells GCC to try reordering instructions so we can yeet those execution stalls that happen when required data justโ€ฆ isn't available yet ๐Ÿ˜ญ. It's giving life support for slow machines โ€” ones with sluggish floating-point or memory load instructions โ€” because it lets other instructions get issued while we're still waiting on the load or FP result to actually be needed. โœจ

Conventionally it's enabled at optimization levels -O2 and -O3. BUT โ€” and this is the plot twist ๐ŸŽ€ โ€” lots of targets override that behavior. For example, on x86 it's disabled at all levels, while on AArch64 it's enabled only at -O3. So like, don't assume, okay? iykyk.

  • -fschedule-insns2 โ€” same energy as -fschedule-insns, except it asks for an additional pass of instruction scheduling after register allocation has been done. This is lowkey iconic 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 โ€” turns off instruction scheduling across basic blocks, which is normally on when scheduling before register allocation, i.e. with -fschedule-insns or at -O2 or higher. no interblock for you ๐Ÿ’…
  • -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. Heads up though: this only makes sense when scheduling before register allocation is already enabled, i.e. with -fschedule-insns or at -O2 or higher. Using it can improve the generated code and shrink its size, by preventing register pressure from climbing above the number of available hard registers โ€” and thus preventing the subsequent spills in register allocation. size down, quality up, we love to see it โœจ
  • -fsched-spec-load โ€” allows speculative motion of some load instructions. Again: 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. yes bestie, it's literally called dangerous ๐Ÿ™ˆ Same rules as above: only makes sense when scheduling before register allocation, i.e. with -fschedule-insns or at -O2 or higher.
  • -fsched-stalled-insns, -fsched-stalled-insns=n โ€” defines how many insns (if any) can be moved prematurely from the queue of stalled insns into the ready list, during the second scheduling pass. So: -fno-sched-stalled-insns means no insns get moved prematurely, -fsched-stalled-insns=0 means there's no limit on how many queued insns can be moved prematurely, and -fsched-stalled-insns with no value is equivalent to -fsched-stalled-insns=1. ๐ŸŽ€
  • -fsched-stalled-insns-dep, -fsched-stalled-insns-dep=n โ€” 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. It only has an effect during the second scheduling pass, and only if -fsched-stalled-insns is used. -fno-sched-stalled-insns-dep is equivalent to -fsched-stalled-insns-dep=0, and -fsched-stalled-insns-dep with no value is equivalent to -fsched-stalled-insns-dep=1. ๐Ÿ’–
  • -fsched2-use-superblocks โ€” when scheduling after register allocation, use superblock scheduling. This allows motion across basic block boundaries, which results in faster schedules. โš ๏ธ experimental alert โš ๏ธ โ€” this option is experimental, because not all machine descriptions used by GCC model the CPU closely enough to avoid unreliable results from the algorithm.

And (say it with me) this only makes sense when scheduling after register allocation, i.e. with -fschedule-insns2 or at -O2 or higher.

  • -fsched-group-heuristic โ€” enables the group heuristic in the scheduler. This one favors the instruction that belongs to a schedule group. Enabled by default when scheduling is enabled, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐Ÿ‘‘
  • -fsched-critical-path-heuristic โ€” enables the critical-path heuristic in the scheduler. Favors instructions on the critical path. Enabled by default when scheduling is enabled, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐Ÿ”ฅ
  • -fsched-spec-insn-heuristic โ€” enables the speculative instruction heuristic in the scheduler. Favors speculative instructions with greater dependency weakness. Enabled by default when scheduling is enabled, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. โœจ
  • -fsched-rank-heuristic โ€” enables the rank heuristic in the scheduler. Favors the instruction belonging to a basic block with greater size or frequency. Enabled by default when scheduling is enabled, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐Ÿ“ˆ
  • -fsched-last-insn-heuristic โ€” enables the last-instruction heuristic in the scheduler. Favors the instruction that's less dependent on the last instruction scheduled. Enabled by default when scheduling is enabled, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐ŸŒธ
  • -fsched-dep-count-heuristic โ€” enables the dependent-count heuristic in the scheduler. Favors the instruction that has more instructions depending on it. Enabled by default when scheduling is enabled, i.e. with -fschedule-insns or -fschedule-insns2 or at -O2 or higher. ๐Ÿซถ

  • -fspeculatively-call-stored-functions โ€” attempts to convert indirect calls of function pointers into pointers loaded from a structure field, if all visible stores to that field store just a single candidate. When it does that, it turns the call into a conditional deciding between the direct call and the original indirect one. These speculative calls often enable more optimizations, such as inlining. And if they seem useless after further optimization? They get converted right back into their original form. ๐Ÿ˜Œ no harm no foul.
  • -freschedule-modulo-scheduled-loops โ€” modulo scheduling happens before traditional scheduling. So if a loop is modulo scheduled, later scheduling passes may change its schedule. Use this option to 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. Selective scheduling runs instead of the second scheduler pass. (Yes bestie, there are two. ๐Ÿ’…)
  • -fsel-sched-pipelining โ€” enables software pipelining of innermost loops during selective scheduling. Heads up: 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, also pipeline outer loops. This option has no effect unless -fsel-sched-pipelining is turned on. ๐ŸŒˆ
  • -fsemantic-interposition โ€” so some object formats, like ELF, allow interposing of symbols by the dynamic linker. That means that for symbols exported from the DSO, the compiler cannot 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 with a debugging implementation), it's 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. periodt.

  • -fshrink-wrap โ€” emit function prologues only before the parts of the function that actually need it, rather than 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 has no effect unless -fshrink-wrap is also turned on and the target supports this. ๐Ÿ’ซ
  • -fcaller-saves โ€” enables allocation of values to registers that are clobbered by function calls, by emitting extra instructions to save and restore the registers around such calls. Such allocation is only done when it seems to result in better code. vibe check first, always โœจ

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, and 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, there's no need to save and restore them around calls. BUT 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 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 โ€” attempts to minimize stack usage. The compiler tries to use less stack space, even if that makes the program slower. tradeoffs, bestie. This option implies setting the large-stack-frame parameter to 100 and the large-stack-frame-growth parameter to 400.
  • -ftree-reassoc โ€” performs reassociation on trees. This flag is enabled by default at -O1 and higher. ๐ŸŒณ
  • -fcode-hoisting โ€” performs 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 โ€” performs partial redundancy elimination (PRE) on trees. This flag is enabled by default at -O2 and -O3. ๐Ÿ’œ
  • -ftree-partial-pre โ€” makes partial redundancy elimination (PRE) more aggressive. This flag is enabled by default at -O3. ๐Ÿ”ฅ
  • -ftree-forwprop โ€” does forward propagation on trees ๐ŸŒณ. On by default at -O1 and higher, so she's already clocked in bestie ๐Ÿ’…
  • -ftree-fre โ€” performs full redundancy elimination (FRE) on trees. So the tea here: the difference between FRE and PRE is that FRE only looks at expressions computed on all paths leading to the redundant computation. She's faster than PRE, yes, but lowkey exposes fewer redundancies. Enabled by default at -O1 and higher โœจ
  • -ftree-phiprop โ€” hoists loads from conditional pointers on trees, iconic behavior honestly. This pass is on by default at -O1 and higher ๐ŸŽ€
  • -fhoist-adjacent-loads โ€” speculatively hoists loads from both branches of an if-then-else, but only if the loads are from adjacent locations in the same structure and the target architecture has a conditional move instruction. Very picky, very demure. Enabled by default at -O2 and higher ๐Ÿฆ‹
  • -ftree-copy-prop โ€” copy propagation on trees, which eliminates unnecessary copy operations. She's cleaning up after everyone fr fr. Enabled by default at -O1 and higher ๐Ÿ’–
  • -fipa-pure-const โ€” discovers which functions are pure or constant. Enabled by default at -O1 and higher โœจ
  • -fipa-reference โ€” discovers which static variables do not escape the compilation unit. Enabled by default at -O1 and higher ๐Ÿซถ
  • -fipa-reference-addressable โ€” discovers read-only, write-only and non-addressable static variables. Enabled by default at -O1 and higher ๐Ÿ’œ
  • -fipa-reorder-for-locality โ€” groups call chains close together in the binary layout so code locality improves and jump distances between frequently called functions get minimized ๐Ÿƒโ™€๏ธ๐Ÿ’จ

Unlike -freorder-functions, this pass looks at the call chains between functions and groups them together โ€” instead of grouping all hot/normal/cold/never-executed functions into separate sections.

And unlike -fprofile-reorder-functions, she's aiming to improve code locality throughout the entire runtime of the program, not just focusing on program startup.

Heads up bestie: this option is incompatible with an explicit -flto-partition= option, because it enforces a custom partitioning scheme. And if you're using it, it's recommended to also use profile feedback โ€” but this option is not enabled by default otherwise ๐Ÿ˜ญ
  • -fipa-stack-alignment โ€” reduces stack alignment on call sites if possible. Enabled by default ๐Ÿ‘‘
  • -fipa-pta โ€” performs interprocedural pointer analysis and interprocedural modification and reference analysis. The way that this can cause excessive memory and compile-time usage on large compilation units... be careful. It is not enabled by default at any optimization level ๐Ÿ’€
  • -fipa-profile โ€” performs interprocedural profile propagation. Functions called only from cold functions get marked as cold. Also, functions executed once (like "cold", "noreturn", static constructors or destructors) get 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 โ€” performs 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. Enabled by default at -O1 and higher ๐Ÿ”ฅ
  • -fipa-cp โ€” performs interprocedural constant propagation. It analyzes the program to figure out when values passed to functions are constants and then optimizes accordingly. This can substantially increase performance if the application has constants passed to functions. Enabled by default at -O2, -Os and -O3. It's also enabled by -fprofile-use and -fauto-profile โœจ
  • -fipa-cp-clone โ€” performs function cloning to make interprocedural constant propagation stronger. When enabled, interprocedural constant propagation clones functions when an externally visible function can be called with constant arguments. Because this can create multiple copies of functions, it may significantly increase code size ๐Ÿ˜ณ. Enabled by default at -O3. Also enabled by -fprofile-use and -fauto-profile ๐Ÿ’…
  • -fipa-bit-cp โ€” when enabled, performs interprocedural bitwise constant propagation. Enabled by default at -O2 and by -fprofile-use and -fauto-profile. It requires that -fipa-cp is enabled ๐ŸŽ€
  • -fipa-vrp โ€” when enabled, performs interprocedural propagation of value ranges. Enabled by default at -O2. It requires that -fipa-cp is enabled ๐Ÿฆ‹
  • -fipa-icf-functions, -fipa-icf-variables, -fipa-icf โ€” perform Identical Code Folding for functions (-fipa-icf-functions), read-only variables (-fipa-icf-variables), or both (-fipa-icf). The optimization reduces code size and may disturb unwind stacks by replacing a function by an equivalent one with a different name ๐Ÿ˜ญ. It works more effectively with link-time optimization enabled.

So even though the behavior is similar to the Gold Linker's ICF optimization, GCC ICF works on different levels, and thus the optimizations are not the same โ€” there are equivalences found only by GCC, and equivalences found only by Gold ๐Ÿ‘ฏโ™€๏ธ

-fipa-icf is enabled by default at -O2 and -Os.

  • -flate-combine-instructions โ€” enables two instruction combination passes that run relatively late in the compilation process. One runs before register allocation, the other runs after register allocation. The main aim of the passes is to substitute definitions into all uses. Most targets enable this flag 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 lore: if the compiler's optimization uses a function's body, or info extracted from its body, to optimize/change another function, then that latter function is called an impacted function of the former. And if a function gets patched, its impacted functions should be patched too. Periodt.

The impacted functions are determined by the compiler's interprocedural optimizations. For example, a caller is impacted when inlining a function into its caller, cloning a function and changing its caller to call this new clone, or extracting a function's pureness/constness information to optimize its direct or indirect callers, etc.

Usually, the more IPA optimizations enabled, the larger the number of impacted functions for each function. 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 these:

  • inline-clone โ€” only enables inlining and cloning optimizations, which includes inlining, cloning, interprocedural scalar replacement of aggregates and partial inlining. So when patching a function, all its callers and its clones' callers are impacted, and therefore 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. So when patching a static function, all its callers are impacted and need to be patched as well.

In addition to all the flags that -flive-patching=inline-clone disables, -flive-patching=inline-only-static disables these extra 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 ๐Ÿ™ˆ

Not me having to tell you this: -flive-patching is not supported with link-time optimization (-flto). Don't do it bestie ๐Ÿ’€
  • -fisolate-erroneous-paths-dereference โ€” detects paths that trigger erroneous or undefined behavior due to dereferencing a null pointer (with -fdelete-null-pointer-checks enabled) or a division by zero. 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.
  • -fisolate-erroneous-paths-attribute โ€” detects paths that trigger erroneous or undefined behavior due to a null value being used in a way 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. 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. When one is found, it 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 the max-tail-merge-comparisons parameter and the max-tail-merge-iterations parameter โฑ๏ธ
  • -ftree-cselim โ€” does conditional store elimination on trees โœจ it's on by default at -O1 and up, but only on targets that actually have conditional move instructions, so if ur target doesn't, don't come crying bestie ๐Ÿ’…
  • -ftree-dce โ€” dead code elimination (DCE) on trees ๐Ÿชฆ bye bye useless code, you will not be missed. Enabled by default at -O1 and higher.
  • -ftree-builtin-call-dce โ€” conditional dead code elimination (DCE) for calls to built-in functions that might set errno but are otherwise side-effect free ๐Ÿ‘€ so it's like... maybe useful, maybe a lil risky, but on by default at -O2 and up, unless you also passed -Os ๐Ÿซถ
  • -ffinite-loops โ€” lowkey the compiler is gonna assume that any loop with an exit will eventually take that exit and not loop forever ๐Ÿ” so it's allowed to nuke loops that have no side effects, and it will not treat "infinite loop forever" as a side effect. Enabled by default at -O2 for C++ with -std=c++11 or higher โญ
  • -ftree-dominator-opts โ€” a whole lil glow-up pass of simple scalar cleanups based on a dominator tree traversal ๐Ÿงš constant/copy propagation, redundancy elimination, range propagation and expression simplification โ€” all of it, slay. It also does jump threading (which is reducing jumps to jumps, iykyk). Enabled by default at -O1 and higher ๐Ÿ’–
  • -ftree-dse โ€” dead store elimination (DSE) on trees โœจ a "dead store" is when you write into a memory location and then immediately overwrite it with another store and nobody reads it in between โ€” so the earlier store can just be deleted, no cap. Enabled by default at -O1 and higher.
  • -ftree-ch โ€” loop header copying on trees ๐Ÿ‘‘ it's a good vibe because it makes code motion optimizations hit harder, plus it saves one whole jump. Enabled by default at -O1 and higher. But not enabled for -Os, because it usually makes ur code bigger ๐Ÿ“ˆ
  • -ftree-loop-optimize โ€” loop optimizations on trees ๐Ÿ” Enabled by default at -O1 and higher.
  • -ftree-loop-linear, -floop-strip-mine, -floop-block โ€” loop nest optimizations ๐ŸŒ€ same thing as -floop-nest-optimize. To actually use this code transformation, GCC has to be configured with --with-isl to turn on the Graphite loop transformation infrastructure. So like... if it wasn't built that way, it's not happening bestie ๐Ÿ’€
  • -fgraphite-identity โ€” turns on the identity transformation for graphite ๐Ÿชž for every SCoP we generate the polyhedral representation and then transform it right back to gimple. Using -fgraphite-identity lets you check the costs or benefits of the GIMPLE -> GRAPHITE -> GIMPLE transformation. The code generator isl also does some minimal optimizations, like index splitting and dead code elimination in loops โœจ
  • -floop-nest-optimize โ€” enables the isl-based loop nest optimizer ๐Ÿง  it's a generic loop nest optimizer built on the Pluto optimization algorithms, and it calculates a loop structure optimized for data-locality and parallelism. Heads up: this option is experimental โš ๏ธ
  • -floop-parallelize-all โ€” uses the Graphite data dependence analysis to find loops that can be parallelized ๐ŸŒˆ and then parallelizes all the loops that can be analyzed as not containing loop carried dependences โ€” and it does not check whether parallelizing them is actually profitable ๐Ÿ’€ it just goes for it, main character energy fr fr
  • -ftree-coalesce-vars โ€” while transforming the program out of the SSA representation, it tries to reduce copying by coalescing versions of different user-defined variables instead of just compiler temporaries ๐Ÿซถ fair warning: this may severely limit ur ability to debug an optimized program compiled with -fno-var-tracking-assignments ๐Ÿ˜ญ in the negated form, this flag prevents SSA coalescing of user variables. Enabled by default if optimization is enabled, and it does very little otherwise.
  • -ftree-loop-if-convert โ€” tries to transform conditional jumps in the innermost loops into branch-less equivalents ๐ŸŽ€ the goal is to remove control-flow from the innermost loops so the vectorization pass has an easier time handling them. Enabled by default if vectorization is enabled.
  • -ftree-loop-distribution โ€” performs loop distribution ๐Ÿฐ this can improve cache performance on big loop bodies and unlock further loop optimizations like parallelization or vectorization. Example time bestie, this loop:
        DO I = 1, N
          A(I) = B(I) + C
          D(I) = E(I) * F
        ENDDO

gets transformed to:

        DO I = 1, N
           A(I) = B(I) + C
        ENDDO
        DO I = 1, N
           D(I) = E(I) * F
        ENDDO

Enabled by default at -O3, and it's also enabled by -fprofile-use and -fauto-profile ๐Ÿ’–

  • -ftree-loop-distribute-patterns โ€” performs loop distribution of patterns that can be code generated with calls to a library ๐Ÿ“š 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 โœจ like, this loop:

        DO I = 1, N
          A(I) = 0
          B(I) = A(I) + I
        ENDDO

becomes:

        DO I = 1, N
           A(I) = 0
        ENDDO
        DO I = 1, N
           B(I) = A(I) + I
        ENDDO

and the initialization loop gets turned into a call to memset zero ๐Ÿซถ

  • -floop-interchange โ€” performs loop interchange outside of graphite ๐Ÿ”„ this can improve cache performance on loop nests and unlock further loop optimizations like vectorization. Example, this 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];

gets 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];

Enabled by default at -O3. 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. Enabled by default at -O3, and also by -fprofile-use and -fauto-profile ๐Ÿ’…
  • -ftree-loop-im โ€” performs loop invariant motion on trees ๐Ÿงš this pass only moves invariants that are hard to handle at RTL level (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 that 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 requires complicated analysis ๐Ÿคฏ that way later optimizations can determine the number easily. Useful especially in connection with unrolling ๐Ÿ‘‘
  • -ftree-scev-cprop โ€” performs final value replacement ๐Ÿ’– if a variable is modified in a loop such 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, the whole trio. Enabled by default at -O1 and higher.
  • -ftree-parallelize-loops, -ftree-parallelize-loops=n โ€” parallelizes loops ๐Ÿงต like, splits their iteration space so they run in multiple threads. This is only possible for loops whose iterations are independent and can be arbitrarily reordered. And ngl the optimization is only profitable on multiprocessor machines, for loops that are CPU-intensive rather than constrained by, say, memory bandwidth. This option implies -pthread, so it's only supported on targets that have support for -pthread ๐Ÿซถ

When a positive value n is specified, the number of threads is fixed at compile time and cannot be changed after compilation. The compiler generates #pragma omp parallel num_threads(n).

When used without =n (i.e., -ftree-parallelize-loops), the number of threads is determined at program execution time via the OMP_NUM_THREADS environment variable ๐ŸŒˆ if OMP_NUM_THREADS is not set, the OpenMP runtime automatically detects the number of available processors and uses that value. This enables creating binaries that adapt to different hardware configurations without recompilation โญ iconic tbh

  • -ftree-pta โ€” performs function-local points-to analysis on trees ๐ŸŽฏ 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. Enabled by default at -O1 and higher, except for -Og.
  • -fstore-merging โ€” performs merging of narrow stores to consecutive memory addresses ๐Ÿฐ this pass merges contiguous stores of immediate values narrower than a word into fewer, wider stores so the instruction count goes down ๐Ÿ“‰ 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 get replaced at their use location with their defining expression. This results in non-GIMPLE code, but it 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 ๐Ÿ’ช it 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 weren't explicitly specified.
  • -ftree-loop-vectorize โ€” performs loop vectorization on trees ๐ŸŒ€ Enabled by default at -O2, and by -ftree-vectorize, -fprofile-use, and -fauto-profile ๐Ÿ’œ
  • -ftree-slp-vectorize โ€” does basic block vectorization on trees ๐ŸŒณโœจ. It's on by default at -O2, and also gets switched on by -ftree-vectorize, -fprofile-use, and -fauto-profile. Slay.
  • -ftrivial-auto-var-init=choice โ€” ok bestie this one is a whole security vibe ๐Ÿ’…. It initializes automatic variables (and temporary objects) with either a pattern or with zeroes, which bumps up the security and predictability of a program by preventing uninitialized memory disclosure and use. But listen โ€” GCC still considers an automatic variable that doesn't have an explicit initializer as uninitialized, so -Wuninitialized and -Wanalyzer-use-of-uninitialized-value will still report warning messages on such automatic variables or temporary objects, and the compiler will perform optimization as if the variable were uninitialized. With this option, GCC will also initialize any padding of automatic variables or temporary objects that have structure or union types to zeroes ๐Ÿซถ. However, the current implementation cannot initialize automatic variables whose initialization is bypassed through switch or goto statement. Use -Wtrivial-auto-var-init to report all such cases.

The three values of choice are:

  • uninitialized โ€” doesn't initialize any automatic variables. That's it, that's the whole job ๐Ÿ™ˆ.
  • 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 aren't 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. Simple. Clean. Iconic.

The default is uninitialized except for C++26, in which case if -ftrivial-auto-var-init= is not specified at all, automatic variables or temporary objects are zero initialized โ€” but zero initialization of padding bits does not happen. Noted ๐Ÿ“.

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" standard attribute or the C++26 "[[indeterminate]]" ๐ŸŽ€.

  • -fvect-cost-model=model โ€” changes up 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, while 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 disables vectorization of loops when any runtime check for data dependence or alignment is required, and it also disables vectorization of epilogue loops, but otherwise is equal to the cheap model.

The default cost model depends on other optimization flags and is either dynamic or cheap.

  • -fsimd-cost-model=model โ€” same energy but for vectorization of loops marked with the OpenMP simd directive ๐Ÿฆ‹. The model argument should be one of unlimited, dynamic, cheap. All values of model have the same meaning as described in -fvect-cost-model, and by default a cost model defined with -fvect-cost-model is used.
  • -ftree-vrp โ€” performs Value Range Propagation on trees ๐ŸŒณ. This is similar to the constant propagation pass, but instead of values, ranges of values are propagated. This lets the optimizers remove unnecessary range checks like array bound checks and null pointer checks. It's enabled by default at -O2 and higher. Null pointer check elimination is only done if -fdelete-null-pointer-checks is enabled โ€” important detail, don't skip it bestie ๐Ÿ’….
  • -fsplit-paths โ€” splits paths leading to loop backedges โœ‚๏ธ. This can improve dead code elimination and common subexpression elimination. Enabled by default at -O3 and above.
  • -fsplit-ivs-in-unroller โ€” enables expression of values of induction variables in later iterations of the unrolled loop using the value in the first iteration. This breaks long dependency chains, thus improving efficiency of the scheduling passes ๐Ÿ”ฅ.

A combination of -fweb and CSE is often sufficient to obtain the same effect. However, that is not reliable in cases where the loop body is more complicated than a single basic block. It also does not work at all on some architectures due to restrictions in the CSE pass ๐Ÿ˜ญ.

This optimization is enabled by default. Periodt.

  • -fvariable-expansion-in-unroller โ€” with this option, the compiler creates multiple copies of some local variables when unrolling a loop, which can result in superior code ๐Ÿ‘‘.

This optimization is enabled by default for PowerPC targets, but disabled by default otherwise.

  • -fpartial-inlining โ€” inline parts of functions ๐Ÿงฉ. This option has any effect only when inlining itself is turned on by 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) performed in previous iterations of loops ๐Ÿ”.

This option is enabled at level -O3. It is also enabled by -fprofile-use and -fauto-profile.

  • -fprefetch-loop-arrays โ€” if supported by the target machine, generate instructions to prefetch memory to improve the performance of loops that access large arrays ๐Ÿ“.

This option may generate better or worse code; results are highly dependent on the structure of loops within the source code. Fr fr, it's a gamble.

Disabled at level -Os.

  • -fno-printf-return-value โ€” do not substitute constants for known return value of formatted output functions such as "sprintf", "snprintf", "vsprintf", and "vsnprintf" (but not "printf" of "fprintf") ๐Ÿ™…โ™€๏ธ. This transformation allows GCC to optimize or even eliminate branches based on the known return value of these functions called with arguments that are either constant, or whose values are known to be in a range that makes determining the exact return value possible. For example, when -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 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 are implemented in the compiler; some targets use one, some use the other, a few use both.

-fpeephole is enabled by default. -fpeephole2 enabled at levels -O2, -O3, -Os.

  • -fno-guess-branch-probability โ€” do not guess branch probabilities using heuristics ๐Ÿ™ˆ.

GCC uses heuristics to guess branch probabilities if they are not provided by profiling feedback (-fprofile-arcs). 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 that the effects of "__builtin_expect" are easier to understand ๐Ÿค”.

It is also possible to specify expected probability of the expression with "__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 in order to reduce number of taken branches and improve 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 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 โ€” in addition to reordering basic blocks in the compiled function, in order to reduce number of taken branches, partitions hot and cold basic blocks into separate sections of the assembly and .o files, to improve paging and cache locality performance ๐Ÿ’–.

okay so this optimization gets automatically turned off when exception handling or unwind tables are in the picture (that's on targets using setjump/longjump or some target-specific scheme, iykyk), and also for linkonce sections, for functions with a user-defined section attribute, and on literally any architecture that doesn't do named sections. ๐Ÿ’€ and when -fsplit-stack is being used, this option is not enabled by default (all so you don't get linker errors, bestie), but you can turn it on explicitly if you've got a linker that actually works.

Enabled for x86 at levels -O2, -O3, -Os.

  • -freorder-functions โ€” reorders functions inside the object file so the code locality gets better. Unlike -fipa-reorder-for-locality, this one prioritises grouping all the functions in a category (hot / normal / cold / never-executed) together. The way it does that is by using special subsections: .text.hot for the most frequently executed functions and .text.unlikely for the ones that probably won't run. ๐ŸŒˆ The reordering itself is done by the linker, so the object file format has to support named sections and the linker has to place them in a reasonable way. no cap.

This option is lowkey useless unless you either give it profile feedback (peep -fprofile-arcs for the deets) 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 whatever language you're compiling. For C (and C++), this activates optimizations based on the type of expressions. Specifically: accessing an object of one type through an expression of a different type is not allowed, unless the types are compatible types, or they differ only in signedness or qualifiers, or the expression has a character type. Accessing scalar objects through a corresponding vector type is also allowed. ๐Ÿ‘‘

So for example, an unsigned int can alias an int, but it can't alias a void* or a double. And a character type may alias any other type. periodt.

Pay special attention to code like this:

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 (this is called "type-punning") is super common. And even with -fstrict-aliasing, type-punning is allowed in C, as long as the memory is accessed through the union type. In ISO C++, type-punning through a union type is undefined behavior, but GCC supports it as an extension. So the code above works as expected. ๐Ÿซถ 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, like:

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. (sneaky, right?)

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 โ€” aligns the start of functions to the next power-of-two greater than or equal to n, skipping up to m-1 bytes. ๐ŸŽ€ This makes sure at least the first m bytes of the function can be fetched by the CPU without crossing an n-byte alignment boundary. It's an optimization for code performance, and alignment is ignored for functions considered cold. If you need alignment for all functions, use -fmin-function-alignment.

If m isn't specified, it defaults to n.

Examples, bestie: -falign-functions=32 aligns functions to the next 32-byte boundary, -falign-functions=24 aligns to the next 32-byte boundary only if that can be done by skipping 23 bytes or less, and -falign-functions=32:7 aligns to the next 32-byte boundary only if that can be done by skipping 6 bytes or less.

The 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 that can be done by skipping 6 bytes or less, otherwise it aligns to the next 32-byte boundary if that can be done by skipping 2 bytes or less. If m2 isn't specified, it defaults to n2. โœจ

Some assemblers only support this flag when n is a power of two; in that case, it gets rounded up.

-fno-align-functions and -falign-functions=1 are equivalent and mean functions are not aligned.

If n isn't specified or is zero, use a machine-dependent default. The maximum allowed n option value is 65536.

Enabled at levels -O2, -O3.

  • -flimit-function-alignment โ€” if this is enabled, 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.
  • -falign-labels
  • -falign-labels=n
  • -falign-labels=n:m
  • -falign-labels=n:m:n2
  • -falign-labels=n:m:n2:m2 โ€” aligns 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 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 isn't 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 โ€” aligns loops to a power-of-two boundary. If the loops run a whole bunch of times, that makes up for any execution of the dummy padding instructions. ๐ŸŒ€ This is an optimization for 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 loops are not aligned. The maximum allowed n option value is 65536.

If n isn't 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 โ€” aligns branch targets to a power-of-two boundary, for branch targets where the targets can only be reached by jumping. In that case, no dummy operations need to be executed. ๐Ÿงš This is an optimization for 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 loops are not aligned.

If n isn't 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 โ€” specifies minimal alignment of functions to the next power-of-two greater than or equal to n. ๐Ÿ‘‘ Unlike -falign-functions, this alignment gets applied to all functions too (even the ones considered cold). The alignment is also not affected by -flimit-function-alignment.
  • -fno-allocation-dce โ€” do not remove unused C++ allocations (using operator new and operator delete) in dead code elimination. ๐Ÿ—‘๏ธ

See also -fmalloc-dce.

  • -fallow-store-data-races โ€” allows the compiler to perform optimizations that may introduce new data races on stores, without proving that the variable can't be concurrently accessed by other threads. It does not affect optimization of local data. It's safe to use this option if you know global data won't 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. ๐Ÿ”ฅ

  • -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's 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 โ€” okay bestie, this one builds webs the way register allocation loves, and gives every single web its own individual pseudo register. That means the register allocation pass can work directly on pseudos, and it also strengthens a bunch of other optimization passes, like CSE, the loop optimizer, and the trivial dead code remover. But lowkey? It can make debugging literally impossible, because variables no longer stay in a "home register". Enabled by default with -funroll-loops. ๐Ÿ’…
  • -fwhole-program โ€” assumes the current compilation unit is the whole entire program being compiled. All public functions and variables โ€” except main and those merged by attribute externally_visible โ€” become static functions and in effect get optimized way more aggressively by interprocedural optimizers. With -flto this option has a limited use. In most cases the precise list of symbols used or exported from the binary is known from 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 an 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. โœจ

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

If you do not specify an optimization level option -O at link time, then GCC uses the highest optimization level used when compiling the object files. Note that it is generally ineffective to specify an optimization level option only at link time and not at compile time, for two reasons. First, compiling without optimization suppresses compiler passes that gather information needed for effective optimization at link time. Second, some early optimization passes can be performed only at compile time and not at link time. ๐Ÿ’€

There are some code generation flags preserved by GCC when generating bytecodes, as they need to be used during the final link. Currently, the following options and their settings are taken from the first object file that explicitly specifies them: -fcommon, -fexceptions, -fnon-call-exceptions, -fgnu-tm and all the -m target flags.

The following options -fPIC, -fpic, -fpie and -fPIE are combined based on the following scheme:

-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 are required to match in all compilation units, and trying to override this at link time with a conflicting value is ignored. This includes options such as -freg-struct-return and -fpcc-struct-return.

Other options such as -ffp-contract, -fno-strict-overflow, -fwrapv, -fno-trapv or -fno-strict-aliasing are 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. You can override them at link time.

Diagnostic options such as -Wstringop-overflow are passed through to the link stage and their setting matches that of the compile-step at function granularity. Note that this matters only for diagnostics emitted during optimization. Note that code transforms such as inlining can lead to warnings being enabled or disabled for regions if code not consistent with the setting at compile time.

When you need to pass options to the assembler via -Wa or -Xassembler make sure to either compile such translation units with -fno-lto or consistently use the same assembler options on all translation units. You can alternatively also specify assembler options at LTO link time.

To enable debug info generation you need to supply -g at compile time. If any of the input files at link time were built with debug info generation enabled the link will enable debug info generation as well. Any elaborate debug info settings like the dwarf level -gdwarf-5 need to be explicitly repeated at the linker command line and mixing different settings in different translation units is discouraged.

If LTO encounters objects with C linkage declared with incompatible types in separate translation units to be linked together (undefined behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be issued. The behavior is still undefined at run time. Similar diagnostics may be raised for other languages. ๐Ÿ™ˆ

Another feature of LTO is that it is possible to apply interprocedural optimizations on files written in different languages:

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 get the C++ runtime libraries and -lgfortran is added to get the Fortran runtime libraries. In general, when mixing languages in LTO mode, you should use the same link command options as when mixing languages in a regular (non-LTO) compilation.

If object files containing GIMPLE bytecode are stored in a library archive, say libfoo.a, it is possible to extract and use them in an LTO link if you are using a linker with plugin support. To create static libraries suitable for LTO, use 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 ensure that the library 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 to make them part of the aggregated GIMPLE image to be optimized.

If you are not using a linker with plugin support and/or do not enable the linker plugin, then the objects inside 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 need the whole program present to do their thing, bestie. If your program doesn't need to export any symbols, you can totally combine -flto and -fwhole-program and let the interprocedural optimizers make way more aggressive assumptions โ€” which can unlock better optimization opportunities. And lowkey? You don't even need -fwhole-program when the linker plugin is active (peep -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 relationship, fr.

Link-time optimization does not work well with generation of debugging information on systems other than those using a combination of ELF and DWARF.

If you specify the optional 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. ๐Ÿซถ

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 available, or otherwise fall back to autodetection of 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, or cache to balance chunk sizes while keeping related symbols together for better caching in incremental LTO. 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. 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-incremental=path โ€” Enable incremental LTO, with its cache in the given existing directory. Can significantly shorten edit-compile cycles with LTO.

When used with LTO (-flto), the output of translation units inside LTO is cached. Cached translation units are likely to be encountered again when recompiling with small code changes, leading to recompile time reduction. ๐Ÿฆ‹

Multiple GCC instances can use the same cache in parallel.

  • -flto-incremental-cache-size=n โ€” Specifies number of cache entries in incremental LTO after which to prune old entries. This is a soft limit, so temporarily there may be more entries.
  • -flto-compression-level=n โ€” This option specifies the level of compression used for intermediate language written to LTO object files, and is only meaningful in conjunction with LTO mode (-flto). GCC currently supports two LTO compression algorithms. For zstd, valid values are 0 (no compression) to 19 (maximum compression), while zlib supports values from 0 to 9. Values outside this range are clamped to either minimum or maximum of the supported values. If the option is not given, a default balanced compression setting is used.
  • -flto-toplevel-asm-heuristics โ€” Enables heuristics to find symbols used in top-level basic "asm". This will restrict link-time optimizations that could cause renaming or deletion of such symbols, which would result in missing symbol errors by linker.

This flag is intended for projects that have not converted to using top-level extended "asm", which specify the usage directly without any false positives.

The heuristics are simple and do not parse the assembly. The heuristics scan through top-level assembly for all possible identifiers; if an identifier is found among declared symbols, the symbol will be marked to restrict link-time optimizations. Static symbols disable more optimizations. Identifiers followed by ':' disable more optimizations as well, because they might be a locally defined symbol in assembly, even when the declaration is marked 'extern'. ๐Ÿ”

  • -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 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 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 โ€” After register allocation and post-register allocation instruction splitting, identify arithmetic instructions that compute processor flags similar to a comparison operation based on that arithmetic. If possible, eliminate the explicit comparison operation.

This pass only applies to certain targets that cannot explicitly represent the comparison operation before register allocation is complete.

Enabled at levels -O1, -O2, -O3, -Os.

  • -ffold-mem-offsets
  • -fno-fold-mem-offsets โ€” Try to eliminate add instructions by folding them in memory loads/stores.

Enabled at levels -O2, -O3.

  • -fcprop-registers โ€” After register allocation and post-register allocation instruction splitting, perform a copy-propagation pass to try to reduce scheduling dependencies and occasionally eliminate the copy.

Enabled at levels -O1, -O2, -O3, -Os.

  • -fprofile-correction โ€” Profiles collected using an instrumented binary for multi-threaded programs may be inconsistent due to missed counter updates. When this option is specified, GCC uses heuristics to correct or smooth out such inconsistencies. By default, GCC emits an error message when an inconsistent profile is detected. ๐Ÿ˜ญ

This option is enabled by -fauto-profile.

  • -fprofile-partial-training โ€” With "-fprofile-use" all portions of programs not executed during training runs are optimized aggressively for size rather than speed. In some cases it is not practical to train all possible hot paths in the program. (For example, it may contain functions specific to a given hardware and training may not cover all hardware configurations the program later runs on.) With "-fprofile-partial-training" profile feedback is ignored for all functions not executed during the training runs, causing them to be optimized as if they were compiled without profile feedback. This leads to better performance when the training is not representative, at the cost of significantly bigger code. ๐Ÿ“ˆ
  • -fprofile-use
  • -fprofile-use=path โ€” Enable profile feedback-directed optimizations, and 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.

By default, GCC emits an error message if the feedback profiles do not match the source code. This error can be turned into a warning by using -Wno-error=coverage-mismatch. Note this may result in poorly optimized code. Additionally, by default, GCC also emits a warning message if the feedback profiles do not exist (see -Wmissing-profile).

If path is specified, GCC looks at the path to find the profile feedback data files. See -fprofile-dir.

  • -fauto-profile
  • -fauto-profile=path โ€” Enable sampling-based feedback-directed optimizations, and 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
bestie, notice these two lists are almost the same but not quite โ€” -fprofile-use ends with -fprofile-reorder-functions and -fauto-profile ends with -fprofile-correction. Do not mix them up, I'm begging. ๐Ÿ’…

path is the name of a file holding your AutoFDO profile info, bestie. If you justโ€ฆ don't say anything? It defaults to fbdata.afdo in the current directory. No thoughts, just vibes.

Okay so to even make an AutoFDO profile data file you gotta run your program with the perf utility on a supported GNU/Linux target system. More deets at <https://perfwiki.github.io/main/>. โœจ

Like, for example:

perf record -e br_inst_retired:near_taken -b -o perf.data \
    -- your_program

Then you use the create_gcov tool to convert that raw profile data into a format GCC can actually eat. And yes, you must also hand this tool the unstripped binary for your program. See <https://github.com/google/autofdo>. ๐Ÿฆ‹

Example time:

create_gcov --binary=your_program.unstripped --profile=perf.data \
    --gcov=profile.afdo
  • -fauto-profile-inlining โ€” when auto-profile is available, inline all the relevant functions that were inlined in the tran run before reading the profile feedback. This lowkey improves context sensitivity of the profile. Enabled by default. ๐Ÿ‘‘

๐ŸŒธ the floating-point options, aka the speed-vs-correctness drama ๐ŸŒธ

The following options control compiler behavior regarding floating-point arithmetic. These options trade off between speed and correctness. All must be specifically enabled. Like, none of these are freebies.

  • -fexcess-precision=style โ€” this one lets you control excess precision on machines where floating-point operations happen in a format with more precision or range than the IEEE standard and interchange floating-point types. An example of such a target is x87 floating point on x86 processors, which uses an 80-bit representation internally instead of the 64-bit IEEE format. For most programs the excess precision is harmless, but some programs may rely on the requirements of the C or C++ language standards for handling IEEE values. ๐Ÿ’…

By default, -fexcess-precision=fast is in effect โ€” meaning 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.

-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. ๐Ÿ˜ญ
  • -ffloat-store โ€” do not store floating-point variables in registers, and inhibit other options that might change whether a floating-point value is taken from a register or memory. Ngl this option has generally been subsumed by -fexcess-precision=standard, which is more general. If you do use -ffloat-store, you may need to modify your program to explicitly store intermediate computations in temporary variables, since -ffloat-store handles rounding to IEEE format only on assignments and not casts the way -fexcess-precision=standard does. ๐Ÿซถ
  • -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. โœจ

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 do not require the guarantees of these specifications.

  • -fno-math-errno โ€” do not 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 maintaining IEEE arithmetic compatibility.

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 do not require the guarantees of these specifications.

The default is -fmath-errno.

On Darwin systems, the math library never sets errno. There is therefore no reason for the compiler to consider the possibility that it might, and -fno-math-errno is the default. ๐Ÿ“

  • -funsafe-math-optimizations โ€” allow optimizations for floating-point arithmetic that (a) assume that arguments and results are valid and (b) may violate IEEE or ANSI standards. When used at link time, it may include libraries or startup files that change the default FPU control word or other similar optimizations.

This option is not turned on by any -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 do not 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). 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 โ€” allow optimizations for floating-point arithmetic that assume that arguments and results are not NaNs or +-Infs.

This option is not turned on by any -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 do not require the guarantees of these specifications.

The default is -fno-finite-math-only.

  • -fno-signed-zeros โ€” allow optimizations for floating-point arithmetic that ignore the signedness of zero. IEEE arithmetic specifies the behavior of distinct +0.0 and -0.0 values, which then prohibits simplification of expressions such as x+0.0 or 0.0*x (even with -ffinite-math-only). This option implies that the sign of a zero result isn't significant.

The default is -fsigned-zeros.

  • -fno-trapping-math โ€” compile code assuming that floating-point operations cannot generate user-visible traps. These traps include division by zero, overflow, underflow, inexact result and invalid operation. This option requires that -fno-signaling-nans be in effect. Setting this option may allow faster code if one relies on "non-stop" IEEE arithmetic, for example.

This option is not turned on by any -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.

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 โ€” disable transformations and optimizations that assume default floating-point rounding behavior (round-to-nearest). This option should be specified for programs that change the FP rounding mode dynamically, or that may be executed with a non-default rounding mode. This option disables constant folding of floating-point expressions at compile time (which may be affected by rounding mode) and arithmetic transformations that are unsafe in the presence of sign-dependent rounding modes.

The default is -fno-rounding-math.

This option is experimental and does not currently guarantee to disable all GCC optimizations that are affected by rounding mode. ๐Ÿ’€ Future versions of GCC may provide finer control of this setting using C99's 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 option disables optimizations that may change the number of exceptions visible with signaling NaNs. This option implies -ftrapping-math.

This option causes the preprocessor macro __SUPPORT_SNAN__ to be defined. โœจ

The default is -fno-signaling-nans.

This option is experimental and does not currently guarantee to disable all GCC optimizations that affect signaling NaN behavior. ๐Ÿ˜ญ
  • -fsingle-precision-constant โ€” bestie, this one says "treat floating-point constants as single precision instead of sneaking in an implicit glow-up to double-precision constants." so like, float stays float. no secret promotion energy. ๐Ÿ’…
  • -fcx-limited-range โ€” when this is on, it's basically declaring that a range reduction step is not needed when you're doing complex division. also: no checking whether the result of a complex multiplication or division is "NaN + I*NaN", and no attempt to rescue the situation if it is. this option gets enabled by -ffast-math.

it also controls the default setting of the ISO C99 "CX_LIMITED_RANGE" pragma. but nevertheless (her word, not mine), the option applies to all languages. iconic reach. โœจ

  • -fcx-fortran-rules โ€” complex multiplication and division follow Fortran rules. range reduction is done as part of complex division, but there's still no checking whether the result of a complex multiplication or division is "NaN + I*NaN", and no rescue attempt for that case either.
  • *-fcx-method=method* โ€” complex multiplication and division follow whatever method you state. the method argument should be one of limited-range, fortran or stdc.

the default is to honor language-specific constraints, which means fortran for Fortran and stdc otherwise. periodt. ๐ŸŽ€


okay so the next batch of 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. ๐Ÿ’€ read carefully, bestie.


  • -fbranch-probabilities โ€” after you run a program compiled with -fprofile-arcs, you can compile it a second time</s> using -fbranch-probabilities, to improve optimizations based on how many 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're 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. no guessing, just receipts. ๐Ÿ”ฅ

enabled by -fprofile-use and -fauto-profile.

  • -fprofile-values โ€” if you combine it with -fprofile-arcs, it adds code so that some data about values of expressions in the program gets 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: it collects the first time of execution of a function and orders these functions in ascending order, aiming to optimize program startup through more efficient loading of text segments. it's giving organized. ๐Ÿฆ‹

enabled with -fprofile-use.

  • -fvpt โ€” if combined with -fprofile-arcs, this option tells 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 knowledge about the value of the denominator.

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 the same type together, because the target machine can execute them more efficiently if they're adjacent to each other in the instruction flow. adjacent besties stay winning. ๐Ÿซถ

enabled at levels -O2, -O3, -Os.

  • -fdep-fusion โ€” detect macro-op fusible pairs consisting of single-use instructions and their uses, and place such pairs together in the instruction stream to increase fusion opportunities in hardware. this pass is executed once before register allocation, and another time before register renaming.

enabled at levels -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.

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 bestie. ๐Ÿ™ˆ

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. she's thorough but at what cost. ๐Ÿ’€
  • -fpeel-loops โ€” peels loops for which there's enough information that they don't roll much (from profile feedback or static analysis). it also turns on complete loop peeling (i.e. complete removal of loops with a small constant number of iterations).

enabled by -O3, -fprofile-use, and -fauto-profile.

  • -fmalloc-dce โ€” control whether "malloc" (and its variants such as "calloc" or "strdup") can be optimized away, provided its return value is only used as a parameter of a "free" call or compared with "NULL". if -fmalloc-dce=1 is used, only calls to "free" are allowed, while with -fmalloc-dce=2 also comparisons with "NULL" pointer are considered safe to remove.

the default is -fmalloc-dce=2. see also -fallocation-dce.

  • -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. one loop said "it's not you it's me" and now there's two. ๐Ÿ’…

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 the result of the condition).

enabled by -fprofile-use and -fauto-profile.

  • -fversion-loops-for-strides โ€” if a loop iterates over an array with a variable stride, create another version of the loop that assumes the stride is always one. for example:
for (int i = 0; i < n; ++i)
  x[i * stride] = ...;

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 allows better vectorization 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 โ€” place each function or data item into its own section in the output file, if the target supports arbitrary sections. the name of the function or the name of the data item determines the section's name in the output file.

use these options on systems where the linker can perform optimizations to improve locality of reference in the instruction space. most systems using the ELF object format have linkers with such optimizations. on AIX, the linker rearranges sections (CSECTs) based on the call graph. the performance impact varies.

together with a linker garbage collection (linker --gc-sections option), these options may lead to smaller statically-linked executables (after stripping).

on ELF/DWARF systems these options do not degenerate the quality of the debug information. there could be issues with other object files/debug info formats.

only use these options when there are significant benefits from doing so, bestie. 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 โ€” optimize the prologue of variadic argument functions with respect to usage of those arguments.
  • -fsection-anchors โ€” try 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 out the call-used registers when a function returns, so your program is harder to mess with: it either makes Return-Oriented Programming (ROP) attacks way harder or stops info from leaking out through leftover register values. ๐Ÿ’…

The possible values of choice are exactly the same ones as for the zero_call_used_regs attribute. The default is skip.

Wanna do this for just one specific function instead of the whole program? Use the function attribute zero_call_used_regs. ๐ŸŽฏ


๐ŸŽ€ Program Instrumentation Options ๐ŸŽ€

Okay bestie, this is where GCC starts โœจ*adding stuff*โœจ to the code it generates โ€” like, run-time instrumentation, on purpose, on top of your actual program. Think of it as giving your binary a little fitness tracker. ๐Ÿซถ

What's the point? A few things, fr fr: collecting profiling stats so you can find your program's hot spots, doing code coverage analysis, or feeding profile-guided optimizations. Another whole class of instrumentation is run-time checking โ€” catching programming errors like invalid pointer dereferences or out-of-bounds array accesses, plus deliberately hostile attacks like 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. iykyk.

  • -p, --profile, -fprofile, -pg โ€” generate extra code that writes out profile information, suitable for the analysis program prof (for -p, --profile, and -fprofile) or gprof (for -pg). You must use this option when compiling the source files you want data about, and you also must use it when linking. Both steps, no skipping. ๐Ÿ‘‘

You can use the function attribute no_instrument_function to suppress profiling of individual functions when compiling with these options. Not me picking and choosing which functions get profiled. ๐Ÿ™ˆ

  • -fprofile-arcs โ€” adds code so that program flow arcs get instrumented. While the program runs, it records how many times each branch and call is executed, and how many times it's 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. That data can 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's 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. ๐Ÿ“

Heads up: 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 โ€” adds code so that program conditions get instrumented. During execution the program records what terms in a conditional contribute to a decision, which you can use 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. ๐Ÿ”ฅ
  • -fpath-coverage โ€” adds code so the paths taken are tracked. During execution the program records the prime paths taken. Lowkey the number of paths grows very fast with complexity, and to avoid exploding compile times GCC will give up instrumentation if the approximate number of paths exceeds the limit controlled by -fpath-coverage-limit. The result can be read with gcov --prime-paths --prime-paths-lines --prime-paths-source, ๐Ÿ˜ญ
  • -fpath-coverage-limit=limit โ€” the threshold at which point -fpath-coverage gives up on instrumenting a function. This limit is approximate and conservative, because GCC uses a pessimistic heuristic which slightly overcounts the running number of paths, and gives up if the threshold is reached before finding all the paths. This option is not for fine grained control over which functions to instrument โ€” rather it's intended to limit the effect of path explosion and keep compile times reasonable. The default is 250000. ๐ŸŽ€
  • --coverage, -coverage โ€” this option is used to compile and link code instrumented for coverage analysis. The options -coverage and --coverage are equivalent; both are 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. ๐Ÿ”ฅ

With -fpath-coverage, GCC finds and enumerates and records the taken prime paths of each function, unless the number of paths would exceed the limit controlled by -fpath-coverage-limit. If the limit is exceeded the function is not instrumented as if -fpath-coverage was not used. A prime path is the longest sequence of unique blocks, except possibly the first and last, which is not a subpath of any other path. ๐Ÿ’…

  • -ftest-coverage โ€” produces 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 converts 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 โ€” sets the directory to search for the profile data files in to path. This option affects only the profile data generated by -fprofile-generate, -ftest-coverage, -fprofile-arcs and used by -fprofile-use and -fbranch-probabilities and its related options. Both absolute and relative paths can be used. By default, GCC uses the current directory as path, thus the profile data file appears in the same directory as the object file. In order to prevent the file name clashing, if the object file name is not an absolute path, we mangle the absolute path of the sourcename.gcda file and use it as the file name of a .gcda file. See details about the file naming in -fprofile-arcs. See similar option -fprofile-note. โญ

When an executable is run in a massive parallel environment, it's recommended to save profile to different folders. That can be done with variables in path that are exported during run-time: ๐Ÿ’œ

  • %p โ€” process ID.
  • %q{VAR} โ€” value of environment variable VAR
  • -fprofile-generate, -fprofile-generate=path โ€” enable options usually used for instrumenting an application to produce profile useful for later recompilation with profile feedback based optimization. You must use -fprofile-generate both when compiling and when linking your program. ๐Ÿ˜ค

The following options are enabled: -fprofile-arcs, -fprofile-values, -finline-functions, and -fipa-bit-cp. โœจ

If path is specified, GCC looks at the path to find the profile feedback data files. See -fprofile-dir.

To optimize the program based on the collected profile information, use -fprofile-use. ๐Ÿ”ฅ

  • -fprofile-info-section, -fprofile-info-section=name โ€” register the profile information in the specified section instead of using a constructor/destructor. The section name is name if it is specified, otherwise the section name defaults to .gcov_info. A pointer to the profile information generated by -fprofile-arcs is placed in the specified section for each translation unit. This option disables the profile information registration through a constructor and it disables the profile information processing through a destructor. This option is not intended to be used in hosted environments such as GNU/Linux. It targets freestanding environments (for example embedded systems) with limited resources which do not support constructors/destructors or the C library file I/O. ๐Ÿงš

The linker could collect the input sections in a continuous memory block and define start and end symbols. A GNU linker script example which defines a linker output section follows:

          .gcov_info      :
          {
            PROVIDE (__gcov_info_start = .);
            KEEP (*(.gcov_info))
            PROVIDE (__gcov_info_end = .);
          }

The program could dump the profiling information registered in this linker set 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 may 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 โ€” okay so if path is specified, GCC saves the .gcno file into the path location. ๐ŸŽ€ Heads up bestie: if you combine the option with multiple source files, the .gcno file will be overwritten. not a drill.
  • -fprofile-prefix-path=path โ€” this one is the glow-up for your build tree paths ๐Ÿ’…. It can be used in combination with profile-generate=profile_dir and profile-use=profile_dir to inform GCC where the base directory of the built source tree is. By default profile_dir will contain files with mangled absolute paths of all object files in the built project. That's lowkey a problem when the directory used to build the instrumented binary differs from the directory used to build the binary optimized with profile feedback, because the profile data will not be found during the optimized build ๐Ÿ˜ญ. In such setups, -fprofile-prefix-path=path with path pointing to the base directory of the build can be used to strip the irrelevant part of the path and keep all file names relative to the main build directory. slay.
  • -fprofile-prefix-map=old=new โ€” when compiling files residing in directory old, record profiling information (with --coverage) describing them as if the files resided in directory new instead. See also -ffile-prefix-map and -fcanon-prefix-map. ๐Ÿฆ‹
  • -fprofile-update=method โ€” alters 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 useful for single-threaded applications, while the second one prevents profile corruption by emitting thread-safe code. ๐Ÿ”ฅ
Warning: When an application does not properly join all threads (or creates an detached thread), a profile file can be still corrupted. ๐Ÿ’€

Using prefer-atomic would be transformed either to atomic, when supported by a target, or to single otherwise. The GCC driver automatically selects prefer-atomic when -pthread is present in the command line, otherwise the default method is single.

If atomic is selected, then the profile information is updated using atomic operations on a best-effort basis. Ideally, the profile information is updated through atomic operations in hardware. If the target platform does not support the required atomic operations in hardware, however, libatomic is available, then the profile information is updated through calls to libatomic. If the target platform neither supports the required atomic operations in hardware nor libatomic, then the profile information is not atomically updated and a warning is issued. In this case, the obtained profiling information may be corrupt for multi-threaded applications. ๐Ÿ˜ญ

For performance reasons, if 64-bit counters are used for the profiling information and the target platform only supports 32-bit atomic operations in hardware, then the performance critical profiling updates are done using two 32-bit atomic operations for each counter update. If a signal interrupts these two operations updating a counter, then the profiling information may be in an inconsistent state. ๐Ÿซ 

  • -fprofile-filter-files=regex โ€” instrument 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'. iconic.

  • -fprofile-exclude-files=regex โ€” instrument 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 that are located in the /usr/ folder.

  • -fprofile-reproducible=[multithreaded|parallel-runs|serial] โ€” control level of reproducibility of profile gathered by "-fprofile-generate". This makes it possible to rebuild program with same outcome which is useful, for example, for 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 is not multi-threaded and profile data streaming is always done in the same order. Note that profile streaming happens at the end of program run but also before "fork" function is invoked.

Note that it is quite common that execution counts of some part of programs depends, for example, on length of temporary file names or memory space randomization (that may affect hash-table collision rate). Such non-reproducible part of programs may be annotated by "no_instrument_function" function attribute. gcov-dump with -l can be used to dump gathered data and verify that they are indeed reproducible. ๐Ÿ‘‘

With -fprofile-reproducible=parallel-runs collected profile stays reproducible regardless the order of streaming of the data into gcda files. This setting makes it possible to run multiple instances of instrumented program in parallel (such as with "make -j"). This reduces quality of gathered data, in particular of indirect call profiling. ๐Ÿฆ‹

  • -fsanitize=address โ€” enable AddressSanitizer, a fast memory error detector. Memory access instructions are instrumented to detect out-of-bounds and use-after-free bugs. The option enables -fsanitize-address-use-after-scope. See <https://github.com/google/sanitizers/wiki/AddressSanitizer> for more details. The run-time behavior can be influenced using the ASAN_OPTIONS environment variable. When set to "help=1", the available options are shown at startup of the instrumented program. See <https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags> for a list of supported options. The option cannot be combined with -fsanitize=thread or -fsanitize=hwaddress. Note that 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. Similarly, -fsanitize=memtag-stack is currently only supported on AArch64 ABIs with 64-bit pointers. ๐Ÿ”

When compiling with -fsanitize=address, you should also use -g to produce more meaningful output. 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). Using -fno-omit-frame-pointer also improves stack traces. Since multiple runs of the program may yield backtraces with different addresses due to ASLR (Address Space Layout Randomization), it may be desirable to turn ASLR off. On Linux, this can be achieved with setarch \uname -m` -R ./prog`. ๐Ÿ’…

  • -fsanitize=kernel-address โ€” enable AddressSanitizer for Linux kernel. See <https://github.com/google/kernel-sanitizers> for more details. ๐Ÿงš
  • -fsanitize=hwaddress โ€” enable Hardware-assisted AddressSanitizer, which uses a hardware ability to ignore the top byte of a pointer to allow the detection of memory errors with a low memory overhead. Memory access instructions are instrumented to detect out-of-bounds and use-after-free bugs. The option enables -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. The option cannot be combined with -fsanitize=thread or -fsanitize=address, and is currently only available on AArch64. ๐ŸŒˆ
  • -fsanitize=kernel-hwaddress โ€” turns on Hardware-assisted AddressSanitizer so you can compile the Linux kernel with it ๐Ÿ’…. It's like -fsanitize=kernel-address but with a different instrumentation method, and like -fsanitize=hwaddress but with the tweaks the Linux kernel needs. Those tweaks: no hwasan library initialization calls, and accounting for the stack pointer having a different value in its top byte.
Heads up bestie ๐Ÿซถ this option has different defaults than -fsanitize=hwaddress. Instrumenting the stack and alloca calls is not on by default, and using a random frame tag is not implemented for kernel instrumentation.
  • -fsanitize=memtag-stack โ€” uses Memory Tagging Extension instructions instead of instrumentation to catch memory errors. Like HWASAN, it's a probabilistic method (so, vibes-based detection, lowkey). Only available on those AArch64 architectures that support Memory Tagging Extensions โœจ.
  • -fsanitize=pointer-compare โ€” instruments comparison operations (<, <=, >, >=) that have pointer operands. You must combine it with either -fsanitize=kernel-address or -fsanitize=address. And it cannot be combined with -fsanitize=thread. Note: by default the check is disabled at run time ๐Ÿ™ˆ. To turn it on, add "detect_invalid_pointer_pairs=2" to the environment variable ASAN_OPTIONS. Using "detect_invalid_pointer_pairs=1" detects an invalid operation only when both pointers are non-null.
  • -fsanitize=pointer-subtract โ€” instruments subtraction with pointer operands. Same deal: must be combined with either -fsanitize=kernel-address or -fsanitize=address, and 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 an invalid operation only when both pointers are non-null.
  • -fsanitize=shadow-call-stack โ€” enables ShadowCallStack, a security enhancement mechanism that protects programs against return address overwrites (think stack buffer overflows, the classic ๐Ÿ˜ญ). How it works: it saves a function's return address to a separately allocated shadow call stack in the function prologue, then restores the return address from the shadow call stack in the function epilogue. Instrumentation only happens in functions that actually need to save the return address to the stack.

Currently it only supports the aarch64 platform. It's specifically designed for linux kernels that enable the CONFIG_SHADOW_CALL_STACK option. For user space programs, runtime support is not currently provided in libc and libgcc โ€” so if you wanna use this in user space you have to provide your own runtime support. And 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.

When compiling with -fsanitize=thread, you should also use -g to produce more meaningful output โœจ.

Note that sanitized atomic builtins cannot throw exceptions when operating on invalid memory addresses with non-call exceptions (-fnon-call-exceptions).

  • -fsanitize=leak โ€” enables 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. You can influence the run-time behavior with the LSAN_OPTIONS environment variable. This option cannot be combined with -fsanitize=thread.
  • -fsanitize=undefined โ€” enables UndefinedBehaviorSanitizer, a fast undefined behavior detector. Various computations get instrumented so undefined behavior is caught at runtime. See https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html for more details. You can influence the run-time behavior with the UBSAN_OPTIONS environment variable. Current suboptions are:
    • -fsanitize=shift โ€” enables checking that the result of a shift operation isn't undefined. Note that what exactly counts as 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 โ€” enables checking that the second argument of a shift operation isn't 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, checks that the result of a shift operation isn't undefined. Note that what exactly counts as undefined differs slightly between C and C++, as well as between ISO C90 and C99, etc.
    • -fsanitize=integer-divide-by-zero โ€” detects integer division by zero ๐Ÿ’€.
    • -fsanitize=unreachable โ€” with this option, the compiler turns the "__builtin_unreachable" call into a diagnostics message call instead. When you reach the "__builtin_unreachable" call, the behavior is undefined.
    • -fsanitize=vla-bound โ€” tells the compiler to check that the size of a variable length array is positive.
    • -fsanitize=null โ€” enables pointer checking. Specifically, an 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 to by a NULL pointer ๐Ÿ™ˆ.
    • -fsanitize=return โ€” 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 โ€” enables signed integer overflow checking. It checks that the result of "+", "*", and both unary and binary "-" doesn't 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 โ€” enables instrumentation of array bounds, so various out of bounds accesses get 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 โ€” enables strict instrumentation of array bounds. Most out of bounds accesses are detected, including flexible array member-like arrays. Initializers of variables with static storage are not instrumented.
  • -fsanitize=alignment โ€” enables checking of alignment of pointers when they are 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.
  • -fsanitize=object-size โ€” enables instrumentation of memory references using the "__builtin_dynamic_object_size" function. Various out of bounds pointer accesses get detected.
  • -fsanitize=float-divide-by-zero โ€” detects floating-point division by zero. Unlike other similar options, -fsanitize=float-divide-by-zero is not enabled by -fsanitize=undefined, since floating-point division by zero can be a legitimate way of obtaining infinities and NaNs ๐ŸŒˆ.
  • -fsanitize=float-cast-overflow โ€” enables floating-point type to integer conversion checking. It checks that the result of the conversion doesn't overflow. Unlike other similar options, -fsanitize=float-cast-overflow is not enabled by -fsanitize=undefined. This option doesn't work well with "FE_INVALID" exceptions enabled.
  • -fsanitize=nonnull-attribute โ€” enables instrumentation of calls, checking whether null values aren't passed to arguments marked as requiring a non-null value by the "nonnull" function attribute.
  • -fsanitize=returns-nonnull-attribute โ€” enables instrumentation of return statements in functions marked with the "returns_nonnull" function attribute, to detect returning of null values from such functions.
  • -fsanitize=bool โ€” enables instrumentation of loads from bool. If a value other than 0/1 is loaded, a run-time error is issued ๐Ÿšจ.
  • -fsanitize=enum โ€” enables instrumentation of loads from an enum type. If a value outside the range of values for the enum type is loaded, a run-time error is issued ๐Ÿšจ.
  • -fsanitize=vptr โ€” this one instruments C++ member function calls, member accesses, and some pointer conversions between base and derived classes, just to double-check that the object you're pointing at actually has the right dynamic type. vibe check for your class hierarchy, basically ๐Ÿ’…
  • -fsanitize=pointer-overflow โ€” instruments pointer arithmetic. If the pointer math overflows, you get a run-time error. no silent chaos allowed โœจ
  • -fsanitize=builtin โ€” instruments the arguments to selected builtin functions. Pass an invalid value to one of those args and boom, run-time error. Example: passing 0 as the argument to __builtin_ctz or __builtin_clz is undefined behavior, and this option will call it out. ๐Ÿ’€
Heads up bestie: sanitizers tend to increase the rate of false positive warnings, most notably the ones around -Wmaybe-uninitialized. We recommend against combining -Werror and [the use of] sanitizers. like, pick a struggle ๐Ÿ˜ญ

Okay so -ftrapv causes traps for signed overflows to be emitted, whereas -fsanitize=undefined gives you a diagnostic message instead. Currently this only works for the C family of languages.

-fno-sanitize=all โœจ

This option disables all the sanitizers you previously enabled. And nope โ€” -fsanitize=all is not allowed, because some sanitizers simply cannot be used together. they don't play nice, it's giving toxic friend group ๐Ÿšซ

-fasan-shadow-offset=number ๐ŸŽ€

Forces GCC to use a custom shadow offset in AddressSanitizer checks. Super useful for experimenting with different shadow memory layouts in Kernel AddressSanitizer.

-fsanitize-sections=s1,s2,... ๐Ÿฆ‹

Sanitize global variables in selected user-defined sections. Heads up: si may contain wildcards.

-fsanitize-recover[=opts] ๐ŸŒธ

-fsanitize-recover= controls error recovery mode for the sanitizers named in the comma-separated list opts. Turn it on for a sanitizer component and it will attempt to keep running the program as if no error happened. Which 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 flips that: only the first detected error is reported, and the 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
  • -fsanitize=address

For these sanitizers error recovery is turned on by default โ€” except -fsanitize=address, for which this feature is experimental. Also -fsanitize-recover=all and -fno-sanitize-recover=all are accepted: the former enables recovery for all sanitizers that support it, the latter disables recovery for all sanitizers that support it.

Even if recovery mode is turned on compiler-side, it also needs to be 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 the default value for AddressSanitizer is halt_on_error=1. You can override this by 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 ๐Ÿ”ฅ

Enable sanitization of local variables to detect use-after-scope bugs. The option sets -fstack-reuse to none.

-fsanitize-trap[=opts] ๐Ÿ‘‘

The -fsanitize-trap= option tells the compiler to report undefined behavior for the sanitizers named in the comma-separated list opts using __builtin_trap instead of a libubsan library routine. If this option is enabled for a certain sanitizer, it takes precedence over -fsanitizer-recover= for that sanitizer โ€” __builtin_trap will be emitted and will be fatal regardless of whether recovery is enabled or disabled using -fsanitize-recover=. no take-backs, it's over ๐Ÿ’€

The advantage here: the libubsan library isn't needed and isn't linked in, so this is usable even in freestanding environments. iconic for embedded girlies โœจ

Currently this feature works with:

  • -fsanitize=undefined (and its suboptions except for -fsanitize=vptr)
  • -fsanitize=float-cast-overflow
  • -fsanitize=float-divide-by-zero
  • -fsanitize=bounds-strict

-fsanitize-trap=all can also be 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, because the instrumentation always needs libubsan support. And -fsanitize-trap=vptr is not allowed, periodt.

-fsanitize-undefined-trap-on-error ๐Ÿ’œ

The -fsanitize-undefined-trap-on-error option is the deprecated equivalent of -fsanitize-trap=all.

-fsanitize-coverage=trace-pc โญ

Enable coverage-guided fuzzing code instrumentation. It inserts a call to __sanitizer_cov_trace_pc into every basic block.

-fsanitize-coverage=trace-cmp ๐Ÿ“

Enable dataflow guided fuzzing code instrumentation. It 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
  • __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
  • __sanitizer_cov_trace_switch โ€” for switch statements

-fcf-protection=[full|branch|return|none|check]

-fcf-protection ๐Ÿ›ก๏ธ

Enable code instrumentation to increase program security by checking that target addresses of control-flow transfer instructions โ€” think indirect function call, function return, indirect jump โ€” are valid. This prevents diverting the flow of control to an unexpected target. It's meant to protect against threats like Return-oriented Programming (ROP), and similarly call/jmp-oriented programming (COP/JOP). we love a secure girlie ๐ŸŒˆ

The -fcf-protection= keywords are interpreted like this:

  • 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 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 compile time.
  • The value none turns off instrumentation.

-fcf-protection is an alias for -fcf-protection=full. To override a previous -fcf-protection option on the command line, add -fcf-protection=none and then -fcf-protection=kind.

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

You can also use the nocf_check attribute to identify which functions and calls should be skipped from instrumentation. ๐Ÿ™ˆ

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 (like, conditions tested for conditional moves, or stored into boolean variables), emit extra code to compute and verify the reversed condition, and to call __builtin_trap if the results don't match. Use it with -fharden-conditional-branches to cover all conditionals. double-checking everything, no cap ๐Ÿ’…

-fharden-conditional-branches ๐Ÿฆ‹

For every non-vectorized conditional branch that survives gimple optimizations, emit extra code to compute and verify the reversed condition, and to call __builtin_trap if the result is unexpected. Use it with -fharden-compares to cover all conditionals.

-fharden-control-flow-redundancy ๐Ÿ‘‘

Emit extra code to set booleans when entering basic blocks, and to verify and trap, at function exits, when the booleans do not form an execution path that is compatible with the control flow graph.

Verification takes place before returns, before mandatory tail calls (see below) and, optionally, before escaping exceptions with -fhardcfr-check-exceptions, before returning calls with -fhardcfr-check-returning-calls, and before noreturn calls with -fhardcfr-check-noreturn-calls.

Tail call optimization takes place too late to affect control flow redundancy, but calls annotated as mandatory tail calls by language front-ends, and any calls marked early enough as potential tail calls, would also have verification issued before the call. But ngl, these possibilities are merely theoretical, since these conditions can only be met when using custom compiler plugins. ๐Ÿค“

-fhardcfr-skip-leaf ๐ŸŒฟ

Disable -fharden-control-flow-redundancy in leaf functions.

-fhardcfr-check-exceptions ๐Ÿ’–

When -fharden-control-flow-redundancy is active, check the recorded execution path against the control flow graph at exception escape points, as if the function body was wrapped with a cleanup handler that performed the check and reraised. This option is enabled by default; use -fno-hardcfr-check-exceptions to disable it.

-fhardcfr-check-returning-calls โœจ

When -fharden-control-flow-redundancy is active, check the recorded execution path against the control flow graph before any function call immediately followed by a return of its result, if any, so as to not prevent tail-call optimization โ€” whether or not it is ultimately optimized to a tail call.

This option is enabled by default whenever sibling call optimizations are enabled (see -foptimize-sibling-calls), but it can be enabled (or disabled, using its negated form) explicitly, regardless of the optimizations.

  • -fhardcfr-check-noreturn-calls=[always|no-xthrow|nothrow|never] โ€” okay so when -fharden-control-flow-redundancy is doing its thing, this one decides whether we check the recorded execution path against the control flow graph before noreturn calls. Your choices bestie: always (literally all of them), no-xthrow (the ones that aren't expected to hand control back to the caller via an exception โ€” and yes this is the default ๐Ÿ’…), nothrow (the ones that may not return control to the caller through an exception either), or never (none of them, we're off duty โœจ).

Checking before a noreturn function that may return control to the caller through an exception might make the check 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 on, the compiler will avoid associating a noreturn call with the implicitly-added cleanup handler, since that would be redundant with the check performed 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 might even be another noreturn call, so the checking can end up performed multiple times. it's giving overachiever ๐Ÿ˜ญ

Various optimizers may cause calls to be marked as noreturn and/or nothrow, even when the corresponding attributes aren't there, which may affect the placement of checks before calls, plus the addition of implicit cleanup handlers for them. This unpredictability โ€” combined with the fact that raising and reraising exceptions frequently amounts to implicitly calling noreturn functions โ€” is why no-xthrow is the default setting for this option: it excludes from the noreturn treatment only internal functions used to (re)raise exceptions, which aren't affected by these optimizations. iykyk ๐Ÿงš

  • -fhardened โ€” turns on a whole squad of flags for C and C++ that level up the security of the generated code without touching its ABI. The exact flags may change between major releases of GCC, but right now it's serving:
-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)

You can get the list of options -fhardened enables by using the --help=hardened option. cute right ๐ŸŽ€

When the system glibc is older than 2.35, -D_FORTIFY_SOURCE=2 gets used instead.

This option is meant for production builds, not just debug builds. lowkey important.

Currently, -fhardened is only supported on GNU/Linux targets.

And -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. respect the user's choices bestie ๐Ÿ’…

  • -fstack-protector โ€” emits extra code to check for buffer overflows, like stack smashing attacks. How? By adding a guard variable to functions with vulnerable objects. This 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 count. periodt ๐Ÿ’–
  • -fstack-protector-all โ€” like -fstack-protector except that all functions are protected. everyone gets a bodyguard.
  • -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. Same deal as before: only variables actually allocated on the stack are considered, and 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. exclusive invite-only energy ๐ŸŽ€
  • -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 to specify it in a single-threaded environment since stack overflow is automatically detected on nearly all systems if there's only one stack.
Heads up bestie: 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. it's giving "I set up the vibe, you do the work" ๐Ÿ˜ญ

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 and is equivalent to bare -fstack-check.

Old-style checking is a generic mechanism that needs no specific target support in the compiler, but bestie it comes with receipts:

  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 is not 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. oof ๐Ÿ’€

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 is not generally sufficient to protect against stack-clash attacks. To protect against those you want -fstack-clash-protection. different girlboss, different job ๐Ÿซถ

  • -fstack-clash-protection โ€” generates code to prevent stack clash style attacks. When this option is enabled, the compiler will only allocate one page of stack space at a time, and each page is accessed immediately after allocation. So it prevents allocations from jumping over any stack guard page provided by the operating system. no hopping the fence ๐Ÿ’…

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 does not grow beyond a certain value, either the value of a register or the address of a symbol. If a larger stack is required, a signal is raised at run time. For most targets, the signal is raised before the stack overruns the boundary, so it's possible to catch the signal without taking special precautions. iconic preemptive behavior โญ

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. slay for the thread girlies ๐Ÿงตโœจ

When code compiled with -fsplit-stack calls code compiled without -fsplit-stack, there may not be much stack space available for the latter code to run. If compiling all code โ€” including library code โ€” with -fsplit-stack is not an option, then the linker can fix up these calls so that the code compiled without -fsplit-stack always has a large stack. Support for this is implemented in the gold linker in GNU Binutils release 2.21 and later.

  • -fstrub=disable โ€” disables stack scrubbing entirely, ignoring any strub attributes. we're not scrubbing anything today, sorry ๐Ÿšซ
  • -fstrub=strict โ€” functions default to strub mode disabled, and it applies strictly the restriction that 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). strict parents energy fr fr ๐Ÿ˜ค
  • -fstrub=relaxed โ€” restores the default stack scrub (strub) setting, namely, strub is only enabled as required by strub attributes associated with function and data types. Relaxed means that 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 precede it in the command line. it's the "actually never mind" button ๐Ÿฆ‹
  • -fstrub=at-calls โ€” enables at-calls strub mode where viable. The primary use of this option is for testing. It exercises the strub machinery in scenarios strictly local to a translation unit. 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. See the strub attribute documentation for details on viability and eligibility requirements. ๐Ÿ“–
  • -fstrub=internal โ€” enables internal strub mode where viable. The primary use of this option is for testing. This option is intended to exercise thoroughly the parts of the strub machinery that implement the less efficient, but interface-preserving strub mode. Functions that would not be affected by this option are quite uncommon. rare queen behavior ๐Ÿ’œ
  • -fstrub=all โ€” enables some strub mode where viable. When both strub modes are viable, at-calls is preferred. -fdump-ipa-strubm adds function attributes that tell which mode was selected for each function. The primary use of this option is for testing, to exercise thoroughly the strub machinery. go off, machinery ๐ŸŽ€
  • -fvtable-verify=[std|preinit|none] โ€” okay so this one is only available when you're compiling C++ code. It turns on (or off, if you use -fvtable-verify=none) the security feature that verifies at run time, for every virtual call, that the vtable pointer through which the call is made is valid for the type of the object, and has not been corrupted or overwritten. If an invalid vtable pointer is detected at run time, an error is reported and execution of the program is immediately halted. ๐Ÿ˜ฑ

This option causes run-time data structures to be built at program startup, which are used for verifying the vtable pointers. The options std and preinit control the timing of when these data structures are built. In both cases the data structures are built before execution reaches main. Using -fvtable-verify=std causes the data structures to be built after shared libraries have been loaded and initialized. -fvtable-verify=preinit causes them to be built before shared libraries have been loaded and initialized.

If this option appears multiple times in the command line with different values specified, none takes highest priority over both std and preinit; preinit takes priority over std.

  • -fvtv-debug โ€” When used in conjunction with -fvtable-verify=std or -fvtable-verify=preinit, causes debug versions of the runtime functions for the vtable verification feature to be called. This flag also causes the compiler to log information about which vtable pointers it finds for each class. This information is written to a file named vtv_set_ptr_data.log in the directory named by the environment variable VTV_LOGS_DIR if that is 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. ๐Ÿ—‘๏ธ
  • -fvtv-counts โ€” This is a debugging flag. When used in conjunction with -fvtable-verify=std or -fvtable-verify=preinit, this causes the compiler to keep track of the total number of virtual calls it encounters and the number of verifications it inserts. It also counts the number of calls to certain run-time library functions that it inserts and logs this information for each compilation unit. The compiler writes this information to a file named vtv_count_data.log in the directory named by the environment variable VTV_LOGS_DIR if that is defined or the current working directory otherwise. It also counts the size of the vtable pointer sets for each class, and writes this information to 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 โ€” Generate instrumentation calls for entry and exit to functions. Just after function entry and just before function exit, the following profiling functions are called with the address of the current function and its call site. (On some platforms, __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 may be looked up exactly in the symbol table.

This instrumentation is also done for functions expanded inline in other functions. The profiling calls indicate where, conceptually, the inline function is entered and exited. This means that addressable versions of such functions must be available. If all your uses of a function are expanded inline, this may mean an additional expansion of code size. If you use extern inline in your C code, an addressable version of such functions must be provided. (This is normally the case anyway, but if you get lucky and the optimizer always expands the functions inline, you might have gotten away without providing static copies.)

A function may be given the attribute no_instrument_function, in which case this instrumentation is not done. This can be used, for example, for the profiling functions listed above, high-priority interrupt routines, and any functions from which the profiling functions cannot safely be called (perhaps signal handlers, if the profiling routines generate output or allocate memory).

  • -finstrument-functions-once โ€” This is similar to -finstrument-functions, but the profiling functions are called only once per instrumented function, i.e. the first profiling function is called after the first entry into the instrumented function and the second profiling function is called before the exit corresponding to this first entry.

The definition of "once" for the purpose of this option is a little vague because the implementation is not protected against data races. As a result, the implementation only guarantees that the profiling functions are called at 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,... โ€” Set the list of functions that are excluded from instrumentation (see 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 is considered to be 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,... โ€” This is similar to -finstrument-functions-exclude-file-list, but this option sets the list of function names to be excluded from instrumentation. The function name to be matched is its user-visible name, such as 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 is considered to be a match. For C99 and C++ extended identifiers, the function name must be given in UTF-8, not using universal character names.
  • -fpatchable-function-entry=N[,M] โ€” Generate 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. The NOP instructions reserve extra space which can be used to patch in any desired instrumentation at run time, provided that the code segment is writable. The amount of space is controllable indirectly via the number of NOPs; the NOP instruction used corresponds to the instruction emitted by the internal GCC back-end interface 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.

Note that the value of __attribute__ ((patchable_function_entry (N,M))) takes precedence over command-line option -fpatchable-function-entry=N,M. This can be used to increase the area size or to remove it completely on a single function. If N=0, no pad location is recorded.

The NOP instructions are inserted at---and maybe before, depending on M---the function entry address, even before the prologue. On PowerPC with the ELFv2 ABI, for a function with dual entry points, the local entry point is this function entry address by default. See the -msplit-patch-nops option to change this.

The maximum value of 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 when not using -msplit-patch-nops.


โœจ Options Controlling the Preprocessor โœจ

These options control the C preprocessor, which is run on each C source file before actual compilation.

If you use the -E option, nothing is done except preprocessing. Some of these options make sense only together with -E because they cause the preprocessor output to be unsuitable for actual compilation.

In addition to the options listed here, there are a number of options to control search paths for include files documented in Directory Options. Options to control preprocessor diagnostics are listed in Warning Options.

  • -D name, --define-macro=name, --define-macro name โ€” Predefine name as a macro, with definition 1.
  • -D name=definition, --define-macro=name=definition, --define-macro name=definition โ€” The contents of definition are tokenized and processed as if they appeared during translation phase three in a #define directive. In particular, the definition is truncated by embedded newline characters.

If you are invoking the preprocessor from a shell or shell-like program you may need to use the shell's quoting syntax to protect characters such as spaces that have a meaning in the shell syntax.

If you wish to define a function-like macro on the command line, write its argument list with surrounding parentheses before the equals sign (if any). Parentheses are meaningful to most shells, so you should quote the option. With sh and csh, -D'name(args...)=definition' works.

-D and -U options are processed in the order they are given on the command line. All -imacros file and -include file options are processed after all -D and -U options.

  • -U name, --undefine-macro=name, --undefine-macro name โ€” Cancel any previous definition of name, either built in or provided with a -D option.
  • -include file, --include=file, --include file โ€” okay bestie, this one is giving โ€œsneak this header in firstโ€ energy โœจ. It processes file as if #include "file" was literally the very first line of the primary source file. But plot twist: the first directory it searches for file is the preprocessorโ€™s working directory, not the directory that has your main source file. If itโ€™s not there, it gets searched in the rest of the #include "..." search chain like normal. And if you drop multiple -include options? They get included in the exact order they appear on the command line. Periodt.
  • -imacros file, --imacros=file, --imacros file โ€” literally exactly like -include, except any output produced by scanning file is thrown away. The macros it defines stay defined, though. So you can snag all the macros from a header without also dragging in its declarations. Obsessed. And 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. So like, the standard ones are still there, bestie. ๐Ÿฆ‹
  • -pthread โ€” defines extra macros you need for using the POSIX threads library. You should use this option consistently for both compilation and linking. Itโ€™s supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets. No cap.
  • -M, --dependencies โ€” 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 object file suffix and with any leading directory parts removed. If there are many included files then the rule is split into several lines using \-newline. The rule has no commands.

This option does not suppress the preprocessorโ€™s debug output, such as -dM. To avoid mixing such 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, --user-dependencies โ€” like -M but do not mention header files that are found in system header directories, nor header files that are 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, --print-missing-file-dependencies โ€” 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, as a missing header file renders this useless.

This feature is used in automatic updating of makefiles. ๐Ÿ‘‘

  • -Mno-modules โ€” disable dependency generation for compiled module interfaces. Simple as that. ๐Ÿ’€
  • -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 errors make gives 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 such as .c, and appends the platformโ€™s usual object suffix. The result is the target.

An -MT option sets the target to be exactly the string you specify. If you 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. -MQ '$(objpfx)foo.o' gives
                 $$(objpfx)foo.o: foo.c

The default target is automatically quoted, as if it were given with -MQ. โœจ

  • -MD, --write-dependencies โ€” -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. ๐Ÿ”ฅ

  • -MMD, --write-user-dependencies โ€” 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 that 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. These are the extensions that 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. Thatโ€™s it. ๐Ÿ’ธ
  • -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. ๐ŸŒ€
  • -fsearch-include-path[=kind] โ€” look for input files on the #include path, not just the current directory. This is particularly useful with C++20 modules, for which both header units and module interface units need to be compiled directly:
g++ -c -std=c++20 -fmodules -fsearch-include-path bits/stdc++.h bits/std.cc

kind defaults to user, which looks on the #include "..." search path; you can also explicitly specify system for the #include <...> search path. ๐Ÿ‘‘

  • -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] โ€” track locations of tokens across macro expansions. This allows the compiler to emit diagnostic about the current macro expansion stack when a compilation error occurs in a macro expansion. Using this option makes the preprocessor and the compiler consume more memory. The level parameter can be used to choose the level of precision of token location tracking thus decreasing the memory consumption if necessary. Value 0 of level de-activates this option. Value 1 tracks tokens locations in a degraded mode for the sake of minimal memory overhead. In this mode all tokens resulting from the expansion of an argument of a function-like macro have the same location. Value 2 tracks tokens locations completely. This value is the most memory hungry. When this option is given no argument, the default parameter value is 2.

Note that -ftrack-macro-expansion=2 is activated by default. ๐Ÿ’…

  • -fmacro-prefix-map=old=new โ€” when preprocessing files residing in directory old, expand the __FILE__ and __BASE_FILE__ macros as if the files resided in directory new instead. This can be used to change an absolute path to a relative path by using . for new which can result in more reproducible builds that are location independent. This option also affects __builtin_FILE() during compilation. See also -ffile-prefix-map and -fcanon-prefix-map. ๐Ÿ—บ๏ธ
  • -fexec-charset=charset โ€” set the execution character set, 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, aka the charset used for wide string and wide character constants ๐Ÿ’–. Default is one of UTF-32BE, UTF-32LE, UTF-16BE, or UTF-16LE โ€” whichever one matches up with the width of wchar_t plus the big-endian or little-endian byte order you're generating code for. Same deal as -fexec-charset: charset can be literally any encoding the system's iconv library routine supports, but bestieโ€ฆ you will have problems with encodings that don't fit exactly in wchar_t. Not a vibe. ๐Ÿซ 
  • -finput-charset=charset โ€” sets the input character set, used for translating from the character set of the input file over to the source character set GCC uses. Default is UTF-8. charset can be any encoding supported by the system's iconv library routine. โœจ

If the input character set is UTF-8, warnings about ill-formed code unit sequences get issued if -Winvalid-utf8 is enabled. Otherwise, no diagnostics are issued when the input character set matches the execution character set. If they're different though, ill-formed code unit sequences turn into an error during transcoding to the execution character set. ๐Ÿ˜ญ

  • -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 at all when a precompiled header is used. ๐Ÿ™ˆ
  • -fpch-preprocess โ€” this option lets you use a precompiled header together with -E. It inserts a special #pragma, #pragma GCC pch_preprocess "filename", into the output to mark 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, bestie. But it is safe to edit the filename if the PCH file lives somewhere else. The filename may be absolute, or it may be relative to GCC's current directory. ๐Ÿ’…
  • -fworking-directory โ€” enables generation of linemarkers in the preprocessor output that let the compiler know the current working directory at the time of preprocessing. When this option is on, 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 on the command line, this option has no effect, since no #line directives are emitted whatsoever. ๐Ÿฆ‹
  • -C, --comments โ€” 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. ๐ŸŽ€

Be prepared for side effects when using -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, --comments-in-macros โ€” do not discard comments, including during macro expansion. This is like -C, except that comments contained within macros also get 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. ๐Ÿงš

  • -P, --no-line-commands โ€” inhibit generation of linemarkers in the output from the preprocessor. This might be useful when you're running the preprocessor on something that is not C code, and it's getting sent to a program that might be confused by the linemarkers. ๐ŸŒˆ
  • -traditional, --traditional, -traditional-cpp, --traditional-cpp โ€” try to imitate the behavior of pre-standard C preprocessors, as opposed to ISO C preprocessors. See the GNU CPP manual for details. ๐Ÿ“–

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. โญ

  • -trigraphs, --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. โœจ

  • -remap โ€” enable special code to work around file systems that only permit very short file names, such as MS-DOS. ๐Ÿ˜ญ
  • -H, --trace-includes โ€” 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 are found to be invalid; an invalid precompiled header file is printed with ...x and a valid one with ...! . ๐Ÿ’…
  • -dletters, --dump=letters, --dump letters โ€” 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. ๐Ÿ’€
    • -dM, --dump=M โ€” 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 is 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. ๐Ÿซถ

  • -dD, --dump=D โ€” 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, --dump=N โ€” like -dD, but emit only the macro names, not their expansions. ๐ŸŽ€
  • -dI, --dump=I โ€” output #include directives in addition to the result of preprocessing. ๐ŸŒธ
  • -dU, --dump=U โ€” 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. ๐Ÿ™ˆ

  • -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 is split into multiple options at the commas. However, many options are modified, translated or interpreted by the compiler driver before being passed to the preprocessor, and -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. ๐Ÿ˜ญ
  • -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. ๐Ÿ’…

  • -no-integrated-cpp, --no-integrated-cpp โ€” perform preprocessing as a separate pass before compilation. By default, GCC performs preprocessing as an integrated part of input tokenization and parsing. If this option is provided, the appropriate language front end (cc1, cc1plus, or cc1obj for C, C++, and Objective-C, respectively) is instead invoked twice โ€” once for preprocessing only, and once for actual compilation of the preprocessed input. This option may be useful in conjunction with the -B or -wrapper options to specify an alternate preprocessor or perform additional processing of the program source between normal preprocessing and compilation. ๐Ÿ‘‘

๐Ÿ› ๏ธ Passing Options to the Assembler ๐Ÿ› ๏ธ

You can pass options to the assembler. fr fr. ๐Ÿ’–

  • -Wa,option โ€” pass option as an option to the assembler. If option contains commas, it is split into multiple options at the commas. โœจ
  • -Xassembler option, --for-assembler=option, --for-assembler option โ€” pass option as an option to the assembler. You can use this to supply system-specific assembler options that GCC does not recognize. ๐Ÿฆ‹

If you want to pass an option that takes an argument, you must use -Xassembler twice โ€” once for the option and once for the argument. ๐ŸŽ€


๐Ÿ”— Options for Linking ๐Ÿ”—

These options come into play when the compiler links object files into an executable output file. They are meaningless if the compiler is not doing a link step. periodt. ๐Ÿ’…

  • object-file-name โ€” okay so if a file name does NOT end in a special recognized suffix, bestie, GCC just assumes it's naming an object file or a library. (The linker is the one that tells object files apart from libraries, by peeking at the file contents, not the name โ€” sneaky.) And if linking is actually happening, those object files get handed straight to the linker as input. ๐Ÿซถ
  • -c
  • -S
  • -E โ€” if ANY of these three is in play, then the linker does not run at all, and you should not be passing object file names as arguments. Periodt. ๐Ÿ’…

โœจ some more -f flags, bestie โœจ

  • -flink-libatomic โ€” turns on linking of libatomic if the target supports it, and lowkey it's enabled by default anyway. The negative form -fno-link-libatomic is there for when you wanna explicitly turn that linking off. ๐Ÿšซ
  • -flinker-output=type โ€” this one controls the code generation of the link-time optimizer. By default the linker output is figured out automatically by the linker plugin, but for debugging the compiler, or if you want incremental linking with a non-LTO object file, manually controlling the type is genuinely useful. ๐Ÿ‘‘

So here's the tea on each type:

  • 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 lets you build 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 gives you similar optimizations as exec, except -fpie is not disabled if you specified it at compilation time.
  • If type is rel, the compiler assumes incremental linking is happening. The sections containing intermediate code for link-time optimization get merged, pre-optimized, and output to the resulting object file. Plus, 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 most of the objects in that library actually get 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 get linked together, the resulting code is better optimized than with link-time optimizations disabled (cross-module inlining happens, for example), but most of the benefits of whole-program optimizations are lost. ๐Ÿ˜ญ

During the incremental link (that's -r, iykyk) the linker plugin defaults to rel. GNU Binutils 2.44 or later is needed to incrementally link LTO objects and non-LTO objects into a single mixed object file. And if any of the object files in an incremental link can't be used for link-time optimization, the linker plugin issues a warning and uses nolto-rel. To keep whole-program optimization, link those objects into a static library instead. ๐Ÿ’ก

  • -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.
  • -fuse-ld=wild โ€” use the Wild linker (wild) instead of the default linker. ๐Ÿฆ‹

๐ŸŒˆ library linking, let's get into it ๐ŸŒˆ

  • -llibrary
  • -l library โ€” search the library named library when linking. (The second form, with the library as a separate argument, exists only for POSIX compliance and is not recommended โ€” so just don't, bestie.)

GCC passes -l directly to the linker, so go read your linker documentation for the exact deets. The general description below is about the GNU linker. ๐Ÿ’ซ

The linker searches a standard list of directories for the library. Those directories include several standard system directories plus any 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 prefers linking with the shared library โ€” unless -static is used.

And here's the thing that trips people up: it matters where in the command you write this option, because the linker searches and processes libraries and object files in the order they're 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 get loaded. ๐Ÿ’€

  • -lobjc โ€” you need this special case of the -l option in order to link an Objective-C or Objective-C++ program. ๐ŸŽ€
  • -nostartfiles โ€” do not use the standard system startup files when linking. The standard system libraries still get used normally, unless -nostdlib, -nolibc, or -nodefaultlibs is used too.
  • -nodefaultlibs โ€” do not use the standard system libraries when linking. Only the libraries you specify get passed to the linker, and options specifying linkage of the system libraries โ€” like -static-libgcc or -shared-libgcc โ€” are ignored. The standard startup files get used normally, unless -nostartfiles is used.

Heads up: the compiler may generate calls to memcmp, memset, memcpy and memmove. These entries are usually resolved by entries in libc, so when this option is specified, those entry points should be supplied through some other mechanism. โš ๏ธ

  • -nolibc โ€” do not 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 come with it and become meaningless when absence of a C library is assumed โ€” for example -lpthread or -lm in some configurations. It's intended for bare-board targets when there is genuinely no C library available. ๐Ÿ“
  • -nostdlib
  • --no-standard-libraries โ€” do not use the standard system startup files or libraries when linking. No startup files, and only the libraries you specify get passed to the linker โ€” and options specifying linkage of the system libraries, such as -static-libgcc or -shared-libgcc, are ignored.

Same warning as above: the compiler may generate calls to memcmp, memset, memcpy and memmove, which are usually resolved by entries in libc. When this option is specified, those entry points should be supplied through some other mechanism. โš ๏ธ

One of the standard libraries bypassed by -nostdlib and -nodefaultlibs is libgcc.a โ€” a library of internal subroutines that GCC uses to overcome shortcomings of particular machines, or special needs for some languages.

In most cases you need libgcc.a even when you wanna avoid other standard libraries. In other words, when you specify -nostdlib or -nodefaultlibs you should usually specify -lgcc as well. That 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++ โ€” do not implicitly link with standard C++ libraries. bye ๐Ÿ‘‹
  • -e entry
  • --entry=entry
  • --entry entry โ€” specify that the program entry point is entry. The argument gets interpreted by the linker; the GNU linker accepts either a symbol name or an address. ๐Ÿšช
  • -pie
  • --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. simple as that. ๐Ÿ™…โ€โ™€๏ธ
  • -static-pie
  • --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 it 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 โ€” link with the POSIX threads library. This one's supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets. On some targets this option also sets flags for the preprocessor, so it should be used consistently for both compilation and linking. ๐Ÿงต
  • -r โ€” produce a relocatable object as output. This is also known as partial linking. ๐Ÿ”—
  • -rdynamic โ€” pass 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. This option is needed for some uses of dlopen, or to allow obtaining backtraces from within a program. ๐Ÿ”ฅ
  • -s โ€” remove all symbol table and relocation information from the executable. yeet those symbols. ๐Ÿ’…
  • -static
  • --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
  • --shared โ€” produce a shared object which can then be linked with other objects to form an executable. Not all systems support this option. For predictable results, you must also specify the same set of options used for compilation (-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 the 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 where an application should use the shared libgcc instead of the static version. The most common one 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. ๐ŸŒธ

okay so real talk, bestie: the G++ driver just automatically adds -shared-libgcc every single time you build a shared library or a main executable, because C++ programs typically use exceptions, so this is genuinely the right thing to do. ๐Ÿ’…โœจ

If, instead, you use the GCC driver to create shared libraries, you might lowkey notice they're not always linked with the shared libgcc. Here's the tea โ˜•: 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 instead. This lets exceptions propagate through such shared libraries, without incurring relocation costs at library load time. no cap. ๐Ÿงš

but heads up bestie: 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. periodt. ๐Ÿ’–
  • -static-libasan โ€” so 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. This option, -static-libasan, directs the GCC driver to link libasan statically, without necessarily linking other libraries statically. iconic. ๐ŸŒธ
  • -static-libhwasan โ€” when the -fsanitize=hwaddress option is used to link a program, the GCC driver automatically links against libhwasan. If libhwasan is available as a shared library, and the -static option is not used, then this links against the shared version of libhwasan. The -static-libhwasan option directs the GCC driver to link libhwasan 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-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-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, fr fr. 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, --symbolic โ€” bind references to global symbols when building a shared object. Warn about any unresolved references (unless overridden by the link editor option -Xlinker -z -Xlinker defs). Only a few systems support this option, so vibe check your platform first. ๐ŸŒˆ
  • -T script โ€” use 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 โ€” pass 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, --for-linker=option, --for-linker option โ€” pass 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. slay. ๐ŸŽ€
  • -u symbol, --force-link=symbol, --force-link symbol โ€” pretend 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. ๐Ÿ’œ
  • -Tbss=addr, -Tdata=addr, -Ttext=addr, -N, -n, -t, -Z, -z keyword โ€” these options are passed through to the linker without interpretation by GCC. Refer to your linker documentation for the meanings of these options, bestie, because GCC is literally just handing them over. ๐Ÿ™ˆ

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, --include-directory-after=dir, --include-directory-after dir, --include-directory=dir, --include-directory dir โ€” add the directory dir to the list of directories to be searched for header files during preprocessing. --include-directory is an alias for -I, while --include-directory-after is an alias for -idirafter. 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. fr fr.

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-, --include-barrier โ€” 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.

In addition, -I- inhibits the use of the directory of the current file directory as the first search directory for #include "file". There is no way to override this effect of -I-. ๐Ÿ’€

  • -iprefix prefix, --include-prefix=prefix, --include-prefix prefix โ€” specify prefix as the prefix for subsequent -iwithprefix options. If the prefix represents a directory, you should include the final /. ๐Ÿฆ‹
  • -iwithprefix dir, -iwithprefixbefore dir, --include-with-prefix=prefix, --include-with-prefix prefix, --include-with-prefix-after=prefix, --include-with-prefix-after prefix, --include-with-prefix-before=prefix, --include-with-prefix-before prefix โ€” append dir to the prefix specified previously with -iprefix, and add the resulting directory to the include search path. -iwithprefixbefore puts it in the same place -I would; -iwithprefix puts it where -idirafter would. ๐ŸŒธ

--include-with-prefix and --include-with-prefix-after are both aliases for -iwithprefix, while --include-with-prefix-before is an alias for -iwithprefixbefore. periodt. ๐Ÿซถ

  • -isysroot dir โ€” bestie this is basically --sysroot but it only does header files, okay? ๐Ÿ’– (exception: on Darwin targets it does both headers and libraries, slay). For more info go read the --sysroot option, it's right there. โœจ
  • -imultilib dir โ€” use dir as a subdirectory of the directory that holds the target-specific C++ headers. ๐ŸŽ€
  • -imultiarch dir โ€” use dir as a subdirectory of the directory that holds the architecture-specific C++ headers. ๐Ÿฆ‹
  • -nostdinc, --no-standard-includes โ€” do not go searching the standard system directories for header files. Only the directories you explicitly named with -I, -iquote, -isystem, and/or -idirafter get searched (plus the directory of the current file, if that applies). nothing else, periodt. ๐Ÿ’…
  • -nostdinc++ โ€” don't search for header files in the C++-specific standard directories, but you still search all the other standard ones. (This one gets used when building the C++ library, iykyk.) ๐ŸŒธ
  • --embed-dir=dir, --embed-directory=dir, --embed-directory dir โ€” appends the dir directory to the list of searched directories for the "#embed" preprocessing directive or the "__has_embed" macro. And lowkey important: there are no default directories for "#embed". ๐Ÿ˜ญ

If dir starts with = or $SYSROOT, then that = or $SYSROOT gets replaced by the sysroot prefix โ€” go see --sysroot and -isysroot. โœจ

  • -iplugindir=dir โ€” sets the directory to search for plugins that get passed by -fplugin=name instead of -fplugin=path/name.so. This one is not meant for you to use, bestie โ€” it's only passed by the driver. ๐Ÿ™ˆ
  • -Ldir, --library-directory=dir, --library-directory dir โ€” add the directory dir to the list of directories to search for -l. simple as that. ๐Ÿ’œ
  • -Bprefix, --prefix=prefix, --prefix prefix โ€” this option says where to find the executables, libraries, include files, and data files of the compiler itself. the whole glow-up location, basically. ๐Ÿ‘‘

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 any. If that name isn't found, or if -B isn't specified, the driver tries two standard prefixes, /usr/lib/gcc/ and /usr/local/lib/gcc/. If neither of those results in a file name that's found, the unmodified program name is searched for using the directories specified in your PATH environment variable. ๐Ÿซถ

The compiler checks whether the path provided by -B refers to a directory, and if necessary it adds a directory separator character at the end of the path. ๐Ÿ’…

-B prefixes that effectively specify directory names also apply to libraries in the linker, because the compiler translates these options into -L options for the linker. They also apply to include files in the preprocessor, because the compiler translates these options into -isystem options for the preprocessor. In this case, the compiler appends include to the prefix. ๐ŸŒˆ

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. The file is left out of the link if it isn't found by those means. ๐Ÿ’€

Another way to specify a prefix much like the -B prefix is to use the environment variable GCC_EXEC_PREFIX. โญ

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's replaced by [dir/]include. This is to help with boot-strapping the compiler. ๐Ÿงš

  • -no-canonical-prefixes, --no-canonical-prefixes โ€” do not expand any symbolic links, do not resolve references to /../ or /./, and do not make the path absolute when generating a relative prefix. leave it as-is, no touch-ups. ๐ŸŽ€
  • --sysroot=dir, --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. โœจ

If you use both this option and the -isysroot option, then the --sysroot option applies to libraries, but the -isysroot option applies to header files. ๐Ÿ“š

The GNU linker (beginning with version 2.16) has the necessary support for this option. If your linker doesn't support this option, the header file aspect of --sysroot still works, but the library aspect does not. ๐Ÿ˜ญ

  • --no-sysroot-suffix โ€” for some targets, a suffix gets added to the root directory specified with --sysroot, depending on the other options used, so that 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. ๐Ÿฆ‹

โœจ Options for Code Generation Conventions โœจ

These machine-independent options control the interface conventions used in code generation. ๐Ÿ› ๏ธ

Most of them have both positive and negative forms; the negative form of -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. ๐Ÿ’…

  • -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 a lifetime of a variable ends, and if the variable lives in memory, the optimizing compiler has the freedom to reuse its stack space with other temporaries or scoped local variables whose live range does not overlap with it. Legacy code extending local lifetime is likely to break with the stack reuse optimization. ๐Ÿ˜ญ

For example,

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 a lifetime of a temporary ends, and if the temporary lives in memory, the optimizing compiler has the freedom to reuse its stack space with other temporaries or scoped local variables whose live range does not overlap with it. However some of the legacy code relies on the behavior of older compilers in which temporaries' stack space is not reused, the aggressive stack reuse can lead to runtime errors. This option is used to control the temporary stack reuse optimization. ๐Ÿ”ฅ

  • -ftrapv โ€” this option generates traps for signed overflow on addition, subtraction, 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. ๐Ÿ’€
  • -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. ๐Ÿ”„
  • -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. โญ
  • -fstrict-overflow โ€” this option implies -fno-wrapv -fno-wrapv-pointer and when negated implies -fwrapv -fwrapv-pointer. ๐Ÿค
  • -fexceptions โ€” enable exception handling. Generates extra code needed to propagate exceptions. For some targets, this implies GCC generates frame unwind information for all functions, which can produce significant data size overhead, although it does not affect execution. If you do not specify this option, GCC enables it by default for languages like C++ that normally require exception handling, and disables it for languages like C that do not normally require it. However, you may need to enable this option when compiling C code that needs to interoperate properly with exception handlers written in C++. You may also wish to disable this option if you are compiling older C++ programs that don't use exception handling. ๐Ÿ’–
  • -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. ๐Ÿšจ

  • -fdelete-dead-exceptions โ€” okay so this one says: if an instruction might throw an exception but it's not otherwise doing anything for the program's execution, feel free to yeet it. Optimized away. ๐Ÿ’…

Important deets tho: this does not affect calls to functions, except the ones carrying the pure or const attributes.

This option is on by default for the Ada and C++ compilers, because the language specs literally allow it. And the optimization passes that actually remove dead exceptions? They turn on independently at different optimization levels. So like, it's a whole separate vibe check.

  • -funwind-tables โ€” basically -fexceptions's chill cousin. It only generates any needed static data, and does not touch the generated code in any other way.

Bestie, you normally do not need to enable this one. A language processor that needs this handling will just enable it on your behalf. Let it cook. ๐Ÿซถ

  • -fasynchronous-unwind-tables โ€” generate the unwind table in DWARF format, if the target machine supports it. This table is exact at every instruction boundary</>, so it can be used for stack unwinding from asynchronous events โ€” think debugger or garbage collector. โœจ
  • -fno-gnu-unique โ€” okay this one is a whole saga, sit down. ๐Ÿ“

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 in the presence of RTLD_LOCAL. This is necessary to avoid problems where a library is used by two different RTLD_LOCAL plugins that depend on a definition in one of them โ€” and therefore end up disagreeing with each other about the binding of the symbol. Messy. ๐Ÿ˜ญ

BUT. 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. That's the escape hatch. ๐Ÿšช

  • -fpcc-struct-return โ€” return short struct and union values in memory, like the longer ones, instead of in registers. It's less efficient, but the glow-up is that it allows 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.

And "short structures and unions" means 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 โ€” return struct and union values in registers when possible. For small structures this is more efficient than -fpcc-struct-return. Periodt. ๐Ÿ’…

If you specify neither -fpcc-struct-return nor -freg-struct-return, GCC defaults to whichever convention is standard for the target. And 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. Main character decision fr. ๐Ÿ‘‘

โš ๏ธ 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 โ€” allocate to an enum type only as many bytes as it needs for the declared range of possible values. Specifically, the enum type becomes equivalent to the smallest integer type that has enough room. Frugal. โœจ

Heads up: 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 โ€” override the underlying type for wchar_t to be short unsigned int instead of the default for the target. This one 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, aka tentative definitions in the C standard. And bestie, tentative definitions are distinct from declarations of a variable with the extern keyword โ€” those ones 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 flag 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.

Lowkey a tradeoff tho: this behavior is inconsistent with C++, and on many targets it implies a speed and code size penalty on global variable references. It's mainly useful to enable legacy code to link without errors. ๐Ÿงš

  • -fno-ident, -Qy, -Qn โ€” -fno-ident suppresses emission of .ident assembler directives and causes the #ident preprocessor directive to be ignored. Meanwhile -Qy and -Qn are obsolete synonyms for -fident and -fno-ident, respectively. Old news, but they're still here. ๐Ÿ’€
  • -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. It's giving internal business only. ๐Ÿ™ˆ

  • -fverbose-asm โ€” put extra commentary information in the generated assembly code to make it more readable. This option is generally only of use to those who actually need to read the generated assembly code (perhaps while debugging the compiler itself). 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. So don't go parsing them, 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. It's 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 โ€” generate position-independent code (PIC) suitable for use in a shared library, if supported for the target machine. Such code accesses all constant addresses through a global offset table (GOT). The dynamic loader resolves the GOT entries when the program starts โ€” and just so we're clear, the dynamic loader is not part of GCC; it's 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. Slay. โœจ

  • -fPIC โ€” okay bestie, if your target machine supports it</p>, this emits position-independent code, which is the vibe you want for dynamic linking ๐Ÿ’– and it dodges any limit on the size of the global offset table. This one actually does something different on AArch64, m68k, PowerPC and SPARC. โš ๏ธ Position-independent code needs special support, so it only works on certain machines โ€” not a universal slay. And when this flag is set, the macros __pic__ and __PIC__ get defined to 2. โœจ
  • -fpie, -fPIE โ€” these are the little siblings of -fpic and -fPIC ๐Ÿซถ same energy, but the position-independent code they generate can only be linked into executables. Usually you use them to compile code that'll be linked using the -pie GCC option. Both -fpie and -fPIE define the macros __pie__ and __PIE__ โ€” the macros have 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, load the callee address at call sites from the GOT and branch to it ๐Ÿฆ‹. This is the efficient-girl move: no PLT stubs, and the 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 more register allocation freedom to the compiler โœจ. Heads up tho โ€” lazy binding requires the PLT, so with -fno-plt all external symbols are resolved at load time. Alternatively, you can use the function attribute noplt to avoid calls through the PLT for specific external functions ๐ŸŽ€. And in position-dependent code, a few targets also convert calls to functions marked to not use the PLT to use the GOT instead.
  • -fno-jump-tables โ€” do not use jump tables for switch statements, even where it'd be more efficient than other code generation strategies. This one's for when you're building code that forms part of a dynamic linker and literally cannot reference the address of a jump table โ€” pair it with -fpic or -fPIC ๐Ÿ’–. On some targets jump tables don't require a GOT anyway, and this option isn't needed. iykyk ๐ŸŒธ
  • -fno-bit-tests โ€” do not use bit tests for switch statements, even where that'd be more efficient than other code generation strategies. That's it, that's the whole vibe check. โœจ
  • -ffixed-reg โ€” treat the register named reg as a fixed register; generated code should never refer to it (except maybe as a stack pointer, frame pointer, or in some other fixed role) ๐Ÿ‘‘. reg must be the name of a register, and the accepted register names are machine-specific โ€” they're 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. periodt. ๐Ÿ’…
  • -fcall-used-reg โ€” treat the register named reg as an allocable register that gets clobbered by function calls. It may be allocated for temporaries or variables that don't live across a call. Functions compiled this way don't save and restore the register reg. ๐Ÿซถ
It is an error to use this flag with the frame pointer or stack pointer. And using it for other registers that have fixed, pervasive roles in the machine's execution model produces disastrous results ๐Ÿ˜ญ fr fr.

This flag doesn't have a negative form either, because it specifies a three-way choice.

  • -fcall-saved-reg โ€” treat the register named reg as an allocable register that's 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. And use of this flag for other registers with fixed pervasive roles in the machine's execution model produces disastrous results ๐Ÿ’€. Also, a different sort of disaster results from using this flag for a register in which function values may be returned. ๐Ÿ˜ญ

This flag also has no negative form, because โ€” say it with me โ€” it specifies a three-way choice. โœจ

  • -fpack-struct[=n] โ€” without a value specified, pack all structure members together without holes. When a value n is specified (which must be a small power of two), pack structure members according to this value, representing the maximum alignment โ€” that is, objects with default alignment requirements larger than this are output potentially unaligned at the next fitting location. ๐Ÿฆ‹
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, and nothing else.
  • -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. Also, 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 isn't 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 don't need them โ€” like for example HP-PA or IA-64 โ€” do nothing. ๐Ÿซถ

A trampoline is a small piece of code created at run time on the stack when the address of a nested function is taken, and it's used to call the nested function indirectly. So yeah, it requires the stack to be made executable 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 generates 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. ๐Ÿ˜ญ not me warning you twice
  • -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. fr fr. ๐Ÿ‘‘

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 of 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, versus 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. It 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's not the default; i.e., declarations only for use within the local DSO should always be marked explicitly as hidden so as 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 touched by -fvisibility, which is why sooo much code can just be recompiled with -fvisibility=hidden and literally nothing breaks. ๐ŸŽ€ But heads up bestie โ€” that also means calls to extern functions with no explicit visibility go through the PLT, so it's way more effective to use __attribute ((visibility)) and/or #pragma GCC visibility to tell the compiler which extern declarations should be treated as hidden. โœจ

And like, -fvisibility DOES affect C++ vague linkage entities. So for instance, an exception class that gets thrown between DSOs must be explicitly marked with default visibility so that the type_info nodes are unified between the DSOs. no cap. ๐Ÿ˜ญ

There's a whole overview of these techniques, their benefits, and how to use them at <https://gcc.gnu.org/wiki/Visibility>. ๐Ÿฆ‹

  • -fstrict-volatile-bitfields โ€” turn this on if accesses to volatile bit-fields (or other structure fields too, though ngl the compiler usually honors those types anyway) should use a single access of the width of the field's type, aligned to a natural alignment if possible. Example: targets with memory-mapped peripheral registers might require all such accesses to be 16 bits wide; with this flag you can declare all peripheral bit-fields as unsigned short (assuming short is 16 bits on these targets) to force GCC to use 16-bit accesses instead of, perhaps, a more efficient 32-bit access. โœจ

If this option is disabled, the compiler uses the most efficient instruction. In the previous example, that might be a 32-bit load instruction, even though that accesses bytes that don't contain any portion of the bit-field, or memory-mapped registers unrelated to the one being updated. ๐Ÿ™ˆ

In some cases, like when the packed attribute is applied to a structure field, it may not be possible to access the field with a single read or write that's correctly aligned for the target machine. In that case GCC falls back to generating multiple accesses rather than code that will fault or truncate the result at run time. ๐Ÿซถ

Note: Due to restrictions of the C/C++11 memory model, write accesses are not allowed to touch non bit-field members. It is therefore recommended to define all bits of the field's type as bit-field members.

The default value of this option is determined by the application binary interface for the target processor. ๐Ÿ’…

  • -fsync-libcalls โ€” this one 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 of this option 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. ๐ŸŒˆ

  • -fzero-init-padding-bits=value โ€” guarantee zero initialization of padding bits in automatic variable initializers. Certain languages guarantee zero initialization of padding bits in certain cases, e.g. C23 when using empty initializers ({}), or C++ when using zero-initialization, or C guarantees that fields not specified in an initializer have their padding bits zero initialized. This option lets you change when padding bits in initializers are guaranteed to be zero initialized. The default is -fzero-init-padding-bits=standard, which makes no further guarantees than the corresponding standard. E.g. ๐Ÿ‘‡
struct A { char a; unsigned long long b; char c; };
union B { char a; unsigned long long b; };
struct A a = {}; // C23 guarantees padding bits are zero.
struct A b = { 1, 2, 3 }; // No guarantees.
union B c = {}; // C23 guarantees padding bits are zero.
union B d = { 1 }; // No guarantees.

-fzero-init-padding-bits=unions guarantees zero initialization of padding bits in unions on top of what the standards guarantee, if the initializer of a union is empty (then all bits of the union are zero initialized) or if the initialized member of the union is smaller than the size of the union (in that case it guarantees padding bits outside of the initialized member are zero initialized). This was the GCC behavior before GCC 15, and in the above example it guarantees zero initialization of the last sizeof (unsigned long long) - 1 bytes in the union. โœจ

-fzero-init-padding-bits=all guarantees additionally zero initialization of padding bits of other aggregates, so the padding in between b.a and b.b (if any) and tail padding in the structure (if any). ๐Ÿ’–


๐Ÿ› ๏ธ GCC Developer Options ๐Ÿ› ๏ธ

This section is all about the command-line options that are primarily of interest to GCC developers โ€” the ones that support compiler testing and investigation of compiler bugs and compile-time performance problems. Think: options that produce debug dumps at various points in the compilation, options that print statistics like memory use and execution time, and options that print info about GCC's configuration, like where it searches for libraries. ๐Ÿ‘‘

Bestie, you should rarely need any of these for ordinary compilation and linking tasks. They're for the devs. iykyk. ๐Ÿ’…

Many developer options that cause GCC to 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 is constructed by concatenating the base dump file name, a pass number, a phase letter, and a pass name. The base dump file name is the name of the output file produced by the compiler if explicitly specified and not an executable; otherwise it is the source file name. The pass number is determined by the order passes are registered with the compiler's pass manager. This is generally the same as the order of execution, but passes registered by plugins, target-specific passes, or passes that are otherwise registered late are numbered higher than the pass named final, even if they are executed earlier. The phase letter is one of i (inter-procedural analysis), l (language-specific), r (RTL), or t (tree). The files are created in the directory of the output file. ๐Ÿฆ‹

  • -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 a list of comma-separated markers is additionally specified. When the su marker is specified, the callgraph is decorated with stack usage information; it is 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. ๐Ÿ˜ญ

  • -dletters
  • --dump=letters
  • --dump letters
  • -fdump-rtl-pass
  • -fdump-rtl-pass-options
  • -fdump-rtl-pass-options=filename โ€” says to make debugging dumps during compilation at times specified by letters when using -d or by pass when using -fdump-rtl. This is used for debugging the RTL-based passes of the compiler. โœจ

Some -dletters switches have different meaning when -E is used for preprocessing. ๐Ÿ‘€

The -options form allows greater control over the details of the dump. See -fdump-tree.

Here are actual instances of command-line options following these patterns and their meanings:

  • -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 โ€” dumps stuff right after the machine-dependent reorganization pass runs, if that pass even exists for your target.
  • -fdump-rtl-mode_sw โ€” dumps after it's done removing redundant mode switches.
  • -fdump-rtl-rnreg โ€” dumps after register renumbering, bestie.
  • -fdump-rtl-outof_cfglayout โ€” dumps after converting out of cfglayout mode.
  • -fdump-rtl-peephole2 โ€” dumps after the peephole pass does its lil peek-a-boo optimization thing.
  • -fdump-rtl-postreload โ€” dumps after the post-reload optimizations.
  • -fdump-rtl-pro_and_epilogue โ€” dumps after it generates the function prologues and epilogues (the little hello/goodbye wrappers of a function, so iconic of them).
  • -fdump-rtl-sched1
  • -fdump-rtl-sched2 โ€” these two enable dumping after the basic block scheduling passes. โœจ
  • -fdump-rtl-ree โ€” dumps after sign/zero extension elimination.
  • -fdump-rtl-seqabstr โ€” dumps after common sequence discovery.
  • -fdump-rtl-shorten โ€” dumps after shortening branches.
  • -fdump-rtl-split1
  • -fdump-rtl-split2
  • -fdump-rtl-split3
  • -fdump-rtl-split4
  • -fdump-rtl-split5 โ€” these bad boys enable dumping after five whole rounds of instruction splitting. five!! the commitment ๐Ÿ’…
  • -fdump-rtl-sms โ€” dumps after modulo scheduling. heads up tho, this pass only runs on some architectures.
  • -fdump-rtl-stack โ€” dumps after converting from GCC's "flat register file" registers over to the x87's stack-like registers. and ngl this pass is only run on x86 variants, so if you're not on x86 don't expect anything.
  • -fdump-rtl-subreg1
  • -fdump-rtl-subreg2 โ€” these two enable dumping after the two subreg expansion passes.
  • -fdump-rtl-vartrack โ€” dumps after variable tracking.
  • -fdump-rtl-vregs โ€” dumps after converting virtual registers to hard registers.
  • -fdump-rtl-web โ€” dumps 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 โ€” okay so these dumps are defined, but they literally always produce empty files. so likeโ€ฆ they exist, they just don't do anything. ๐Ÿ’€
  • -da
  • --dump=a
  • -fdump-rtl-all โ€” produces all the dumps listed above. all of them. the whole collection, no cap.
  • -dA
  • --dump=A โ€” annotates the assembler output with miscellaneous debugging info.
  • -dD
  • --dump=D โ€” dumps all macro definitions at the end of preprocessing, on top of the normal output.
  • -dH
  • --dump=H โ€” produces a core dump whenever an error occurs. dramatic much? ๐Ÿ˜ญ
  • -dp
  • --dump=p โ€” annotates the assembler output with a comment showing which pattern and alternative is used. it also prints the length and cost of each instruction.
  • -dP
  • --dump=P โ€” dumps the RTL in the assembler output as a comment before each instruction. also turns on -dp annotation.
  • -dx
  • --dump=x โ€” just generates RTL for a function instead of compiling it. usually you'd use this together with -fdump-rtl-expand.

  • -fdump-debug โ€” dumps the debugging information generated during the debug generation phase.
  • -fdump-earlydebug โ€” dumps the debugging information generated during the early debug generation phase.
  • -fdump-noaddr โ€” when doing debugging dumps, this suppresses address output. why would you want that? bc it makes it way more feasible to use diff on debugging dumps from compiler invocations with different compiler binaries and/or different text / bss / data / heap / stack / dso start locations. slay for reproducibility ๐Ÿซถ
  • -freport-bug โ€” collects and dumps debug info into a temporary file if an internal compiler error (ICE) occurs.
  • -fdump-unnumbered โ€” when doing debugging dumps, suppresses instruction numbers and address output. again, this makes it way more feasible to run diff on debugging dumps for compiler invocations with different options โ€” especially with and without -g.
  • -fdump-unnumbered-links โ€” when doing debugging dumps (peep the -d option above), this suppresses instruction numbers for the links to the previous and next instructions in a sequence.
  • -fdump-internal-locations โ€” dumps detailed info about GCC's internal representation of source code locations.
  • -fdump-ipa-switch
  • -fdump-ipa-switch-options โ€” these control 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 is created in the same directory as the output file. here's the possible dumps:
    • all โ€” enables all inter-procedural analysis dumps.
    • cgraph โ€” dumps info about call-graph optimization, unused function removal, and inlining decisions.
    • inline โ€” dumps after function inlining.
    • strubm โ€” dumps after selecting "strub" modes, and recording the selections as function attributes.
    • strub โ€” dumps "strub" transformations: interface changes, function wrapping, and insertion of builtin calls for stack scrubbing and watermarking.

on top of all that, the options -optimized, -missed, -note, and -all can also be provided, with the same meaning as for -fopt-info, and they default to -optimized.

so like, for example, -fdump-ipa-inline-optimized-missed will emit info on callsites that got inlined, along with the callsites that did not get inlined. no cap.

by default, the dump contains 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 which 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 is generated by appending the suffix "ipa-clones" to the source file name, and the file gets created in the same directory as the output file. each entry in the file is on its own separate line, containing semicolon separated fields. ๐Ÿ“

when it's a call graph clone creation, the individual fields are:

  1. the string "Callgraph clone".
  2. the 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. heads up: this number is unique only within a compilation unit or within whole-program analysis, but it's 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. the 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. again โ€” this number is unique only within a compilation unit or within whole-program analysis, but it's 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.

and when it's a call graph clone removal, the individual fields are:

  1. the string "Callgraph removal".
  2. the 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. (yes, again โ€” unique only within a compilation unit or within whole-program analysis, but likely 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 info. 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 โ€” these control the dumping of language-specific info. the options and filename portions behave just like they're described in the -fdump-tree option. -fdump-tree-all enables all language-specific dumps; other options vary with the language. for instance, see
  • -fdump-passes โ€” prints on stderr the list of optimization passes that are turned on and off by the current command-line options.
  • -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 โ€” these control the dumping at various stages of processing the intermediate language tree to a file. if you use the -options form, options is a list of - separated options that control the details of the dump. not all options apply to all dumps; the ones that aren't meaningful just get ignored, no biggie. here's what's available:
    • address โ€” prints the address of each node. usually this isn't meaningful since it changes based on 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.

okay so these next ones are the little seasoning sprinkles ๐Ÿง‚ you tack onto your <code>-fdump-tree-...</code> and <code>-fdump-rtl-...</code> options to control exactly what gets dumped. mix and match, bestie ๐Ÿ’…

  • slim โ€” when you're dumping front-end intermediate representations, this tells GCC to chill on dumping members of a scope or the body of a function just because that scope got reached. nope. it only dumps those items when they're actually reachable by some other path. when you're dumping pretty-printed trees, this also stops it from dumping the bodies of control structures. and when you're dumping RTL, it prints the RTL in slim (condensed) form instead of the default LISP-like representation. condensed queen ๐Ÿ‘‘
  • raw โ€” prints a raw representation of the tree. by default trees get pretty-printed into a C-like representation, but this one says "no makeup, show me the real you" ๐Ÿ™ˆ
  • details โ€” turns on more detailed dumps (tho not every dump option honors this, fyi). also pulls in info from the optimization passes.
  • stats โ€” dumps alllll the statistics about the pass (again, not every dump option honors it, she's picky).
  • blocks โ€” shows basic block boundaries. lowkey disabled in raw dumps, just so you know.
  • graph โ€” for each of the other indicated dump files (-fdump-rtl-pass), dumps a representation of the control flow graph that's suitable for viewing with GraphViz, into file.passid.pass.dot. every function in the file gets pretty-printed as a subgraph so GraphViz can render them all in one single plot. it's giving visualization slay ๐Ÿ“Š. RTL is always dumped in slim form here, no exceptions.
  • vops โ€” shows virtual operands for every statement.
  • lineno โ€” shows line numbers for statements.
  • uid โ€” shows the unique ID ("DECL_UID") for each variable.
  • verbose โ€” shows the tree dump for each statement.
  • eh โ€” shows the EH region number holding each statement.
  • scev โ€” shows scalar evolution analysis details.
  • optimized โ€” shows optimization information (only available in certain passes).
  • missed โ€” shows missed optimization information (only available in certain passes).
  • note โ€” shows other detailed optimization information (only available in certain passes).
  • folding โ€” dumps info about match-and-simplify (match.pd) patterns when they get applied.
  • all โ€” turns on all optionsโ€ฆ except raw, slim, verbose and lineno. those four said "not today" ๐Ÿ’€
  • optall โ€” turns on all the optimization options, aka optimized, missed, and note. periodt.

so likeโ€ฆ how do you even figure out which tree dumps exist or find the dump for a pass you care about?? bestie, follow these steps ๐Ÿซถ

  1. Invoke GCC with -fdump-passes and in the stderr output look for a code that corresponds to the pass you're 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.
  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 it 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.
heads up bestie โš ๏ธ those numeric codes are NOT stable and may change from one version of GCC to another. don't hardcode them, i'm begging ๐Ÿ™

โœจ -fopt-info โœจ

-fopt-info
-fopt-info-options
-fopt-info-options=filename

this one controls optimization dumps from all the various optimization passes ๐Ÿ’– if the -options form is used, options is a list of - separated option keywords that select the dump details and optimizations.

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.

you can freely mix options from each group since they're non-overlapping ๐ŸŽ€. however โ€” in case of any conflicts, the later options override the earlier options on the command line. last one wins, classic.

which messages get emitted

  • optimized โ€” prints info when an optimization is successfully applied. it's 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. slay ๐Ÿ’…
  • missed โ€” prints info about missed optimizations. individual passes control which information to include in the output.
  • note โ€” prints verbose info about optimizations, such as certain transformations, more detailed messages about decisions etc.
  • all โ€” prints detailed optimization information. this includes optimized, missed, and note.

the verbosity dial

  • 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. (iykyk ๐Ÿงš)

which optimizations to include

one or more of these 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 ๐Ÿ‘‘

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. tho 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. sorry babes, one file only ๐Ÿ’€

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.

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.

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.


โœจ -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. don't build your whole pipeline on it, bestie ๐Ÿ˜ฌ

it's 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,
  • 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 ๐Ÿช†.


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

(the dial goes UP, honey ๐ŸŽš๏ธ)


โœจ -fenable-kind-pass / -fdisable-kind-pass โœจ

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

fr fr โ€” these are for GCC devs poking at the compiler itself. if you're just out here compiling your code, use the normal options, okay? ๐Ÿซถ
  • -fdisable-ipa-pass โ€” bestie, this one turns OFF an IPA pass. pass is the pass name, like literally the name of the pass. And if the same pass gets statically invoked in the compiler more than once? Then you gotta append a sequential number to the pass name, starting from 1. that's it, that's the rule ๐Ÿ’…
  • -fdisable-rtl-pass, -fdisable-rtl-pass=range-list โ€” disable an RTL pass. pass is the pass name, and yep, same deal as above: statically invoked multiple times โ†’ append a sequential number starting from 1. Now range-list is the fun part: it's a comma-separated list of function ranges or assembler names. Each range is a number pair separated by a colon, and it's inclusive on both ends (so no sneaky off-by-one, we're not doing that today). If the range is trivial you can simplify the number pair down to 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. Where do you find the uid? It's shown in the function header of a dump file, and you can dump the pass names by using option -fdump-passes. โœจ
  • -fdisable-tree-pass, -fdisable-tree-pass=range-list โ€” disable a tree pass. See -fdisable-rtl for the description of option arguments. (same energy, different tree ๐ŸŽ€)
  • -fenable-ipa-pass โ€” enable an IPA pass. pass is the pass name. If the same pass is statically invoked in the compiler multiple times, append a sequential number starting from 1. ๐Ÿ’–
  • -fenable-rtl-pass, -fenable-rtl-pass=range-list โ€” enable an RTL pass. See -fdisable-rtl for option argument description and examples. ๐Ÿซถ
  • -fenable-tree-pass, -fenable-tree-pass=range-list โ€” enable a tree pass. See -fdisable-rtl for the description of option arguments. ๐ŸŒธ

Here are some examples showing uses of these options. no cap, these are literally in the manual:

# 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 internal consistency checking. The default depends on the compiler configuration (so it's giving mystery, depending on your setup ๐ŸŒˆ). -fchecking=2 enables further internal consistency checking that might affect code generation. yes, further. it goes deeper. ๐Ÿ’€
  • -frandom-seed=string โ€” this option provides a seed that GCC uses in place of random numbers in generating certain symbol names that have to be different in every compiled file. It's also used to place unique stamps in coverage data files and the object files that produce them. And here's the slay: you can use -frandom-seed to produce reproducibly identical object files. ๐Ÿ‘‘

The string can either be a number (decimal, octal or hex) or an arbitrary string โ€” and in that case it's converted to a number by computing CRC32. โœจ

The string should be different for every file you compile. (yes, every. do not reuse bestie, i'm begging ๐Ÿ™ˆ)
  • -save-temps, --save-temps โ€” store the usual "temporary" intermediate files permanently. Name them as auxiliary output files, as specified described under -dumpbase and -dumpdir.

When used in combination with the -x command-line option, -save-temps is sensible enough to avoid overwriting an input source file with the same extension as an intermediate file. The corresponding intermediate file may be obtained by renaming the source file before using -save-temps. ๐Ÿงš

  • -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 specified after the -o option, including any directory separators. If the -o option is not used, the -save-temps=obj switch behaves like -save-temps=cwd. ๐ŸŽ€
  • -specs=file, --specs=file, --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. ๐ŸŒธ
  • -time[=file] โ€” report the CPU time taken by each subprocess in the compilation sequence. For C source files, this is the compiler proper and assembler (plus the linker if linking is done). โฑ๏ธ

Without the specification of an output file, the output looks like this:

# cc1 0.12 0.01
# as 0.00 0.01

The first number on each line is the "user time", that is time spent executing the program itself. The second number is "system time", time spent executing operating system routines on behalf of the program. Both numbers are in seconds.

With the specification of an output file, the output is appended to the named file, and it looks like this:

0.12 0.01 cc1 <options>
0.00 0.01 as <options>

The "user time" and the "system time" are moved before the program name, and the options passed to the program are displayed, so that one can later tell what file was being compiled, and with which options. lowkey a little time capsule ๐Ÿ“ผ

  • -fdump-final-insns[=file] โ€” dump 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 occurs during compilation, run the compiler a second time, adding opts and -fcompare-debug-second to the arguments passed to the second compilation. Dump the final internal representation in both compilations, and print an error if they differ. ๐Ÿ‘€

If the equal sign is omitted, the default -gtoggle is used.

The environment variable GCC_COMPARE_DEBUG, if defined, non-empty and nonzero, implicitly enables -fcompare-debug. If GCC_COMPARE_DEBUG is defined to a string starting with a dash, then it is 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). To get just a warning, setting GCC_COMPARE_DEBUG to -w%n-fcompare-debug not overridden will do. ๐ŸŒŸ

  • -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 omitting other options that would cause the compiler to produce output to files or to standard output as a side effect. Dump files and preserved temporary files are renamed so as to contain the .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. (it's giving "niche", it's giving "for the devs only" ๐Ÿ’…)

  • -gtoggle โ€” turn off generation of debug info, if leaving out this option generates it, or turn it on at level 2 otherwise. The position of this argument in the command line does not matter; it takes effect after all other options are processed, and it does so only once, no matter how many times it is given. This is mainly intended to be used with -fcompare-debug. ๐Ÿ”
  • -fvar-tracking-assignments-toggle โ€” toggle -fvar-tracking-assignments, in the same way that -gtoggle toggles -g. periodt. ๐Ÿ’…
  • -Q โ€” when used on the command line prior to --help=, -Q acts as a modifier to the help output. ๐ŸŒˆ

Otherwise, this option makes the compiler print out each function name as it is compiled, and print some statistics about each pass when it finishes. ๐Ÿ“Š

  • -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. 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. (so like, don't @ me if the numbers are off by a crumb ๐Ÿ˜ญ)

  • -ftime-report-details โ€” record the time consumed by infrastructure parts separately for each pass. ๐Ÿ”
  • -fira-verbose=n โ€” control the verbosity of the dump file for the integrated register allocator. The default value is 5. 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. โœจ
  • -flto-report โ€” prints a report with internal details on the workings of the link-time optimizer. The contents of this report vary from version to version. It is meant to be useful to GCC developers when processing object files in LTO mode (via -flto). ๐ŸŒˆ
Disabled by default.
  • -flto-report-wpa โ€” like -flto-report, but only print 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 lets the target libraries get built for portable baseline environments, while the compiler itself defaults to something more demanding. That's lowkey the whole point: users can easily override the defaults the compiler is configured to use when building their own programs if those defaults aren't ideal for their target environment, whereas rebuilding the runtime libraries is usually not as easy or desirable. Big difference in effort, bestie. ๐Ÿซถ

Unlike TFLAGS, using specs means you can select different flags for different multilibs. The way to do that: build with make TFLAGS=-fmultiflags, after configuring --with-specs=%{fmultiflags:...}. โœจ

This option gets discarded by the driver once it's done processing driver self spec.

It's also useful for checking 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 the consistency of the (estimated) profile and the effect of individual passes. Receipts on your profile, basically.
  • -fstack-usage โ€” makes the compiler output stack usage info for the program, on a per-function basis. The filename for the dump is made by appending .su to the auxname. The auxname is generated from the name of the output file, if it's explicitly specified and it's not 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 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 manipulates the stack dynamically: in addition to the static allocation described above, stack adjustments are made in the body of the function, for example to push/pop arguments around function calls. If the qualifier bounded is also present, the amount of these adjustments is bounded at compile time and the second field is an upper bound of the total amount of stack used by the function. If it's not present, the amount of these adjustments is not bounded at compile time and the second field only represents the bounded part. Not bounded at compile time = the vibe is chaos, fr fr.

  • -fstats โ€” emit statistics about front-end processing at the end of the compilation. This option is supported only by the C++ front end, and the info is generally only useful to the G++ development team. (iykyk โ€” it's an internal team thing.)
  • -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 a 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 the second, third, fourth, tenth and eleventh invocation. For dbg_cnt(tail_call) true is returned for the first 10 invocations. ๐ŸŽ€
  • -print-autofdo-gcov-version, --print-autofdo-gcov-version โ€” print the current version of GCOV being used by the AutoFDO infrastructure. Version check, slay.
  • -print-file-name=library, --print-file-name=library, --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. One job. It does that one job.
  • -print-multi-directory, --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-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-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-multiarch โ€” print the path to OS libraries for the selected multiarch, relative to some lib subdirectory.
  • -print-prog-name=program, --print-prog-name=program, --print-prog-name program โ€” like -print-file-name, but searches for a program such as cpp. ๐Ÿ”ฅ
  • -print-libgcc-file-name, --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-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 /. THE TRAILING SLASH. DO NOT FORGET IT. ๐Ÿ˜ญ

  • -print-sysroot, --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. Silence. Iconic silence.
  • -print-sysroot-headers-suffix, --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). Config-dependent, so don't assume the shape bestie.
  • -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.) ๐Ÿ› ๏ธ
  • --param name=value, --param=name=value โ€” GCC by convention uses parameters that can be specified on the command line instead of hard-wired constants to represent arbitrary compiler limits or heuristics. Many parameters are related to optimization; for example, GCC does not inline functions that contain more than a certain number of instructions. The static analyzer similarly uses parameters to limit complexity, link-time optimization uses parameters to control partitioning, and so on. Other parameters control aspects of GCC that are completely internal, such as its memory allocation and garbage collection strategy. Still others control target-specific behavior. ๐Ÿฆ‹

The --param option provides a uniform interface for specifying values for these compiler parameters. However, the names of specific parameters, and the meaning of the values, are tied to the internals of the compiler, and are subject to change without notice in future releases. You should not depend on parameter settings for correct compilation of your program. They are exposed via the command line for the convenience of developers in debugging compilation problems or, in some cases, to provide workarounds for compiler bugs.

โš ๏ธ Not stable, bestie. Names and meanings can shift between releases without warning. Don't build your whole personality (or your correct compilation) around them. ๐Ÿ’€

๐ŸŽฏ Target-Specific Options ๐ŸŽฏ

Each target machine supported by GCC can have its own options โ€” for example, to let you compile for a particular processor variant or ABI, or to control optimizations specific to that machine. Similarly, GCC also has options that are specific to particular operating systems or runtime environments on the target. ๐Ÿ‘‘

By convention, the names of machine-specific options start with -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.

The ilp32 model is deprecated. ๐Ÿ™ˆ
  • -mbig-endian โ€” generate big-endian code. This is the default when GCC is configured for an aarch64_be-*-* target.
  • -mlittle-endian โ€” generate little-endian code. This is the default when GCC is configured for an aarch64-*-* but not an aarch64_be-*-* target.
  • -menable-sysreg-checking โ€” generates an error message if an attempt is made to access a system register which is not available on the target architecture. Vibe check on your sysreg access, and it will absolutely call you out. ๐ŸŽ€
  • -mgeneral-regs-only โ€” bestie, this one says: generate code that only touches the general-purpose registers. It stops the compiler from reaching for floating-point and Advanced SIMD registers, but it puts zero restrictions on the assembler. Your asm can do whatever it wants ๐Ÿ’…
  • -mcmodel=tiny โ€” generate code for the tiny code model. The program and its statically defined symbols have to 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. Static or dynamic linking both work. This is the default code model, the main character of code models โœจ
  • -mcmodel=large โ€” generate code for the large code model. It makes no assumptions about addresses and sizes of sections. Programs can be statically linked only. Heads up: -mcmodel=large is incompatible with -mabi=ilp32, -fpic and -fPIC. They cannot sit together, it's giving enemies to lovers but the lovers never make up ๐Ÿ’€
  • -mtp=name โ€” specify which 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, so you don't end up accessing a different thread pointer from the wrong exception level. Consistency is the vibe ๐ŸŽ€
  • -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. Strict girl summer vs. chill girl summer ๐Ÿฆ‹
  • -momit-leaf-frame-pointer, -mno-omit-leaf-frame-pointer โ€” omit or keep the frame pointer in leaf functions. The former behavior (omitting it) is the default.
  • -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 sysreg for a canary in an appropriate system register.

With that latter choice, the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset additionally specify which system register to use as the base register for reading the canary, and from what offset from that base register. There is no default register or offset, because this is entirely for use within the Linux kernel. iykyk ๐Ÿ™ˆ

  • -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 the bit size of immediate TLS offsets. Valid values are 12, 24, 32, 48. This option requires binutils 2.26 or newer, no cap.
  • -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. This flag will be ignored if an architecture or cpu is specified on the command line which does not need the workaround.
  • -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. This flag will be ignored if an architecture or cpu is specified on the command line which does not need the workaround.
  • -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 it reduces the precision of reciprocal square root results to about 16 bits for single precision and to 32 bits for double precision. Precision? We don't know her ๐Ÿ˜ญ
  • -mlow-precision-sqrt, -mno-low-precision-sqrt โ€” enable or disable the square root approximation. Same deal: only has an effect if -ffast-math or -funsafe-math-optimizations is used as well. Enabling it reduces the 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 โ€” it drags its bestie along ๐ŸŒธ
  • -mlow-precision-div, -mno-low-precision-div โ€” enable or disable the division approximation. Once again, only has an effect if -ffast-math or -funsafe-math-optimizations is used as well. Enabling it reduces the precision of division results to about 16 bits for single precision and to 32 bits for double precision.
  • -mtrack-speculation, -mno-track-speculation โ€” enable or disable generation of additional code to track speculative execution through conditional branches. The tracking state can then be used by the compiler when expanding calls to __builtin_speculation_safe_value to permit a more efficient code sequence to be generated. Sneaky speculative slay ๐Ÿ”ฅ
  • -moutline-atomics, -mno-outline-atomics โ€” enable or disable calls to out-of-line helpers to implement atomic operations. These helpers will, at runtime, determine if the LSE instructions from ARMv8.1-A can be used; if not, they will use the load/store-exclusive instructions that are present in the base ARMv8.0 ISA.

This option is only applicable when compiling for the base ARMv8.0 instruction set. If using a later revision, e.g. -march=armv8.1-a or -march=armv8-a+lse, the ARMv8.1-Atomics instructions will be used directly. The same applies when using -mcpu= when the selected cpu supports the lse feature. This option is on by default.

  • -mmax-vectorization, -mno-max-vectorization โ€” enable or disable an override to the vectorizer cost model that makes vectorization always appear profitable. This option can be combined with -mautovec-preference, allowing precise control over which ISA will be used for auto-vectorization. Unlike -fno-vect-cost-model or -fvect-cost-model=unlimited, this option does not turn off cost comparison between different vector modes.
  • -mautovec-preference=name โ€” force an ISA selection strategy for auto-vectorization. The possible values of name are:
    • default โ€” use the default heuristics.
    • asimd-only โ€” use only Advanced SIMD for auto-vectorization.
    • sve-only โ€” use only SVE for auto-vectorization.
    • prefer-asimd โ€” use both Advanced SIMD and SVE. Prefer Advanced SIMD when the costs are deemed equal.
    • prefer-sve โ€” use both Advanced SIMD and SVE. Prefer SVE when the costs are deemed equal.

For best performance it is highly recommended to use -mcpu or -mtune instead. This parameter should only be used for code exploration. Don't make it your whole personality ๐Ÿงš

  • -march=name โ€” specify the name of the target architecture and, optionally, one or more feature modifiers. This option has the form -march=arch{+[no]feature}*.

The list below summarizes the permissible values for arch and the features that they enable by default. Format is: arch value : Architecture : includes by default.

  • armv8-a : Armv8-A : +fp, +simd
  • armv8.1-a : Armv8.1-A : armv8-a, +crc, +lse, +rdma
  • armv8.2-a : Armv8.2-A : armv8.1-a
  • armv8.3-a : Armv8.3-A : armv8.2-a, +pauth, +fcma, +jscvt
  • armv8.4-a : Armv8.4-A : armv8.3-a, +flagm, +fp16fml, +dotprod, +rcpc2
  • armv8.5-a : Armv8.5-A : armv8.4-a, +sb, +ssbs, +predres, +frintts, +flagm2
  • armv8.6-a : Armv8.6-A : armv8.5-a, +bf16, +i8mm
  • armv8.7-a : Armv8.7-A : armv8.6-a, +wfxt, +xs
  • armv8.8-a : Armv8.8-a : armv8.7-a, +mops
  • armv8.9-a : Armv8.9-a : armv8.8-a
  • armv9-a : Armv9-A : armv8.5-a, +sve, +sve2
  • armv9.1-a : Armv9.1-A : armv9-a, +bf16, +i8mm
  • armv9.2-a : Armv9.2-A : armv9.1-a, +wfxt, +xs
  • armv9.3-a : Armv9.3-A : armv9.2-a, +mops
  • armv9.4-a : Armv9.4-A : armv9.3-a, +sve2p1
  • armv9.5-a : Armv9.5-A : armv9.4-a, cpa, +faminmax, +lut
  • armv8-r : Armv8-R : armv8-r

The value native is available on native AArch64 GNU/Linux and causes the compiler to pick the architecture of the host system. This option has no effect if the compiler is unable to recognize the architecture of the host system. When -march=native is given and no other -mcpu or -mtune is given, then GCC will pick the host CPU as the CPU to tune for as well as select the architecture features from. That is, -march=native is treated as -mcpu=native.

The permissible values for feature are listed in the sub-section on aarch64-feature-modifiers,,-march and -mcpu Feature Modifiers. Where conflicting feature modifiers are specified, the right-most feature is used.

GCC uses name to determine what kind of instructions it can emit when generating assembly code. If -march is specified without either of -mtune or -mcpu also being specified, the code is tuned to perform well across a range of target processors implementing the target architecture. She's versatile like that ๐Ÿ’–

  • -mtune=name โ€” specify the name of the target processor for which GCC should tune the performance of the code. The permissible values for this option 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, oryon-1, neoverse-512tvb, neoverse-e1, neoverse-n1, neoverse-n2, neoverse-v1, neoverse-v2, grace, neoverse-v3, neoverse-v3ae, armagicpu, neoverse-n3, olympus, rigel, cortex-a725, cortex-x925, 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-r82ae, cortex-x1, cortex-x1c, cortex-x2, cortex-x3, cortex-x4, cortex-a510, cortex-a520, cortex-a520ae, cortex-a710, cortex-a715, cortex-a720, cortex-a720ae, ampere1, ampere1a, ampere1b, ampere1c, cobalt-100, apple-m1, apple-m2, apple-m3, apple-m4, apple-m5, c1-nano, c1-pro, c1-premium c1-ultra and native.

Okay that list is a whole roster and every single one of them is iconic in her own way ๐Ÿ‘‘

okay so bestie, we're still deep in AArch64 tuning land and it's lowkey a whole personality. stay with me ๐Ÿ’…

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, apple-m1, apple-m2, apple-m3, gb10 specify that GCC should tune for a big.LITTLE system. big brain energy, small core energy, both at once โœจ

The value neoverse-512tvb specifies that GCC should tune for Neoverse cores that (a) implement SVE and (b) have a total vector bandwidth of 512 bits per cycle. In other words, the option tells GCC to tune for Neoverse cores that can execute 4 128-bit Advanced SIMD arithmetic instructions a cycle and that can execute an equivalent number of SVE arithmetic instructions per cycle (2 for 256-bit SVE, 4 for 128-bit SVE). This is more general than tuning for a specific core like Neoverse V1 but is more specific than the default tuning described below. it's giving "vibes-based but with math" ๐Ÿงฎ

Additionally on native AArch64 GNU/Linux systems the value native tunes performance to the host system. This option has no effect if the compiler is unable to recognize the processor of the host system. if it can't clock the vibe, it just... doesn't โœ‹

Where none of -mtune=, -mcpu= or -march= are specified, the code is tuned to perform well across a range of target processors. equal-opportunity tuning, we love to see it ๐Ÿซถ

This option cannot be suffixed by feature modifiers. no add-ons, periodt ๐Ÿšซ


โœจ -mcpu=name โœจ

Specify the name of the target processor, optionally suffixed by one or more feature modifiers. This option has the form -mcpu=cpu{+[no]feature}*, where the permissible values for cpu are the same as those available for -mtune. The permissible values for feature are documented in the sub-section on aarch64-feature-modifiers,,-march and -mcpu Feature Modifiers. Where conflicting feature modifiers are specified, the right-most feature is used. right-most wins, like the last person to speak in the group chat ๐Ÿ‘‘

GCC uses name to determine what kind of instructions it can emit when generating assembly code (as if by -march) and to determine the target processor for which to tune for performance (as if by -mtune). Where this option is used in conjunction with -march or -mtune, those options take precedence over the appropriate part of this option. so -march and -mtune are the main characters here, -mcpu is the supporting role ๐Ÿ’…

-mcpu=neoverse-512tvb is special in that it does not refer to a specific core, but instead refers to all Neoverse cores that (a) implement SVE and (b) have a total vector bandwidth of 512 bits a cycle. Unless overridden by -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. Unless overridden by -mtune, -mcpu=neoverse-512tvb tunes code in the same way as for -mtune=neoverse-512tvb. a whole category of cores, not just one, iconic behavior honestly ๐ŸŒˆ


โœจ -moverride=string โœจ

Override tuning decisions made by the back-end in response to a -mtune= switch. The syntax, semantics, and accepted values for string in this option are not guaranteed to be consistent across releases. fr fr, this thing can change on you between versions ๐Ÿ˜ญ

This option is only intended to be useful when developing GCC. devs only, bestie โ€” not for the general population ๐Ÿ™ˆ


โœจ -mpc-relative-literal-loads / -mno-pc-relative-literal-loads โœจ

  • -mpc-relative-literal-loads, -mno-pc-relative-literal-loads โ€” Enable or disable PC-relative literal loads.

With this option literal pools are accessed using a single instruction and emitted after each function. This limits the maximum size of functions to 1MB. one meg, that's the cap, no cap ๐Ÿ“ This is enabled by default for -mcmodel=tiny.


โœจ -msign-return-address=scope โœจ

Select the function scope on which return address signing will be applied. Permissible values are:

  • none โ€” disables return address signing
  • non-leaf โ€” enables pointer signing for functions which are not leaf functions
  • all โ€” enables pointer signing for all functions

The default value is none. doing nothing is the default, honestly relatable ๐Ÿ˜Œ

This option has been deprecated by -mbranch-protection. ๐Ÿ‘‹ it's over, use the new one

โœจ -mbranch-protection=features โœจ

Select the branch protection features to use. features can have one of the following forms:

  • none is the default and turns off all types of branch protection. protection? never heard of her ๐Ÿ’€
  • 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 turns on return address signing to its standard level: signing functions that save the return address to memory (non-leaf functions practically always do this) using the A-key. basically every non-leaf function does this, so it's a whole thing ๐ŸŽ€
  • pac-ret+leaf extends the pac-ret signing to include leaf functions.
  • pac-ret+b-key or pac-ret+leaf+b-key can be used to sign the functions with the B-key instead of the A-key. switching keys like switching outfits ๐Ÿ’…
  • bti turns on branch target identification mechanism.
  • gcs turns on guarded control stack compatible code generation. guarded, protected, secured, we love her ๐Ÿซถ

โœจ -mharden-sls=opts โœจ

Enable compiler hardening against straight line speculation (SLS). opts is a comma-separated list of the following options:

  • retbr
  • blr

In addition, -mharden-sls=all enables all SLS hardening while -mharden-sls=none disables all SLS hardening. all or nothing, very on brand โœจ


โœจ -mearly-ra=scope โœจ

Determine when to enable an early register allocation pass. This pass runs before instruction scheduling and tries to find a spill-free allocation of floating-point and vector code. It also tries to make use of strided multi-register instructions, such as SME2's strided LD1 and ST1. spill-free?? we're manifesting a clean allocation, no leaks, periodt ๐Ÿงš

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
  • 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. tier list of defaults, and -O2 is S-tier โญ


โœจ -mearly-ldp-fusion / -mno-early-ldp-fusion โœจ

  • -mearly-ldp-fusion, -mno-early-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. it's early, it's fusing, it's on by default, slay ๐Ÿ’–

โœจ -mlate-ldp-fusion / -mno-late-ldp-fusion โœจ

  • -mlate-ldp-fusion, -mno-late-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. same fusion, but fashionably late ๐Ÿฆ‹

โœจ -mnarrow-gp-writes โœจ

Enable conversion of 64-bit general purpose register writes to equivalent 32-bit operations when the upper 32 bits are known to be zero. This pass can be controlled with -mnarrow-gp-writes and is active at -O2 and above, but not enabled by default, except for -mcpu=olympus. 64 โ†’ 32 when the top bits are zero, tiny but mighty, except olympus gets special treatment ๐Ÿ‘‘


โœจ -msve-vector-bits=bits โœจ

Specify the number of bits in an SVE vector register. This option only has an effect when SVE is enabled. no SVE, no opinion ๐Ÿคทโ€โ™€๏ธ

GCC supports two forms of SVE code generation:

  • "vector-length agnostic" output that works with any size of vector register
  • "vector-length specific" output that allows GCC to make assumptions about the vector length when it is useful for optimization reasons.

The possible values of 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. the vibes are subject to change, do not build your whole life on them ๐Ÿ’€

The default is -msve-vector-bits=scalable, which produces vector-length agnostic code. agnostic and unbothered, the default mood โœจ


โœจ -march and -mcpu Feature Modifiers โœจ

Feature modifiers used with -march and -mcpu can be any of the following and their inverses nofeature: yes bestie, every single one of these has a no version, the duality of woman ๐ŸŽ€

  • 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. always on, queen behavior ๐Ÿ‘‘
  • 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. also always on, we stan a default ๐Ÿ’…
  • 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. too old, not supported, sorry bestie ๐Ÿšซ
  • 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. dot product, math girlies rise ๐Ÿงฎ
  • 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. again, too old, don't even try it ๐Ÿ’€
  • 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. same energy, Armv8.2-A or nothing โœ‹
  • profile โ€” Enable the Statistical Profiling extension. This option is only to enable the extension at the assembler level and does not affect code generation. assembler-only, codegen doesn't care, iykyk ๐Ÿ™ˆ
  • 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. random but make it assembler-only โœจ
  • memtag โ€” Enable the Armv8.5-a Memory Tagging Extensions. Use of this option with architectures prior to Armv8.5-A is not supported. Armv8.5-A gatekeeping, as always ๐Ÿšซ
  • 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. default at 8.5-a, iconic ๐Ÿ’–
  • 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. also a default at 8.5-a, twinning ๐Ÿฆ‹
  • predres โ€” turns on the Armv8-a Execution and Data Prediction Restriction instructions โœจ heads up tho bestie: this one is only here to enable the extension at the assembler level, it does not touch code generation. It's enabled by default for -march=armv8.5-a.
  • sve2 โ€” enables the Armv8-a Scalable Vector Extension 2 ๐Ÿ’œ this also enables SVE instructions.
  • sve2-bitperm โ€” enables SVE2 bitperm instructions ๐ŸŒธ this also enables SVE2 instructions.
  • sve2-sm4 โ€” enables SVE2 sm4 instructions ๐ŸŽ€ this also enables SVE2 instructions.
  • sve2-aes โ€” enables SVE2 aes instructions โœจ this also enables SVE2 instructions.
  • sve2-sha3 โ€” enables SVE2 sha3 instructions ๐Ÿ’… this also enables SVE2 instructions.
  • sve2p1 โ€” enables SVE2.1 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. It's enabled by default for -march=armv8.6-a. And fr, using 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. 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 โšก
  • mops โ€” enable the instructions to accelerate memory operations like memcpy, memmove, memset ๐Ÿƒโ€โ™€๏ธ๐Ÿ’จ this one is enabled by default for -march=armv8.8-a
  • flagm โ€” enable the Flag Manipulation instructions Extension ๐Ÿšฉ
  • flagm2 โ€” enable the FlagM2 flag conversion instructions ๐Ÿšฉ
  • pauth โ€” enable the Pointer Authentication Extension ๐Ÿ”
  • cssc โ€” enable the Common Short Sequence Compression instructions ๐Ÿ“ฆ
  • cmpbr โ€” enable the shorter compare and branch instructions, cbb, cbh and cb โœ‚๏ธ
  • sme โ€” enable the Scalable Matrix Extension ๐Ÿ‘‘
  • sme-i16i64 โ€” enable the FEAT_SME_I16I64 extension to SME โœจ this also enables SME instructions.
  • sme-f64f64 โ€” enable the FEAT_SME_F64F64 extension to SME โœจ this also enables SME instructions.
  • sme2 โ€” enable the Scalable Matrix Extension 2 ๐Ÿ’– this also enables SME instructions.
  • sme-f8f16 โ€” enable the FEAT_SME_F8F16 extension to SME ๐ŸŒธ this also enables SME2 and FP8 instructions.
  • sme-f8f32 โ€” enable the FEAT_SME_F8F32 extension to SME ๐ŸŒธ this also enables SME2 and FP8 instructions.
  • sme-b16b16 โ€” enable the FEAT_SME_B16B16 extension to SME ๐Ÿ’œ this also enables SME2 and SVE_B16B16 instructions.
  • sme-f16f16 โ€” enable the FEAT_SME_F16F16 extension to SME ๐Ÿ’œ this also enables SME2 instructions.
  • sme2p1 โ€” enable the Scalable Matrix Extension version 2.1 ๐ŸŽ€ this also enables SME2 instructions.
  • fcma โ€” enable the complex number SIMD extensions ๐Ÿ”ข
  • jscvt โ€” enable the fjcvtzs JavaScript conversion instruction ๐ŸŸจ
  • frintts โ€” enable floating-point round to integral value instructions ๐ŸŽฏ
  • wfxt โ€” enable wfet and wfit instructions โณ
  • xs โ€” enable the XS memory attribute extension ๐Ÿ—‚๏ธ
  • 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 ๐Ÿ”’
  • rcpc2 โ€” enable the RCpc2 extension ๐Ÿ’ซ
  • rcpc3 โ€” enable the RCpc3 (Release Consistency) extension ๐Ÿ’ซ
  • fp8 โ€” enable the fp8 (8-bit floating point) extension ๐ŸŽฑ
  • fp8fma โ€” enable the fp8 (8-bit floating point) multiply accumulate extension ๐ŸŽฑโœ–๏ธโž•
  • ssve-fp8fma โ€” enable the fp8 (8-bit floating point) multiply accumulate extension in streaming mode ๐ŸŒŠ
  • fp8dot4 โ€” enable the fp8 (8-bit floating point) to single-precision 4-way dot product extension ๐ŸŽฑ
  • ssve-fp8dot4 โ€” enable the fp8 (8-bit floating point) to single-precision 4-way dot product extension in streaming mode ๐ŸŒŠ
  • fp8dot2 โ€” enable the fp8 (8-bit floating point) to half-precision 2-way dot product extension ๐ŸŽฑ
  • ssve-fp8dot2 โ€” enable the fp8 (8-bit floating point) to half-precision 2-way dot product extension in streaming mode ๐ŸŒŠ
  • faminmax โ€” enable the Floating Point Absolute Maximum/Minimum extension ๐Ÿ“ˆ๐Ÿ“‰
  • lut โ€” enable the Lookup Table extension ๐Ÿ“‹
  • sme-lutv2 โ€” enable the SME Lookup Table v2 (LUTv2) extension ๐Ÿ“‹
  • cpa โ€” enable the Checked Pointer Arithmetic instructions โœ…
  • sve-b16b16 โ€” enable the SVE non-widening brain floating-point (bf16) extension ๐Ÿง  ngl this only has an effect when sve2 or sme2 are also enabled.
  • sve-bfscale โ€” enable the SVE_BFSCALE extension โš–๏ธ
  • poe2 โ€” enable the Permission Overlays Extension 2 ๐ŸชŸ
  • tev โ€” enable the TIndex Exception-like Vector Extension ๐Ÿ’ซ
  • tlbid โ€” enable the TLBI Domains Extension ๐ŸŒ
  • gcie โ€” enable the GICv5 (Generic Interrupt Controller) CPU Interface Extension ๐Ÿšฆ
  • lscp โ€” enable the load acquire and store release pair extension ๐Ÿ”
  • mops-go โ€” enable tag only variants of MOPS instructions ๐Ÿท๏ธ this also enables the instructions to accelerate memory operations and Armv8.5-a Memory Tagging Extensions.
  • sve2p3 โ€” enable SVE2.3 ๐Ÿ’œ this also enables SVE2.2 instructions.
  • sme2p3 โ€” enable SME2.3 ๐Ÿ‘‘ this also enables SME2.2 instructions.
  • f16f32dot โ€” enable Armv9.7-a f16f32dot instructions โœจ this also enables Advanced SIMD, floating-point instructions and Armv8.2-a FP16 instructions.
  • sve-b16mm โ€” enable the SVE B16MM Extension ๐Ÿง  this also enables SVE instructions, Advanced SIMD and floating-point instructions.
  • mtetc โ€” enable Data cache tag block operations ๐Ÿท๏ธ this also enables Armv8.5-a Memory Tagging Extensions.
  • f16f32mm โ€” enable Armv9.7-a f16f32mm instructions โœจ this also enables Advanced SIMD, floating-point instructions and Armv8.2-a FP16 instructions.
  • f16mm โ€” enable f16mm instructions โœจ this also enables Advanced SIMD, floating-point instructions and Armv8.2-a FP16 instructions.
Ok so the dependency tea โ˜• feature crypto implies aes, sha2, and simd, which implies fp. And conversely, nofp implies nosimd, which implies nocrypto, noaes and nosha2. The way it cascades down, iykyk ๐Ÿ’…

๐ŸŒˆ Adapteva Epiphany Options ๐Ÿ’–

These -m options are defined for Adapteva Epiphany ๐Ÿฆ‹:

  • -mhalf-reg-file, -mno-half-reg-file โ€” don't allocate any register in the range r32...r63 ๐Ÿ™… that's what lets your code run on hardware variants that just... don't have these registers.
  • -mprefer-short-insn-regs, -mno-prefer-short-insn-regs โ€” preferentially allocate registers that allow short instruction generation โœจ heads up tho: this can result in an increased instruction count, so it may either reduce or increase overall code size. Chaotic, I know.
  • -mbranch-cost=num โ€” set the cost of branches to roughly num "simple" instructions. This cost is only a heuristic bestie and is not guaranteed to produce consistent results across releases ๐Ÿ“‰.
  • -mcmove, -mno-cmove โ€” enable the generation of conditional moves ๐Ÿ”€.
  • -mnops=num โ€” emit num NOPs before every other generated instruction ๐Ÿซฅ.
  • -mno-soft-cmpsf, -msoft-cmpsf โ€” for single-precision floating-point comparisons, emit an fsub instruction and test the flags ๐Ÿšฉ this is faster than a software comparison, but it 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.
  • -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, -mround-nearest โ€” -mno-round-nearest makes 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. Note that -mlong-calls is equivalent to -mno-short-calls, and similarly -mno-long-calls is equivalent to -mshort-calls. Symmetry slay ๐Ÿ’…

  • -msmall16, -mno-small16 โ€” 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 โ€” bestie, any mode at function entry is valid here, and it gets retained or restored when the function returns and when it calls other functions. This one is chef's kiss for compiling libraries or other compilation units you might want to 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 for any extra mode switching that might be needed, compared with what would be needed with a more specific choice of prevailing FPU mode. ๐Ÿ’–
  • truncate โ€” the mode used for floating-point calculations with truncating (i.e. round towards zero) rounding mode. That includes conversion from floating point to integer. โœ‚๏ธ
  • round-nearest โ€” the mode used for floating-point calculations with round-to-nearest-or-even rounding mode. ๐ŸŽฏ
  • int โ€” 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 โ€” periodt.


  • -mmay-round-for-trunc, -mno-may-round-for-trunc โ€” this option lets floating point to integer truncation be replaced with rounding to save mode switching. It's disabled by default. ๐Ÿ”„
  • -mfp-iarith, -mno-fp-iarith โ€” this option enables use of the floating-point unit for integer add and subtract. Also disabled by default. โž•โž–
  • -msplit-lohi, -mno-split-lohi, -mpost-inc, -mno-post-inc, -mpost-modify, -mno-post-modify โ€” code generation tweaks that control, respectively, splitting of 32-bit loads, generation of post-increment addresses, and generation of post-modify addresses. The defaults are msplit-lohi, -mpost-inc, and -mpost-modify. ๐Ÿ› ๏ธ
  • -mno-vect-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, -mno-split-vecmove-early โ€” split vector moves into single word moves before reload. In theory this can give better register allocation, but so far the reverse seems to be generally the case. ๐Ÿ’€ (theory ate, practice did not)
  • -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:
    • gfx900 โ€” compile for GCN5 Vega 10 devices (gfx900).
    • gfx902 โ€” compile for GCN5 Vega gfx902 devices. (Experimental) ๐Ÿงช
    • gfx904 โ€” compile for GCN5 Vega gfx904 devices. (Experimental) ๐Ÿงช
    • gfx906 โ€” compile for GCN5 Vega 20 devices (gfx906).
    • gfx908 โ€” compile for CDNA1 Instinct MI100 series devices (gfx908).
    • gfx909 โ€” compile for GCN5 Vega gfx909 devices. (Experimental) ๐Ÿงช
    • gfx90a โ€” compile for CDNA2 Instinct MI200 series devices (gfx90a).
    • gfx90c โ€” compile for GCN5 Vega 7 devices (gfx90c).
    • gfx942 โ€” compile for CDNA3 Instinct MI300 series devices (gfx942). (Experimental) ๐Ÿงช
    • gfx950 โ€” compile for the CDNA3 gfx950 devices. (Experimental) ๐Ÿงช
    • gfx9-generic โ€” compile generic code for Vega devices, executable on the following subset of GFX9 devices: gfx900, gfx902, gfx904, gfx906, gfx909 and gfx90c.
    • gfx9-4-generic โ€” compile generic code for CDNA3 devices, executable on the following subset of GFX9 devices: gfx942 and gfx950. (Experimental) ๐Ÿงช
    • gfx1030 โ€” compile for RDNA2 gfx1030 devices (GFX10 series).
    • gfx1031 โ€” compile for RDNA2 gfx1031 devices (GFX10 series). (Experimental) ๐Ÿงช
    • gfx1032 โ€” compile for RDNA2 gfx1032 devices (GFX10 series). (Experimental) ๐Ÿงช
    • gfx1033 โ€” compile for RDNA2 gfx1033 devices (GFX10 series). (Experimental) ๐Ÿงช
    • gfx1034 โ€” compile for RDNA2 gfx1034 devices (GFX10 series). (Experimental) ๐Ÿงช
    • gfx1035 โ€” compile for RDNA2 gfx1035 devices (GFX10 series). (Experimental) ๐Ÿงช
    • gfx1036 โ€” compile for RDNA2 gfx1036 devices (GFX10 series).
    • gfx10-3-generic โ€” compile generic code for GFX10-3 devices, executable on gfx1030, gfx1031, gfx1032, gfx1033, gfx1034, gfx1035, and gfx1036.
    • gfx1100 โ€” compile for RDNA3 gfx1100 devices (GFX11 series).
    • gfx1101 โ€” compile for RDNA3 gfx1101 devices (GFX11 series). (Experimental) ๐Ÿงช
    • gfx1102 โ€” compile for RDNA3 gfx1102 devices (GFX11 series). (Experimental) ๐Ÿงช
    • gfx1103 โ€” compile for RDNA3 gfx1103 devices (GFX11 series).
    • gfx1150 โ€” compile for RDNA3 gfx1150 devices (GFX11 series). (Experimental) ๐Ÿงช
    • gfx1151 โ€” compile for RDNA3 gfx1151 devices (GFX11 series). (Experimental) ๐Ÿงช
    • gfx1152 โ€” compile for RDNA3 gfx1152 devices (GFX11 series). (Experimental) ๐Ÿงช
    • gfx1153 โ€” compile for RDNA3 gfx1153 devices (GFX11 series). (Experimental) ๐Ÿงช
    • gfx11-generic โ€” compile generic code for GFX11 devices, executable on gfx1100, gfx1101, gfx1102, gfx1103, gfx1150, gfx1151, gfx1152, and gfx1153.
  • -mgang-private-size=bytes โ€” set the amount of local data-share (LDS) memory to reserve for gang-private variables. The default is 512. ๐Ÿง 
  • -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. โš ๏ธ
  • -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. โš ๏ธ
  • -Wopenacc-dims, -Wno-openacc-dims โ€” control warnings about invalid OpenACC dimensions. ๐Ÿšจ

๐Ÿน 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, -mdpfp-lrsr โ€” control whether lr and sr instructions use FPX extension aux registers. This is enabled by default. ๐ŸŽ›๏ธ
  • -mea โ€” generate extended arithmetic instructions. Currently only divaw, adds, subs, and sat16 are supported. Only valid for -mcpu=ARC700. ๐Ÿงฎ
  • -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 โ€” turns on generation of ARC SIMD instructions via target-specific builtins โœจ. Only valid for -mcpu=ARC700, bestie, don't try it anywhere else.
  • -msoft-float โ€” okay so this one is literally ignored ๐Ÿ™ˆ it's here for compatibility purposes only. Software floating-point code is emitted by default, and that default can be overridden by the 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, periodt.
  • -mdiv-rem โ€” enable "div" and "rem" instructions for ARCv2 cores ๐Ÿ’…
  • -mcode-density, -mno-code-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.
  • -mbitops โ€” enable use of NPS400 bit operations โœจ
  • -mcmem โ€” enable use of NPS400 xld/xst extension.
  • *-mmpy-option=multo* โ€” compile ARCv2 code with a multiplier design option. You can specify the option using either a string or a numeric value for multo. wlh1 is the default value. The recognized values are, and bestie I'm listing every single one:
    • 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".
    • 6, wlh5 โ€” one 32x4 multiplier, blocking, sequential. The following instructions are additionally enabled: "mpy", "mpyu", "mpym", "mpymu", and "mpy_s".
    • 7, plus_dmpy โ€” ARC HS SIMD support.
    • 8, plus_macd โ€” ARC HS SIMD support.
    • 9, plus_qmacw โ€” ARC HS SIMD support.
This option is only available for ARCv2 cores, so don't come crying to me if you try it on something else ๐Ÿ˜ญ
  • *-mfpu=fpu* โ€” enables support for specific floating-point hardware extensions for ARCv2 cores ๐ŸŒธ. Supported values for fpu are:
    • fpus โ€” enables support for single-precision floating-point hardware extensions.
    • fpud โ€” enables support for double-precision floating-point hardware extensions. The single-precision floating-point extension is also enabled. Not available for ARC EM.
    • fpuda โ€” enables support for double-precision floating-point hardware extensions using double-precision assist instructions. The single-precision floating-point extension is also enabled. This option is only available for ARC EM.
    • fpuda_div โ€” enables support for double-precision floating-point hardware extensions using double-precision assist instructions. The single-precision floating-point, square-root, and divide extensions are also enabled. This option is only available for ARC EM.
    • fpuda_fma โ€” enables support for double-precision floating-point hardware extensions using double-precision assist instructions. The single-precision floating-point and fused multiply and add hardware extensions are also enabled. This option is only available for ARC EM.
    • fpuda_all โ€” enables support for double-precision floating-point hardware extensions using double-precision assist instructions. All single-precision floating-point hardware extensions are also enabled. This option is only available for ARC EM.
    • 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 โ€” specifies general-purpose registers that the processor automatically saves/restores on interrupt entry and exit ๐Ÿ›Ÿ. register-range is specified as two registers separated by a dash. The register range always starts with "r0", 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* โ€” specifies the number of registers replicated in the second register bank on entry to fast interrupt. Fast interrupts are interrupts with the highest priority level P0. These interrupts save only PC and STATUS32 registers to avoid memory transactions during interrupt entry and exit sequences. Use this option when you are using fast interrupts in an ARC V2 family processor. Permitted values are 4, 8, 16, and 32 ๐Ÿ’–
  • *-mlpc-width=width* โ€” specify 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 is known that the "lp_count" register can hold the required loop-counter value. Depending on the width specified, the compiler and run-time library might continue to use the loop mechanism for various needs. This option defines macro "__ARC_LPC_WIDTH__" with the value of width.
  • -mrf16 โ€” this option instructs the compiler to generate code for a 16-entry register file. This option defines the "__ARC_RF16__" preprocessor macro โœจ
  • -mbranch-index โ€” enable 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. Yes bestie, they do double duty ๐Ÿ’…


  • -mlock โ€” passed down to the assembler to enable the locked load/store conditional extension. Also sets the preprocessor symbol "__Xlock".
  • -mswape โ€” passed down to the assembler to enable the swap byte ordering extension instruction. Also sets the preprocessor symbol "__Xswape".
  • -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 ๐ŸŽ€

The following options are passed through to the linker:


  • -marclinux, -mno-arclinux โ€” 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, -mno-arclinux_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: like, the meaning of what gets emitted, iykyk ๐ŸŒˆ


  • -mlong-calls โ€” generate calls as register indirect calls, thus providing access to the full 32-bit address range ๐ŸŒ
  • -mmedium-calls, -mno-medium-calls โ€” don't use less than 25-bit addressing range for calls, which is the offset available for an unconditional branch-and-link instruction. Conditional execution of function calls is suppressed, to allow use of the 25-bit range, rather than the 21-bit range with conditional branch-and-link. This is the default for tool chains built for "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 โ€” do not generate sdata references. This is the default for tool chains built for "arc-linux-uclibc" and "arceb-linux-uclibc" targets.
  • -mvolatile-cache, -mno-volatile-cache โ€” control how volatile references are accessed. The default is -mvolatile-cache, which uses ordinary cached memory accesses for volatile references. Use -mno-volatile-cache to enable cache bypass for volatile references.

The following options fine tune code generation: lil tweaks, big energy โœจ


  • -mauto-modify-reg โ€” enable the use of pre/post modify with register displacement ๐Ÿ’ซ
  • -mno-brcc, -mbrcc โ€” this option controls a target-specific pass in arc_reorg to generate compare-and-branch ("brcc") instructions, which is enabled by default. It has no effect on generation of these instructions driven by the combiner pass, ngl.
  • -mcase-vector-pcrel โ€” use PC-relative switch case tables to enable case table shortening. This is the default for -Os.
  • -mno-cond-exec โ€” disable the ARCompact-specific pass to generate conditional execution instructions ๐Ÿšซ

ngl</p>, the target-independent pass that generates conditional execution? It's lowkey struggling. ๐Ÿ˜ญ Because delay slot scheduling is doing its thing, and operand numbers, literal sizes, instruction lengths and conditional-execution support are all interacting with each other, the generic pass often just... doesn't find the good stuff. So the ARC port keeps a special extra pass hanging around that hunts for more conditional-execution opportunities after register allocation, branch shortening and delay slot scheduling have all already happened. It generally (but not always, bestie) improves performance and code size โ€” the price is extra compile time, which is exactly why there's a flag to turn it off. And listen: if your call instructions are blowing past their allowable offset range because they got conditionalized, you should look at using -mmedium-calls instead. ๐Ÿ’…

  • -mearly-cbranchsi โ€” turns on pre-reload use of the "cbranchsi" pattern. โœจ
  • -mindexed-loads โ€” lets indexed loads happen. Heads up though, this can be problematic, because some optimizers then assume indexed stores exist too โ€” and they literally don't. ๐Ÿ™ˆ
  • -mlra-priority-none โ€” don't give target registers any priority at all. Simple. Clean. ๐ŸŽ€
  • -mlra-priority-compact โ€” sets target register priority for r0..r3 / r12..r15. ๐Ÿ‘‘
  • -mlra-priority-noncompact โ€” reduces target register priority for r0..r3 / r12..r15.
  • -mmillicode โ€” okay so when you're optimizing for size (that's with -Os), prologues and epilogues that have to save or restore a big pile of registers often get shortened by calling a special function in libgcc. That's a millicode call, and it's giving efficiency. 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. Warning bestie: these are only valid for CPUs that have the code-density feature. ๐Ÿ’€
  • -msize-level=level โ€” fine-tunes size optimization with regards to 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 the 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 equals a normal instruction.

๐ŸŒˆ ARM Options ๐ŸŒˆ

These -m options are defined for the ARM port, bestie. Buckle up, there's a lot. ๐Ÿ’–

  • -mabi=name โ€” generate code for the specified ABI. Permissible values are: apcs-gnu, atpcs, aapcs and aapcs-linux.
  • -mapcs-frame โ€” generates a stack frame that's compliant with the ARM Procedure Call Standard for all functions, even when that's not strictly necessary for the code to run correctly. If you also specify -fomit-frame-pointer with this, the stack frames won't be generated for leaf functions. Default is -mno-apcs-frame. This option is deprecated. โš ๏ธ
  • -mapcs โ€” synonym for -mapcs-frame, and also deprecated. ๐Ÿšซ
  • -mthumb-interwork โ€” generates code that supports calling between the ARM and Thumb instruction sets. Without this, on pre-v5 architectures the two instruction sets can't be reliably used inside one program. Default is -mno-thumb-interwork, because specifying -mthumb-interwork makes slightly larger code. In AAPCS configurations this option is meaningless. ๐Ÿ’€
  • -msched-prolog, -mno-sched-prolog โ€” allow or prevent the reordering of instructions in the function prologue, or the merging of those instructions with the instructions in the function's body. With -mno-sched-prolog, 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. Default is -msched-prolog. โœจ
  • -mfloat-abi=name โ€” specifies which floating-point ABI to use. Permissible values are: soft, softfp and hard.
    • soft makes GCC generate output containing library calls for floating-point operations.
    • softfp allows code using hardware floating-point instructions to be generated, 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. And major warning: 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. No mixing, bestie. ๐Ÿ˜ญ

  • -mgeneral-regs-only โ€” generates code that uses only the general-purpose registers. This stops the compiler from using floating-point and Advanced SIMD registers, but it imposes no restrictions on the assembler. ๐Ÿ’…
  • -mlittle-endian โ€” generates code for a processor running in little-endian mode. This is the default for all standard configurations. ๐ŸŒธ
  • -mbig-endian โ€” generates code for a processor running in big-endian mode; the default is to compile for a little-endian processor.
  • -mbe8, -mbe32 โ€” when linking a big-endian image, select between BE8 and BE32 formats. Has no effect for little-endian images and is ignored there. The default depends on the selected target architecture: for ARMv6 and later the default is BE8, for older architectures it's BE32. BE32 format has been deprecated by ARM. โš ๏ธ
  • -march=name[+extension...] โ€” 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. Can be used together 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, iwmmxt and iwmmxt2.

Additionally, the following architectures โ€” which lack support for the Thumb execution state โ€” are recognized, but support is deprecated: armv4.

A bunch of these architectures support extensions, and you add them 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 this additive construction is for extensions prefixed with +no...: these disable the specified option and any other extensions that might depend on that extension being present. ๐Ÿงš

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. Periodt. ๐Ÿ’…

Most extension names are generically named, but their effect depends on the architecture they're applied to. For example, +simd can be applied to both armv7-a and armv8-a, but it enables 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 don't 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.
    • +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-fp16 โ€” the Advanced SIMD (Neon) v1 instructions plus the VFPv3 floating-point instructions, and it also brings the half-precision floating-point conversion operations. โœจ
  • +neon-vfpv4 โ€” the Advanced SIMD (Neon) v2 instructions plus the VFPv4 floating-point instructions. ๐Ÿฆ‹
  • +nosimd โ€” turns OFF the Advanced SIMD instructions. heads up: this does not disable floating point. bestie, they're two different things, ok? ๐Ÿ˜Œ
  • +nofp โ€” turns OFF the floating-point instructions and the Advanced SIMD instructions. both. gone. ๐Ÿ’€

armv7ve ๐Ÿ‘‘

The extended version of the ARMv7-A architecture, and it comes with support for virtualization. main character energy fr fr. ๐ŸŽ€

  • +fp โ€” the VFPv4 floating-point instructions, with 16 double-precision registers. Also: the extension +vfpv4-d16 can be used as an alias for this extension. iykyk
  • +simd โ€” the Advanced SIMD (Neon) v2 instructions and the VFPv4 floating-point instructions. And guess what โ€” the extension +neon-vfpv4 can be used as an alias for this one too. โœจ
  • +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. two for one, obsessed
  • +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 instructions and the VFPv3 floating-point instructions. Also, the extension +neon-vfpv3 can be used as an alias for this extension. ๐Ÿซถ
  • +neon-fp16 โ€” the Advanced SIMD (Neon) v1 instructions and the VFPv3 floating-point instructions, with the half-precision floating-point conversion operations.
  • +nosimd โ€” disables the Advanced SIMD instructions. Again: does not disable floating point. say it with me ๐Ÿ—ฃ๏ธ
  • +nofp โ€” disables the floating-point and Advanced SIMD instructions.

armv8-a ๐ŸŒˆ

  • +crc โ€” the Cyclic Redundancy Check (CRC) instructions. checksums but make it fancy
  • +simd โ€” the ARMv8-A Advanced SIMD and floating-point instructions.
  • +crypto โ€” the cryptographic instructions. ๐Ÿ”
  • +nocrypto โ€” disables the cryptographic instructions.
  • +nofp โ€” disables the floating-point, Advanced SIMD and cryptographic instructions. all three, bestie ๐Ÿ˜ญ
  • +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. And fun fact: this also enables the Advanced SIMD and floating-point instructions. it's giving bundle deal
  • +nocrypto โ€” disables the cryptographic instructions.
  • +nofp โ€” disables 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 ๐Ÿฆ‹

(same list for both, so we're doing them together, periodt)

  • +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 the 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 โ€” enables the Dot Product extension. This also enables Advanced SIMD instructions. math but cute
  • +nocrypto โ€” disables the cryptographic extension.
  • +nofp โ€” disables 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.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. stacked fr fr
  • +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 โ€” disables the cryptographic extension.
  • +nofp โ€” disables 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 โ€” disables the cryptographic extension.
  • +nofp โ€” disables 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 โ€” disables the cryptographic extension.
  • +nofp โ€” disables 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. And the extension +vfpv3xd can be used as an alias for this extension. iykyk
  • +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 โ€” disables the floating-point extension.
  • +idiv โ€” the ARM-state integer division instructions.
  • +noidiv โ€” disables the ARM-state integer division extension.

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. both?! we love range
  • +nofp โ€” disables 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. both, bestie. both โœจ
  • +nofp โ€” turn the floating-point extension OFF. bye bye floaties ๐Ÿ‘‹
  • +cdecp0, +cdecp1, ... , +cdecp7 โ€” turn on the Custom Datapath Extension (CDE) on the coprocessors you pick, according to the numbers given in the options, which live in the range 0 to 7. pick ur faves ๐ŸŽ€
  • +pacbti โ€” turn on the Pointer Authentication and Branch Target Identification Extension. ๐Ÿ”

armv8-m.main

  • +dsp โ€” the DSP instructions.
  • +nodsp โ€” turn the DSP extension off.
  • +fp โ€” the single-precision floating-point instructions.
  • +fp.dp โ€” the single- and double-precision floating-point instructions.
  • +nofp โ€” turn the floating-point extension off.
  • +cdecp0, +cdecp1, ... , +cdecp7 โ€” turn on the Custom Datapath Extension (CDE) on selected coprocessors according to the numbers given in the options, 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 โ€” turn the cryptographic instructions off.
  • +nofp โ€” turn off the floating-point, Advanced SIMD and cryptographic instructions. all three, gone, periodt ๐Ÿ’€

-march=native makes the compiler auto-detect the architecture of the build computer. ngl, right now this feature is only supported on GNU/Linux, and not all architectures are recognized. if the auto-detect doesn't work out, the option just... has no effect. no drama, no change ๐Ÿฆ‹

-march=unset makes the compiler straight-up ignore any -march=... options that showed up earlier on the command line, and behave like the option was never passed at all. this is lowkey useful to dodge warnings about conflicting CPU and architecture options when the two produce different architecture specifications. ghosted, but legally ๐Ÿ‘ป

-mtune=name ๐Ÿ’–

okay so this option names the target ARM processor that GCC should tune the performance of the code for. for some ARM implementations you genuinely get better performance by using this option. the 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.

like, that's a LOT of names. collect them all, bestie. ๐ŸŽ€

plus, this option can also tell GCC to tune the performance of the code for a big.LITTLE system. those 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 performance for a blend of processors within architecture arch. the goal is code that runs well on the current most popular processors โ€” balancing optimizations that help some CPUs in the range against avoiding performance pitfalls of the other CPUs. heads up tho: the effects of this option may change in future GCC versions as CPU models come and go. trends shift, iykyk โœจ

-mtune permits the same extension options as -mcpu, but โ€” plot twist โ€” the extension options do not affect the tuning of the generated code. ๐Ÿ’…

-mtune=native makes the compiler 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. respectfully, nothing happens ๐Ÿฆ‹

-mcpu=name[+extension...] ๐Ÿ‘‘

this one specifies the name of the target ARM processor. GCC uses this name to derive the name of the target ARM architecture โ€” as if you'd said it with -march โ€” and the ARM processor type to tune for performance, as if you'd said it with -mtune. and where this option gets used alongside -march or -mtune, those options take precedence over the appropriate part of this option. they win, bestie ๐Ÿ’–

many of the supported CPUs implement optional architectural extensions. where that's the case, the architectural extensions are normally enabled by default. but 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. teamwork makes the flags work ๐Ÿซถ

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. ๐ŸŽ€

permissible names for this option are the same as those for -mtune. (scroll up, bestie, the whole list is right there โฌ†๏ธ)

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, cortex-m55, cortex-m85 and star-mc1.
  • +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. yeah it nukes both on those, be careful ๐Ÿ’€
  • +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. just the SIMD, floaties survive ๐Ÿ“
  • +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 it's equivalent to -march=arch -mtune=generic-arch. see -mtune for more info. ๐Ÿ’…

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

-mcpu=unset causes the compiler to ignore any -mcpu=... options that appear earlier on the command line and behave as if the option was never passed. this is useful to avoid warnings about conflicting CPU and architecture options when the two produce different architecture specifications. same energy as -march=unset, iconic ๐Ÿ‘‘

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

quick note tho: neon is an alias for neon-vfpv3, and vfp is an alias for vfpv2. same thing, cuter name ๐ŸŽ€

the setting auto is the default and it's special โ€” it causes the compiler to select the floating-point and Advanced SIMD instructions based on the settings of -mcpu and -march. let the compiler decide, it's got this ๐Ÿฆ‹

If the floating-point hardware you picked includes the NEON extension (like -mfpu=neon), bestie, pls note that GCC's auto-vectorization pass will not generate floating-point operations unless you also pass -funsafe-math-optimizations. Why? Because NEON hardware does not 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. ๐Ÿ’€

You can also set the fpu name at function level using the target("fpu=") function attributes or pragmas. โœจ

  • -mfp16-format=name โ€” sets the format of the __fp16 half-precision floating-point type. Permissible names are none, ieee, and alternative; the default is none, and in that case the __fp16 type isn't defined at all. ๐ŸŽ€
  • -mstructure-size-boundary=n โ€” the sizes of all structures and unions get rounded up to a multiple of the number of bits you set here. Permissible values are 8, 32 and 64. The default varies for different toolchains. For the COFF targeted toolchain the default value is 8. A value of 64 is only allowed if the underlying ABI supports it.

Specifying a larger number can produce faster, more efficient code, but it can also increase the size of the program. Different values are potentially incompatible, fr fr โ€” code compiled with one value cannot necessarily expect to work with code or libraries compiled with another value, if they exchange information using structures or unions. ๐Ÿ˜ญ

This option is deprecated.
  • -mabort-on-noreturn โ€” generates a call to the function abort at the end of a noreturn function. It is executed if the function tries to return. ๐Ÿ™ˆ
  • -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 that 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.

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. ๐Ÿ’…

  • -msingle-pic-base โ€” treats 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. ๐Ÿ‘‘
  • -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 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.
  • -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. โœจ
  • -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). ๐Ÿฆ‹

  • -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. ๐ŸŒธ

  • -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.
  • -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. ๐Ÿ’œ
  • -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.
  • -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. โœจ
  • -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. ๐Ÿ’–
  • -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. ๐Ÿ”ฅ
  • -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. ๐Ÿ˜ญ
  • -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. ๐ŸŒˆ
  • -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.

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. ๐Ÿ’…

  • -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. ๐Ÿงš
  • -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. โš ๏ธ
  • -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. ๐Ÿ‘‘
  • -mpure-code โ€” do not allow constant data to be placed in code sections. Additionally, when compiling for ELF object format give all text sections the ELF processor-specific section attribute SHF_ARM_PURECODE. This option is only available when generating non-pic code for M-profile targets. ๐ŸŽ€
  • -mcmse โ€” Generates secure code exactly as laid out in the ARMv8-M Security Extensions: Requirements on Development Tools Engineering Specification, which lives over at <https://developer.arm.com/documentation/ecm0359818/latest/>. โœจ
  • -mfix-cmse-cve-2021-35465 โ€” bestie, this one patches you against a potential security oopsie with the VLLDM instruction on some M-profile devices when you're using CMSE (that's CVE-2021-365465 ๐Ÿ’€). It's on by default whenever you pass -mcpu= with cortex-m33, cortex-m35p, cortex-m52, cortex-m55, cortex-m85 or star-mc1. Wanna turn it off? Say -mno-fix-cmse-cve-2021-35465 and the mitigation dips. ๐Ÿซถ
  • -mstack-protector-guard=guard
  • -mstack-protector-guard-offset=offset โ€” these two make stack protection code using a canary sitting at guard. The locations you can pick are global (for a global canary) or tls (for a canary you reach through the TLS register). Heads up: -mstack-protector-guard-offset= is only meant to go with -fstack-protector-guard=tls, and it is not for use in user-land code. ๐Ÿ™ˆ
  • -mfdpic
  • -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 is on by default and it implies -fPIE if none of the PIC/PIE-related options is provided. On any other target it only switches on the FDPIC-specific code generation features, and you have to explicitly hand over the PIC/PIE-related options yourself if you need them. ๐Ÿ‘‘
Ngl, static linking is not supported here, because it would still drag in the dynamic linker when the program self-relocates. If that behavior is acceptable to you, use -static and -Wl,-dynamic-linker.

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=features โ€” turns on branch protection features (armv8.1-m.main only, no cap). The features you can pass take one of these forms:
    • none โ€” generates code with no branch protection or return address signing.
    • standard โ€” generates code with all branch protection features enabled at their standard level.
    • pac-ret โ€” generates code with return address signing set to its standard level, which means signing all functions that save the return address to memory.
    • pac-ret+leaf โ€” extends the pac-ret signing to include leaf functions too, even if they don't write the return address to memory.
    • bti โ€” adds landing-pad instructions at the permitted targets of indirect branch instructions.

If support for the +pacbti architecture extension isn't enabled (like, say, via -march=), then every branch protection and return address signing operation is constrained to use only the instructions defined in the architectural-NOP space. The generated code stays backwards-compatible with earlier versions of the architecture, but the extra 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.

The default is to generate code without branch protection or return address signing. ๐Ÿ’…

  • -mvectorize-with-neon-quad
  • -mvectorize-with-neon-double โ€” these decide whether vectorization uses NEON quad-word or double-word registers. The default is -mvectorize-with-neon-quad. ๐Ÿฆ‹

๐ŸŽ€ AVR Options ๐ŸŽ€

These options are defined for AVR implementations, babes:

  • -mmcu=mcu โ€” specifies the AVR instruction set architecture (ISA) or device type. The default for this option is avr2.

Here's the tea: 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](https://gcc.gnu.org/wiki/avr-gcc#spec-files)) file specs-mcu. Only the latter is provided by the compiler, according to the supported mcus below. The rest is supported by AVR-LibC ([https://github.com/avrdudes/avr-libc/](https://github.com/avrdudes/avr-libc/)), or by means of atpack ([https://gcc.gnu.org/wiki/avr-gcc#atpack](https://gcc.gnu.org/wiki/avr-gcc#atpack)) files from the hardware manufacturer. ๐Ÿงš

The following AVR devices and ISAs are supported:

  • 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" โ€” okay so these are "XMEGA" devices with up to 64 KiB of combined program memory and RAM, and the program memory is visible in the RAM address space. The mcu = list is iconic and also very long, bestie, so buckle up: "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" girlies with more than 64 KiB and up to 128 KiB of program memory. mcu = "atxmega64a3", "atxmega64a3u", "atxmega64a4u", "atxmega64b1", "atxmega64b3", "atxmega64c3", "atxmega64d3", "atxmega64d4", "avr128da28", "avr128da28s", "avr128da32", "avr128da32s", "avr128da48", "avr128da48s", "avr128da64", "avr128da64s", "avr128db28", "avr128db32", "avr128db48", "avr128db64".
  • "avrxmega5" โ€” "XMEGA" devices with more than 64 KiB and up to 128 KiB of program memory and more than 64 KiB of RAM. mcu = "atxmega64a1", "atxmega64a1u".
  • "avrxmega6" โ€” "XMEGA" devices with more than 128 KiB of program memory. mcu = "atxmega128a3", "atxmega128a3u", "atxmega128b1", "atxmega128b3", "atxmega128c3", "atxmega128d3", "atxmega128d4", "atxmega192a3", "atxmega192a3u", "atxmega192c3", "atxmega192d3", "atxmega256a3", "atxmega256a3b", "atxmega256a3bu", "atxmega256a3u", "atxmega256c3", "atxmega256d3", "atxmega384c3", "atxmega384d3".
  • "avrxmega7" โ€” "XMEGA" devices with more than 128 KiB of program memory and more than 64 KiB of RAM. mcu = "atxmega128a1", "atxmega128a1u", "atxmega128a4u".
  • "avrtiny" โ€” the "Reduced Tiny" Tiny core devices, and these babies have only 16 general purpose registers plus 512 B up to 4 KiB of program memory. mcu = "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, no cap. mcu = "attiny11", "attiny12", "attiny15", "attiny28", "at90s1200".

  • -mabsdata โ€” assume that all data in static storage can be accessed by LDS / STS instructions. Heads up bestie, this option only has an effect on reduced Tiny devices like ATtiny40. Also see the "absdata" AVR Attributes, variable attribute.
  • -mcvt โ€” use a compact vector table โœจ. Some devices support a CVT with only four entries: 0=Reset, 1=NMI, 2=Prio1 IRQ, 3=Prio0 IRQs. This option links startup code from "crtmcu-cvt.o" instead of the usual "crtmcu.o". And it's not just a cuter table โ€” the startup code will also set bit "CPUINT_CTRLA.CPUINT_CVT" which enables the CVT on the device.

When you do not want the startup code to set "CPUINT_CTRLA.CPUINT_CVT", then you can satisfy symbol "__init_cvt" so that the respective code is no more pulled in from "libmcu.a". For example, you can link with -Wl,--defsym,__init_cvt=0.

The CVT startup code is available since AVR-LibC v2.3 (https://github.com/avrdudes/avr-libc/issues/1010).

  • -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.
  • -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 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 types: a "char" is 1 byte, an "int" is 1 byte, a "long" is 2 bytes, and "long long" is 4 bytes. > Please note that this option does not conform to the C standards, but it results in smaller code size. ๐Ÿซถ
  • -mmain-is-OS_task โ€” do not save registers in "main". The effect is the same like attaching attribute AVR Attributes, "OS_task" to "main". It is activated per default if optimization is on.
  • -mno-call-main โ€” don't run "main" by means of
        XCALL  main
        XJMP   exit

Instead, put "main" in section ".init9" (https://avrdudes.github.io/avr-libc/avr-libc-user-manual/mem_sections.html#sec_dot_init) so that no call is required. By setting this option the user asserts that "main" will not return.

This option can be used for devices with very limited resources in order to save a few bytes of code and stack space. It will work as expected since AVR-LibC v2.3 (https://github.com/avrdudes/avr-libc/issues/1012). With older versions, there will be no performance gain.

  • -mno-interrupts โ€” generated code is not compatible with hardware interrupts. Code size is smaller. Trade-offs, bestie ๐Ÿ’…
  • -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.

  • -mpmem-wrap-around โ€” enable program counter wrap-around in linker relaxation.
  • -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.

  • -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 "libmcu.a".
Notice that since AVR-LibC v2.3, that library contains code that is essential for the correct functioning of a program. In particular, it contains parts of the startup code like: "__init_sp" (https://github.com/avrdudes/avr-libc/issues/1011) to initialize the stack pointer with symbol "__stack", "__init_cvt" (https://github.com/avrdudes/avr-libc/issues/1010) to set up the hardware to use a compact vector table with -mcvt, "__call_main" (https://github.com/avrdudes/avr-libc/issues/1012) to call "main" and "exit", and "__do_flmap_init" (https://github.com/avrdudes/avr-libc/issues/931) to set up FLMAP according to symbol "__flmap".
  • -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. ๐Ÿ‘‘

โœจ AVR Optimization Options โœจ

The following options are pure optimization options. Options -mgas-isr-prologues, -mmain-is-OS_task, -mno-call-main and -mrelax from above are only almost optimization options, since there are rare occasions where their different code generation matters. ๐Ÿ™ˆ

  • -maccumulate-args โ€” accumulate outgoing function arguments and acquire/release the needed stack space for outgoing function arguments once in function prologue/epilogue. Without this option, outgoing arguments are pushed before calling a function and popped afterwards. See also the -fdefer-pop Optimize Options, optimization option.

Popping the arguments after the function call can be expensive on AVR so that accumulating the stack space might lead to smaller executables because arguments need not be removed from the stack after such a function call.

This option can lead to reduced code size for functions that perform several calls to functions that get their arguments on the stack like calls to printf-like functions.

  • -mbranch-cost=cost โ€” sets the branch costs for conditional branch instructions to cost. Reasonable values for cost are small, non-negative integers. The default branch cost is 0. tiny number, big consequences ๐Ÿ’…
  • -mcall-prologues โ€” function prologues/epilogues get expanded as calls to appropriate subroutines instead of being inlined. Code size is smaller. skinnier binaries, bestie ๐ŸŽ€
  • -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.
  • -mfuse-move
  • -mno-fuse-move
  • -mfuse-move=level โ€” runs a post reload optimization pass that tries to fuse move instructions and to split multi-byte instructions into 8-bit operations. The default uses level=3 for optimization -O1, and level=23 for higher optimizations. Valid values for level are in the range 0 ... 23, which is a 3:2:2:2 mixed radix value. Each digit controls some aspect of the optimization. math? in MY compiler flags? it's more likely than u think โœจ
  • -mfuse-move2 โ€” runs a post combine optimization pass that tries to fuse move instructions.
  • -mstrict-X โ€” uses 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

look at those extra instructions just vibing in there ๐Ÿ˜ญ

  • -msplit-bit-shift โ€” splits multi-byte shifts with a constant offset into a shift with a byte offset and a residual shift with a non-byte offset. This optimization is turned on per default for -O2 and higher, including -Os but excluding -Oz. Splitting of shifts with a constant offset that is a multiple of 8 is controlled by -mfuse-move.
  • -msplit-ldst โ€” splits multi-byte loads and stores into several byte loads and stores. This optimization is turned on per default for -O2 and higher.
  • -muse-nonzero-bits โ€” enables optimizations that are only possible when some bits in a register are always zero. This optimization is turned on per default for -O2 and higher.

"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 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. Periodt.
  • 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. so don't be out here changing it mid-run, ok?? ๐Ÿ™ˆ
  • For indirect calls to functions and computed goto, the linker generates stubs. Stubs are jump pads sometimes also called trampolines. Thus, the indirect call/jump jumps to such a stub. The stub contains a direct jump to the desired address.
  • Linker relaxation must be turned on so that the linker generates the stubs correctly in all situations. See the compiler option -mrelax and the linker option --relax. There are corner cases where the linker is supposed to generate stubs but aborts without relaxation and without a helpful error message. no helpful error message?? it's giving chaos ๐Ÿ’€
  • The default linker script is arranged for code with EIND = 0. If code is supposed to work for a setup with EIND != 0, a custom linker script has to be used in order to place the sections whose name start with .trampolines into the segment where EIND points to.
  • The startup code from libgcc never sets EIND. Notice 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://avrdudes.github.io/avr-libc/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.
        #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. she's in the linker script, she's iconic, she's doing her job ๐Ÿ’œ

  • 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. just give it a name bestie, the linker wants a name ๐Ÿซถ


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.

  • 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. MUST. reset. it. to. zero. no cap ๐Ÿšจ

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. manifesting the number 4 for you rn โœจ

  • __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. case sensitivity really said "i'm the main character" ๐Ÿ’…

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_CVT__ โ€” the code is being compiled with option -mcvt to use a compact vector table. compact! cute! efficient! we love to see it ๐ŸŽ€

more AVR macro lore, bestie โ€” these are the predefined macros that spill the tea on what your tiny chip can do ๐Ÿ’–

  • __AVR_XMEGA__ โ€” the device / architecture belongs to the XMEGA family of devices.
  • __AVR_HAVE_ADIW__ โ€” the device has the ADIW and SBIW instructions. iconic.
  • __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__ โ€” this macro is undefined when the code is compiled for a core architecture. When the code is compiled for a device, the macro is defined to 1 when the .rodata sections for read-only data is located in RAM; and defined to 0, otherwise.
  • __WITH_AVRLIBC__ โ€” the compiler is configured to be used together with AVR-LibC. See the --with-avrlibc configure option.
  • __HAVE_SIGNAL_N__ โ€” the compiler supports the signal(num) and interrupt(num) AVR Attributes,,function attributes with an argument num that specifies the number of the interrupt service routine.
  • __HAVE_DOUBLE_MULTILIB__ โ€” defined if -mdouble= acts as a multilib option.
  • __HAVE_DOUBLE32__, __HAVE_DOUBLE64__ โ€” defined if the compiler supports 32-bit double resp. 64-bit double. The actual layout is specified by option -mdouble=.
  • __DEFAULT_DOUBLE__ โ€” the size in bits of double if -mdouble= is not set. To test the layout of double in a program, use the built-in macro __SIZEOF_DOUBLE__.
  • __HAVE_LONG_DOUBLE32__, __HAVE_LONG_DOUBLE64__, __HAVE_LONG_DOUBLE_MULTILIB__, __DEFAULT_LONG_DOUBLE__ โ€” same as above, but for long double instead of double.
  • __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 so these next ones are lowkey internal โ€” the compiler uses them to talk to device specs files and the compiler proper. You do not need to set these by hand, periodt. They are not optimization options. Using them in the wrong way may lead to sub-optimal or wrong code. They are documented for completeness, and in order to get a better understanding of device specs (https://gcc.gnu.org/wiki/avr-gcc#spec-files) files.

โš ๏ธ bestie, using these options wrong can give you sub-optimal or straight-up wrong code. no cap.
  • -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. Currently, 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.

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.

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.
  • -mspecld-anomaly, -mno-specld-anomaly โ€” when enabled, the compiler ensures that the generated code does not contain speculative loads after jump instructions. If this option is used, __WORKAROUND_SPECULATIVE_LOADS is defined.
  • -mcsync-anomaly, -mno-csync-anomaly โ€” when enabled, the compiler ensures that the generated code does not contain CSYNC or SSYNC instructions too soon after conditional branches. If this option is used, __WORKAROUND_SPECULATIVE_SYNCS is defined.
  • -mlow64k, -mno-low64k โ€” when enabled, the compiler is free to take advantage of the knowledge that the entire program fits into the low 64k of memory. The default behavior is to assume that the program is arbitrarily large (-mno-low64k).
  • -mstack-check-l1 โ€” do stack checking using information placed into L1 scratchpad memory by the uClinux kernel.
  • -mid-shared-library, -mno-id-shared-library โ€” generate code that supports shared libraries via the library ID method. This allows for execute in place and shared libraries in an environment without virtual memory management. This option implies -fPIC. With a bfin-elf target, this option implies -msim. The default is -mno-id-shared-library, to generate code that doesn't assume ID-based shared libraries are being used.
  • -mleaf-id-shared-library, -mno-leaf-id-shared-library โ€” generate code that supports shared libraries via the library ID method, but assumes that this library or executable won't link against any other ID shared libraries. That allows the compiler to use faster code for jumps and calls.
  • The default is -mno-leaf-id-shared-library, which means no assumption gets made that the code you're compiling won't link against any ID shared libraries. And bestie, that assumption being off means slower code for jump and call insns. It's giving "safe but sluggish" fr fr.
  • -mshared-library-id=n โ€” picks the identification number of the ID-based shared library you're compiling. Set n to 0 and you get more compact code โœจ. Set it to anything else and it forces that number onto the current library, but ngl it's no more space- or time-efficient than just... not using this option at all. ๐Ÿ™ˆ
  • -msep-data, -mno-sep-data โ€” generates code that lets the data segment live in a totally different area of memory from the text segment. Why do we care? Because it enables execute in place in an environment with no virtual memory management, by eliminating relocations against the text section. The default is -mno-sep-data, which tells GCC to assume the data segment just follows the text segment. Simple. Chill. ๐Ÿ˜Œ
  • -mlong-calls, -mno-long-calls โ€” tells the compiler to do function calls by first loading the function's address into a register, and then doing a subroutine call on that register. You need this switch if the target function is chilling outside the 24-bit addressing range of the offset-based version of the subroutine call instruction.

This feature is not enabled by default, okay? Specifying -mno-long-calls puts the default behavior back. And heads up: these switches do nothing for how the compiler generates code to handle function calls via function pointers. Not the vibe you thought it was. ๐Ÿ’…

  • -mfast-fp โ€” links 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), all in the interest of performance. Trade-offs, bestie. โšก
  • -minline-plt โ€” enables inlining of PLT entries in function calls to functions that aren't known to bind locally. But it has no effect without -mfdpic. Pointless alone, iconic together. ๐Ÿซถ
  • -mmulticore โ€” builds a standalone application for multicore Blackfin processors. This option brings in the proper start files and link scripts that support multicore, and it defines the macro "__BFIN_MULTICORE". It can only be used with -mcpu=bf561[-sirevision].

You can pair it with -mcorea or -mcoreb, which selects the one-application-per-core programming model. Without -mcorea or -mcoreb, you get the single-application/dual-core programming model instead. In that model, the main function of Core B should be named "coreb_main".

And if you just don't use this option at all? Then the single-core application programming model is what you get. Default behavior, no drama. ๐ŸŒธ

  • -mcorea โ€” builds a standalone application for Core A of BF561 when you're using the one-application-per-core programming model. Proper start files and link scripts get used to support Core A, and the macro "__BFIN_COREA" is defined. This option can only be used in conjunction with -mmulticore. Ride or die, they come as a pair. ๐Ÿ‘‘
  • -mcoreb โ€” builds a standalone application for Core B of BF561 when using the one-application-per-core programming model. Proper start files and link scripts support Core B, and the macro "__BFIN_COREB" is defined. When you use this one, "coreb_main" should be used instead of "main". Also only valid in conjunction with -mmulticore. Twin energy. ๐ŸŽ€
  • -msdram โ€” builds 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. Your loader should initialize SDRAM before loading the application, okay? Don't skip that step. ๐Ÿ’€
  • -micplb โ€” assumes 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. Depends on the context, bestie. ๐Ÿค”

โœจ C6X Options โœจ ๐Ÿฆ‹

  • -march=name โ€” specifies the name of the target architecture. GCC uses this name to figure out what kind of instructions it can emit when generating assembly code. Permissible names are: c62x, c64x, c64x+, c67x, c67x+, c674x. Pick your fighter. โญ
  • -mbig-endian โ€” generates code for a big-endian target.
  • -mlittle-endian โ€” generates code for a little-endian target. And this one is the default. ๐Ÿ‘‘
  • -msim โ€” chooses startup files and linker script suitable for the simulator.
  • -msdata=default โ€” puts small global and static data in the ".neardata" section, which is pointed to by register "B14". Puts small uninitialized global and static data in the ".bss" section, which sits right next to ".neardata". Puts small read-only data into the ".rodata" section. And the corresponding sections used for the big chonky pieces of data are ".fardata", ".far" and ".const". Small stuff stays close, big stuff goes far. ๐Ÿ’…
  • -msdata=all โ€” puts all data, not just small objects, into the sections reserved for small data, and uses addressing relative to the "B14" register to access them.
  • -msdata=none โ€” makes no use of the sections reserved for small data, and uses absolute addresses to access all data. Puts all initialized global and static data in the ".fardata" section, all uninitialized data in the ".far" section, and all constant data into the ".const" section. Everything's feral, nothing's near. ๐Ÿ™ˆ
  • -mdsbt โ€” compiles for the DSBT shared library ABI. This option is required to compile with -fpic or -fPIC, and it implies -fpic. No cap.
  • -mlong-calls โ€” avoids generating PC-relative calls; uses indirection instead.

โœจ CRIS Options โœจ ๐Ÿงš

These options are defined specifically for the CRIS ports, bestie. Niche but iconic.

  • -march=architecture-type, -mcpu=architecture-type โ€” generates code for the specified architecture. The choices for architecture-type are v3, v8 and v10, for respectively ETRAX 4, ETRAX 100, and ETRAX 100 LX. Default is v0.
  • -mtune=architecture-type โ€” tunes 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 as for -march=architecture-type. Same menu, different vibe. โœจ
  • -mmax-stackframe=n โ€” warns when the stack frame of a function exceeds n bytes. Watch out for the chonky frames. ๐Ÿ˜ญ
  • -metrax4, -metrax100 โ€” these two are synonyms for -march=v3 and -march=v8 respectively. Nicknames, basically. ๐ŸŽ€
  • -mmul-bug-workaround, -mno-mul-bug-workaround โ€” works around a bug in the "muls" and "mulu" instructions for CPU models where it applies. This option is disabled by default. ๐Ÿ’€
  • -mpdebug โ€” enables CRIS-specific verbose debug-related information in the assembly code. It also has the effect of turning off the #NO_APP formatted-code indicator to the assembler at the beginning of the assembly file. Two for one, slay. ๐Ÿซถ
  • -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- forms) arrange (or eliminate arrangements) for the stack frame, individual data and constants to be aligned for the maximum single data access size for the chosen CPU model. The default is to arrange for 32-bit alignment. ABI details such as structure layout are not affected by these options. ๐Ÿ’…
  • -m32-bit, -m16-bit, -m8-bit โ€” similar to the stack-, data- and const-align options above, these 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. Pick your alignment era. โญ
  • -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.
โš ๏ธ Only use this option together with visual inspection of the compiled code, bestie. No warnings or errors are generated when call-saved registers must be saved, or when storage for local variables needs to be allocated. GCC will just... not tell you. ๐Ÿ˜ญ
  • -mbest-lib-options, -moverride-best-lib-options โ€” -mbest-lib-options selects the most feature-enabling options allowed by other options. It has no no- form, but -moverride-best-lib-options disables it regardless of the relative order of the two options on the command line. Chaotic but valid. ๐Ÿ’…
  • -mtrap-using-break8 โ€” emits traps as break 8. This is the default for CRIS v3 and up. If disabled, calls to "abort" are used instead.
  • -mtrap-unaligned-atomic โ€” emits checks causing break 8 instructions to execute when applying atomic builtins on misaligned memory. ๐Ÿ”ฅ
  • -munaligned-atomic-may-use-library โ€” handles atomic builtins that may be applied to unaligned data by calling library functions. This option overrides -mtrap-unaligned-atomic. It wins, periodt. ๐Ÿ‘‘
  • -sim โ€” 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 it passes linker options to locate initialized data at 0x40000000 and zero-initialized data at 0x80000000. Fancy addresses, fancy vibes. โœจ

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

Like. That's the whole roster. Every single one of them. Don't make me say it again. ๐Ÿ’€ (jk I will if I have to, bestie, that's what I'm here for ๐Ÿซถ)

  • -mbig-endian, -mlittle-endian โ€” selects 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.

Three whole personalities, pick the one that matches your energy. ๐Ÿ’…

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. Like, the whole thing, no mixing, bestie. ๐Ÿ™ˆ

  • -mdouble-float, -mno-double-float โ€” when -mhard-float is in effect, this enables generation of double-precision float instructions. It's the default except when compiling for CK803.
  • -mfdivdu, -mno-fdivdu โ€” when -mhard-float is in effect, enables generation of "frecipd", "fsqrtd", and "fdivd" instructions. Default except when compiling for CK803.
  • -mfpu=fpu โ€” picks the floating-point processor. 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 โ€” enables the extended "lrw" instruction. Defaults to on for CK801 and off otherwise.
  • -mistack, -mno-istack โ€” enables interrupt stack instructions; default is off.
The -mistack option is required to handle the "interrupt" and "isr" function attributes. No option, no interrupt handling, periodt.
  • -mmp, -mno-mp โ€” enables multiprocessor instructions; default is off.
  • -mcp, -mno-cp โ€” enables coprocessor instructions; default is off.
  • -mcache, -mno-cache โ€” enables coprocessor instructions; default is off.
  • -msecurity, -mno-security โ€” enables C-SKY security instructions; default is off.
  • -mtrust, -mno-trust โ€” enables C-SKY trust instructions; default is off.
  • -mdsp, -mno-dsp, -medsp, -mno-edsp, -mvdsp, -mno-vdsp โ€” enable C-SKY DSP, Enhanced DSP, or Vector DSP instructions, respectively. All of these 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 one gets ignored for CK801 where that's just the required behavior, and it defaults to on for CK802. For other targets, default is off.
  • -mhigh-registers, -mno-high-registers โ€” generate code using the high registers numbered 16-31. Not supported on CK801, CK802, or CK803, and it's 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. Defaults to on.
  • -mmultiple-stld, -mno-multiple-stld โ€” generate code using "stm" and "ldm" instructions. Not supported on CK801 but enabled by default on other processors.
  • -mconstpool, -mno-constpool โ€” create constant pools in the compiler instead of deferring it to the assembler. This is the default and it's required for correct code generation on CK801 and CK802, and optional on other processors.
  • -mstack-size, -mno-stack-size โ€” emit .stack_size directives for each function in the assembly output. Defaults to off.
  • -mccrt, -mno-ccrt โ€” generate code for the C-SKY compiler runtime instead of libgcc. 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 can result in code that is not compliant with the C-SKY V2 ABI prologue requirements and that cannot be debugged or backtraced. ๐Ÿ˜ญ It's disabled by default for a reason, bestie.
  • -msim, -mno-sim โ€” links the library libsemi.a which is in compatible with simulator. Applicable to ELF compiler only.

๐ŸชŸ Cygwin and MinGW Options ๐ŸชŸ

These extra 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 enabled by default on those targets.
  • -mcrtdll=library โ€” preprocess, compile or link with specified C RunTime DLL library. This option adjusts 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.
  • -mdll โ€” available for Cygwin and MinGW targets. Specifies that a DLL โ€” a dynamic link library โ€” is to be generated, enabling the selection of the required runtime startup object and entry point.
  • -mnop-fun-dllimport โ€” available for Cygwin and MinGW targets. Specifies that the "dllimport" attribute should be ignored.
  • -mthreads โ€” support 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.
  • -municode โ€” available for MinGW-w64 targets. Causes the "UNICODE" preprocessor macro to be predefined, and chooses Unicode-capable runtime startup code.
  • -mwin32 โ€” available for Cygwin and MinGW targets. 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.
  • -mwindows โ€” available for Cygwin and MinGW targets. Specifies that a GUI application is to be generated by instructing the linker to set the PE header subsystem type appropriately.
  • -fno-set-stack-executable โ€” available for MinGW targets. 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.
  • -fwritable-relocated-rdata โ€” available for MinGW and Cygwin targets. Specifies that relocated-data in read-only section is put into the ".data" section. This is a necessary for older runtimes not supporting modification of ".rdata" sections for pseudo-relocation.
  • -mpe-aligned-commons โ€” available for Cygwin and MinGW targets. 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's enabled by default if GCC detects that the target assembler found during configuration supports the feature.
  • -muse-libstdc-wrappers โ€” use Cygwin DLL wrappers to support C++ operators "new" and "delete".

See also under x86 Options for standard options.


๐ŸŽ 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.

The Darwin tools vary in their behavior when presented with an ISA mismatch. The assembler, as, only permits instructions to be used that are valid for the subtype of the file it is generating, so you cannot put 64-bit instructions in a ppc750 object file. The linker for shared libraries, /usr/bin/libtool, fails and prints an error if asked to create a shared library with a less restrictive subtype than its input files (for instance, trying to put a ppc970 object file in a ppc7400 library). The linker for executables, ld, quietly gives the executable the most restrictive subtype of any of its input files.

  • -Fdir โ€” add 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. ๐Ÿฆ‹

Okay bestie, so like โ€” a framework directory is literally just a directory that has frameworks chillin' inside it. And a framework? It's a directory with a Headers and/or PrivateHeaders directory sitting right there inside it, and the whole thing ends in .framework. The name of the framework is just the name of that directory minus the .framework, duh. ๐Ÿ’…

The headers that belong to the framework live in one of those two directories, and heads up: Headers gets searched first. A subframework is a framework directory that lives inside a framework's Frameworks directory. Here's the tea: includes of subframework headers can only show up in a header of the framework that contains the subframework, or in a sibling subframework header. Two subframeworks are siblings if they occur in the same framework. Also, a subframework should not have the same name as a framework โ€” you get a warning if you violate that, so like, don't. ๐Ÿซ 

As of right now, a subframework cannot have subframeworks. In the future the mechanism may be extended to support this. No promises, babe.

The standard frameworks hang out in /System/Library/Frameworks and /Library/Frameworks. An example include looks like #include <Framework/header.h>, where Framework is the name of the framework and header.h is found in the PrivateHeaders or Headers directory.


  • -iframeworkdir โ€” basically -F but the directory is treated as a system directory. The main difference between -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. โœจ
  • -arch name โ€” generate output for architecture name. As described above, GCC generates output for the architecture it was configured for, using its usual options to select subarchitecture variants. The -arch option is accepted for compatibility, but an error is diagnosed if name is inconsistent with GCC's own idea of the target architecture. ๐Ÿ˜ฌ
  • -dependency-file filename โ€” an alias for the preprocessor option -MF filename.
  • -fapple-kext โ€” generate code for Darwin loadable kernel extensions. ๐Ÿ‘‘
  • -gused โ€” emit debugging information for symbols that are used. For stabs debugging format, this enables -feliminate-unused-debug-symbols. This is by default ON.
  • -gfull โ€” emit debugging information for all symbols and types.
  • -matt-stubs, -mno-att-stubs โ€” enable AT&T-style PIC stubs. This is the default when supported by the target architecture (currently x86 only).
  • -mconstant-cfstrings, -fconstant-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. Also, -fconstant-cfstrings is an alias for -mconstant-cfstrings. ๐Ÿ’–
  • -mdynamic-no-pic โ€” generate code suitable for executables (not shared libraries). This option is incompatible with -fpic, -fPIC, -fpie, or -fPIE. Pick a lane, bestie.
  • -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.
  • -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.
  • -mmacosx-version-min=version, -asm_macosx_version_min=version โ€” the -mmacosx-version-min option specifies 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. Meanwhile -asm_macosx_version_min=version is similar, but the GCC driver passes its version information only to the assembler.
  • -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, bestie, fr fr: 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. ๐Ÿ’€
  • -msymbol-stubs, -mno-symbol-stubs โ€” force generation of external symbol indirection stubs for PIC references. By default, this option is enabled automatically if the target linker version (-mtarget-linker) is old enough to require them.
  • -mtarget-linker=version, -mtarget-linker version โ€” specify the target ld64 version, overriding any version specified in the GCC configuration. Newer linker versions support improved code generation in some cases, for example for PIC code. โœจ
  • -ObjC โ€” equivalent to -x objective-c; specifies that the input is is Objective-C source code.
  • -ObjC++ โ€” equivalent to -x objective-c++; specifies that the input is is Objective-C++ source code.
  • -Wnonportable-cfstrings, -Wno-nonportable-cfstrings โ€” warn if constant CoreFoundation string objects contain non-portable characters. This warning is enabled by default.
  • -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.
  • -nodefaultexport โ€” do not add default symbol exports to modules or dynamic libraries.
  • -allowable_client client_name, -client_name, -compatibility_version, -current_version, -dead_strip, -dylib_file, -dylinker, -dylinker_install_name, -dynamic, -exported_symbols_list, -filelist, -flat_namespace, -force_flat_namespace, -framework, -headerpad_max_install_names, -image_base, -init symbol-name, -install_name, -keep_private_externs, -pagezero_size, -preload, -read_only_relocs, -sectalign, -sectcreate, -seg_addr_table, -seg1addr, -segaddr, -segprot, -segs_read_only_addr, -segs_read_write_addr, -sub_library, -sub_umbrella, -twolevel_namespace, -twolevel_namespace_hints, -umbrella, -undefined, -unexported_symbols_list, -weak_framework, -weak_reference_mismatches, -whatsloaded, -whyload โ€” these options are passed to the Darwin linker. The Darwin linker man page describes them in detail. (Yeah, that's a whole lotta options, we love a link-time moment. ๐ŸŽ€)

๐ŸŒˆ DEC Alpha Options ๐ŸŒˆ

These -m options are defined for the DEC Alpha implementations, bestie:

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

  • -mfp-regs, -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.

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 โ€” okay so this is literally -mieee but the generated code ALSO babysits the IEEE inexact-flag. Flip it on and your generated code is doing fully-compliant IEEE math, no shortcuts. On top of _IEEE_FP, it also defines _IEEE_FP_EXACT as a preprocessor macro. ๐Ÿ’… Heads up tho: on some Alpha implementations the code it spits out may run significantly slower than the default stuff. And because basically almost no code out there actually cares about the inexact-flag, bestie, you should normally not specify this one. Other Alpha compilers call it -ieee_with_inexact, iykyk.
  • -mfp-trap-mode=trap-mode โ€” this one decides which floating-point related traps get enabled. Other Alpha compilers call it -fptm trap-mode. You've got four values to pick from, no more no less:
    • n โ€” the default (normal) setting, queen of the group chat. The only traps enabled are the ones that literally cannot be disabled in software (e.g., division by zero trap).
    • u โ€” everything n gives you, plus underflow traps are enabled too. ๐Ÿซถ
    • su โ€” like u, but the instructions get marked as safe for software completion (go read the Alpha architecture manual for the deets, bestie).
    • sui โ€” like su, but inexact traps are enabled as well. โœจ
  • -mfp-rounding-mode=rounding-mode โ€” picks your IEEE rounding mode. Other Alpha compilers call this -fprm rounding-mode. The rounding-mode can be one of:
    • n โ€” normal IEEE rounding mode. Floating-point numbers round towards the nearest machine number, or towards the even machine number if there's a tie.
    • m โ€” round towards minus infinity.
    • c โ€” chopped rounding mode. Floating-point numbers round towards zero.
    • d โ€” dynamic rounding mode. A field in the floating-point control register (fpcr, see the Alpha architecture reference manual) 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 basically means round towards plus infinity. ๐Ÿ™ˆ
  • -mtrap-precision=trap-precision โ€” so in the Alpha architecture, floating-point traps are imprecise, which means without software assistance it is literally impossible to recover from a floating trap, and program execution normally needs to be terminated. ๐Ÿ˜ญ GCC can generate code that helps operating system trap handlers figure out the exact location that caused a floating-point trap. Depending on what your application needs, you pick your precision level:
    • p โ€” program precision. This is the default, and it means a trap handler can only identify which program caused a floating-point exception.
    • f โ€” function precision. The trap handler can determine the function that caused a floating-point exception.
    • i โ€” instruction precision. The trap handler can determine the exact instruction that caused a floating-point exception. ๐ŸŽฏ

Other Alpha compilers hand you the equivalent options called -scope_safe and -resumption_safe.

  • -mieee-conformant โ€” this marks the generated code as IEEE conformant. ๐ŸŽ€ But listen: 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 only effect is to emit the line .eflag 48 in the function prologue of the generated assembly file. That's it. That's the whole personality.
  • -mbuild-constants โ€” normally GCC looks at a 32- or 64-bit integer constant to see if it can construct it from 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 make GCC construct all integer constants using code, even if it takes more instructions (the max is six). You typically reach for this 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 say whether GCC should generate code to use the optional BWX, CIX, FIX and MAX instruction sets. The default is to use whatever instruction sets are supported by the CPU type you specified via the -mcpu= option, or by the CPU on which GCC was built if you didn't specify any.
  • -msafe-bwa, -mno-safe-bwa โ€” these say whether, in the absence of the optional BWX instruction set, GCC should generate multi-thread and async-signal safe code for byte and aligned word memory accesses. ๐Ÿฆ‹
  • -msafe-partial, -mno-safe-partial โ€” these say whether GCC should generate multi-thread and async-signal safe code for partial memory accesses, including piecemeal accesses to unaligned data as well as block accesses to leading and trailing parts of aggregate types or other objects in memory that do not respectively start and end on an aligned 64-bit data boundary. Yeah, it's a mouthful. It's giving very specific. ๐Ÿ’…
  • -mfloat-vax, -mfloat-ieee โ€” generate code that uses (or does not use) VAX F and G floating-point arithmetic instead of IEEE single and double precision.
  • -mexplicit-relocs, -mno-explicit-relocs โ€” older Alpha assemblers gave you no way to generate symbol relocations except through assembler macros, and using those macros doesn't allow optimal instruction scheduling. ๐Ÿ˜ค GNU Binutils as of version 2.12 supports a new syntax that lets the compiler explicitly mark which relocations should apply to which instructions. This option is mostly useful for debugging, since GCC detects the assembler's capabilities 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 8 bytes long or smaller get placed in 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. ๐ŸŽ€

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.

When generating code for shared libraries, -fpic implies -msmall-data and -fPIC implies -mlarge-data. Lowkey a package deal.

  • -msmall-text, -mlarge-text โ€” with -msmall-text, the compiler assumes the code of the entire program (or shared library) fits in 4MB, and is thus reachable with a branch instruction. When -msmall-data is used, the compiler can assume that all local symbols share the same $gp value, which cuts the number of instructions required for a function call from 4 down to 1. ๐Ÿ‘‘

The default is -mlarge-text.

  • -mcpu=cpu_type โ€” sets the instruction set and 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. -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 is not changed. Native toolchains also support the value native, which selects the best architecture option for the host processor. -mtune=native has no effect if GCC does not 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 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 contains estimates of the number of clock cycles for "typical" EV4 & EV5 hardware for the Level 1, 2 & 3 caches (also called Dcache, Scache, and Bcache), as well as to main memory. Note that L3 is only valid for EV5. ๐ŸŒˆ
  • -mtls-kernel โ€” emit rdval instead of rduniq for thread pointer.
  • -mtls-size=bitsize โ€” specify bit size of immediate TLS offsets. Valid values for bitsize are 16, 32, and 64; it defaults to 32.
  • -mlong-double-128, -mlong-double-64 โ€” specify the size of the long double type. Note that -mlong-double-128 is incompatible with VAX floating point. ๐Ÿ™…

๐Ÿฆ‹ eBPF Options ๐Ÿฆ‹

  • -mframe-limit=bytes โ€” this specifies the hard limit for frame sizes, in bytes. Currently, 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 targeted. ๐Ÿ’œ
  • -mbig-endian โ€” generate code for a big-endian target.
  • -mlittle-endian โ€” generate code for a little-endian target. This is the default. ๐Ÿ’…
  • -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 โ€” turns generation of 32-bit ALU instructions on or off. It's on for CPU v3 and above, bestie. โœจ
  • -mv3-atomics, -mno-v3-atomics โ€” toggles the instructions for general atomic operations that showed up in CPU v3. On for CPU v3 and above. ๐Ÿ”ฅ
  • -mbswap, -mno-bswap โ€” toggles byte swap instructions. On for CPU v4 and above. ๐Ÿฆ‹
  • -msdiv, -mno-sdiv โ€” toggles signed division and modulus instructions. On for CPU v4 and above. ๐Ÿ’…
  • -msmov, -mno-smov โ€” toggles sign-extending move and memory load instructions. On for CPU v4 and above. ๐Ÿ‘‘
  • *-mcpu=version* โ€” this is the "which version of the eBPF ISA are we targeting" knob. Newer versions might not be supported by every kernel, so likeโ€ฆ vibe check your kernel first. The default is v4. ๐Ÿซถ

Supported values for version are:

  • v1 โ€” the very first stable eBPF ISA, no special features, no extensions. The baby of the family. ๐Ÿผ
  • v2 โ€” supports the jump extensions, as in -mjmpext.
  • v3 โ€” everything from v2, plus:
    • 32-bit jump operations, as in -mjmp32
    • 32-bit ALU operations, as in -malu32
    • general atomic operations, as in -mv3-atomics
  • v4 โ€” everything from 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, -mno-co-re โ€” toggles BPF Compile Once - Run Everywhere (CO-RE) support. And ngl, BPF CO-RE support is on by default when you're generating BTF debug information for the BPF target, aka -gbtf. ๐Ÿ’–
  • -mxbpf โ€” generates code for an expanded version of BPF, one that relaxes some of the restrictions the BPF architecture puts on you:
    • Save and restore callee-saved registers at function entry and exit, respectively.
  • *-masm=dialect* โ€” outputs assembly instructions using the 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 it, memmove, memcpy and memset shall always be expanded inline. Anything bigger than this threshold would have to be implemented with a library call instead of being expanded inline โ€” but bestie, BPF doesn't allow libcalls, so blowing past this threshold just gives you a compile-time error. ๐Ÿ’€ The default is 1024 bytes.
  • -Wco-re โ€” enables warnings for the scenarios where -mco-re is on, but it might not be possible to generate CO-RE compatible code. Consider it a lil heads-up text. ๐Ÿ™ˆ

๐ŸŒธ FR30 Options ๐ŸŒธ

These options are defined specifically for the FR30 port. Very niche, very demure. ๐ŸŽ€

  • -msmall-model โ€” use the small address space model. This can produce smaller code, but it does assume that all symbolic values and addresses fit into a 20-bit range.
  • -mno-lsim โ€” assume that runtime support has already been provided, so there's no need to include the simulator library (libsim.a) on the linker command line. ๐Ÿ˜Œ

๐Ÿ’œ FRV Options ๐Ÿ’œ

  • -mgpr-32 โ€” only use the first 32 general-purpose registers.
  • -mgpr-64 โ€” use all 64 general-purpose registers. Go big. ๐Ÿ‘‘
  • -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. It's giving commitment issues but make it registers. ๐Ÿ˜ญ
  • -mdword, -mno-dword โ€” controls whether the ABI uses double-word instructions.
  • -mdouble, -mno-double โ€” toggles use of floating-point double instructions.
  • -mmedia, -mno-media โ€” toggles use of media instructions.
  • -mmuladd, -mno-muladd โ€” toggles use of multiply and add/subtract instructions.
  • -mfdpic โ€” selects the FDPIC ABI, which uses function descriptors to represent pointers to functions. With no PIC/PIE-related options at all, 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 get computed with 32 bits. With a bfin-elf target, this option implies -msim. โœจ
  • -minline-plt โ€” enables inlining of PLT entries in function calls to functions that aren't known to bind locally. It has no effect without -mfdpic. It's enabled by default if you're optimizing for speed and compiling for shared libraries (i.e., -fPIC or -fpic), or when an optimization option like -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. (yes bestie, they differ by one capital letter, stay woke ๐Ÿ’€)
  • -mgprel-ro โ€” enables the use of GPREL relocations in the FDPIC ABI for data that's 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 isn't, -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. Like, ever. ๐Ÿ™…โ€โ™€๏ธ
  • -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 lets those functions 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 does anything when VLIW packing is enabled. And no, it doesn't create new packets โ€” it merely adds NOPs to the 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, -mno-pack โ€” toggles packing VLIW instructions.
  • -mno-eflags โ€” do not mark ABI switches in e_flags.
  • -mcond-move, -mno-cond-move โ€” toggles the use of conditional-move instructions; it's enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. So like, don't get attached. ๐Ÿ’”
  • -mscc, -mno-scc โ€” toggles the use of conditional set instructions; it's enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ‘‹
  • -mcond-exec, -mno-cond-exec โ€” toggles the use of conditional execution; it's enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ˜ญ
  • -mvliw-branch, -mno-vliw-branch โ€” toggles an optimization pass that packs branches into VLIW instructions; it's enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ™ˆ
  • -mmulti-cond-exec, -mno-multi-cond-exec โ€” toggles optimization of && and || in conditional execution; it's enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿ’€
  • -mnested-cond-exec, -mno-nested-cond-exec โ€” toggles nested conditional execution optimizations; it's enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐Ÿซ 
  • -moptimize-membar, -mno-optimize-membar โ€” this switch removes redundant membar instructions from the compiler-generated code. It's enabled by default. ๐Ÿ”ฅ
  • -mtomcat-stats โ€” cause gas to print out tomcat statistics. ๐Ÿฑ iconic honestly
  • *-mcpu=cpu* โ€” select the processor type to generate code for. Possible values are frv, fr550, tomcat, fr500, fr450, fr405, fr400, fr300 and simple. Pick your fighter. โญ

๐Ÿฆ‹ FT32 Options ๐Ÿฆ‹

These options are defined specifically for the FT32 port.

  • -msim โ€” specifies that the program will be run on the simulator. This causes an alternate runtime startup and library to be linked. You must not use this option when generating programs that will run on real hardware; you have to provide your own runtime library for whatever I/O functions are needed. Real talk. ๐Ÿ’…
  • -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.

๐Ÿ’– 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, -mno-android โ€” compile code compatible with the 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. And finally, this option causes the preprocessor macro __ANDROID__ to be defined. โœจ

This option can be disabled completely with -mno-android.

  • -tno-android-cc โ€” disable the compilation effects of -mandroid, i.e., do not enable -mbionic, -fPIC, -fno-exceptions and -fno-rtti by default.
  • -tno-android-ld โ€” disable the linking effects of -mandroid, i.e., pass standard Linux linking options to the linker. ๐Ÿซถ

๐ŸŽ€ H8/300 Options ๐ŸŽ€

okay so these -m options are the ones that are defined for the H8/300 implementations, let's get into it bestie:

  • -mrelax โ€” shortens some address references at link time when it possibly can, and it pulls this off by using the linker option -relax.
  • -mh โ€” generates code for the H8/300H.
  • -ms โ€” generates code for the H8S.
  • -mn โ€” generates code for the H8S and H8/300H in the normal mode. Heads up though, you must use this switch together with either -mh or -ms.
  • -msx โ€” generates H8SX code.
  • -ms2600 โ€” generates code for the H8S/2600. This switch must be used with -ms.
  • -mquickcall โ€” uses registers for argument passing.
  • -mslowbyte โ€” treats access to byte-sized memory as slow.
  • -mexr, -mno-exr โ€” stores extended registers on the stack before execution of functions with the "monitor" attribute. The default is -mexr. This option is valid only for H8S targets.
  • -mint32 โ€” makes "int" data 32 bits by default.
  • -malign-300 โ€” on the H8/300H and H8S, uses 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 instead. This option has no effect on the H8/300.

๐Ÿ’œ HPPA Options ๐Ÿ’œ

and these -m options are the ones defined for the HPPA family of computers, purr:

  • -march=architecture-type โ€” generates code for the specified architecture. 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 check /usr/lib/sched.models on an HP-UX system to figure out the proper architecture option for your machine. Code compiled for lower numbered architectures runs on higher numbered architectures, but not the other way around, so don't try it.
  • -mpa-risc-1-0, -mpa-risc-1-1, -mpa-risc-2-0 โ€” these are synonyms for -march=1.0, -march=1.1, and -march=2.0, respectively.
  • -matomic-libcalls, -mno-atomic-libcalls โ€” generate libcalls for atomic loads and stores when sync libcalls are disabled. This option is enabled by default. It only affects the generation of atomic libcalls by the HPPA backend.

Both the sync and libatomic libcall implementations use locking. As a result, processor stores are not atomic with respect to other atomic operations. Processor loads up to DImode are atomic with respect to other atomic operations provided they are implemented as a single access.

The PA-RISC architecture does not support any atomic operations in hardware except for the "ldcw" instruction. Thus, all atomic support is implemented using sync and atomic libcalls. Sync libcall support is in libgcc.a. Atomic libcall support is in libatomic.

This option generates "__atomic_exchange" calls for atomic stores. It also provides special handling for atomic DImode accesses on 32-bit targets.

  • -mcaller-copies โ€” the caller copies function arguments passed by hidden reference. > Please use this option with care bestie, 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 โ€” disables floating-point registers. Equivalent to -msoft-float.
  • -mdisable-indexing โ€” stops the compiler from using indexing address modes. This avoids some rather obscure problems when compiling MIG generated code under MACH.
  • -mfast-indirect-calls โ€” generates 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, so like, be aware.
  • -mfixed-range=register-range โ€” generates 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.
  • -mgas โ€” enables 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 is 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 are passed to that ld. The ld that is 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 is 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 are passed to that ld. The ld that is 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 โ€” enables the optimization pass in the HP-UX linker. Note this makes symbolic debugging impossible. ๐Ÿ˜ญ
  • -mlong-calls โ€” generates code that uses long call sequences. This ensures that a call is always able to reach linker generated stubs. The default is to generate long calls only when the distance from the call site to the beginning of the function or translation unit, as the case may be, exceeds a predefined limit set by the branch type being used. The limits for normal calls are 7,600,000 and 240,000 bytes, respectively for the PA 2.0 and PA 1.X architectures. Sibling calls are always limited at 240,000 bytes.

Distances are measured from the beginning of functions when using the -ffunction-sections option, or when using the -mgas and -mno-portable-runtime options together under HP-UX with the SOM linker.

It is normally not desirable to use this option as it degrades performance. However, it may be useful in large applications, particularly when partial linking is used to build the application.

The types of long calls used depends on the capabilities of the assembler and linker, and the type of code being generated. The impact on systems that support long absolute calls, and long PIC symbol-difference or PC-relative calls should be relatively small. However, an indirect call is used on 32-bit ELF systems in PIC code and it is quite long.

  • -mlong-load-store โ€” generates 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.
  • -mno-space-regs โ€” generates 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 peek at /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, -mwsio โ€” the -msio generates 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 โ€” generates 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 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.

  • -msoft-mult โ€” use software integer multiplication.

This disables the use of the "xmpyu" instruction.

  • -munix=unix-std โ€” generates compiler predefines and selects 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 though 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. Thus, extreme care is needed in using this option. like, actually be careful.

Library code that is 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 C library implementation of "setlocale" has a dependency on libdld.sl. There isn't an archive version of libdld.sl. Thus, when the -static option is specified, special link options are needed to resolve this dependency.

On HP-UX 10 and up, the GCC driver quietly sneaks in the options it needs to link against libdld.sl whenever you pass -static. Wild, right? So your "static" binary ends up being dynamic anyway ๐Ÿ’€. And on the 64-bit port, the linkers are out here generating dynamic binaries by default regardless. If that's not the vibe you want, hit -nolibdld and the GCC driver will stop adding those link options. Periodt.

  • -threads โ€” turns on multithreading support using the dce thread library under HP-UX. This one sets flags for both the preprocessor and the linker, bestie, so it's doing double duty โœจ

IA-64 Options ๐Ÿฆ‹

These are the -m options that exist for the Intel IA-64 architecture. Let's get into it.

  • -mbig-endian โ€” generate code for a big-endian target. This is the default on HP-UX. ๐Ÿ‘‘
  • -mlittle-endian โ€” generate code for a little-endian target. This is the default for AIX5 and GNU/Linux.
  • -mgnu-as, -mno-gnu-as โ€” generate (or don't) code for the GNU assembler. This is the default.
  • -mgnu-ld, -mno-gnu-ld โ€” generate (or don't) code for the GNU linker. This is the default.
  • -mno-pic โ€” generate code that does not use a global pointer register. Heads up: the result is not position independent code, and it violates the IA-64 ABI. Not a casual choice, bestie.
  • -mvolatile-asm-stop, -mno-volatile-asm-stop โ€” generate (or don't) a stop bit immediately before and after volatile asm statements.
  • -mregister-names, -mno-register-names โ€” generate (or don't) in, loc, and out register names for the stacked registers. This may make assembler output more readable ๐Ÿ‘€
  • -mno-sdata, -msdata โ€” disable (or enable) optimizations that use the small data section. This may be useful for working around optimizer bugs ๐Ÿ›
  • -mconstant-gp โ€” generate code that uses a single constant global pointer value. This is useful when compiling kernel code.
  • -mauto-pic โ€” generate code that is self-relocatable. This implies -mconstant-gp. This is useful when 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".
  • -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 it does not always do so. Sometimes it eats, sometimes it doesn't ๐Ÿคท
  • -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-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, -mno-sched-spec-ldc โ€” use a simple data speculation check. This option is on by default.
  • -msched-control-spec-ldc, -mno-sched-control-spec-ldc โ€” use a simple check for control speculation. This option is on by default.
  • -msched-stop-bits-after-every-cycle, -mno-sched-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, -mno-sched-fp-mem-deps-zero-cost โ€” assume that floating-point stores and loads are not likely to cause a conflict when placed into the same instruction group. This option is disabled by default.
  • -msel-sched-dont-check-control-spec, -mno-sel-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, -mno-sched-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.

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.
  • la32v1.0 โ€” LoongArch32 ISA version 1.0.
  • la32rv1.0 โ€” LoongArch32 Reduced ISA version 1.0.

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.
  • loongarch32 โ€” generic LoongArch 32-bit processor.
  • -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 โ€” let the compiler use hardware floating-point instructions for both 32-bit and 64-bit operations. โœจ
  • 32 โ€” hardware floating-point instructions for 32-bit operations only.
  • none, 0 โ€” nope, absolutely not, no hardware floating-point instructions allowed, periodt. ๐Ÿšซ

  • -msimd=simd-type โ€” turns on LoongArch SIMD instruction generation for vectorization and through builtin functions. simd-type can be one of these:
    • lasx โ€” generate instructions from the 256-bit LoongArch Advanced SIMD Extension (LASX) and the 128-bit LoongArch SIMD Extension (LSX). Two for one, slay. ๐Ÿ‘‘
    • lsx โ€” generate instructions from the 128-bit LoongArch SIMD Extension (LSX).
    • none โ€” no LoongArch SIMD instruction may be generated at all.
  • -msoft-float โ€” forces -mfpu=none and blocks floating-point registers from being used for parameter passing. Heads up bestie: this option may change the target ABI. ๐Ÿ˜ณ
  • -msingle-float โ€” forces -mfpu=32 and lets 32-bit floating-point registers carry parameters. Again: this option may change the target ABI.
  • -mdouble-float โ€” forces -mfpu=64 and lets 32/64-bit floating-point registers carry parameters. And yes, this one may change the target ABI too. ๐Ÿ’…
  • -mlasx, -mno-lasx, -mlsx, -mno-lsx โ€” these nudge the scope of the SIMD extensions (none / LSX / LASX) the compiler is allowed to use for code generation, little by little. Turning LASX on with -mlasx automatically turns LSX on too, and turning LSX off with -mno-lsx automatically turns LASX off. They're driver-only options: they act on the final -msimd configuration state and make incremental changes in the order they appear on the GCC driver's command line, deriving the final / canonicalized -msimd option that gets handed to the compiler proper. Order matters, iykyk. ๐Ÿฆ‹
  • -mbranch-cost=n โ€” set the cost of branches to roughly n instructions.
  • -maddr-reg-reg-cost=n โ€” set the cost of ADDRESS_REG_REG to the value calculated by n.
  • -mcheck-zero-division, -mno-check-zero-divison โ€” trap (or don't trap) on integer division by zero. Default is -mcheck-zero-division for -O0 or -Og, and -mno-check-zero-division for the other optimization levels. (And yeah, the disabled spelling in the docs is literally -mno-check-zero-divison โ€” one i short, no cap. ๐Ÿ’€)
  • -mbreak-code=code โ€” emit a break code instruction for irrecoverable traps coming from __builtin_trap or inserted by the compiler (think an erroneous path isolated with -fisolate-erroneous-paths-dereference), or an amswap.w $r0, $r1, $r0 instruction which makes the hardware throw an Instruction Not-defined Exception if code is negative or greater than 32767. Default is -1, which means use the amswap.w instruction.
  • -mcond-move-int, -mno-cond-move-int โ€” conditional moves for integral data in general-purpose registers are enabled (or disabled). Default is -mcond-move-int.
  • -mcond-move-float, -mno-cond-move-float โ€” conditional moves for floating-point registers are enabled (or disabled). Default is -mcond-move-float.
  • -mmemcpy, -mno-memcpy โ€” force (or don't force) the use of memcpy for non-trivial block moves. Default is -mno-memcpy, which lets GCC inline most constant-sized copies. Setting the optimization level to -Os also forces memcpy โ€” but -mno-memcpy may override that behavior if you explicitly specify it, regardless of the order of these options on the command line. Sneaky but true. ๐Ÿ™ˆ
  • -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. Default is -mno-strict-align.
  • -G num โ€” drop global and static data smaller than num bytes into a small data section. The default value is 0.
  • -mmax-inline-memcpy-size=n โ€” inline every block move (stuff like 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 fit within 128MB of addressing space, and the data segment must fit within 2GB of addressing space.
    • medium โ€” the text segment and the data segment must both fit within 2GB of addressing space. This is the default code model unless GCC was configured with --with-cmodel= naming a different default code model.
    • large (Not implemented yet)
    • extreme โ€” this mode puts no limit on the size of the code segment or the data segment. But -mcmodel=extreme is incompatible with -fplt and/or -mexplicit-relocs=none.
  • -mexplicit-relocs=style, -mexplicit-relocs, -mno-explicit-relocs โ€” choose when to use assembler relocation operators for symbolic addresses. The alternative is assembler macros instead, which can 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 uses relocation operators wherever linker relaxation is impossible (better code quality ๐Ÿ’…) and macros everywhere else.

The default value for this option is figured out from the assembler capability detected at GCC build-time plus the setting of -mrelax:

  • -mexplicit-relocs=none if the assembler doesn't 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.

For backward compatibility, -mexplicit-relocs is equivalent to -mexplicit-relocs=always, while -mno-explicit-relocs is equivalent to -mexplicit-relocs=none.

  • -mdirect-extern-access, -mno-direct-extern-access โ€” control use of the GOT to access external symbols. Default is -mno-direct-extern-access: the GOT is used for external symbols with default visibility, but not used for other external symbols.

With -mdirect-extern-access, the GOT is not used at all and all external symbols are PC-relatively addressed. This is only suitable for environments where no dynamic link happens โ€” like firmwares, OS kernels, executables linked with -static or -static-pie. Also: -mdirect-extern-access is not compatible with -fPIC or -fpic. ๐Ÿšจ

  • -mrelax, -mno-relax โ€” take (or don't take) advantage of linker relaxations. If -mpass-mrelax-to-as is enabled, this option also gets passed to the assembler. The default is decided at GCC build-time by detecting the matching assembler support: -mrelax if the assembler supports both the -mrelax option and conditional branch relaxation โ€” and bestie, that conditional branch relaxation is required, otherwise the .align directives and conditional branch instructions in the assembly GCC outputs may get rejected by the assembler because of a relocation overflow ๐Ÿ˜ญ โ€” and -mno-relax otherwise.
  • -mpass-mrelax-to-as, -mno-pass-mrelax-to-as โ€” pass (or don't pass) the -mrelax or -mno-relax option through to the assembler. The default is decided at GCC build-time by detecting the matching assembler support: -mpass-mrelax-to-as if the assembler supports the -mrelax option, -mno-pass-mrelax-to-as otherwise. This one is mostly useful for debugging, or for interoperating with assemblers different from the build-time one.
  • -mrecip โ€” enables use of the reciprocal estimate and reciprocal square root estimate instructions, with extra Newton-Raphson steps thrown in to boost precision, instead of doing a divide (or a square root and divide) for floating-point arguments. These instructions are only generated when -funsafe-math-optimizations is enabled together with -ffinite-math-only and -fno-trapping-math. Off by default. Before you use this option, you gotta be sure the target CPU supports the frecipe and frsqrte instructions. And note: while the throughput of the sequence beats the throughput of the non-reciprocal instruction, the precision of the sequence can drop by up to 2 ulp โ€” like, the inverse of 1.0 comes out as 0.99999994. So close and yet so far. ๐Ÿ˜ญ
  • -mrecip=opt โ€” 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 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. Cute little subtraction, we love to see it. ๐ŸŽ€

  • -mfrecipe, -mno-frecipe โ€” use (or don't use) frecipe.{s/d} and frsqrte.{s/d} instructions. When compiling with -march=la664, it's enabled by default. Otherwise the default is -mno-frecipe.
  • -mdiv32, -mno-div32 โ€” use (or don't use) div.w[u] and mod.w[u] instructions with input that isn't sign-extended. When compiling with -march=la664, it's enabled by default. Otherwise the default is -mno-div32.
  • -mlam-bh, -mno-lam-bh โ€” use (or don't use) am{swap/add}[_db].{b/h} instructions. When compiling with -march=la664, it's enabled by default. Otherwise the default is -mno-lam-bh.
  • -mlamcas, -mno-lamcas โ€” use (or don't use) amcas[_db].{b/h/w/d} instructions. When compiling with -march=la664, it's enabled by default. Otherwise the default is -mno-lamcas.
  • -mld-seq-sa, -mno-ld-seq-sa โ€” whether a same-address load-load barrier (dbar 0x700) is needed. When compiling with -march=la664, it's enabled by default. Otherwise the default is -mno-ld-seq-sa, meaning the load-load barrier is needed. ๐Ÿ›‘
  • -mscq, -mno-scq โ€” use (or don't use) the 16-byte conditional store instruction sc.q. Default is -mscq if the machine type specified with -march= supports this instruction, and -mno-scq otherwise.
  • -mtls-dialect=opt โ€” this one picks which TLS dialect is allowed for the general dynamic and local dynamic TLS models ๐Ÿ’…. The opt bestie can be exactly one of:
    • trad โ€” use traditional TLS. This is the default, no cap.
    • desc โ€” use TLS descriptors.

  • -mannotate-tablejump
  • -mno-annotate-tablejump โ€” makes an annotation section called .discard.tablejump_annotate so that the jirl instruction and the jump table get correlated whenever a jump table is used to optimize a switch statement ๐Ÿ‘‘. Some external tools โ€” like objtool from the Linux kernel building system โ€” need that annotation to analyze the control flow. The default is -mno-annotate-tablejump.

๐Ÿฑ LynxOS Options ๐Ÿฑ

These ones are available for LynxOS targets, bestie.

  • -mshared โ€” use shared libraries. The default is to link with static libraries, jsyk.
  • -mthreads โ€” support multi-threading โœจ.
  • -mlegacy-threads โ€” support legacy multi-threading. Heads up: this option is incompatible with -mthreads, so pick a lane.

๐ŸŒธ M32C Options ๐ŸŒธ

  • -mcpu=name โ€” select the CPU that code gets generated for ๐Ÿ’œ. name can be 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 โ€” says the program is gonna run on the simulator ๐Ÿฆ‹. This makes an alternate runtime library get linked in that supports, like, file I/O and stuff. You must not use this option when generating programs that run on real hardware โ€” you gotta provide your own runtime library for whatever I/O functions are needed.
  • -memregs=number โ€” sets how many memory-based pseudo-registers GCC uses while generating code. These pseudo-registers act like real registers, so there's a whole tradeoff between GCC fitting the code into available registers and the performance penalty of using memory instead of registers ๐Ÿ˜ญ. Note that all modules 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, and they're giving very specific energy.

  • -m32r2 โ€” generate code for the M32R/2.
  • -m32rx โ€” generate code for the M32R/X.
  • -m32r โ€” generate code for the M32R. This is the default โญ.
  • -mmodel=small โ€” assume all objects live in the lower 16MB of memory (so their addresses can be loaded with the ld24 instruction), and assume all subroutines are 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 (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 (the compiler generates seth/add3 instructions to load their addresses), and assume subroutines may not be reachable with the bl instruction (the compiler generates the much slower seth/add3/jl instruction sequence) ๐ŸŒ.
  • -msdata=none โ€” disable use of the small data area. Variables go into one of .data, .bss, or .rodata (unless the section attribute has been specified). This is the default. The small data area consists of 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, thank god ๐Ÿ™ˆ.
  • -mdebug โ€” makes the M32R-specific code in the compiler display some statistics that might help in debugging programs.
  • -malign-loops
  • -mno-align-loops โ€” align all loops to a 32-byte boundary. This option is disabled by 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 ๐Ÿ’–. 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. Teamwork, honestly ๐Ÿซถ.

  • -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:
    • 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.
  • -m68302 โ€” generate code for a 68302.
  • -m68332 โ€” generate code for a 68332.
  • -m68851 โ€” so the 68851 was an external MMU for the 68020 processor, right? GCC will accept this flag... and then literally do nothing with it. Accepted. Not used. That's the whole story bestie ๐Ÿ’€
  • -mcpu32 โ€” generate output for a CPU32. This is the default when the compiler was configured for CPU32-based systems, and it's equivalent to -march=cpu32. Use it for microcontrollers with a CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334, 68336, 68340, 68341, 68349 and 68360. that's a whole lotta 683's and we love that for them ๐Ÿซถ
  • -mfidoa โ€” generate code for a Fido A. that's it. that's the entry. go off little dog core ๐Ÿถ
  • -m5200 โ€” generate output for a 520X ColdFire CPU. It's the default when the compiler was configured for 520X-based systems, and it's equivalent to -mcpu=5206 โ€” but heads up, it's now deprecated in favor of that option. Use it for microcontrollers with a 5200 core, including the MCF5202, MCF5203, MCF5204 and MCF5206. โœจ
  • -m5206e โ€” generate output for a 5206e ColdFire CPU. Also deprecated now, in favor of the equivalent -mcpu=5206e.
  • -m528x โ€” generate output for a member of the ColdFire 528X family. Deprecated, bestie โ€” use the equivalent -mcpu=528x.
  • -m5307 โ€” generate output for a ColdFire 5307 CPU. Deprecated in favor of the equivalent -mcpu=5307.
  • -m5407 โ€” generate output for a ColdFire 5407 CPU. Deprecated in favor of the equivalent -mcpu=5407.
  • -mcfv4e โ€” generate output for a ColdFire V4e family CPU (e.g. 547x/548x). This one includes use of hardware floating-point instructions. It's equivalent to -mcpu=547x, and yes, now deprecated in favor of that option. the deprecation arc is real ๐Ÿ˜ญ
  • -m68020-40 โ€” generate output for a 68040, but without using any of the new instructions. The result is 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. It's equivalent to -march=68020 -mtune=68020-40. ๐Ÿ’…
  • -m68020-60 โ€” same deal but for a 68060, again without using any of the new instructions, so the code runs relatively efficiently on either a 68020/68881 or a 68030 or a 68040. And again, the generated code does use the 68881 instructions that are emulated on the 68060. 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. macro definitions, we stan โœจ
  • -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 is taken from the target CPU โ€” either the default CPU or the one you specified 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, -mno-short, -mnoshort โ€” treat type int as 16 bits wide, like short int. On top of that, parameters passed on the stack are also aligned to a 16-bit boundary even on targets whose API mandates promotion to 32-bit. This option is disabled by default. ๐Ÿ™ˆ
  • -mbitfield, -mno-bitfield, -mnobitfield โ€” control use of the bit-field instructions. The -m68000, -mcpu32 and -m5200 options imply -mnobitfield; the -m68020 option implies -mbitfield. the implications are implying, fr fr
  • -mrtd, -mno-rtd, -mnortd โ€” control use of 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. ๐Ÿ˜ญ

And in addition, seriously incorrect code results if you call a function with too many arguments. (Normally, extra arguments are harmlessly ignored.) seriously incorrect. we said what we said.

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. different from the published ABI specs. that's a big yikes. ๐Ÿ’€

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, -mno-sep-data โ€” with -msep-data, generate code that allows the data segment to be located in a different area of memory from the text segment. This allows for execute-in-place in an environment without virtual memory management. This option implies -fPIC. This option is disabled by default; GCC generates code that assumes that the data segment follows the text segment. โœจ
  • -mid-shared-library, -mno-id-shared-library โ€” if enabled, generate code that supports shared libraries via the library ID method. This allows for execute-in-place and shared libraries in an environment without virtual memory management. This option implies -fPIC. It's disabled by 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 it's no more space- or time-efficient than just 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 isn't needed; -fPIC suffices.

GCC normally uses a single instruction to load values from the GOT. While that's relatively efficient, it only works if the GOT is smaller than about 64k. Anything larger makes the linker 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. very few. okay.

These options have no effect unless GCC is generating position-independent code. ๐Ÿ”ฅ

  • -mxtls โ€” support TLS segment larger than 64K. The considerations for using this option are similar to those for -mxgot above; the default 16-bit offset addressing for TLS is more efficient, but it may be inadequate for some programs. ๐Ÿฆ‹
  • -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. new processor family just dropped ๐Ÿ‘‘

  • -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-immediates, -mno-relax-immediates โ€” 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- or big-endian target, respectively. The default is big-endian. Little-endian code is supported only with -m340. ๐ŸŒˆ
  • -m210 โ€” generate code for the 210 processor. ๐Ÿ’œ
  • -m340 โ€” generate code for the 340 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. segfault. so be careful bestie. 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. ๐Ÿ’…
  • -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. version soup but make it iconic ๐Ÿ‘‘
  • -mxl-soft-mul, -mno-xl-soft-mul โ€” use software multiply emulation. On by default, bestie, so it's doing the emulation thing unless you tell it not to. ๐Ÿงฎ
  • -mxl-soft-div, -mno-xl-soft-div โ€” use software emulation for divides. Also enabled by 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-gp-opt โ€” use GP-relative .sdata/.sbss sections. ๐Ÿ’ซ
  • -mxl-multiply-high โ€” use multiply high instructions for the high part of a 32x32 multiply. โœ–๏ธ
  • -mxl-float-convert โ€” use hardware floating-point conversion instructions. ๐Ÿ”„
  • -mxl-float-sqrt โ€” use the 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 โ€” pick your application model, app-model. The valid models are:
    • executable โ€” normal executable (the default), and it uses the startup code crt0.o. ๐Ÿš€
    • xmdstub โ€” for use with the Xilinx Microprocessor Debugger (XMD) based software intrusive debug agent called xmdstub. This one uses the 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 the startup file crt2.o, which does not contain a processor reset vector handler. That makes it suitable for transferring control on a processor reset to the bootloader rather than the application. ๐Ÿ‘ข
    • novectors โ€” for applications that don't require any of the MicroBlaze vectors. Might be useful for apps running within a monitoring application. This model uses crt3.o as a startup file. ๐Ÿ‘€
  • -mxl-prefetch โ€” enable insertion of prefetch ("wic") instructions at call sites. ๐Ÿ“ก
  • -mpic-data-is-text-relative โ€” assume that the displacement between the text and data segments is fixed at static link time. This lets data be referenced by offset from the start of the text address instead of via the GOT, since PC-relative addressing isn't supported. ๐Ÿซถ

๐ŸŒˆ MIPS Options ๐ŸŒˆ

okay this is the big one, bestie. hydrate. ๐Ÿ’ง
  • -EB, -meb โ€” generate big-endian code. ๐Ÿ˜
  • -EL, -mel โ€” generate little-endian code. 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. Also allegrex.

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 the 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's possible to generate code that runs on a family of processors, but optimize the code for one particular member of that family. ๐Ÿ‘‘

-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 (or don't 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 (or don't use) the MIPS16e2 ASE. This option modifies the behavior of the -mips16 option such that it targets the MIPS16e2 ASE. ๐Ÿ”ง
  • -mflip-mips16, -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. ๐Ÿงช (yes, the page really lists that same flag twice, no I did not make that up ๐Ÿ’€)
  • -minterlink-compressed, -mno-interlink-compressed โ€” require (or don't 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 (or don't generate) code that is suitable for SVR4-style dynamic objects. -mabicalls is the default for SVR4-based systems. ๐ŸŒŸ
  • -mshared, -mno-shared โ€” generate (or don't 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. ๐Ÿ’จ

-mshared is the default, bestie. periodt. ๐Ÿ’…


  • -mplt, -mno-plt โ€” assume (or like, do NOT assume, obviously) that the static and dynamic linkers support PLTs and copy relocations. ๐Ÿซถ Heads up tho: this option only affects -mno-shared -mabicalls. And for the n64 ABI, it does absolutely nothing without -msym32. You can make -mplt the default by configuring GCC with --with-mips-plt. Otherwise the default is -mno-plt.
  • -mxgot, -mno-xgot โ€” lift (or don't lift) the usual restrictions on the size of the global offset table. ๐ŸŽ€

So normally GCC uses a single instruction to load values from the GOT. Which is lowkey efficient, but it only works if the GOT is smaller than about 64k. Anything bigger and the linker throws hands with an error like:

        relocation truncated to fit: R_MIPS_GOT16 foobar

If that happens to you, 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. ๐Ÿ˜ญ

Ngl, 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. she's mysterious like that โœจ
  • -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 โ€” equivalent to -msoft-float, but additionally asserts that the program being compiled does not perform any floating-point operations. This option is presently supported only by some bare-metal MIPS configurations, where it may select a special set of libraries that lack all floating-point support (including, for example, the floating-point "printf" formats). > If code compiled with -mno-float accidentally contains floating-point operations, it is likely to suffer a link-time or run-time failure. ๐Ÿ˜ณ like... don't do that.
  • -msingle-float โ€” assume that the floating-point coprocessor only supports single-precision operations.
  • -mdouble-float โ€” assume that the floating-point coprocessor supports double-precision operations. This is the default. ๐Ÿ‘‘
  • -modd-spreg, -mno-odd-spreg โ€” enable the use of odd-numbered single-precision floating-point registers for the o32 ABI. This is the default for processors that are known to support these registers. When using the o32 FPXX ABI, -mno-odd-spreg is set by default.
  • -mabs=2008, -mabs=legacy โ€” these options control the treatment of the special not-a-number (NaN) IEEE 754 floating-point data with the "abs.fmt" and "neg.fmt" machine instructions. ๐Ÿงš

By default or when -mabs=legacy is used, the legacy treatment is selected. In this case these instructions are considered arithmetic and avoided where correct operation is required and the input operand might be a NaN. A longer sequence of instructions that manipulate the sign bit of floating-point datum manually is used instead โ€” unless the -ffinite-math-only option has also been specified.

The -mabs=2008 option selects the IEEE 754-2008 treatment. In this case these instructions are considered non-arithmetic and therefore operating correctly in all cases, including in particular where the input operand is a NaN. These instructions are therefore always used for the respective operations. slay.

  • -mnan=2008, -mnan=legacy โ€” these options 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, whereas 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. In this case qNaNs are denoted by the first bit of their trailing significand field being 1, whereas sNaNs are denoted by the first bit of their trailing significand field being 0. bestie the bits are literally flipped. ๐Ÿ’€

The default is -mnan=legacy unless GCC has been configured with --with-nan=2008.

  • -mllsc, -mno-llsc โ€” use (do not 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 if the runtime environment can emulate the instructions, and -mno-llsc can be useful when compiling for nonstandard ISAs. You can make either option the default by configuring GCC with --with-llsc and --without-llsc respectively. --with-llsc is the default for some configurations; see the installation documentation for details. ๐Ÿ“–

  • -mdsp, -mno-dsp โ€” use (do not 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 (do not 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 (do not use) the MIPS SmartMIPS ASE. โœจ
  • -mpaired-single, -mno-paired-single โ€” use (do not use) paired-single floating-point instructions. This option requires hardware floating-point support to be enabled.
  • -mdmx, -mno-mdmx โ€” use (do not use) MIPS Digital Media Extension instructions. This option can only be used when generating 64-bit code and requires hardware floating-point support to be enabled.
  • -mips3d, -mno-mips3d โ€” use (do not use) the MIPS-3D ASE. The option -mips3d implies -mpaired-single. ๐ŸŽ€
  • -mmicromips, -mno-micromips โ€” generate (do not generate) microMIPS code.

MicroMIPS code generation can also be controlled on a per-function basis by means of "micromips" and "nomicromips" attributes. iykyk

  • -mmt, -mno-mt โ€” use (do not use) MT Multithreading instructions.
  • -mmcu, -mno-mcu โ€” use (do not use) the MIPS MCU ASE instructions.
  • -meva, -mno-eva โ€” use (do not use) the MIPS Enhanced Virtual Addressing instructions.
  • -mvirt, -mno-virt โ€” use (do not use) the MIPS Virtualization (VZ) instructions.
  • -mxpa, -mno-xpa โ€” use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
  • -mcrc, -mno-crc โ€” use (do not use) the MIPS Cyclic Redundancy Check (CRC) instructions.
  • -mginv, -mno-ginv โ€” use (do not use) the MIPS Global INValidate (GINV) instructions. ๐Ÿ’…
  • -mmsa, -mno-msa โ€” use (do not use) the MIPS MSA extension instructions.
  • -mloongson-mmi, -mno-loongson-mmi โ€” use (do not use) the MIPS Loongson MultiMedia extensions Instructions (MMI). ๐ŸŒธ
  • -mloongson-ext, -mno-loongson-ext โ€” use (do not use) the MIPS Loongson EXTensions (EXT) instructions.
  • -mloongson-ext2, -mno-loongson-ext2 โ€” use (do not use) the MIPS Loongson EXTensions r2 (EXT2) instructions.
  • -mlong64 โ€” force "long" types to be 64 bits wide. See -mlong32 for an explanation of the default and the way that the pointer size is determined. ๐Ÿซถ
  • -mlong32 โ€” force "long", "int", and pointer types to be 32 bits wide.

The default size of "int"s, "long"s and pointers depends on the ABI. All the supported ABIs use 32-bit "int"s. The n64 ABI uses 64-bit "long"s, as does the 64-bit EABI; the others use 32-bit "long"s. Pointers are the same size as "long"s, or the same size as integer registers, whichever is smaller.

  • -msym32, -mno-sym32 โ€” assume (do not assume) that all symbols have 32-bit values, regardless of the selected ABI. This option is useful in combination with -mabi=64 and -mno-abicalls because it allows GCC to generate shorter and faster references to symbolic addresses. ๐Ÿ”ฅ speed.
  • -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 (do not extend) the -G behavior to local data too, such as to static variables in C. -mlocal-sdata is the default for all configurations.

If the linker complains that an application is using too much small data, you might want to try rebuilding the less performance-critical parts with -mno-local-sdata. You might also want to build large libraries with -mno-local-sdata, so that the libraries leave more room for the main program. ๐Ÿ’–

  • -mextern-sdata, -mno-extern-sdata โ€” assume (do not assume) that externally-defined data is in a small data section if the size of that data is within the -G limit. -mextern-sdata is the default for all configurations.
okay this one has RULES bestie, listen up. ๐Ÿ‘‘

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. slay, flexible. ๐Ÿ’…

  • -mgpopt, -mno-gpopt โ€” use (do not 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 โ€” this one's for the โœจspecial casesโœจ where the $gp register might not actually be holding the value of _gp. Like, imagine the code is part of a library that might get used inside a boot monitor โ€” programs calling boot monitor routines are out here passing an unknown value in $gp ๐Ÿ’€. (And yeah, in those situations the boot monitor itself is usually compiled with -G0.)

Heads up bestie: -mno-gpopt implies -mno-local-sdata and -mno-extern-sdata.


  • -membedded-data
  • -mno-embedded-data โ€” put variables in the read-only data section first if that's possible, then next in the small data section if that's possible, otherwise just plop them in data. It's giving slightly slower code than the default, but it cuts down the amount of RAM you need when executing, so some embedded systems are literally obsessed with it ๐ŸŽ€.
  • -muninit-const-in-rodata
  • -mno-uninit-const-in-rodata โ€” drop uninitialized const variables into the read-only data section. ๐Ÿซถ Lowkey only meaningful if you're also using -membedded-data.
  • -mcode-readable=setting โ€” tell GCC whether it's allowed to generate code that reads from executable sections. Three possible settings, babes:
    • -mcode-readable=yes โ€” instructions may freely access executable sections. This is the default setting, slay โœจ.
    • -mcode-readable=pcrel โ€” MIPS16 PC-relative load instructions can access executable sections, but other instructions must not do so. Useful on 4KSc and 4KSd processors when the code TLBs have the Read Inhibit bit set ๐Ÿ‘‘. 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 one's useful on targets configured with a dual instruction/data SRAM interface but that (unlike the M4K) do not automatically redirect PC-relative loads to the instruction RAM.

On SDE targets, -mcode-data-in-code is available as a traditional alias for -mcode-readable=no, and -mcode-xonly for -mcode-readable=pcrel.

  • -msplit-addresses
  • -mno-split-addresses โ€” enable (or disable) use of the %hi() and %lo() assembler relocation operators. Ngl this one's been superseded by -mexplicit-relocs but it's still kicking around for backwards compatibility ๐Ÿฆ‹.
  • -mexplicit-relocs=none
  • -mexplicit-relocs=base
  • -mexplicit-relocs=pcrel
  • -mexplicit-relocs
  • -mno-explicit-relocs โ€” these control whether explicit relocs (like %gp_rel) get used or not. The default value depends on the version of GAS that was around when GCC itself was built ๐Ÿ‘€.

The "base" explicit-relocs support landed in GAS in 2001. The "pcrel" explicit-relocs support landed in GAS in 2014, and it supports %pcrel_hi and %pcrel_lo.

  • -mcheck-zero-division
  • -mno-check-zero-division โ€” trap (or do not trap) on integer division by zero. Bestie, division by zero is a whole crime scene ๐Ÿ˜ญ.

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, 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 (or disable) an optimization that pairs consecutive load or store instructions to enable load/store bonding ๐ŸŽ€. It's enabled by default, but it only takes effect when the selected architecture is known to support bonding. Vibe check first, always.
  • -mstrict-align
  • -mno-strict-align
  • -munaligned-access
  • -mno-unaligned-access โ€” disable (or enable) direct unaligned access for MIPS Release 6. MIPSr6 requires load/store unaligned-access support, either from hardware or by trapping and emulation ๐Ÿ™ˆ. In that latter case, -mstrict-align may be needed by the operating system kernel. The options -munaligned-access and -mno-unaligned-access are obsolete, and only provided for backward compatibility.
  • -mmemcpy
  • -mno-memcpy โ€” force (or 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 โœจ.
  • -mlong-calls
  • -mno-long-calls โ€” disable (or do not disable) use of the jal instruction. Calling functions with jal is more efficient but requires the caller and callee to be in the same 256 megabyte segment ๐Ÿ‘‘.

This option has no effect on abicalls code. The default is -mno-long-calls.

  • -mmad
  • -mno-mad โ€” enable (or disable) use of the mad, madu and mul instructions, as provided by the R4650 ISA ๐Ÿ’….
  • -mimadd
  • -mno-imadd โ€” enable (or 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 ๐Ÿ˜ญ.
  • -mfused-madd
  • -mno-fused-madd โ€” enable (or 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 (with a .s suffix) when assembling them ๐ŸŽ€.
  • -mfix-24k
  • -mno-fix-24k โ€” work around the 24K E48 errata (that's lost data on stores during refill, bestie ๐Ÿ’€). 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
  • -mno-fix-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 โœจ.
  • -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 ๐ŸŽ€.)
  • -mfix4300
  • -mno-fix4300 โ€” work around a bug in early VR4300 silicon that causes multiplies with certain operands to corrupt immediately following multiplies ๐Ÿ’€.
  • -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 chillin' in the current function's stack frame;
    1. the memory taken up by an incoming stack argument;
    2. the memory of an object whose address is link-time-constant.

It's the kernel's whole job to make sure those speculative peeks into those regions are actually safe, bestie. No cap.

So if your input program has a function declaration like:

void foo (void);

then whoever implements foo has to let j foo and jal foo get executed speculatively. GCC respects that rule for the functions it compiles itself, and it expects non-GCC functions (think hand-written assembly, iykyk) to play by the same rules too. ๐Ÿ’…

The option comes in three flavors:

  • -mr10k-cache-barrier=load-store โ€” drops a cache barrier before a load or store that might get speculatively executed and might have side effects even if it gets aborted. ๐Ÿ˜ฌ
  • -mr10k-cache-barrier=store โ€” drops a cache barrier before a store that might get speculatively executed and might have side effects even if it gets aborted.
  • -mr10k-cache-barrier=none โ€” turns cache barrier insertion all the way off. This is the default setting.

  • -mflush-func=func, -mno-flush-func โ€” tells GCC which function to call to flush the I and D caches, or says "don't call any function at all." If it is called, the function has to take the same arguments as the common _flush_func, which is: the address of the memory range whose cache is being flushed, the size of that memory range, and the number 3 (because that flushes both caches ๐Ÿงนโœจ). The default depends on the target GCC was configured for, but it's commonly either _flush_func or __cpu_flush.
  • -mbranch-cost=num โ€” sets the cost of branches to roughly num "simple" instructions. Heads up though: this cost is only a heuristic, and it is not guaranteed to give you consistent results across releases. A zero cost redundantly picks the default, which is based on the -mtune setting.
  • -mbranch-likely, -mno-branch-likely โ€” turn use of Branch Likely instructions on or off, regardless of what the default is for the architecture you picked. By default, Branch Likely instructions may be generated if your selected architecture supports them. The exception: MIPS32 and MIPS64 architectures, and the processors that implement them โ€” for those, Branch Likely instructions are not generated by default, because MIPS32 and MIPS64 specifically deprecate their use. ๐Ÿ’€
  • -mcompact-branches=never, -mcompact-branches=optimal, -mcompact-branches=always โ€” these control which form of branches get generated. Default is -mcompact-branches=optimal.
    • -mcompact-branches=never โ€” compact branch instructions are never generated.
    • -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 is used instead.
    • If it's used for MIPS16/microMIPS targets, it's just ignored right now. The behavior for MIPS16/microMIPS may change in future, since they do have some compact branch instructions.
    • -mcompact-branches=optimal โ€” a delay slot branch gets used if one is available in the current ISA and the delay slot is successfully filled. If the delay slot isn't 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 instance, on the SB-1, if FP exceptions are disabled and we're emitting 64-bit code, then we can use both FP pipes. Otherwise? Only one FP pipe for you. ๐Ÿฅฒ
  • -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 only does anything when optimizing for the VR4130. It normally makes code faster, but at the cost 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 them. The synci instructions (if enabled) get generated when __builtin___clear_cache is compiled. This option defaults to -mno-synci, but you can override that default by configuring GCC with --with-synci. When you're compiling code for single processor systems, it's generally safe to use synci. But on many multi-core (SMP) systems, it does not invalidate the instruction caches on all cores and may lead to undefined behavior. ๐Ÿ˜ญ
  • -mrelax-pic-calls, -mno-relax-pic-calls โ€” try to turn PIC calls that normally get 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 all by themselves, no compiler help needed. ๐Ÿซถ
  • -mmcount-ra-address, -mno-mcount-ra-address โ€” emit (or don't emit) code that lets _mcount 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 these:
    • Returning the new address in register $31.
    • Storing the new address in *ra-address, if ra-address is nonnull.

The default is -mno-mcount-ra-address.

  • -mframe-header-opt, -mno-frame-header-opt โ€” enable (or disable) frame header optimization in the o32 ABI. With the o32 ABI, calling functions allocate 16 bytes on the stack so the called function can write out register arguments. When this is enabled, the optimization suppresses that frame header allocation if it can be figured out that it's unused. This optimization is off by default at all optimization levels.
  • -mlxc1-sxc1, -mno-lxc1-sxc1 โ€” when applicable, enable (or disable) generation of lwxc1, swxc1, ldxc1, sdxc1 instructions. Enabled by default.
  • -mmadd4, -mno-madd4 โ€” when applicable, enable (or disable) generation of 4-operand madd.s, madd.d and related instructions. Enabled by default.

๐Ÿ‘‘ MMIX Options ๐Ÿ‘‘

These options are defined for the MMIX:

  • -mlibfuncs, -mno-libfuncs โ€” say 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 (inside 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 that yields 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, but the latter is almost exclusively the one people use. ๐Ÿ’…
  • -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. That 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 โ€” which means a program using lots of static data may need -mno-base-addresses. โœจ
  • -msingle-exit, -mno-single-exit โ€” force (or don't force) generated code to have a single exit point in each function.
  • -mset-data-start=address โ€” when linking, set the start of the data section to address.
  • -mset-program-start=address, -mno-set-program-start โ€” when linking, set the program start address to address. It defaults to 0x100 unless -mno-set-program-start is used to suppress this option entirely.

๐ŸŒธ MN10300 Options ๐ŸŒธ

These -m options are defined for Matsushita MN10300 architectures:

  • -mmult-bug, -mno-mult-bug โ€” when enabled, generate code to dodge bugs in the multiply instructions for the MN10300 processors. This is the default.
  • -mam33, -mno-am33 โ€” generate code using features specific to the AM33 processor. The default is -mno-am33.
  • -mam33-2, -mno-am33-2 โ€” generate code using features specific to the AM33/2.0 processor. The default is -mno-am33-2.
  • -mam34, -mno-am34 โ€” generate code using features specific to the AM34 processor. The default is -mno-am34.
  • -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 has to be one of mn10300, am33, am33-2 or am34. ๐Ÿฆ‹
  • -mreturn-pointer-on-d0, -mno-return-pointer-on-d0 โ€” okay so when the compiler is generating a function that returns a pointer, this makes it hand that pointer back in both a0 and d0. If you don't do that, the pointer only comes back in a0, and then literally any attempt to call one of those functions without a prototype just errors out ๐Ÿ’€. Heads up: this is on by default, so if you want it off you gotta say -mno-return-pointer-on-d0.
  • -mno-crt0 โ€” don't link in the C run-time initialization object file. that's it, that's the whole vibe ๐ŸŽ€
  • -mrelax โ€” tells the linker bestie to go do a relaxation optimization pass so branches, calls and absolute memory addresses all get shortened โœจ. tiny lil caveat: this only does anything when you use it on the command line for the final link step. also it makes symbolic debugging impossible so likeโ€ฆ pick a struggle ๐Ÿ™ˆ
  • -mliw, -mno-liw โ€” lets the compiler generate Long Instruction Word instructions when the target is the AM33 or later. enabled by default, no cap. -mliw defines the preprocessor macro __LIW__; -mno-liw defines the preprocessor macro __NO_LIW__ ๐Ÿ’…
  • -msetlb, -mno-setlb โ€” lets the compiler generate the SETLB and Lcc instructions when the target is the AM33 or later. also enabled by default. -msetlb defines the preprocessor macro __SETLB__; -mno-setlb 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, -mno-mul.x โ€” generate mul.x and umul.x instructions. this one is enabled by default for moxiebox-*-* configurations ๐ŸŒธ
  • -mno-crt0 โ€” do not link in the C run-time initialization object file. (yes bestie, same energy as the other one ๐Ÿ’–)

๐ŸŒˆ MSP430 Options ๐ŸŒˆ

these options are defined for the MSP430:

  • -masm-hex โ€” forces assembly output to always use hex constants. normally those constants are signed decimals, but this option exists for testsuite and/or aesthetic purposes โœจ (aesthetic purposes?? iconic honestly).
  • -mmcu=name โ€” picks the MCU to target. this gets used to create a C preprocessor symbol based on the MCU name, converted to upper case and pre- and post-fixed with __. that symbol is then used by the msp430.h header file to select an MCU-specific supplementary header file ๐ŸŽ€

the option also sets the ISA to use. if the MCU name is one that's known to only support the 430 ISA then that one gets selected, otherwise the 430X ISA is selected. a generic MCU name of msp430 can also be used to select the 430 ISA. similarly 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 the name of the MCU with .ld appended. so specifying -mmcu=xxx on the gcc command line defines the C preprocessor symbol __XXX__ and causes the linker to search for a script called xxx.ld ๐Ÿซถ

the ISA and hardware multiply supported for the different MCUs is hard-coded into GCC. however, an external devices.csv file can be used to extend device support beyond those that have been hard-coded.

GCC searches for the devices.csv file using the following methods in the given precedence order, where the first method takes precedence over the second which takes precedence over the third.

  1. Include path specified with -I and -L โ€” devices.csv is searched for in each of the directories specified by include paths and linker library search paths.
  2. Path specified by the environment variable MSP430_GCC_INCLUDE_DIR โ€” define the value of the global environment variable MSP430_GCC_INCLUDE_DIR to the full path to the directory containing devices.csv, and GCC will search this directory for devices.csv. if devices.csv is found, this directory is also registered as an include path and linker library path. header files and linker scripts in this directory can therefore be used without manually specifying -I and -L on the command line.
  3. The msp430-elf{,bare}/include/devices directory โ€” finally, GCC examines msp430-elf{,bare}/include/devices from the toolchain root directory. this directory does not exist in a default installation, but if you have created it and copied devices.csv there, then the MCU data is read. as above, this directory is also 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 โ€” 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 โญ
  • -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 cannot be done until the final link ๐Ÿ”ฅ
  • mhwmult=type โ€” describes the type of hardware multiply supported by the target. accepted values for type 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. a value of auto can also be given. this tells GCC to deduce the hardware multiply support based upon the MCU name provided by the -mmcu option. if no -mmcu option is specified or if the MCU name is not 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. when compiling at -O3 or higher however the hardware multiplier is invoked inline. this makes for bigger, but faster code ๐Ÿ‘‘

the hardware multiply routines disable interrupts whilst running and restore the previous interrupt state when they finish. this makes them safe to use inside interrupt handlers as well as in normal code ๐Ÿซถ

  • -minrt โ€” enable the use of a minimum runtime environment without support for static initializers or constructors. this is intended for memory-constrained devices. the compiler includes special symbols in some objects that tell the linker and runtime which code fragments are required ๐ŸŽ€
  • -mtiny-printf โ€” enable reduced code size printf and puts library functions. the tiny implementations of these functions are not reentrant, so must be used with caution in multi-threaded applications โš ๏ธ

support for streams has been removed and the string to be printed are always sent to stdout via the 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=n โ€” takes an integer n between 0 and 64 inclusive, and sets the maximum number of inline shift instructions which should be emitted to perform a shift operation by a constant amount. when this value needs to be exceeded, an mspabi helper function is used instead. the default value is 4 โœจ

this only affects cases where a shift by multiple positions cannot be completed with a single instruction (e.g. all shifts >1 on the 430 ISA).

shifts of a 32-bit value are at least twice as costly, so the value passed for this option is divided by 2 and the resulting value used instead ๐Ÿ’…

  • -mcode-region=where, -mdata-region=where โ€” these options tell the compiler where to place functions and data that do not have one of the lower, upper, either or section attributes. possible values for where 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 ๐ŸŒธ
  • -muse-lower-region-prefix โ€” add the .lower prefix to section names when compiling with -mcode-region=lower or -mdata-region=lower. disabled by default.
  • -msilicon-errata=name[,name...] โ€” this option passes on a request to assembler to enable the fixes for the named silicon errata. refer to the assembler documentation for details ๐Ÿฆ‹
  • -msilicon-errata-warn=name[,name...] โ€” this option passes on a request to the assembler to enable warning messages when a named silicon errata might need to be applied. refer to the assembler documentation for details.
  • -mwarn-devices-csv, -mno-warn-devices-csv โ€” warn if devices.csv is not found or there are problems parsing it (default: on) โญ

๐Ÿ’œ NDS32 Options ๐Ÿ’œ

these options are defined for NDS32 implementations:

  • -mbig-endian, -EB โ€” generate code in big-endian mode.
  • -mlittle-endian, -EL โ€” generate code in little-endian mode.
  • -mabi=2, -mfloat-abi=soft โ€” use the soft floating-point ABI ๐ŸŽ€
  • -mabi=2fp+, -mfloat-abi=hard โ€” use the hard floating-point ABI ๐Ÿ”ฅ
  • -mreduced-regs โ€” use reduced-set registers for register allocation.
  • -mfull-regs โ€” use full-set registers for register allocation.
  • -malways-align โ€” always align function entry, jump targets, and return address.
  • -malign-functions โ€” align function entry to 4 bytes.
  • -mfp-as-gp, -mno-fp-as-gp โ€” enable/disable fp-as-gp optimization.
  • -mcmov, -mno-cmov โ€” enable/disable generation of conditional move instructions.
  • -mhw-abs, -mno-hw-abs โ€” enable/disable generation of hardware abs instructions.
  • -mext-perf, -mno-ext-perf โ€” enable/disable generation of performance extension instructions.
  • -mext-perf2, -mno-ext-perf2 โ€” enable/disable generation of performance extension 2 instructions.
  • -mext-string, -mno-ext-string โ€” enable/disable generation of string extension instructions.
  • -mext-dsp, -mno-ext-dsp โ€” enable/disable generation of DSP extension instructions.
  • -mext-fpu-fma, -mno-ext-fpu-fma โ€” enable/disable generation of floating-point multiply-accumulation instructions โœจ
  • -mext-fpu-sp, -mno-ext-fpu-sp โ€” turns generation of single-precision floating-point instructions on / off โœจ
  • -mext-fpu-dp, -mno-ext-fpu-dp โ€” same deal but for double-precision floating-point instructions ๐Ÿ’…
  • -mv3push, -mno-v3push โ€” enable/disable generation of v3 push25/pop25 instructions ๐Ÿซถ
  • -m16-bit, -mno-16-bit โ€” enable/disable generation of 16-bit instructions, no cap ๐ŸŽ€
  • -mvh, -mno-vh โ€” enable/disable Virtual Hosting support ๐ŸŒˆ
  • -misr-vector-size=num โ€” set the size of each interrupt vector. Heads up bestie, it must be 4 or 16 or it's not it ๐Ÿ’€
  • -misr-secure=num โ€” sets the security level of c-isr for the whole file ๐Ÿ”’
  • -mcache-block-size=num โ€” the size of each cache block. It must be a power of 2 between 4 and 512, periodt โญ
  • -march=arch โ€” pick your target architecture. arch can be one of v2, v3, v3j, v3m, v3f, or v3s ๐Ÿฆ‹
  • -mcpu=cpu โ€” pick the CPU you're compiling for. cpu can be one of:
n6, n650, n7, n705, n8, n801, sn8, sn801, s8, s801, e8, e801, n820,
s830, e830, n9, n903, n903a, n968, n968a, n10, n1033, n1033a,
n1033-fpu, n1033-spu, n1068, n1068a, n1068-fpu, n1068a-fpu, d10, d1088,
d1088-fpu, d1088-spu, n15, d15, n15s, d15s, n15f, d15f, n12, n1213,
n1233, n1233-fpu, n1233-spu, n13, n1337, n1337-fpu, n1337-spu, or simple
  • -mconfig-fpu=num โ€” set an FPU configuration value from 0 to 7. So 0--3 is as the FPU spec says, and 4--7 correspond to 0--3 ๐Ÿงš
  • -mconfig-mul=type โ€” configuration for the multiply instruction. type can be one of fast, fast1 (equivalent to fast), fast2, or slow. The default is fast1 ๐Ÿ’–
  • -mconfig-register-ports=kind โ€” the numbers of read/write ports for n9/n10 cores. The value should be 3r2w or 2r1w ๐Ÿ‘‘
  • -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 be still within 16MB addressing space.
    • large โ€” all the text and data segments can be within 4GB addressing space.

The default is large on GNU/Linux targets and medium on other ELF targets ๐ŸŒธ

  • -mctor-dtor, -mno-ctor-dtor โ€” enable/disable the constructor/destructor feature ๐ŸŽ€
  • -mrelax, -mno-relax โ€” enable/disable the linker option to relax instructions ๐Ÿ”ฅ
  • -mrelax-hint, -mno-relax-hint โ€” enable/disable insertion of hints for the linker to do relaxation โœจ
  • -msched-prolog-epilog, -mno-sched-prolog-epilog โ€” enable/disable scheduling of a function's prologue and epilogue sequence ๐Ÿซถ
  • -mret-in-naked-func, -mno-ret-in-naked-func โ€” enable/disable generation of return instructions in naked functions. This option is enabled by default ๐Ÿ’…
  • -malways-save-lp, -mno-always-save-lp โ€” enable/disable always saving $lp on the stack ๐ŸŒˆ
  • -munaligned-access, -mno-unaligned-access โ€” enable/disable unaligned word and halfword accesses to packed data ๐Ÿฆ‹
  • -minline-asm-r15, -mno-inline-asm-r15 โ€” allow/disallow use of r15 for inline asm ๐Ÿ‘‘

๐ŸŽฎ Nvidia PTX Options ๐ŸŽฎ

These options are defined for Nvidia PTX, bestie:

  • -m64 โ€” ignored, but preserved for backward compatibility. Only the 64-bit ABI is supported, so don't come looking for 32-bit ๐Ÿ’€
  • -march=architecture-string โ€” generate code for the specified PTX ISA target architecture. The valid architecture strings are sm_30, sm_35, sm_37, sm_50, sm_52, sm_53, sm_61, sm_70, sm_75, sm_80, and sm_89. The default depends on how the compiler has been 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 โ€” alias of -march= ๐Ÿ’…
  • -march-map=architecture-string โ€” select the closest available -march= value that is not more capable. For instance, for -march-map=sm_50 select -march=sm_37, and for -march-map=sm_53 select -march=sm_53 ๐ŸŽฏ
  • -mptx=version-string โ€” generate code for the specified PTX ISA version. The valid version strings are 3.1, 4.0, 4.1, 4.2, 5.0, 6.0, 6.3, 7.0, 7.3, and 7.8. The default PTX ISA version is the one that added support for the selected PTX ISA target architecture, see -march=, but at least 6.3, or 7.3 for -march=sm_52 and higher ๐ŸŒธ

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 instead of offloading execution ๐Ÿ‘‘
  • -moptimize, -mno-optimize โ€” enable/disable partitioned execution optimizations. This option is enabled by default when any level of optimization is selected ๐Ÿ’–
  • -msoft-stack, -mno-soft-stack โ€” okay so listen:

For -mno-soft-stack (the default, unless -mgomp has been specified), use PTX "native" stacks, that is, generate code that uses .local memory or PTX "alloca" directly for stack storage. Unless -mptx=7.3 or higher and -march=sm_52 or higher are active, variable-length arrays and dynamically allocating memory on the stack with "alloca" are not supported โš ๏ธ

For -msoft-stack (implied by -mgomp), generate code that does not use .local memory or PTX "alloca" directly for stack storage. Instead, a per-warp stack pointer is maintained explicitly. This enables variable-length stack allocation (with variable-length arrays or "alloca"), and when global memory is used for underlying storage, makes it possible to access automatic variables from other threads, or with atomic instructions. This code generation variant is used for OpenMP offloading, but the option is exposed on its own for the purpose of testing the compiler; to generate code suitable for linking into programs using OpenMP offloading, use option -mgomp ๐ŸŒˆ

  • -msoft-stack-reserve-local=size โ€” specify the size of .local memory used for the stack when the exact amount is not known. It defaults to 128 ๐ŸŽ€
  • -muniform-simt, -mno-uniform-simt โ€” enable/disable a code generation variant that allows execution of all threads in each warp, while maintaining memory state and side effects as if only one thread in each warp was active outside of OpenMP SIMD regions. All atomic operations and calls to runtime (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 current lane index to compute the master lane index ๐Ÿคฏ
  • -mgomp, -mno-gomp โ€” enable/disable generation of code for use in OpenMP offloading. -mgomp enables -msoft-stack and -muniform-simt options, and selects a corresponding multilib variant ๐Ÿ’œ

๐ŸŒฑ OpenRISC Options ๐ŸŒฑ

These options are defined for OpenRISC, bestie:

  • -mboard=name โ€” configure a board specific runtime. This is passed to the linker for newlib board library linking. The default is or1ksim ๐Ÿฆ‹
  • -msoft-div, -mhard-div โ€” select software or hardware divide (l.div, l.divu) instructions. This default is hardware divide ๐Ÿ’…
  • -msoft-mul, -mhard-mul โ€” select software or hardware multiply (l.mul, l.muli) instructions. This 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 equivalents are 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 are 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 are generated to store the immediate to a register first ๐Ÿงš
  • -mcmodel=small โ€” generate OpenRISC code for the small model: the GOT is limited to 64k and function call jumps are limited to 64M offsets. This is the default model ๐Ÿ’–
  • -mcmodel=large โ€” generate OpenRISC code for the large model: the GOT may grow up to 4G in size and function call jumps can target the full 4G address space ๐Ÿš€

๐Ÿ•ฐ๏ธ PDP-11 Options ๐Ÿ•ฐ๏ธ

These options are defined for the PDP-11, and honestly? vintage icon behaviour:

  • -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, -mno-ac0 โ€” with -mac0, return floating-point results in ac0 (fr0 in Unix assembler syntax). The default, -mno-ac0, is to return floating-point results in memory ๐Ÿ’…
  • -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 โ€” makes int a lil 16-bit baby. This is the default, bestie, it's what you get unless you say otherwise. ๐Ÿ’–
  • -mint32, -mno-int16 โ€” now int gets the 32-bit upgrade. glow up โœจ
  • -msplit โ€” for when your target has split instruction and data space. Heads up: this implies -m45. ๐Ÿ‘‘
  • -munix-asm โ€” assembler syntax from Unix, okurrr.
  • -mdec-asm โ€” assembler syntax from DEC.
  • -mgnu-asm โ€” assembler syntax from GNU. This one's the default, no surprise there. ๐ŸŽ€
  • -mlra โ€” use the shiny new LRA register allocator. By default you get the old reload allocator instead โ€” yes, the one with the grandpa vibes. ๐Ÿ’€

๐ŸŒธ Picolibc Options ๐ŸŒธ

These options are the ones calling the shots on compilation and linking when you're rolling with Picolibc:

  • --oslib=library โ€” go hunt for the library named library after the C library, so that symbols the C library left undefined can get defined by this one instead. The C library, libgcc, and this library all get tucked between --start-group and --end-group flags so each one can reference symbols in the others. And for lots of targets, Picolibc ships a semihost variant (you ask for it with --oslib=semihost) that brings just enough basic OS functionality to make console and file I/O work โ€” whether you're running in an emulator or hooked up with an in-circuit debugger. ๐Ÿฆ‹
  • --crt0=[none|minimal|hosted|semihost] โ€” swaps the default crt0.o name out for crt0-variant.o. Here's the tea on each variant:
    • none gives you literally no startup code at all, so you can supply your own. main character energy, we respect it.
    • minimal does the basic memory setup but does not invoke any constructors.
    • When no -crt0 option is given, the default initialization code adds calls to all constructors.
    • hosted adds a call to exit when main returns.
    • semihost reaches for a command-line parameter supplied via the semihosting interface and splits it into arguments at whitespace boundaries, then passes the resulting array of strings to main in argc and argv. On some targets โ€” including AArch64, ARC, ARM, LoongArch, M680x0, RISC-V, SH, and x86 โ€” semihost also traps hardware exceptions and prints info to the console.
ngl, --crt0=semihost depends upon APIs provided by --oslib=semihost. Don't forget that part. ๐Ÿ˜ญ
  • --printf=[d|f|l|i|m] โ€” pick your printf variant. Picolibc serves up five different printf variants that trade functionality for code size, going down and down. ๐Ÿ’…
    • d is the default level โ€” full C17 and POSIX.1-2024 conformance, she ate.
    • f has the same feature set but supports float values instead of double, which get passed using the printf_float macro.
    • l elides all floating-point and POSIX positional parameter support.
    • i limits integers to those no larger than long.
    • m removes support for most formatting options including width and precision. The formats and arguments are still parsed correctly, but the output just... doesn't respect those parameters. ๐Ÿ™ˆ
  • --scanf=[d|f|l|i|m] โ€” same deal, but for scanf. Five variants, decreasing functionality, decreasing code size. ๐ŸŒˆ
    • d is the default โ€” full C17 and POSIX.1-2024 conformance.
    • f removes support for double values.
    • l elides all floating point support.
    • i limits integers to those no larger than long.
    • m removes support for %[ conversion specifiers.

โšก 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 heads up: some standard C runtime features get removed. ๐Ÿ‘€

This option disables support for static initializers and constructors. And beware โ€” the compiler could still generate code with static initializers and constructors. It's on the programmer to make sure the source program doesn't use those features. no cap.

The minimal startup code does not pass argc and argv arguments to main, so main has to be declared as int main (void). This is already the norm for most firmware projects, so lowkey fine. ๐Ÿ’œ

  • -mmcu=mcu โ€” specify the PRU hardware variant to use. A correspondingly-named spec file gets loaded, passing the memory region sizes to the linker and defining hardware-specific C macros.

Newlib provides only the sim spec, meant 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 โ€” makes GCC pass the --no-relax command-line option to the linker instead of the --relax option.
  • -mloop, -mno-loop โ€” allow (or do not allow) GCC to use the LOOP instruction.
  • -mmul, -mno-mul โ€” allow (or do not allow) GCC to use the PRU multiplier unit.
  • -mfillzero, -mno-fillzero โ€” allow (or do not allow) GCC to use the FILL and ZERO instructions.
  • -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. Here's the difference list, bestie: ๐Ÿ“‹

Function Pointer Size

TI ABI says 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 get 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 isn't using the returned value. GNU always passes and expects a valid return value pointer.

Size Of Struct Containing Bit-fields

TI ABI mandates that struct size is determined by the bit-field type, if it contains any. GNU, on the other hand, allocates the smallest amount of bytes that would fit the bit-field.

For example, TI ABI reserves 4 bytes for this struct, whereas GNU reserves a single byte:

struct S { int i:1; };

Access Size For Volatile Bit-fields

TI ABI mandates that volatile bit-fields are accessed using their type. In contrast, GNU ABI uses the smallest integer type fitting the bit-field.

For example, TI ABI requires a single load of 4 bytes for the following bit-field. GNU generates a load of 1 byte:

struct S { volatile int i:1; };

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.
  • -mabi=ABI-string โ€” specify integer and floating-point calling convention. ABI-string contains two parts: the size of integer types and the registers used for floating-point types. For example, -march=rv64ifd -mabi=lp64d means that long and pointers are 64-bit (implicitly defining int to be 32-bit), and that floating-point values up to 64 bits wide are passed in F registers. Contrast that with -march=rv64ifd -mabi=lp64f, which still lets the compiler generate code that uses the F and D extensions but only allows floating-point values up to 32 bits long to be passed in registers; or -march=rv64ifd -mabi=lp64, in which no floating-point arguments are passed in registers at all. ๐Ÿ‘‘

The default for this argument is system dependent; if you want a specific calling convention you should specify one explicitly. The valid calling conventions are: 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. โš ๏ธ

  • -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.
  • -mfence-tso, -mno-fence-tso โ€” do or don't use the fence.tso instruction, which is unimplemented on some processors (including those from T-Head). If the fence.tso instruction isn't available then a stronger fence is used instead.
  • -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 โ€” specify the version of the RISC-V Unprivileged (formerly User-Level) ISA specification that generated code should conform 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|Profile|Profile_ISA|processor-string] โ€” generate code for a given RISC-V ISA or profile, or a combination of them (e.g. rv64im rvi20u64 rvi20u64_zbb). The names of ISAs and profiles must be lower case. Examples include rv64i, rv32g, rv32e, rv32imaf, rva22u64 and rva23u64. To combine a named profile with optional RISC-V ISA extensions, give the profile first and then append the extension name(s) using an underscore as a delimiter (e.g. rvi20u64_zca_zcb rva23u64_zacas). Additionally, a special value help (-march=help) is accepted to list all supported extensions. โœจ

-march=unset causes the compiler to ignore any -march=... options that appear earlier on the command line, behaving as if the option was never passed. This is useful for ensuring that the architecture is taken from the -mcpu option, and an error results if no -mcpu option is given when -march=unset is used.

The syntax of the ISA string is defined as follows:

  • The string has to start with rv32 or rv64, and then i, e, or g right after โ€” that little trio is what we call the base ISA โœจ
    • After the base ISA comes the list of extension names. These come in two flavours: multi-letter (like zba) and single-letter (like v). Single-letter ones can just vibe next to each other back to back, but multi-letter ones must be separated by underscores. No exceptions bestie ๐Ÿ’…
    • An underscore can go basically anywhere after the base ISA. It doesn't do anything special โ€” it's purely there for readability, like a little separator for your eyes ๐ŸŽ€
    • Extension names can carry an optional version number, written as <major>p<minor> or just <major> โ€” so like m2p1 or m2. Cute, right? ๐Ÿฆ‹

Supported extensions are listed below โ€” this is the full roster, no skips, no cap:

  • g (version -) โ€” General-purpose computing base extension; g expands to i, m, a, f, d, zicsr and zifencei.
  • e (version 2.0) โ€” Reduced base integer extension
  • i (versions 2.0, 2.1) โ€” Base integer extension
  • m (version 2.0) โ€” Integer multiplication and division extension
  • a (versions 2.0, 2.1) โ€” Atomic extension
  • f (versions 2.0, 2.2) โ€” Single-precision floating-point extension
  • d (versions 2.0, 2.2) โ€” Double-precision floating-point extension
  • c (version 2.0) โ€” Compressed extension
  • b (version 1.0) โ€” Standard extension for bit manipulation functions
  • v (version 1.0) โ€” Vector extension
  • h (version 1.0) โ€” Hypervisor extension
  • zic64b (version 1.0) โ€” Cache block size is 64 bytes
  • zicbom (version 1.0) โ€” Cache-block management extension
  • zicbop (version 1.0) โ€” Cache-block prefetch extension
  • zicboz (version 1.0) โ€” Cache-block zero extension
  • ziccamoa (version 1.0) โ€” Main memory supports all atomics in A
  • ziccif (version 1.0) โ€” Main memory supports instruction fetch with atomicity requirement
  • zicclsm (version 1.0) โ€” Main memory supports misaligned loads/stores
  • ziccrse (version 1.0) โ€” Main memory supports forward progress on LR/SC sequences
  • zicfilp (version 1.0) โ€” Control-flow integrity landing pad extension
  • zicfiss (version 1.0) โ€” Control-flow integrity shadow stack extension
  • zicntr (version 2.0) โ€” Standard extension for base counters and timers
  • zicond (version 1.0) โ€” Integer conditional operations extension
  • zicsr (version 2.0) โ€” Control and status register access extension
  • zifencei (version 2.0) โ€” Instruction-fetch fence extension
  • zihintntl (version 1.0) โ€” Non-temporal locality hints extension
  • zihintpause (version 2.0) โ€” Pause hint extension
  • zihpm (version 2.0) โ€” Standard extension for hardware performance counters
  • zimop (version 1.0) โ€” May-be-operations extension
  • zilsd (version 1.0) โ€” Load/store pair instructions extension
  • zmmul (version 1.0) โ€” Integer multiplication extension
  • za128rs (version 1.0) โ€” Reservation set size of 128 bytes
  • za64rs (version 1.0) โ€” Reservation set size of 64 bytes
  • zaamo (version 1.0) โ€” Atomic memory operations extension
  • zabha (version 1.0) โ€” Byte and halfword atomic memory operations extension
  • zacas (version 1.0) โ€” Atomic compare-and-swap instructions extension
  • zalrsc (version 1.0) โ€” Load-reserved/store-conditional subset of the A extension
  • zawrs (version 1.0) โ€” Wait-on-reservation-set extension
  • zama16b (version 1.0) โ€” Misaligned loads, stores, and AMOs that are fully contained within a naturally-aligned 16-byte boundary are atomic
  • zfa (version 1.0) โ€” Additional floating-point extension
  • zfbfmin (version 1.0) โ€” Minimal BF16 support extension
  • zfh (version 1.0) โ€” Half-precision floating-point extension
  • zfhmin (version 1.0) โ€” Minimal half-precision floating-point extension
  • zfinx (version 1.0) โ€” Single-precision floating-point in integer registers extension
  • zdinx (version 1.0) โ€” Double-precision floating-point in integer registers extension
  • zca (version 1.0) โ€” Integer compressed instruction extension
  • zcb (version 1.0) โ€” Simple compressed instruction extension
  • zcd (version 1.0) โ€” Compressed double-precision floating point loads and stores extension
  • zce (version 1.0) โ€” Compressed instruction extensions for embedded processors
  • zcf (version 1.0) โ€” Compressed single-precision floating point loads and stores extension
  • zcmop (version 1.0) โ€” Compressed may-be-operations extension
  • zcmp (version 1.0) โ€” Compressed push pop extension
  • zcmt (version 1.0) โ€” Table jump instruction extension
  • zclsd (version 1.0) โ€” Compressed load/store pair instructions extension
  • zba (version 1.0) โ€” Address calculation extension
  • zbb (version 1.0) โ€” Basic bit manipulation extension
  • zbc (version 1.0) โ€” Carry-less multiplication extension
  • zbkb (version 1.0) โ€” Cryptography bit-manipulation extension
  • zbkc (version 1.0) โ€” Cryptography carry-less multiply extension
  • zbkx (version 1.0) โ€” Cryptography crossbar permutation extension
  • zbs (version 1.0) โ€” Single-bit operation extension
  • zk (version 1.0) โ€” Standard scalar cryptography extension
  • zkn (version 1.0) โ€” NIST algorithm suite extension
  • zknd (version 1.0) โ€” AES Decryption extension
  • zkne (version 1.0) โ€” AES Encryption extension
  • zknh (version 1.0) โ€” Hash function extension
  • zkr (version 1.0) โ€” Entropy source extension
  • zks (version 1.0) โ€” ShangMi algorithm suite extension
  • zksed (version 1.0) โ€” SM4 block cipher extension
  • zksh (version 1.0) โ€” SM3 hash function extension
  • zkt (version 1.0) โ€” Data independent execution latency extension
  • ztso (version 1.0) โ€” Total store ordering extension
  • zvbb (version 1.0) โ€” Vector basic bit-manipulation extension
  • zvbc (version 1.0) โ€” Vector carry-less multiplication extension
  • zve32f (version 1.0) โ€” Vector extensions for embedded processors
  • zve32x (version 1.0) โ€” Vector extensions for embedded processors
  • zve64d (version 1.0) โ€” Vector extensions for embedded processors
  • zve64f (version 1.0) โ€” Vector extensions for embedded processors
  • zve64x (version 1.0) โ€” Vector extensions for embedded processors
  • zvfbfmin (version 1.0) โ€” Vector BF16 converts extension
  • zvfbfwma (version 1.0) โ€” Vector BF16 widening multiply/add extension
  • zvfh (version 1.0) โ€” Vector half-precision floating-point extension
  • zvfhmin (version 1.0) โ€” Vector minimal half-precision floating-point extension
  • zvkb (version 1.0) โ€” Vector cryptography bit-manipulation extension
  • zvkg (version 1.0) โ€” Vector GCM/GMAC extension
  • zvkn (version 1.0) โ€” Vector NIST Algorithm Suite extension, zvkn will expand to
  • zvknc (version 1.0) โ€” Vector NIST Algorithm Suite with carry-less multiply extension, zvknc
  • zvkned (version 1.0) โ€” Vector AES block cipher extension
  • zvkng (version 1.0) โ€” Vector NIST Algorithm Suite with GCM extension, zvkng will expand
  • zvknha (version 1.0) โ€” Vector SHA-2 secure hash extension
  • zvknhb (version 1.0) โ€” Vector SHA-2 secure hash extension
  • zvks (version 1.0) โ€” Vector ShangMi algorithm suite extension, zvks will expand
  • zvksc (version 1.0) โ€” Vector ShangMi algorithm suite with carry-less multiplication extension,
  • zvksed (version 1.0) โ€” Vector SM4 block cipher extension
  • zvksg (version 1.0) โ€” Vector ShangMi algorithm suite with GCM extension
  • zvksh (version 1.0) โ€” Vector SM3 secure hash extension
  • zvkt (version 1.0) โ€” Vector data independent execution latency extension
  • zvl1024b (version 1.0) โ€” Minimum vector length standard extensions
  • zvl128b (version 1.0) โ€” Minimum vector length standard extensions
  • zvl16384b (version 1.0) โ€” Minimum vector length standard extension
  • zvl2048b (version 1.0) โ€” Minimum vector length standard extensions
  • zvl256b (version 1.0) โ€” Minimum vector length standard extensions
  • zvl32768b (version 1.0) โ€” Minimum vector length standard extension
  • zvl32b (version 1.0) โ€” Minimum vector length standard extensions
  • zvl4096b (version 1.0) โ€” Minimum vector length standard extensions
  • zvl512b (version 1.0) โ€” Minimum vector length standard extensions
  • zvl64b (version 1.0) โ€” Minimum vector length standard extensions
  • zvl65536b (version 1.0) โ€” Minimum vector length standard extension
  • zvl8192b (version 1.0) โ€” Minimum vector length standard extension
  • zhinx (version 1.0) โ€” Half-precision floating-point in integer registers extension
  • zhinxmin (version 1.0) โ€” Minimal half-precision floating-point in integer registers extension
  • sdtrig (version 1.0) โ€” Debug triggers extension
  • sha (version 1.0) โ€” The augmented hypervisor extension
  • shcounterenw (version 1.0) โ€” Support writeable enables for any supported counter
  • shgatpa (version 1.0) โ€” SvNNx4 mode supported for all modes supported by satp
  • shlcofideleg (version 1.0) โ€” Delegating LCOFI interrupts to VS-mode
  • shtvala (version 1.0) โ€” The htval register provides all needed values
  • shvstvala (version 1.0) โ€” The vstval register provides all needed values
  • shvstvecd (version 1.0) โ€” The vstvec register supports direct mode
  • shvsatpa (version 1.0) โ€” The vsatp register supports all modes supported by satp
  • smaia (version 1.0) โ€” Advanced interrupt architecture extension
  • smcntrpmf (version 1.0) โ€” Cycle and instret privilege mode filtering
  • smcsrind (version 1.0) โ€” Machine-level indirect CSR access
  • smepmp โ€” 1.0 โ€” PMP enhancements for memory access and execution prevention on machine mode ๐Ÿ’…
  • smmpm โ€” 1.0 โ€” Supervisor-mode pointer masking extension
  • smnpm โ€” 1.0 โ€” Supervisor-mode pointer masking extension
  • smrnmi โ€” 1.0 โ€” Resumable non-maskable interrupts
  • smstateen โ€” 1.0 โ€” State enable extension
  • smdbltrp โ€” 1.0 โ€” Double trap extensions
  • ssaia โ€” 1.0 โ€” Advanced interrupt architecture extension for supervisor mode
  • ssccptr โ€” 1.0 โ€” Main memory supports page table reads
  • sscofpmf โ€” 1.0 โ€” Count overflow and filtering extension
  • sscounterenw โ€” 1.0 โ€” Support writeable enables for any supported counter
  • sscsrind โ€” 1.0 โ€” Supervisor-mode indirect CSR access
  • ssnpm โ€” 1.0 โ€” Supervisor-mode pointer masking extension
  • sspm โ€” 1.0 โ€” Supervisor-mode pointer masking extension
  • ssstateen โ€” 1.0 โ€” Supervisor-mode state-enable extension
  • sstc โ€” 1.0 โ€” Supervisor-mode timer interrupts extension
  • sstvala โ€” 1.0 โ€” Stval provides all needed values
  • sstvecd โ€” 1.0 โ€” Stvec supports direct mode
  • ssstrict โ€” 1.0 โ€” Unimplemented reserved encodings raise illegal instruction exceptions and no non-conforming extensions are present
  • ssdbltrp โ€” 1.0 โ€” Double trap extensions
  • ssu64xl โ€” 1.0 โ€” UXLEN=64 must be supported
  • supm โ€” 1.0 โ€” User-mode pointer masking 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
  • svvptc โ€” 1.0 โ€” Extension for obviating memory-management instructions after marking PTEs valid
  • svadu โ€” 1.0 โ€” Hardware updating of A/D bits extension
  • svade โ€” 1.0 โ€” Cause exception when hardware updating of A/D bits is disabled
  • svbare โ€” 1.0 โ€” Satp mode bare is supported
  • xcvalu โ€” 1.0 โ€” Core-V miscellaneous ALU extension
  • xcvbi โ€” 1.0 โ€” Core-V immediate branch extension
  • xcvelw โ€” 1.0 โ€” Core-V event load word extension
  • xcvmac โ€” 1.0 โ€” Core-V multiply-accumulate extension
  • xcvsimd โ€” 1.0 โ€” Core-V SIMD extension
  • xsfcease โ€” 1.0 โ€” SiFive CEASE instruction extension
  • xsfvcp โ€” 1.0 โ€” SiFive VCIX vector coprocessor extension
  • xsfvfnrclipxfqf โ€” 1.0 โ€” SiFive FP32-to-int8 ranged clip instructions
  • xsfvqmaccdod โ€” 1.0 โ€” SiFive int8 matrix multiplication extension
  • xsfvqmaccqoq โ€” 1.0 โ€” SiFive int8 matrix multiplication 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
  • xtheadvector โ€” 1.0 โ€” T-head vector extension
  • xventanacondops โ€” 1.0 โ€” Ventana integer conditional operations extension
  • xmipscmov โ€” 1.0 โ€” Mips conditional move extension
  • xmipscbop โ€” 1.0 โ€” Mips prefetch extension
  • xandesperf โ€” 5.0 โ€” Andes performace extension
  • xandesbfhcvt โ€” 5.0 โ€” Andes bfloat16 conversion extension
  • xandesvbfhcvt โ€” 5.0 โ€” Andes vector bfloat16 conversion extension
  • xandesvsintload โ€” 5.0 โ€” Andes vector INT4 load extension
  • xandesvpackfph โ€” 5.0 โ€” Andes vector packed FP16 extension
  • xandesvdot โ€” 5.0 โ€” Andes vector dot product extension
  • xsmtvdot โ€” 1.0 โ€” SpacemiT vector dot product extension

okay so real talk bestie ๐ŸŒธ when -march= isn't specified at all, GCC just borrows the setting from -mcpu. the way it just inherits it like that ๐Ÿ’…

and if BOTH -march and -mcpu= are missing? then the default is system dependent, no cap. so if you want a specific architecture extension, bestie, you gotta specify one explicitly. don't just vibe and hope ๐Ÿ™ˆ

also โ€” when the RISC-V specifications define an extension as depending on other extensions, GCC implicitly adds those dependent extensions to the enabled extension set if they weren't added explicitly. it's giving "we got you, don't worry about it" energy ๐Ÿซถ

๐ŸŽ€ Core Name ๐ŸŽ€

  • -mcpu=processor-string โ€” use the architecture of, and optimize the output for, the given processor, specified by a particular CPU name. the permissible values for this option 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-p450,
    • sifive-p670,
    • thead-c906,
    • xt-c908,
    • xt-c908v,
    • xt-c910,
    • xt-c910v2,
    • xt-c920,
    • xt-c920v2,
    • tt-ascalon-x,
    • tt-ascalon-d8,
    • xiangshan-nanhu,
    • xiangshan-kunminghu,
    • mips-p8700,
    • andes-n22,
    • andes-n25,
    • andes-a25,
    • andes-nx25,
    • andes-ax25,
    • andes-a27,
    • andes-ax27,
    • andes-n225,
    • andes-d23,
    • andes-n45,
    • andes-nx45,
    • andes-a45,
    • andes-ax45,
    • spacemit-x60.
heads up bestie: -mcpu does NOT override -march or -mtune. it's not that kind of party ๐Ÿ’€

โœจ Tune Name โœจ

  • -mtune=processor-string โ€” optimize the output for the given processor, specified by microarchitecture or particular CPU name. the permissible values for this option are:
    • generic,
    • rocket,
    • sifive-3-series,
    • sifive-5-series,
    • sifive-7-series,
    • sifive-p400-series,
    • sifive-p600-series,
    • tt-ascalon-x,
    • tt-ascalon-d8,
    • thead-c906,
    • xt-c908,
    • xt-c908v,
    • xt-c910,
    • xt-c910v2,
    • xt-c920,
    • xt-c920v2,
    • xiangshan-nanhu,
    • xiangshan-kunminghu,
    • spacemit-x60,
    • generic-ooo,
    • size,
    • mips-p8700,
    • andes-25-series,
    • andes-23-series,
    • andes-45-series,
    • and all valid options for -mcpu=.

when -mtune= isn't specified, GCC takes the setting from -mcpu. and the default is generic if neither one is specified. periodt โœจ

and about the size choice โ€” bestie, this one is not intended for use by end-users. it's used when -Os is specified. it overrides the instruction cost info that -mtune= provides, but it does not override the pipeline info. it just helps reduce code size while still giving good performance. iykyk ๐Ÿ’…


  • -mpreferred-stack-boundary=num โ€” attempt to keep the stack boundary aligned to a 2 raised to num byte boundary. if -mpreferred-stack-boundary isn't specified, the default is 4 (16 bytes or 128-bits). ๐Ÿงš
โš ๏ธ warning bestie: if you use this switch, then you must build all modules with the same value, including any libraries. that includes the system libraries and startup modules. no mixing, no chaos, fr fr ๐Ÿ˜ญ
  • -msmall-data-limit=n โ€” put 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. โญ
  • -mmovcc
  • -mno-movcc โ€” do or don't produce branchless conditional-move code sequences even with targets that do not have specific instructions for conditional operations. if enabled, sequences of ALU operations are produced using base integer ISA instructions where profitable. ๐Ÿ’…
  • -minline-atomics
  • -mno-inline-atomics โ€” do or don't use smaller but slower subword atomic emulation code that uses libatomic function calls. the default is to use fast inline subword atomics that do not require libatomic. ๐Ÿ”ฅ
  • -minline-strlen
  • -mno-inline-strlen โ€” do or do not attempt to inline "strlen" calls if possible. inlining can only be done if the string is properly aligned and instructions for accelerated processing are available. the default is to inline "strlen" calls. ๐ŸŒธ
  • -minline-strcmp
  • -mno-inline-strcmp โ€” do or do not attempt to inline "strcmp" calls if possible. inlining can only be done if the strings are properly aligned and instructions for accelerated processing are available. the default is to inline "strcmp" calls. ๐ŸŒˆ
  • -minline-strncmp
  • -mno-inline-strncmp โ€” do or do not attempt to inline "strncmp" calls if possible. inlining can only be done if the strings are properly aligned and instructions for accelerated processing are available. the default is to inline "strncmp" calls. ๐Ÿฆ‹
  • -mstringop-strategy=strategy โ€” specify a particular strategy for inlining string and memory operations. strategy may be one of auto, libcall, scalar, or vector. โœจ
  • -mshorten-memrefs
  • -mno-shorten-memrefs โ€” do or do not attempt to make more use of compressed load/store instructions by replacing a load/store of 'base register + large offset' with a new load/store of 'new base + small offset'. if the new base gets stored in a compressed register, then the new load/store can be compressed. currently targets 32-bit integer load/stores only. ๐Ÿ‘‘

  • -mstrict-align, -mno-strict-align โ€” bestie, this one controls whether we generate unaligned memory accesses or not. The default gets picked for you based on whether the processor we're optimizing for supports fast unaligned access. So it's not vibes, it's hardware detective work. ๐Ÿ”
  • -mscalar-strict-align, -mno-scalar-strict-align โ€” same deal: do or don't generate unaligned memory accesses, default set by whether the processor we're optimizing for supports fast unaligned access. Oh and btw, this is literally just an alias for -mstrict-align. Twin sisters fr fr. ๐Ÿ‘ฏ
  • -mvector-strict-align, -mno-vector-strict-align โ€” do or don't generate unaligned vector memory accesses. Default is off unless the processor we're optimizing for explicitly supports element-misaligned vector memory access. Yes, "element-misaligned" is a real phrase, we're all fine here. ๐Ÿ˜ญ
  • -mmax-vectorization, -mno-max-vectorization โ€” turn on or off an override to the vectorizer cost model that makes vectorization always appear profitable. And listen, this is not the same as -fno-vect-cost-model or -fvect-cost-model=unlimited โ€” the difference is that this option does not turn off cost comparison between different vector modes. Different vibe entirely, no cap. ๐Ÿ’…
  • -mcmodel=medlow โ€” generate code for the medium-low code model. The program and its statically defined symbols must lie within a single 2 GiB address range, and must lie between absolute addresses -2 GiB and +2 GiB. Programs can be statically or dynamically linked. This is the default code model unless GCC has been configured with --with-cmodel= specifying a different 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.
Heads up bestie: the code generated by the medium-any code model is position-independent, but it is not guaranteed to function correctly when linked into position-independent executables or libraries. That's a real caveat, don't skip it. ๐Ÿ™ˆ
  • -mcmodel=large โ€” generate code for a large code model, which has no restrictions on size or placement of symbols. Absolute freedom, main character energy, no rules. โœจ
  • -mexplicit-relocs, -mno-explicit-relocs โ€” use or don't use assembler relocation operators when dealing with symbolic addresses. The alternative is to use assembler macros instead, which may limit optimization. Tradeoffs, always tradeoffs. ๐Ÿ˜ฎโ€๐Ÿ’จ
  • -mrelax, -mno-relax โ€” take advantage of linker relaxations to reduce the number of instructions required to materialize symbol addresses. The default is to take advantage of linker relaxations, so relax (get it). ๐Ÿง˜
  • -mriscv-attribute, -mno-riscv-attribute โ€” emit (or don't emit) the RISC-V attribute to record extra information into ELF objects. This feature requires at least binutils 2.32. Minimum version check, we love an entry requirement. โญ
  • -mcsr-check, -mno-csr-check โ€” enables or disables the CSR checking.
  • -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 register, we love to see it. ๐ŸŽ
  • -malign-data=type โ€” control 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.
Support for RISC-V big-endian is experimental. The ABI is not yet stable and could change in incompatible ways in future releases. Proceed accordingly, bestie. ๐Ÿ’€
  • -mlittle-endian โ€” generate little-endian code. This is the default when GCC is configured for a riscv64-*-* or riscv32-*-* but not a riscv64be-*-* or riscv32be-*-* target.
  • -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 per-thread canary in the TLS block.

With the latter choice, the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which register to use as base register for reading the canary, and from what offset from that base register. There is no default register or offset as this is entirely for use within the Linux kernel. Kernel-only, iykyk. ๐Ÿง

  • -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 is the default. Classic, timeless, trad. ๐ŸŽ€
  • -mrvv-vector-bits=value โ€” specify how the number of bits for an RVV vector register, as taken from the -march= option, is interpreted. The value parameter is specified as a string keyword and may be one of scalable or zvl. The default is scalable, which tells GCC to interpret the number as a minimum, while zvl tells GCC to use exactly the number of bits specified. โœจ
  • -mrvv-max-lmul=value โ€” this option allows explicit control over the maximum length multiplier (LMUL) used when generating code for the RISC-V Vector Extensions (RVV). The value parameter is specified as a string keyword and may be one of m1, m2, m4, m8, or dynamic. The default is m1 for compatibility with existing hardware that does not support the other options. Backwards compat stays winning. ๐Ÿ†
  • -madjust-lmul-cost, -mno-adjust-lmul-cost โ€” this option adjusts the cost model used to schedule vector instructions to multiply the latency of instructions by the RVV length multiplier, LMUL. It is disabled by default.
  • -mautovec-segment, -mno-autovec-segment โ€” enable or disable generation of vector segment load/store instructions. This option is enabled by default. She's on by default, as she should be. ๐Ÿ’–

๐ŸŒธ RL78 Options ๐ŸŒธ

  • -msim โ€” links in additional target libraries to support operation within a simulator.
  • -mmul=none, -mmul=g10, -mmul=g13, -mmul=g14, -mmul=rl78 โ€” specifies the type of hardware multiplication and division support to be used. The simplest is none, which uses software for both multiplication and division. This is the default. The g13 value is for the hardware multiply/divide peripheral found on the RL78/G13 (S2 core) targets. The g14 value selects the use of the multiplication and division instructions supported by the RL78/G14 (S3 core) parts. The value rl78 is an alias for g14 and the value mg10 is an alias for none.

In addition a C preprocessor macro is defined, based upon the setting of this option. Possible values are: __RL78_MUL_NONE__, __RL78_MUL_G13__ or __RL78_MUL_G14__.

  • -mcpu=g10, -mcpu=g13, -mcpu=g14, -mcpu=rl78 โ€” specifies the RL78 core to target. The default is the G14 core, also known as an S3 core or just RL78. The G13 or S2 core does not have multiply or divide instructions; instead it uses a hardware peripheral for these operations. The G10 or S1 core does not have register banks, so it uses a different calling convention.

If this option is set it also selects the type of hardware multiply support to use, unless this is overridden by an explicit -mmul=none option on the command line. Thus specifying -mcpu=g13 enables the use of the G13 hardware multiply peripheral and specifying -mcpu=g10 disables the use of hardware multiplications altogether.

Note, although the RL78/G14 core is the default target, specifying -mcpu=g14 or -mcpu=rl78 on the command line does change the behavior of the toolchain since it also enables G14 hardware multiply support. If these options are not specified on the command line, then software multiplication routines are used even though the code targets the RL78 core. This is for backward compatibility with older toolchains which did not have hardware multiply and divide support. Weird? Yes. Historic? Also yes. ๐Ÿซถ

In addition a C preprocessor macro is defined, based upon the setting of this option. Possible values are: __RL78_G10__, __RL78_G13__ or __RL78_G14__.

  • -mg10, -mg13, -mg14, -mrl78 โ€” these are aliases for the corresponding -mcpu= option. They are provided for backwards compatibility.
  • -mallregs โ€” allow the compiler to use all of the available registers. By default registers r24..r31 are reserved for use in interrupt handlers. With this option enabled these registers can be used in ordinary functions as well. Unlock the whole roster. ๐Ÿ”“
  • -mrelax, -mno-relax โ€” enable/disable assembler and linker relaxation. This is enabled by default at -Os.
  • -mes0 โ€” assume ES is zero throughout program execution, and use it to address read-only data.
  • -msave-mduc-in-interrupts, -mno-save-mduc-in-interrupts โ€” specifies that interrupt handler functions should preserve the MDUC registers. This is only necessary if normal code might use the MDUC registers, for example because it performs multiplication and division operations. The default is to ignore the MDUC registers as this makes the interrupt handlers faster. The target option -mg13 needs to be passed for this to work as this feature is only available on the G13 target (S2 core). The MDUC registers are only saved if the interrupt handler performs a multiplication or division operation or it calls another function. Very specific, very conditional, we respect the precision. ๐ŸŽฏ

๐Ÿ’œ IBM RS/6000 and PowerPC Options ๐Ÿ’œ

These -m options are defined for the IBM RS/6000 and PowerPC:

  • -mcpu=cpu_type โ€” set architecture type, register usage, and instruction scheduling parameters for machine type cpu_type. 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, future, powerpc, powerpc64, powerpc64le, rs64, and native. That's the whole guest list, bestie. ๐ŸŽŸ๏ธ

-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 cpu type detects and selects the architecture option that corresponds to the host processor of the system performing the compilation. -mcpu=native has no effect if GCC does not recognize the processor. Sorry, if GCC doesn't know her, nothing happens. ๐Ÿคท

The other options pick one specific processor. Code made with those runs best on that processor โ€” and lowkey might not run at all on others. ๐Ÿ’€

The -mcpu options automatically enable or disable these bad boys:

  • -maltivec
  • -mfprnd
  • -mhard-float
  • -mmfcrf
  • -mmultiple
  • -mpopcntb
  • -mpopcntd
  • -mpowerpc64
  • -mpowerpc-gpopt
  • -mpowerpc-gfxopt
  • -mmulhw
  • -mdlmzb
  • -mmfpgpr
  • -mvsx
  • -mcrypto
  • -mhtm
  • -mpower8-fusion
  • -mquad-memory
  • -mquad-memory-atomic
  • -mfloat128
  • -mfloat128-hardware
  • -mprefixed
  • -mpcrel
  • -mmma
  • -mdense-math
  • -mrop-protect

Bestie, important: which exact options get toggled for any given CPU changes between compiler versions, depending on whatever setting seems to spit out the most optimal code for that CPU. It does not necessarily reflect what the actual hardware can even do. So if you wanna set one individual option to a specific value, just say it after the -mcpu option, like this:

-mcpu=970 -mno-altivec

On AIX, -maltivec and -mpowerpc64 are not enabled or disabled by -mcpu at the moment, because AIX doesn't have full support for these options. You can still flip them on or off individually if you're sure it'll work in your environment. ๐Ÿซก

In other cases, we recommend you use the -mcpu=cpu_type option rather than the options that control generation of specific instructions. Fr fr, just do that. โœจ


  • -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. Same values for cpu_type apply to -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. Iconic teamwork. ๐Ÿ’…
  • -mpowerpc64, -mno-powerpc64 โ€” -mpowerpc64 lets GCC generate the extra 64-bit instructions found in the full PowerPC64 architecture, and treats GPRs as 64-bit, doubleword quantities. GCC defaults to -mno-powerpc64.
  • -mcmodel=small โ€” Generates PowerPC64 code for the small model: the TOC is limited to 64k.
  • -mcmodel=medium โ€” Generates 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 โ€” Generates 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.
  • -mprofile-kernel โ€” Available on PowerPC64 GNU/Linux targets. When used with -pg, it causes calls to mcount to be inserted before the function prologue instead of after it.
  • -maltivec, -mno-altivec โ€” Generate code that uses (or does not use) AltiVec instructions, and also enable the use of built-in functions that allow more direct access to the AltiVec instruction set. You may also need to set -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. Slay, endianness. ๐ŸŒˆ

  • -mpowerpc-gpopt, -mno-powerpc-gpopt โ€” Specifying -mpowerpc-gpopt allows GCC to use the optional PowerPC architecture instructions in the General Purpose group, including floating-point square root. Specifying
  • -mpowerpc-gfxopt, -mno-powerpc-gfxopt โ€” -mpowerpc-gfxopt allows GCC to use the optional PowerPC architecture instructions in the Graphics group, including floating-point select.
  • -mmfcrf, -mno-mfcrf โ€” -mmfcrf 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.
  • -mpopcntb, -mno-popcntb โ€” -mpopcntb 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.
  • -mpopcntd, -mno-popcntd โ€” -mpopcntd lets GCC generate the popcount instruction implemented on the POWER7 processor and other processors that support the PowerPC V2.06 architecture.
  • -mfprnd, -mno-fprnd โ€” -mfprnd lets GCC generate the FP round to integer instructions implemented on the POWER5+ processor and other processors that support the PowerPC V2.03 architecture.
  • -mcmpb, -mno-cmpb โ€” -mcmpb lets GCC generate the compare bytes instruction implemented on the POWER6 processor and other processors that support the PowerPC V2.05 architecture.
  • -mhard-dfp, -mno-hard-dfp โ€” -mhard-dfp lets GCC generate the decimal floating-point instructions implemented on some POWER processors.
  • -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.
  • -msplit-patch-nops โ€” When adding NOPs for a patchable area via the -fpatchable-function-entry option, emit the "before" NOPs in front of the global entry point and the "after" NOPs after the local entry point. This makes the sequence of NOPs not consecutive when a global entry point is generated. Without this option the NOPs are emitted directly before and after the local entry point, making them consecutive but moving global and local entry point further apart. If only a single entry point is generated this option has no effect.
  • -misel, -mno-isel โ€” This switch enables or disables the generation of ISEL instructions.
  • -mvsx, -mno-vsx โ€” Generate code that uses (does not use) vector/scalar (VSX) instructions, and also enable the use of built-in functions that allow more direct access to the VSX instruction set.
  • -mcrypto, -mno-crypto โ€” Enable the use (disable) of the built-in functions that allow direct access to the cryptographic instructions that were added in version 2.07 of the PowerPC ISA. ๐Ÿ”
  • -mhtm, -mno-htm โ€” Enable (disable) the use of the built-in functions that allow direct access to the Hardware Transactional Memory (HTM) instructions that were added in version 2.07 of the PowerPC ISA.
  • -mpower8-fusion, -mno-power8-fusion โ€” Generate code that keeps (does not keeps) some integer operations adjacent so that the instructions can be fused together on power8 and later processors.
  • -mquad-memory, -mno-quad-memory โ€” Generate code that uses (does not use) the non-atomic quad word memory instructions. The -mquad-memory option requires use of 64-bit mode.
  • -mquad-memory-atomic, -mno-quad-memory-atomic โ€” Generate code that uses (does not use) the atomic quad word memory instructions. The -mquad-memory-atomic option requires use of 64-bit mode.
  • -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. The 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 also enables the generation of ISA 3.0 IEEE 128-bit floating point instructions. Otherwise, if you do not specify generation of ISA 3.0 instructions or you are targeting a 32-bit big-endian system, IEEE 128-bit floating point is handled with software emulation.

  • -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 โ€” Modify generation of the TOC (Table Of Contents), which is created for every executable file. The -mfull-toc option is selected by default. In that case, GCC allocates at least one TOC entry for each unique non-automatic variable reference in your program. GCC also places floating-point constants in the TOC. However, only 16,384 entries are available in the TOC.

If you get a linker error message saying you've overflowed the available TOC space, you can reduce the amount of TOC space used with the -mno-fp-in-toc and -mno-sum-in-toc options. -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 options. Each one makes GCC produce very slightly slower and larger code at the expense of conserving TOC space. Trade-offs, bestie. ๐Ÿ™ˆ

If you still run out of space in the TOC even when you specify both of these options, specify -mminimal-toc instead. This option causes GCC to make only one TOC entry for every file. When you specify this option, GCC produces code that is slower and larger but which uses extremely little TOC space. You may wish to use this option only on files that contain less frequently-executed code. ๐Ÿ‘‘


  • -maix64, -maix32 โ€” okay bestie, this is the 64-bit AIX ABI glow-up ๐Ÿ’… Turning on -maix64 gets you 64-bit pointers, a 64-bit long type, and literally all the infrastructure needed to make them work. Plot twist: -maix64 implies -mpowerpc64, and -maix32 does the opposite โ€” it turns OFF the 64-bit ABI and implies -mno-powerpc64. GCC's default vibe here is -maix32.
  • -mxl-compat, -mno-xl-compat โ€” makes your code behave more like IBM XL compiler semantics when you're using the AIX-compatible ABI ๐ŸŽ€ What that means in practice: floating-point arguments get passed to prototyped functions beyond the register save area (RSA) on the stack, in addition to argument FPRs. Also, it won't 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. โœจ

Storytime: the AIX calling convention got extended but wasn't documented at first, to handle a lowkey obscure K&R C case โ€” calling a function that takes the address of its arguments with fewer arguments than declared ๐Ÿ™ˆ. IBM XL compilers access floating-point arguments that don't fit in the RSA from the stack when a subroutine is compiled without optimization. But likeโ€ฆ always storing floating-point arguments on the stack is inefficient and rarely needed, so this option is not enabled by default and only becomes necessary when you're calling subroutines compiled by IBM XL compilers without optimization. iykyk.

  • -mpe โ€” supports the IBM RS/6000 SP Parallel Environment (PE). It links an application written to use message passing with special startup code so the app can actually 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 point at the right directory. Also, the Parallel Environment does not support threads, so -mpe and -pthread are incompatible. No cap. ๐Ÿšซ
  • -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) onto their natural size-based boundary. -malign-power tells GCC to follow the ABI-specified alignment rules instead. GCC defaults to the standard alignment defined in the ABI. ๐ŸŒธ

Heads up: on 64-bit Darwin, natural alignment is the default, and -malign-power is not supported there. ๐Ÿ’€

  • -msoft-float, -mhard-float โ€” generate code that does not use (or uses) the floating-point register set. If you go with -msoft-float, software floating-point emulation is provided โ€” and you gotta pass the option to GCC when linking too. ๐Ÿ”—
  • -mmultiple, -mno-multiple โ€” generate code that uses (or does not use) the load multiple word instructions and the store multiple word instructions. These instructions are generated by default on POWER systems, and not generated on PowerPC systems. ๐Ÿซถ
Careful bestie: do NOT use -mmultiple on little-endian PowerPC systems, because 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 does not use) the load or store instructions that update the base register to the address of the calculated memory location. These 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 can incur a performance penalty on Power6 processors in certain situations, like 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 does not use) the floating-point multiply and accumulate instructions. These are generated by default if hardware floating point is used. Update: 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 does not use) the half-word multiply and multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors. These are generated by default when targeting those processors. ๐Ÿงš
  • -mdlmzb, -mno-dlmzb โ€” generate code that uses (or does not 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. โœจ

Example time, bestie: 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. The way it just shrinks?? iconic. ๐ŸŽ€

  • -mbit-word, -mno-bit-word โ€” allow bit-fields to cross word boundaries. ๐Ÿฆ‹
  • -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 โ€” that's 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. And psst โ€” -mrelocatable code aligns the stack to an 8-byte boundary. ๐Ÿ‘‘
  • -mrelocatable-lib, -mno-relocatable-lib โ€” just 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. Mix and match, periodt. ๐Ÿ’…
  • -mlittle, -mlittle-endian โ€” on System V.4 and embedded PowerPC systems, compile code for the processor in little-endian mode. The -mlittle-endian option is the same as -mlittle. ๐Ÿ“
  • -mbig, -mbig-endian โ€” on System V.4 and embedded PowerPC systems, compile code for the processor in big-endian mode. The -mbig-endian option is the same as -mbig. ๐ŸŒธ
  • -mdynamic-no-pic โ€” on Darwin / macOS systems, compile code so that it is not relocatable, but its external references are relocatable. The resulting code is suitable for applications, but not shared libraries. โš ๏ธ
  • -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. ๐Ÿซก
  • -mprioritize-restricted-insns=priority โ€” this option controls the priority assigned to dispatch-slot restricted instructions during the second scheduling pass. The argument priority takes the value 0, 1, or 2 to assign no, highest, or second-highest (respectively) priority to dispatch-slot restricted instructions. ๐Ÿ”ฅ
  • -msched-costly-dep=dependence_type โ€” this option controls which dependences are considered costly by the target during instruction scheduling. The argument dependence_type takes one of the following values:
    • no โ€” no dependence is costly.
    • all โ€” all dependences are costly.
    • 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 for which the latency is greater than or equal to number is costly.
  • -minsert-sched-nops=scheme โ€” this option controls which NOP insertion scheme is used during the second scheduling pass. The argument scheme takes one of the following values:
    • no โ€” don't insert NOPs.
    • 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 to 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 to 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 โ€” select the type of traceback table. Valid values for traceback_type are full, part, and no. ๐Ÿฆ‹
  • -maix-struct-return โ€” return all structures in memory (as specified by the AIX ABI). ๐Ÿ“ฆ
  • -msvr4-struct-return โ€” return structures smaller than 8 bytes in registers (as specified by the SVR4 ABI). ๐ŸŽ
  • -mabi=abi-type โ€” bestie, this one extends the current ABI with a specific extension, or yeets one back out. Valid values are: altivec, no-altivec, ibmlongdouble, ieeelongdouble, elfv1, elfv2, and for AIX: vec-extabi, vec-default. That's the whole menu, no substitutions ๐Ÿ’…
  • -mabi=ibmlongdouble โ€” switches the current ABI so it uses IBM extended-precision long double. Lowkey this is not likely to work if your system defaults to using IEEE extended-precision long double, so heads up ๐Ÿซถ. If you change the long double type away from IEEE extended-precision, the compiler issues a warning unless you pass -Wno-psabi. Requires -mlong-double-128 to be enabled.
  • -mabi=ieeelongdouble โ€” the mirror twin: changes the current ABI to use IEEE extended-precision long double. Also not likely to work if your system defaults to IBM extended-precision long double. If you change the long double type away from IBM extended-precision, the compiler issues a warning unless you use -Wno-psabi. Requires -mlong-double-128 to be enabled.
  • -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 ๐Ÿ’€ iconic behaviour honestly.
  • -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 energy, different endianness ๐ŸŒˆ
  • -mgnu-attribute, -mno-gnu-attribute โ€” emit .gnu_attribute assembly directives that set tag/value pairs in a .gnu.attributes section, specifying 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), which tells everything 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 that bit.
  • -msim โ€” on embedded PowerPC systems, assume 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. (yes the name is real, we love a quirky target ๐Ÿ’›)
  • -mvxworks โ€” on System V.4 and embedded PowerPC systems, specify that you are 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 (or do not) adhere to the Embedded Applications Binary Interface (EABI), which is a set of modifications to the System V.4 specifications. Picking -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. Picking -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. The -meabi option 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 sits adjacent to the .sdata section. The -msdata=eabi option is incompatible with the -mrelocatable option ๐Ÿšจ and it also sets the -memb option.
  • -msdata=sysv โ€” on System V.4 and embedded PowerPC systems, put small global and static data in the .sdata section, pointed to by register r13. Put small uninitialized global and static data in the .sbss section, adjacent to .sdata. The -msdata=sysv option is incompatible with the -mrelocatable option.
  • -msdata=default, -msdata โ€” on System V.4 and embedded PowerPC systems, if -meabi is used, compile code exactly like -msdata=eabi; otherwise compile code exactly like -msdata=sysv.
  • -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 though. 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 (stuff like calls to memcpy or structure copies) that are 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) that are 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 โ€” generate an inline expansion using loop code for all block compares that are less than or equal to num bytes, but greater than the limit for non-loop inline block compare expansion. If the block length isn't constant, at most num bytes are compared before memcmp is called to handle the rest of the block. The default value is target-specific.
  • -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 at the end of the inline compare, a call to strcmp or strncmp takes care of the rest of the comparison. The default is 64 bytes ๐Ÿ“
  • -G num โ€” on embedded PowerPC systems, put global and static items 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 is also passed to the linker, and all modules should be compiled with the same -G num value โ€” no mixing and matching bestie ๐Ÿ™ˆ
  • -mregnames, -mno-regnames โ€” on System V.4 and embedded PowerPC systems, do (or do not) emit register names in the assembly language output using symbolic forms.
  • -mlongcall, -mno-longcall โ€” by default, assume that all calls are far away so that a longer and more expensive calling sequence is required. This is required for calls farther than 32 megabytes (33,554,432 bytes) from the current location. A short call is generated if the compiler knows the call can't possibly be that far away. This setting can be overridden by the shortcall function attribute, or by #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 just generate slower code. As of this writing, the AIX linker can do this, as can the GNU linker for PowerPC/64. There are plans to add this feature to the GNU linker for 32-bit PowerPC systems as well.

On PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, GCC can generate long calls using an inline PLT call sequence (see -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). The 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 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 โ˜•)

  • -mpltseq, -mno-pltseq โ€” implement (or do not implement) -fno-plt and long calls using an inline PLT call sequence that supports lazy linking and long calls to functions in dlopen'd shared libraries. Inline PLT calls are only supported on PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, and are enabled by default if 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 do not 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 ๐Ÿ”ฅ
  • -mrecip
  • -mno-recip

Okay so bestie, this one turns on using the reciprocal estimate and reciprocal square root estimate instructions, plus extra Newton-Raphson steps to bump up the precision โ€” instead of actually doing a divide or a square root plus divide for floating-point args. ๐Ÿ’… 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). And like, fair warning: even though the throughput of the sequence is generally higher than the throughput of the non-reciprocal instruction, the precision can drop by up to 2 ulp โ€” like, the inverse of 1.0 equals 0.99999994 โ€” for reciprocal square roots. It's giving "fast but slightly delulu." ๐Ÿ˜ญ

  • -mrecip=opt

This one controls which reciprocal estimate instructions are allowed to show up. opt is a comma-separated list of options, and any of them can be preceded by a "!" to invert it:

  • all โ€” Enable all estimate instructions. Go big or go home. โœจ
  • 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 handle the double-precision reciprocal square root calculations. It's the "everything but that one thing" of compiler flags. ๐Ÿ™ˆ

  • -mrecip-precision
  • -mno-recip-precision

Assume (or do not 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 do not provide an estimate that converges after three steps. No cap, three steps just isn't enough. ๐Ÿ’€

  • -mveclibabi=type

Specifies the ABI type to use for vectorizing intrinsics using an external library. The only type supported at present is mass, which specifies 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. The MASS libraries must be specified at link time. That's a whole lot of names, and yes, you do have to have them all. ๐Ÿซถ

  • -mfriz
  • -mno-friz

Generate (or do not 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. Heads up: the "friz" instruction does not return the same value if the floating-point number is too large to fit in an integer. It's giving "close enough" energy and honestly, that's a whole mood. ๐Ÿ™ˆ

  • -mpointers-to-nested-functions
  • -mno-pointers-to-nested-functions

Generate (or do not 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, TOC value to be loaded in register "r2", and static chain value to be loaded in register "r11". The -mpointers-to-nested-functions is on by default. And like โ€” you genuinely 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. That's not a vibe, that's a hard no. ๐Ÿ’€

  • -msave-toc-indirect
  • -mno-save-toc-indirect

Generate (or do not generate) code to save the TOC value in the reserved stack location in the function prologue if the function calls through a pointer on AIX and 64-bit Linux systems. If the TOC value is not saved in the prologue, it is saved just before the call through the pointer. The -mno-save-toc-indirect option is the default.

  • -mcompat-align-parm
  • -mno-compat-align-parm

Generate (or do not generate) code to pass structure parameters with a maximum alignment of 64 bits, for compatibility with older versions of GCC. Blast from the past moment, ngl.

Older versions of GCC (prior to 4.9.0) incorrectly did not align a structure parameter on a 128-bit boundary when that structure contained a member requiring 128-bit alignment. This is corrected in more recent versions of GCC. This option may be used to generate code that is compatible with functions compiled with older versions of GCC.

The -mno-compat-align-parm option is the default. Slay, we're modern here. โœจ

  • -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 global canary or tls for per-thread canary in the TLS block (the default with GNU libc version 2.4 or later). ๐Ÿค

With the latter choice, the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which register to use as base register for reading the canary, and from what offset from that base register. The default for those is as specified in the relevant ABI.

  • -mpcrel
  • -mno-pcrel

Generate (or do not generate) pc-relative addressing. The -mpcrel option requires that the medium code model (-mcmodel=medium) and prefixed addressing (-mprefixed) options are enabled. Package deal, bestie. ๐ŸŽ€

  • -mprefixed
  • -mno-prefixed

Generate (or do not generate) addressing modes using prefixed load and store instructions. The -mprefixed option requires that the option -mcpu=power10 (or later) is enabled.

  • -mmma
  • -mno-mma

Generate (or do not generate) the MMA instructions. The -mma option requires that the option -mcpu=power10 (or later) is enabled.

  • -mdense-math
  • -mno-dense-math

Generate (or do not generate) Dense Math Facility (DMF) instructions. The -mdense-math option requires that the option -mcpu=future (or later) is enabled. Future CPU era, we're manifesting it. ๐Ÿ”ฎ

  • -mrop-protect
  • -mno-rop-protect

Generate (or do not generate) ROP protection instructions when the target processor supports them. Currently this option disables the shrink-wrap optimization (-fshrink-wrap).

  • -mprivileged
  • -mno-privileged

Generate (or do not generate) code that runs in privileged state. Fancy. ๐Ÿ‘‘

  • -mblock-ops-unaligned-vsx
  • -mno-block-ops-unaligned-vsx

Generate (or do not generate) unaligned vsx loads and stores for inline expansion of "memcpy" and "memmove".

  • -msplat-word-constant
  • -mno-splat-word-constant

Generate (or do not generate) code that uses the "XXSPLTIW" instruction. This option is enabled by default.

  • -msplat-float-constant
  • -mno-splat-float-constant

Generate (or do not generate) code that uses the "XXSPLTIDP" instruction. This option is enabled by default.

  • -mieee128-constant
  • -mno-ieee128-constant

Generate (or do not generate) code that uses the "LXVKQ" instruction. This option is enabled by default.

  • -mwarn-altivec-long
  • -mno-warn-altivec-long

Enable or disable warnings about deprecated vector long ... Altivec type usage. This option is enabled by default. She's watching you, be careful. ๐Ÿ‘€


๐Ÿฆ‹ RX Options ๐Ÿฆ‹

These command-line options are defined for RX targets, bestie:

  • -m64bit-doubles
  • -m32bit-doubles

Make the "double" data type be 64 bits (-m64bit-doubles) or 32 bits (-m32bit-doubles) in size. The default is -m32bit-doubles. Note RX floating-point hardware only works on 32-bit values, which is why the default is -m32bit-doubles. It's not a choice, it's just the hardware being picky. ๐Ÿ˜ญ

  • -fpu
  • -nofpu

Enables (-fpu) or disables (-nofpu) the use of RX floating-point hardware. The default is enabled for the RX600 series and disabled for the RX200 series.

Floating-point instructions are only generated for 32-bit floating-point values, however, so the FPU hardware is not used for doubles if the -m64bit-doubles option is used.

Note: If the -fpu option is enabled then -funsafe-math-optimizations is also enabled automatically. This is because the RX FPU instructions are themselves unsafe. Like, they said it, not me. ๐Ÿ’€
  • -mcpu=name

Selects the type of RX CPU to be targeted. Currently three types are supported: the generic RX600 and RX200 series hardware, and 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.

The RX200 series does not have a hardware floating-point unit and so -nofpu is enabled by default when this type is selected.

  • -mbig-endian-data
  • -mlittle-endian-data

Store data (but not code) in the big-endian format. The default is -mlittle-endian-data, i.e. to store 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 ensure that the area does not overflow. Also, when the small data area is used, one of the RX's registers (usually "r13") is reserved for use pointing to this area, so it is no longer available for use by the compiler. This could result in slower and/or larger code if variables are pushed onto the stack instead of being held in this register. Trade-offs, bestie, always trade-offs. โš–๏ธ

Note: common variables (variables that have not been initialized) and constants are not placed into the small data area, as they are assigned to other sections in the output executable.

The default value is zero, which disables this feature. Okay and heads up bestie: this one is not switched on by default even when you crank the optimization levels (-O2 etc), because reserving a register can genuinely make things worse. It's giving "your mileage may vary" energy. It's entirely up to the programmer to experiment and figure out whether this feature actually helps their program. โœจ And for how the actual register that holds the small data area pointer gets picked? Go read the description of the -mpid option, it's all spelled out there.

  • -msim, -mno-sim โ€” use the simulator runtime. The default is to use the libgloss board-specific runtime instead.
  • -mas100-syntax, -mno-as100-syntax โ€” when you're generating assembler output, use a syntax that plays nice with Renesas's AS100 assembler. ๐ŸŽ€ The GAS assembler can also handle this syntax, but it comes with some restrictions, which is why it is not generated by default.
  • -mmax-constant-size=N โ€” sets the maximum size, in bytes, of a constant that can be used as an operand in an RX instruction. Here's the tea: the RX instruction set does let you use constants up to 4 bytes long in instructions, but a longer value means a longer instruction. So sometimes it's genuinely beneficial to restrict the size of the constants used in instructions. ๐Ÿ’… Constants that are too big get popped 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, bestie. That's the process where the linker tries to shrink your program by hunting down shorter versions of various instructions. ๐Ÿ” Disabled by default.
  • -mint-register=N โ€” specify how many registers to reserve for fast interrupt handler functions. 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, reserves **no registers.
  • -msave-acc-in-interrupts โ€” says interrupt handler functions should preserve the accumulator register. You only need this if normal code might use the accumulator register, like when it's doing 64-bit multiplications. The default is to ignore the accumulator, because that makes the interrupt handlers faster. โšก
  • -mpid, -mno-pid โ€” enables generation of position-independent data. When it's on, any access to constant data happens via an offset from a base address held in a register. This means the location of constant data can be figured out at run time without needing the executable to be relocated โ€” huge win for embedded apps 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. That 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 yeah โ€” 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. ๐Ÿคฏ

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 โ€” stops GCC from throwing 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 it finds, 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 info.)

The default is to allow these instructions, but it is not possible for GCC to reliably detect all the circumstances where a string instruction might be used to access an I/O register, so their use cannot be disabled automatically. Instead it's reliant on the programmer to use the -mno-allow-string-insns option if their program accesses I/O space. ๐Ÿ‘ˆ

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. And lowkey important: -mno-jsr does not mean "don't use "JSR"" โ€” it means any type of branch may be used. ๐Ÿซถ
  • -mlra โ€” use the new LRA register allocator. By default, the old "reload" allocator is used.
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 ensures that it only uses the registers "r10", "r11", "r12" and/or "r13" โ€” and only provided that the normal use of the corresponding registers have been restricted via the -ffixed-reg or -mint-register command-line options.

๐ŸŒˆ S/390 and zSeries Options ๐ŸŒˆ

These are the -m options defined for the S/390 and zSeries architecture. Buckle up, bestie. ๐Ÿ’œ

  • -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 โ€” store (or don't store) the address of the caller's frame as a backchain pointer into the callee's stack frame. A backchain may be needed to allow debugging with tools that don't understand DWARF call frame information. ๐Ÿ› When -mno-packed-stack is in effect, the backchain pointer is stored at the bottom of the stack frame; when -mpacked-stack is in effect, the backchain is placed into the topmost word of the 96/160 byte register save area.

In general, code compiled with -mbackchain is call-compatible with code compiled with -mno-backchain; however, using the backchain for debugging purposes usually requires that the whole binary is built with -mbackchain. And heads up: 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 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; unused fields still take up stack space. When -mpacked-stack is specified, register save slots are densely packed at the top of the register save area; unused space gets reused for other purposes, allowing for more efficient use of the available stack space. ๐Ÿงš However, 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. But 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 does not 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. โญ Note: -m31 is deprecated and support will be removed.
  • -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 โ€” turns on a whole lil set of builtins that use the instructions from the transactional execution facility that showed up with the IBM zEnterprise EC12 machine generation S/390 System z Built-in Functions โœจ. -mhtm is on by default when you're using -march=zEC12.
  • -mvx, -mno-vx โ€” with -mvx you generate code using the instructions from the vector extension facility from the IBM z13 machine generation ๐Ÿฆ‹. Heads up tho: this option changes the ABI for some vector type values when it comes to alignment and calling conventions. If vector type values are being used in an ABI-relevant context, a GAS .gnu_attribute command gets added to mark the resulting binary with the ABI used. -mvx is on by default with -march=z13.
  • -mzvector, -mno-zvector โ€” this one enables vector language extensions and builtins using instructions from the vector extension facility from the IBM z13 machine generation ๐Ÿ‘‘. It adds support for vector to be used as a keyword for defining vector type variables and arguments. vector is only available when GNU extensions are enabled, and it is not expanded when you're requesting strict standard compliance, e.g. with -std=c99. On top of the GCC low-level builtins, -mzvector also enables a set of builtins added for compatibility with AltiVec-style implementations like Power and Cell. To actually use those builtins you must include the header file vecintrin.h ๐Ÿ“Ž. -mzvector is disabled by default.
  • -mmvcle, -mno-mvcle โ€” generate (or don't generate) code using the mvcle instruction to do block moves. When -mno-mvcle is specified, use a mvc loop instead. That's the default unless you're optimizing for size.
  • -mdebug, -mno-debug โ€” print (or don't print) extra debug info while compiling. Default is to not print debug info ๐Ÿ›.
  • -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, z17/arch15, and native.

The default is -march=z900.

Specifying native as the 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 everything applicable about the generated code to cpu-type, 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) 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 so they point to specialized trace routines that can selectively skip function trace entries for the TPF OS. This option is off by default, even when compiling for the TPF OS and specifying -mtpf-trace ๐Ÿ’€.
  • -mmain โ€” for the TPF OS target, use this when linking to add the startup code and other linker options to produce a main object.
  • -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 meant to identify functions that most probably cause a stack overflow. Useful for environments with a limited stack size, e.g. the Linux kernel ๐Ÿ“.

A value of zero disables this warning; that is the default.

  • -mwarn-dynamicstack, -mno-warn-dynamicstack โ€” emit a warning if the function calls alloca or uses dynamically-sized arrays. That's generally a bad idea when your stack size is limited ๐Ÿ™ˆ.
  • -mstack-guard=stack-guard, -mstack-size=stack-size, -mno-stack-guard, -mno-stack-size โ€” if these options are enabled, the S/390 back end emits extra instructions in the function prologue that trigger a trap if the stack size is stack-guard bytes above the stack-size (remember, 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 meant to help you debug stack overflow problems. The additionally emitted code causes only a 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 assumes that the stack starts at an address aligned to the value given by stack-size.

The -mstack-guard= option can only be used in conjunction with -mstack-size=. You can override these options on the command line with -mno-stack-guard and -mno-stack-size, respectively.

  • -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 function 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.

  • -mpic-data-is-text-relative, -mno-pic-data-is-text-relative โ€” when compiling for S/390 with -fpic or -fPIC, normally GCC emits code using relative addressing between code and data. But for hotpatching it might be required to introduce new .text parts while using the existing .data and .bss sections. In that case, use -mno-pic-data-is-text-relative to force addressing through the GOT instead.
  • -mstack-protector-guard=guard, -mstack-protector-guard-record โ€” 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).

Option -mstack-protector-guard-record results in the generation of section __stack_protector_loc containing pointers to all instructions which load the address of the global guard. So this option only has an effect in conjunction with -mstack-protector-guard=global. The intended use is for the Linux kernel.

  • -mindirect-branch=choice, -mindirect-branch-jump=choice, -mindirect-branch-call=choice, -mfunction-return=choice, -mfunction-return-mem=choice, -mfunction-return-reg=choice โ€” this whole lil group addresses security vulnerabilities related to speculative execution and indirect branch prediction by enabling replacement of indirect branches and function returns with direct branches to a thunk ๐Ÿ›ก๏ธ.

Specifying a choice of keep causes generation of the default code. thunk triggers generation of out-of-line thunks and replaces the formerly indirect branch with a direct branch to the thunk. thunk-extern does the branch replacement like thunk but does not emit the thunks. thunk-inline is only available with -mindirect-branch-jump; it should be used in preference to thunk in user-space applications to support correct stack unwinding and exception handling.

-mindirect-branch sets the value of -mindirect-branch-jump and -mindirect-branch-call. -mfunction-return sets the value of -mfunction-return-reg and -mfunction-return-mem.

All of these options can also be set on a per-function basis using function attributes.

  • -mindirect-branch-table, -mno-indirect-branch-table โ€” this one's useful alongside the -mindirect-branch and -mfunction-return options. When enabled, it causes generation of tables pointing to the branch locations which have been patched by those options. The tables are emitted in sections named .s390_indirect_jump, .s390_indirect_call, .s390_return_reg, and .s390_return_mem. Each section consists of an array of 32-bit elements; each entry holds the offset from the entry to the patched location.
  • -mfentry, -mno-fentry โ€” when used together with the -pg option, emit profiling code using the __fentry__ hook provided by GLIBC 2.29 or later. This is only available for 64-bit code. If this option is not enabled, profiling uses the less efficient _mcount hook instead.
  • -mrecord-mcount, -mno-record-mcount โ€” when enabled, generate a __mcount_loc section with the locations of all generated profiling calls to _mcount or __fentry__.
  • mnop-mcount, mno-nop-mcount โ€” instead of generating calls to _mcount or __fentry__ with -pg, insert a sequence no-op instructions of the same length at the locations where the calls would have been inserted. This can be used together with the -mrecord-mcount option to patch the call sequences into the object file without recompiling it.
  • -mpreserve-args, -mno-preserve-args โ€” when enabled, save all argument registers to the stack, and generate corresponding CFI information. This is useful for applications that want to implement their own stack unwinding and need access to function arguments ๐Ÿ’œ.
  • -munaligned-symbols, -mno-unaligned-symbols โ€” assume that external symbols with a natural alignment of 1 are potentially unaligned. By default, all symbols without explicit alignment are assumed to be aligned on a 2-byte boundary as mandated by the IBM Z ABI.

๐ŸŒˆ SH Options ๐ŸŒˆ

These -m options are defined for the SH implementations:

  • -m1 โ€” generate code for the SH1.
  • -m2 โ€” generate code for the SH2.
  • -m2e โ€” generate code for the SH2e ๐ŸŽ€.
  • -m2a-nofpu โ€” generates code for the SH2a sans FPU, or for a SH2a-FPU in a way that the floating-point unit never gets used. it's giving "we have an FPU but we're not talking to it" ๐Ÿ’…
  • -m2a-single-only โ€” generates code for the SH2a-FPU, but in such a way that no double-precision floating-point operations are used. single or nothing, bestie โœจ
  • -m2a-single โ€” generates code for the SH2a-FPU, assuming the floating-point unit is in single-precision mode by default.
  • -m2a โ€” generates code for the SH2a-FPU, assuming the floating-point unit is in double-precision mode by default. main character FPU behavior ๐Ÿ˜Œ
  • -m3 โ€” generates code for the SH3.
  • -m3e โ€” generates code for the SH3e.
  • -m4-nofpu โ€” generates code for the SH4 without a floating-point unit.
  • -m4-single-only โ€” generates code for the SH4 with a floating-point unit that only supports single-precision arithmetic.
  • -m4-single โ€” generates code for the SH4, assuming the floating-point unit is in single-precision mode by default.
  • -m4 โ€” generates code for the SH4.
  • -m4-100 โ€” generates code for SH4-100.
  • -m4-100-nofpu โ€” generates code for SH4-100 in such a way that the floating-point unit is not used.
  • -m4-100-single โ€” generates code for SH4-100, assuming the floating-point unit is in single-precision mode by default.
  • -m4-100-single-only โ€” generates code for SH4-100 in such a way that no double-precision floating-point operations are used.
  • -m4-200 โ€” generates code for SH4-200.
  • -m4-200-nofpu โ€” generates code for SH4-200 in such a way that the floating-point unit is not used.
  • -m4-200-single โ€” generates code for SH4-200, assuming the floating-point unit is in single-precision mode by default.
  • -m4-200-single-only โ€” generates code for SH4-200 in such a way that no double-precision floating-point operations are used.
  • -m4-300 โ€” generates code for SH4-300.
  • -m4-300-nofpu โ€” generates code for SH4-300 in such a way that the floating-point unit is not used.
  • -m4-300-single โ€” generates code for SH4-300 in such a way that no double-precision floating-point operations are used.
  • -m4-300-single-only โ€” generates code for SH4-300 in such a way that no double-precision floating-point operations are used.
  • -m4-340 โ€” generates code for SH4-340 (no MMU, no FPU). truly unbothered, no extras ๐ŸŽ€
  • -m4-400 โ€” generates code for SH4-400 (no MMU, no FPU).
  • -m4-500 โ€” generates code for SH4-500 (no FPU). passes -isa=sh4-nofpu to the assembler.
  • -m4a-nofpu โ€” generates code for the SH4al-dsp, or for a SH4a in such a way that the floating-point unit is not used.
  • -m4a-single-only โ€” generates code for the SH4a, in such a way that no double-precision floating-point operations are used.
  • -m4a-single โ€” generates code for the SH4a, assuming the floating-point unit is in single-precision mode by default.
  • -m4a โ€” generates code for the SH4a.
  • -m4al โ€” same as -m4a-nofpu, except that it implicitly passes -dsp to the assembler. heads up: GCC doesn't generate any DSP instructions at the moment. so it's vibes only rn ๐Ÿ’€
  • -mb โ€” compile code for the processor in big-endian mode.
  • -ml โ€” compile code for the processor in little-endian mode.
  • -mdalign โ€” align doubles at 64-bit boundaries. ๐Ÿšจ note that this changes the calling conventions, and thus some functions from the standard C library do not work unless you recompile it first with -mdalign. no cap, recompile or suffer.
  • -mrelax โ€” shorten some address references at link time, when possible; uses the linker option -relax.
  • -mbigtable โ€” use 32-bit offsets in switch tables. the default is to use 16-bit offsets.
  • -mbitops โ€” enable the use of bit manipulation instructions on SH2A. slay โœจ
  • -mfmovd โ€” enable the use of the instruction fmovd. check -mdalign for alignment constraints.
  • -mrenesas, -mno-renesas โ€” comply with the calling conventions defined by Renesas. the default for all targets of the SH toolchain is -mno-renesas, which uses the calling conventions defined for GCC before the Renesas conventions were available.
  • -mnomacsave โ€” mark the MAC register as call-clobbered, even if -mrenesas is given.
  • -mieee, -mno-ieee โ€” control the IEEE compliance of floating-point comparisons, which affects the handling of cases where the result of a comparison is unordered. by default -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. the implicit settings can be overridden by specifying either -mieee or -mno-ieee.
  • -minline-ic_invalidate, -mno-inline-ic_invalidate โ€” inline code to invalidate instruction cache entries after setting up nested function trampolines. this option has no effect if -musermode is in effect and the selected code generation option (e.g. -m4) does not allow the use of the icbi instruction. if the selected code generation option does not allow the use of the icbi instruction, and -musermode is not in effect, the inlined code manipulates the instruction cache address array directly with an associative write. not only does this require privileged mode at run time, but it also fails if the cache line had been mapped via the TLB and has become unmapped. ๐Ÿ˜ญ so many conditions bestie
  • -misize โ€” dump instruction size and location in the assembly code.
  • -matomic-model=model โ€” sets the model of atomic operations and additional parameters as a comma-separated list. for details on the atomic built-in functions see __atomic Builtins. the following models and parameters are supported:

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. the generated atomic sequences require additional support from the interrupt/exception handling code of the system and are only suitable for SH3* and SH4* single-core systems. this option is enabled by default when the target is 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. this is a variation of the gUSA sequences which can also be used on SH1* and SH2* targets. the generated atomic sequences require additional support from the interrupt/exception handling code of the system and are only suitable for single-core systems. when using this model, the gbr-offset= parameter has to be specified as well. don't forget it fr fr

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. 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. additional support from the interrupt/exception handling code of the system is not required for this model.

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 specified value must be an integer multiple of four and in the range 0-1020.

strict

this parameter prevents mixed usage of multiple atomic models, even if they are compatible, and makes the compiler generate atomic sequences of the specified model only.

  • -mtas โ€” generate the tas.b opcode for __atomic_test_and_set. โš ๏ธ notice that depending on the particular hardware and software configuration this can degrade overall performance due to the operand cache line flushes that are implied by the tas.b instruction. 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. be careful out there ๐Ÿซถ
  • -mprefergot โ€” when generating position-independent code, emit function calls using the Global Offset Table instead of the Procedure Linkage Table.
  • -musermode, -mno-usermode โ€” don't allow (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. -musermode is the default when the target is sh*-*-linux*. if the target is SH1* or SH2*, -musermode has no effect, since there is no user mode. iykyk ๐Ÿ’…
  • -multcost=number โ€” set the cost to assume for a multiply instruction.
  • -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 โ€” Okay so this one 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.

  • -maccumulate-outgoing-args, -mno-accumulate-outgoing-args โ€” Reserve space once for outgoing arguments in the function prologue rather than around each call. This is generally beneficial for performance and size, and also needed for unwinding to avoid changing the stack frame around conditional code. -maccumulate-outgoing-args is enabled the default.
  • -mdivsi3_libfunc=name โ€” Set the name of the library function used for 32-bit signed division to name. 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.
  • -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.
  • -mbranch-cost=num โ€” Assume num to be the cost for a branch instruction. Higher numbers make the compiler try to generate more branch-free code if possible. If not specified the value is selected depending on the processor type that is being compiled for.
  • -mzdcbranch, -mno-zdcbranch โ€” Assume (do not assume) that zero displacement conditional branch instructions bt and bf are fast. If -mzdcbranch is specified, the compiler prefers zero displacement branch code sequences. This is enabled by default when generating code for SH4 and SH4A. It can be explicitly disabled by specifying -mno-zdcbranch.
  • -mcbranch-force-delay-slot โ€” Force the usage of delay slots for conditional branches, which stuffs the delay slot with a nop if a suitable instruction cannot be found. By default this option is disabled. It can be enabled to work around hardware bugs as found in the original SH7055.
  • -mfsca, -mno-fsca โ€” Allow or disallow the compiler to emit the fsca instruction for sine and cosine approximations. The option -mfsca must be used in combination with -funsafe-math-optimizations. It is enabled by default when generating code for SH4A. Using -mno-fsca disables sine and cosine approximations even if -funsafe-math-optimizations is in effect.
  • -mfsrra, -mno-fsrra โ€” Allow or disallow the compiler to emit the fsrra instruction for reciprocal square root approximations. The option -mfsrra must be used in combination with -funsafe-math-optimizations and -ffinite-math-only. It is 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, -mno-pretend-cmove โ€” Prefer or don't prefer zero-displacement conditional branches for conditional move instruction patterns. This can result in faster code on the SH4 processor.
  • -mfdpic, -mno-fdpic โ€” Generate code using the FDPIC ABI.
  • -mlra, -mno-lra โ€” Use the new LRA register allocator. By default, the old reload allocator is used.

โ˜€๏ธ Solaris 2 Options โ˜€๏ธ

These options are supported on Solaris 2:

  • -mclear-hwcap, -mno-clear-hwcap โ€” -mclear-hwcap tells the compiler to remove the hardware capabilities generated by the Solaris assembler. This is only necessary when object files use ISA extensions not supported by the current machine, but check at runtime whether or not to use them.
  • -mimpure-text, -mno-impure-text โ€” -mimpure-text, used in addition to -shared, tells the compiler to not pass -z text to the linker when linking a shared object. Using 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.

  • -gsctf โ€” Generate Solaris CTF. Needs to be used both for compilation and linking. See ctf(7) for more information. This is only supported since Solaris 11.4 SRU 84 where the necessary toolchain support was added.

๐Ÿ›ธ 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 the global register 1, each global register 2 through 4 is then treated as an allocable register that is clobbered by function calls. This is the default.

To be fully SVR4 ABI-compliant at the cost of some performance loss, specify -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 are 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 cannot be done directly in cross-compilation. You must 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.

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

  • -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 are contained in another type, or if they have an absolute address. Otherwise, it assumes they have 4-byte alignment. Specifying this option avoids some rare compatibility problems with code generated by other compilers. It is not the default because it results in a performance loss, especially for floating-point code.

  • -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, in place of twice as many ld and st pairs. However, the use of this changed alignment directly violates the SPARC ABI. Thus, it's intended only for use on targets where the developer acknowledges that their resulting code is not directly in line with the rules of the ABI.
  • -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.

  • -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 does not 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 is 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

okay so by default โ€” like, unless your build was configured some other way โ€” GCC spits out code for the V7 variant of the SPARC architecture. And if you pass -mcpu=cypress, the compiler also optimizes for the Cypress CY7C602 chip, which is the one living inside the SPARCStation/SPARCServer 3xx series. It's also the vibe for the older SPARCStation 1, 2, IPX and friends. legacy queen energy ๐Ÿ‘‘

With -mcpu=v8, GCC generates code for the V8 variant of the SPARC architecture. The only glow-up from V7 code is that the compiler now emits the integer multiply and integer divide instructions โ€” which exist in SPARC-V8 but literally do not exist in SPARC-V7. And with -mcpu=supersparc, it additionally optimizes for the SuperSPARC chip, the icon 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 for the Fujitsu MB86930 chip โ€” the original SPARClite, with no FPU, bestie, none, zero. And with -mcpu=f934, it additionally optimizes for the Fujitsu MB86934 chip, the more recent SPARClite, which does have an 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 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. And then the chip-specific extras:

  • -mcpu=ultrasparc โ€” compiler additionally optimizes for the Sun UltraSPARC I/II/IIi chips.
  • -mcpu=ultrasparc3 โ€” compiler additionally optimizes for the Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.
  • -mcpu=niagara โ€” compiler additionally optimizes for Sun UltraSPARC T1 chips.
  • -mcpu=niagara2 โ€” compiler additionally optimizes for Sun UltraSPARC T2 chips.
  • -mcpu=niagara3 โ€” compiler additionally optimizes for Sun UltraSPARC T3 chips.
  • -mcpu=niagara4 โ€” compiler additionally optimizes for Sun UltraSPARC T4 chips.
  • -mcpu=niagara7 โ€” compiler additionally optimizes for Oracle SPARC M7 chips.
  • -mcpu=m8 โ€” compiler additionally optimizes for Oracle M8 chips.

  • -mtune=cpu_type โ€” set the instruction scheduling parameters for machine type cpu_type, but do not set the instruction set or register set the way -mcpu=cpu_type does. Same values work for both, but the only useful ones for -mtune=cpu_type are the ones that select a particular CPU implementation: 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.
  • -mvis3b / -mno-vis3b โ€” with -mvis3b, GCC generates code that takes advantage of version 3.0 of the UltraSPARC Visual Instruction Set extensions, plus the additional VIS instructions introduced in the Oracle SPARC Architecture 2011. The default is -mvis3b when targeting a cpu that supports such instructions, such as niagara-7 and later. Setting -mvis3b also sets -mvis3, -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 -mvis3b, -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, -mvis3b, -mvis3, -mvis2 and -mvis. ๐Ÿ”ฅ
  • -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.
  • -mptr32 / -mptr64 โ€” use 32- or 64-bit pointers, respectively. Unlike the -m32 and -m64 options, this affects only the pointer size and not the ABI. ๐Ÿ’…
  • -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. ๐Ÿฆ‹

๐ŸŒˆ 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. (so like... it works, but the girlies use -shared now, no cap)
  • -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 โ€” bestie, this one controls whether we optimize basic blocks that use the same index pointer 4 or more times to copy that pointer into the ep register and then use the shorter sld and sst instructions. ๐Ÿ’… -mep is on by default if you're optimizing, so likeโ€ฆ it's already serving unless you say otherwise.
  • -mno-prolog-function, -mprolog-function โ€” do you want external functions to save and restore registers at the prologue and epilogue of a function? -mprolog-function says yes bestie, -mno-prolog-function says no. The external functions are slower, but they use less code space if more than one function saves the same number of registers. And -mprolog-function is on by default when you optimize. โœจ
  • -mspace โ€” the "make it smol" button. ๐ŸŽ€ It tries to make the code as small as possible. At present, this just turns on the -mep and -mprolog-function options. That's it. That's the whole vibe.
  • -mtda=n โ€” put static or global variables whose size is n bytes or less into the tiny data area that register ep points to. Heads up: the tiny data area can hold up to 256 bytes in total (128 bytes for byte references). It's tiny for a reason, iykyk.
  • -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. Bigger than tiny, still not huge. ๐ŸŒธ
  • -mzda=n โ€” put static or global variables whose size is n bytes or less into the first 32 kilobytes of memory. Living in the front of the address space, main character energy. ๐Ÿ‘‘
  • -mv850 โ€” specify that the target processor is the V850. ๐Ÿฆ‹
  • -mv850e3v5 โ€” specify that the target processor is the V850E3V5. The preprocessor constant __v850e3v5__ is defined if this option is used. โœจ
  • -mv850e2v4 โ€” specify that the target processor is the V850E3V5. This is an alias for the -mv850e3v5 option. (Yes, it says V850E3V5, not V850E2V4 โ€” that's literally what it says, no cap. ๐Ÿ™ˆ)
  • -mv850e2v3 โ€” specify that the target processor is the V850E2V3. The preprocessor constant __v850e2v3__ is defined if this option is used.
  • -mv850e2 โ€” specify that the target processor is the V850E2. The preprocessor constant __v850e2__ is defined if this option is used.
  • -mv850e1 โ€” specify that the target processor is the V850E1. The preprocessor constants __v850e1__ and __v850e__ are defined if this option is used.
  • -mv850es โ€” specify that the target processor is the V850ES. This is an alias for the -mv850e1 option.
  • -mv850e โ€” specify that the target processor is the V850E. The preprocessor constant __v850e__ is defined if this option is used.

And here's the tea, bestie: 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. ๐Ÿซถ

Also, the preprocessor constants __v850 and __v851__ are always defined, regardless of which processor variant is the target. Periodt. ๐Ÿ’–

  • -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 โ€” pass on (or do not pass on) the -mrelax command-line option to the assembler. Passing the vibes along. ๐Ÿ’ซ
  • -mlong-jumps, -mno-long-jumps โ€” disable (or re-enable) the generation of PC-relative jump instructions.
  • -msoft-float, -mhard-float โ€” disable (or re-enable) the generation of hardware floating point instructions. This option is only significant 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. And listen: the use of this instruction is not enabled by default when the e3v5 architecture is selected, because its use is still experimental. โš ๏ธ Proceed with the caution, bestie.
  • -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, -mno-big-switch โ€” generate code suitable for big switch tables. Use this option only if the assembler/linker complain about out of range branches within a switch table. Like, only reach for this when the toolchain is literally yelling at you. ๐Ÿ˜ญ
  • -mapp-regs, -mno-app-regs โ€” -mapp-regs causes r2 and r5 to be used in the code generated by the compiler. This setting is the default. -mno-app-regs causes r2 and r5 to be treated as fixed registers.
  • -msmall-sld, -mno-small-sld โ€” enable or disable the use of the short load instructions.
  • -mno-strict-align โ€” do not enforce strict data alignment.
  • -mjump-tables-in-data-section, -mno-jump-tables-in-data-section โ€” enable or disable placement of jump tables for switch statements in the .data section rather than the .code section. The default is -mno-jump-tables-in-data-section. ๐ŸŽ€

๐Ÿฆ‹ 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. It's giving "be nice to the old assembler". ๐Ÿ™ˆ
  • -mgnu โ€” do output those jump instructions, on the assumption that the GNU assembler is being used. Bestie's got this one. ๐Ÿ’…
  • -md, -md-float โ€” use the D_floating data format for double-precision floating-point numbers instead of G_floating.
  • -mg, -mg-float โ€” use the G_floating data format for double-precision floating-point numbers instead of D_floating.
  • -mlra, -mno-lra โ€” enable Local Register Allocation. And ngl, this is still experimental for the VAX, so by default the compiler uses standard reload. โš ๏ธ
  • -mvaxc-alignment โ€” use VAXC conventions for alignment of structure members.
  • -mqmath, -mno-qmath โ€” enable or disable new instruction patterns for 64-bit integer addition and subtraction.

๐ŸŒˆ Visium Options ๐ŸŒˆ

  • -mdebug โ€” use this option when linking programs that perform file I/O and are destined to run on an MCM target. It causes the libraries libc.a and libdebug.a to be linked. You should run the program on the target under the control of the GDB remote debugging stub. ๐Ÿ›
  • -msim โ€” use this option when linking programs that perform file I/O and are destined to run on the simulator. It causes the 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.
Real talk: -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. Don't mix and match, bestie, it will Not Go Well. ๐Ÿ˜ญ
  • -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. That last 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 โ€” okay so 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. โœจ
  • -mvthreads โ€” Link against the VxWorks AE vThread runtime environment. ๐ŸŽ€
  • -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 โœจ

This section documents -m options available for the x86 family of computers.

The following group of options allows compilation to target a specific processor.

  • -march=cpu-type โ€” Generate instructions for the machine type cpu-type. 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, MMX, SSE, SSE2, and FXSR instruction set support. โœจ
  • x86-64-v2, x86-64-v3, x86-64-v4 โ€” These choices for cpu-type select the corresponding micro-architecture level from the x86-64 psABI. On ABIs other than the x86-64 psABI they select the same CPU features as the x86-64 psABI documents for the particular micro-architecture level.

Since these cpu-type values do not have a corresponding -mtune setting, using -march with these values enables generic tuning. Specific tuning can be enabled using the -mtune=other-cpu-type option with an appropriate other-cpu-type value. ๐Ÿฆ‹

  • i386 โ€” Original Intel i386 CPU. ๐ŸŽ€
  • i486 โ€” Intel i486 CPU. (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 with no MMX support. ๐Ÿ˜ญ
  • i686 โ€” When used with -march, the Pentium Pro instruction set is used, so the code runs on all i686 family chips. When used with -mtune, it has the same meaning 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; low-power version of Intel Pentium III CPU with MMX, SSE, SSE2 and FXSR instruction set support. Used by Centrino notebooks. โญ
  • 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, CX16 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, 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, 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, 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, bestie, and it's giving 64-bit extensions plus MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL and AVX-VNNI instruction set support. ๐Ÿ’–
  • arrowlake โ€” Intel Arrow Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT and CMPCCXADD instruction set support. โœจ
  • 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, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3 and SM4 instruction set support. ๐Ÿฆ‹
  • pantherlake, wildcatlake โ€” Intel Panther Lake / Wildcat Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, AVX-VNNI, UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3 and SM4 instruction set support. ๐ŸŒธ
  • novalake โ€” Intel Nova Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, AVX-VNNI, UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3, SM4, PREFETCHI, APX_F, AVX10.1, AVX10.2 and MOVRS instruction set support. ๐Ÿ’…
  • sapphirerapids, emeraldrapids โ€” Intel Sapphire Rapids / Emerald Rapids CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512-FP16 and AVX512BF16 instruction set support. ๐Ÿ”ฅ
  • graniterapids โ€” Intel Granite Rapids CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512-FP16, AVX512BF16, AMX-FP16 and PREFETCHI instruction set support. ๐Ÿ‘‘
  • graniterapids-d โ€” Intel Granite Rapids D CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512FP16, AVX512BF16, AMX-FP16, PREFETCHI and AMX-COMPLEX instruction set support. ๐Ÿ’œ
  • diamondrapids โ€” Intel Diamond Rapids CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512FP16, AVX512BF16, AMX-FP16, PREFETCHI, AMX-COMPLEX, AVX10.1-512, AVX-IFMA, AVX-NE-CONVERT, AVX-VNNI-INT16, AVX-VNNI-INT8, CMPccXADD, SHA512, SM3, SM4, AVX10.2-512, APX_F, AMX-AVX512, AMX-FP8, MOVRS and AMX-MOVRS instruction set support. ๐ŸŽ€
ok yes that list is long long but every single one of those is doing something, bestie, do not skip them ๐Ÿ™ˆ
  • bonnell, atom โ€” Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3 and CX16 instruction set support. ๐Ÿ“
  • silvermont, slm โ€” Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW and RDRND instruction set support. โญ
  • goldmont โ€” Intel Goldmont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW, RDRND, AES, SHA, RDSEED, XSAVE, XSAVEC, XSAVES, XSAVEOPT, CLFLUSHOPT and FSGSBASE instruction set support. โœจ
  • goldmont-plus โ€” Intel Goldmont Plus CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW, RDRND, AES, SHA, RDSEED, XSAVE, XSAVEC, XSAVES, XSAVEOPT, CLFLUSHOPT, FSGSBASE, PTWRITE, RDPID and SGX instruction set support. ๐ŸŒˆ
  • tremont โ€” Intel Tremont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW, RDRND, AES, SHA, RDSEED, XSAVE, XSAVEC, XSAVES, XSAVEOPT, CLFLUSHOPT, FSGSBASE, PTWRITE, RDPID, SGX, CLWB, GFNI-SSE, MOVDIRI, MOVDIR64B, CLDEMOTE and WAITPKG instruction set support. ๐Ÿงš
  • sierraforest โ€” Intel Sierra Forest CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, CLDEMOTE, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, ENQCMD and UINTR instruction set support. ๐ŸŒธ
  • grandridge โ€” Intel Grand Ridge CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, CLDEMOTE, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, ENQCMD and UINTR instruction set support. ๐Ÿ’–
  • clearwaterforest โ€” Intel Clearwater Forest CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, CLDEMOTE, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, AVX-VNNI, ENQCMD, UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3, SM4, USER_MSR and PREFETCHI instruction set support. ๐Ÿฆ‹

ok and now we're switching teams, it's AMD's turn ๐Ÿ’…

  • k6 โ€” AMD K6 CPU with MMX instruction set support. ๐ŸŽ€
  • k6-2, k6-3 โ€” Improved versions of AMD K6 CPU with MMX and 3DNow! instruction set support. โœจ
  • athlon, athlon-tbird โ€” AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow! and SSE prefetch instructions support. ๐ŸŒŸ
  • athlon-4, athlon-xp, athlon-mp โ€” Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow! and full SSE instruction set support. ๐Ÿ’œ
  • k8, opteron, athlon64, athlon-fx โ€” Processors based on the AMD K8 core with x86-64 instruction set support, including the AMD Opteron, Athlon 64, and Athlon 64 FX processors. (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow! and 64-bit instruction set extensions.) ๐Ÿ”ฅ
  • k8-sse3, opteron-sse3, athlon64-sse3 โ€” Improved versions of AMD K8 cores with SSE3 instruction set support. โญ
  • amdfam10, barcelona โ€” CPUs based on AMD Family 10h cores with x86-64 instruction set support. (This supersets CX16, MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit instruction set extensions.) ๐Ÿ‘‘
  • bdver1 โ€” AMD Family 15h coreโ€“based CPUs with x86-64 instruction set support, bestie. (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 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 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 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 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 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 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 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.)
  • znver6 โ€” AMD Family 1ah core based CPUs with x86-64 instruction set support. (This supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, WBNOINVD, PKU, VPCLMULQDQ, VAES, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, AVX512VNNI, AVX512BITALG, AVX512VPOPCNTDQ, GFNI, AVXVNNI, MOVDIRI, MOVDIR64B, AVX512VP2INTERSECT, PREFETCHI, AVXVNNIINT8, AVXIFMA, AVX512FP16, AVXNECONVERT, AVX512BMM and 64-bit instruction set extensions.)
  • 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.
  • shijidadao โ€” ZHAOXIN shijidadao CPU with x86-64, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE, CX16, ABM, BMI, BMI2, F16C, FXSR, RDSEED, AVX2, FMA, SHA, LZCNT instruction set support.
  • geode โ€” AMD Geode embedded processor with MMX and 3DNow! instruction set support.
  • c86-4g-m4 โ€” HYGON c86-4g-m4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, CLFLUSHOPT, XSAVES, LZCNT, POPCNT instruction set support.
  • c86-4g-m6 โ€” HYGON c86-4g-m6 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, CLFLUSHOPT, XSAVES, LZCNT, POPCNT instruction set support.
  • c86-4g-m7 โ€” HYGON c86-4g-m7 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, CLFLUSHOPT, XSAVES, LZCNT, POPCNT, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, GFNI, AVX512VNNI, VAES, AVX512BITALG, AVX512VPOPCNTDQ, AVX512VP2INTERSECT, AVXVNNI, VPCLMULQDQ, WBNOINVD instruction set support.
  • c86-4g-m8 โ€” HYGON c86-4g-m8 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, CLFLUSHOPT, XSAVES, LZCNT, POPCNT, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, GFNI, AVX512VNNI, VAES, AVX512BITALG, AVX512VPOPCNTDQ, AVX512VP2INTERSECT, AVXVNNI, VPCLMULQDQ, WBNOINVD instruction set support.
  • -mtune=cpu-type โ€” tunes everything applicable about the generated code for cpu-type, except the ABI and the set of available instructions. So like โ€” it schedules stuff nicely for that specific chip, but it will not emit code that can't run on the default machine type unless you also pass -march=cpu-type. Example bestie: if GCC is configured for i686-pc-linux-gnu, then -mtune=pentium4 gives you code tuned for Pentium 4 that still runs on i686 machines. ๐Ÿซถ

The choices for cpu-type are the same as for -march. Plus -mtune supports 2 extra choices for cpu-type:

  • generic โ€” produces code optimized for the most common IA32/AMD64/EM64T processors. If you actually know the CPU your code will run on, use the corresponding -mtune or -march option instead of -mtune=generic. But if you have no idea what CPU your users have, this is the one for you. ๐Ÿ’…

As new processors hit the marketplace, the behavior of this option will change. So if you upgrade to a newer version of GCC, code generation controlled by this option changes to reflect whatever processors were most common when that GCC version dropped. Not me getting a different binary from the same flag ๐Ÿ˜ญ

There is no -march=generic option, because -march says which instruction set the compiler may use, and there is no generic instruction set that works on all processors. Meanwhile -mtune indicates the processor (or, in this case, the collection of processors) the code is optimized for. Periodt.

  • intel โ€” produces code optimized for the most current Intel processors, which are Haswell and Silvermont for this version of GCC. If you know the CPU your code will run on, use the corresponding -mtune or -march option instead of -mtune=intel. But if you want your app to perform better on both Diamond Rapids and Clearwater Forest, use this. ๐Ÿ‘‘

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 changes to reflect the most current Intel processors at the time that version of GCC was 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.


The following options let you get way more granular about which instruction set extensions GCC targets. Each one has a corresponding -mno-option to disable use of those instructions. โœจ

These extensions are also available as built-in functions: see x86 Built-in Functions for the deets on which functions these switches enable and disable. ๐Ÿงš

These options enable GCC to use these extended instructions in generated code. Applications that do run-time CPU detection must compile separate files for each supported architecture, using the appropriate flags. In particular, the file containing the CPU detection code should be compiled without these options. ๐Ÿซก

To control whether 387 or SSE/AVX instructions are generated automatically for floating-point arithmetic, see -mfpmath=, below.

  • -mmmx โ€” support MMX built-in functions.
  • -msse โ€” support MMX and SSE built-in functions and code generation.
  • -msse2 โ€” support MMX, SSE and SSE2 built-in functions and code generation.
  • -msse3 โ€” support MMX, SSE, SSE2 and SSE3 built-in functions and code generation.
  • -mssse3 โ€” support MMX, SSE, SSE2, SSE3 and SSSE3 built-in functions and code generation.
  • -msse4.1 โ€” support MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 built-in functions and code generation.
  • -msse4.2 โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1 and SSE4.2 built-in functions and code generation.
  • -msse4 โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1 and SSE4.2 built-in functions and code generation.
Heads up bestie: -msse4 enables both SSE4.1 and SSE4.2 support, while -mno-sse4 turns those features off. Neither form of the option touches SSE4A support โ€” that one is controlled separately by -msse4a. ๐ŸŽ€
  • -msse4a โ€” support MMX, SSE, SSE2, SSE3 and SSE4A built-in functions and code generation.
  • -mavx โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2 and AVX built-in functions and code generation.
  • -mavx2 โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and AVX2 built-in functions and code generation.
  • -mavx512f โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2 and AVX512F built-in functions and code generation.
  • -mavx512cd โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512CD built-in functions and code generation.
  • -mavx512vl โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512VL built-in functions and code generation.
  • -mavx512bw โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512BW built-in functions and code generation.
  • -mavx512dq โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512DQ built-in functions and code generation.
  • -mavx512ifma โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512IFMA built-in functions and code generation.
  • -mavx512vbmi โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512VBMI built-in functions and code generation.
  • -mavx512vpopcntdq โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512VPOPCNTDQ built-in functions and code generation.
  • -mavx512vp2intersect โ€” support AVX512VP2INTERSECT built-in functions and code generation.
  • -mavx512vnni โ€” support AVX512VNNI built-in functions and code generation.
  • -mavx512vbmi2 โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512VBMI2 built-in functions and code generation.
  • -mavx512bf16 โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512BF16 built-in functions and code generation.
  • -mavx512fp16 โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512-FP16 built-in functions and code generation.
  • -mavx512bitalg โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512BITALG built-in functions and code generation.
  • -mavx512bmm โ€” support AVX512BMM built-in functions and code generation.
  • -mavxvnni โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and AVXVNNI built-in functions and code generation.
  • -mavxifma โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and AVXIFMA built-in functions and code generation.
  • -mavxvnniint8 โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2 and AVXVNNIINT8 built-in functions and code generation.
  • -mavxneconvert โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and AVXNECONVERT build-in functions and code generation.
  • -mavxvnniint16 โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2 and AVXVNNIINT16 built-in functions and code generation.
  • -mavx10.1 โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and AVX10.1 built-in functions and code generation.
  • -mavx10.2 โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX10.1 and AVX10.2 built-in functions and code generation.
  • -msha โ€” support SHA1 and SHA256 built-in functions and code generation.
  • -maes โ€” support AES built-in functions and code generation.
  • -mpclmul โ€” support PCLMUL built-in functions and code generation.
  • -mclflushopt โ€” support CLFLUSHOPT instructions.
  • -mclwb โ€” support CLWB instruction.
  • -mfsgsbase โ€” support FSGSBASE built-in functions and code generation.
  • -mptwrite โ€” support PTWRITE built-in functions and code generation.
  • -mrdrnd โ€” support RDRND built-in functions and code generation.
  • -mf16c โ€” support F16C built-in functions and code generation.
  • -mfma โ€” support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and FMA built-in functions and code generation.
  • -mfma4 โ€” support FMA4 built-in functions and code generation.
  • -mpconfig โ€” support PCONFIG built-in functions and code generation.
  • -mwbnoinvd โ€” support WBNOINVD built-in functions and code generation.
  • -mprfchw โ€” support PREFETCHW instruction.
  • -mrdpid โ€” support RDPID built-in functions and code generation.
  • -mrdseed โ€” support RDSEED instruction.
  • -msgx โ€” support SGX built-in functions and code generation.
  • -mxop โ€” support XOP built-in functions and code generation.
  • -mlwp โ€” support LWP built-in functions and code generation.
  • -m3dnow โ€” support 3DNow! built-in functions.
  • -m3dnowa โ€” support Athlon 3Dnow! built-in functions.
  • -mpopcnt โ€” support code generation of popcnt instruction.
  • -mabm โ€” support code generation of Advanced Bit Manipulation (ABM) instructions.
  • -madx โ€” support flag-preserving add-carry instructions.
  • -mbmi โ€” support BMI built-in functions and code generation.
  • -mbmi2 โ€” support BMI2 built-in functions and code generation.
  • -mlzcnt โ€” support LZCNT built-in function and code generation.
  • -mfxsr โ€” support FXSAVE and FXRSTOR instructions.
  • -mxsave โ€” support XSAVE and XRSTOR instructions.
  • -mxsaveopt โ€” support XSAVEOPT instruction.
  • -mxsavec โ€” support XSAVEC instructions.
  • -mxsaves โ€” support XSAVES and XRSTORS instructions.
  • -mrtm โ€” support RTM built-in functions and code generation.
  • -mhle โ€” support Hardware Lock Elision prefixes.
  • -mtbm โ€” support TBM built-in functions and code generation.
  • -mmwaitx โ€” support MWAITX and MONITORX built-in functions and code generation.
  • -mclzero โ€” support CLZERO built-in functions and code generation.
  • -mpku โ€” support PKU built-in functions and code generation.
  • -mgfni โ€” support GFNI built-in functions and code generation.
  • -mvaes โ€” enables VAES built-in functions + codegen. โœจ
  • -mwaitpkg โ€” turns on WAITPKG built-in functions and code generation.
  • -mvpclmulqdq โ€” VPCLMULQDQ built-in functions + codegen, yes ma'am.
  • -mmovdiri โ€” MOVDIRI built-in functions and code generation.
  • -mmovdir64b โ€” MOVDIR64B built-in functions and code generation.
  • -menqcmd โ€” ENQCMD built-in functions and code generation.
  • -muintr โ€” UINTR built-in functions and code generation.
  • -mtsxldtrk โ€” TSXLDTRK built-in functions and code generation.
  • -mcldemote โ€” CLDEMOTE built-in functions and code generation.
  • -mserialize โ€” SERIALIZE built-in functions and code generation.
  • -mamx-tile โ€” AMX-TILE built-in functions and code generation.
  • -mamx-int8 โ€” AMX-INT8 built-in functions and code generation.
  • -mamx-bf16 โ€” AMX-BF16 built-in functions and code generation.
  • -mhreset โ€” HRESET built-in functions and code generation.
  • -mkl โ€” KL built-in functions and code generation.
  • -mwidekl โ€” WIDEKL built-in functions and code generation.
  • -mcmpccxadd โ€” hooks you up with MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and CMPCCXADD build-in functions plus code generation. it's giving โœจeverythingโœจ
  • -mamx-fp16 โ€” AMX-FP16 built-in functions and code generation.
  • -mprefetchi โ€” PREFETCHI built-in functions and code generation.
  • -mraoint โ€” RAOINT built-in functions and code generation.
  • -mamx-complex โ€” AMX-COMPLEX built-in functions and code generation.
  • -msm3 โ€” MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and SM3 built-in functions and code generation.
  • -msm4 โ€” MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and SM4 built-in functions and code generation.
  • -msha512 โ€” MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and SHA512 built-in functions and code generation.
  • -mapxf โ€” enables code generation for APX features, and the list is long: EGPR, PUSH2POP2, NDD, PPX, NF, CCMP and ZU. no skips ๐Ÿ’…
  • -musermsr โ€” USER_MSR built-in functions and code generation.
  • -mamx-avx512 โ€” MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX10.1, AVX10.2 and AMX-AVX512 built-in functions and code generation. the whole roster fr fr ๐Ÿ˜ญ
  • -mamx-tf32 โ€” AMX-TF32 built-in functions and code generation.
  • -mamx-fp8 โ€” AMX-FP8 built-in functions and code generation.
  • -mmovrs โ€” MOVRS built-in functions and code generation.
  • -mamx-movrs โ€” AMX-MOVRS built-in functions and code generation.

okay bestie, these additional options are available for the x86 processor family. so if you're on x86, this next batch is your moment ๐ŸŒˆ


  • -mfpmath=unit โ€” generates floating-point arithmetic for the selected unit, and unit can be one of these iconic picks:
    • 387 โ€” uses the standard 387 floating-point coprocessor, which is present on most chips and emulated everywhere else. code compiled with this runs almost everywhere. but heads up: temporary results get computed in 80-bit precision instead of whatever precision the type says, so results come out slightly different compared to most other chips. peep -ffloat-store if you want the full lore.

this is the default choice for non-Darwin x86-32 targets.

  • sse โ€” uses the scalar floating-point instructions from the SSE instruction set. Pentium III and newer chips support this, and on the AMD side it's Athlon-4, Athlon XP and Athlon MP chips. the earlier version of SSE only does single-precision arithmetic, so double and extended-precision arithmetic still go through 387. a later version โ€” only on Pentium 4 and AMD x86-64 chips โ€” handles double-precision too.

on the x86-32 compiler you must use -march=cpu-type, -msse or -msse2 switches to enable SSE extensions and actually make this option do something. on the x86-64 compiler those extensions are on by default, no extra steps ๐Ÿซถ

the resulting code should be considerably faster in the majority of cases and dodges the numerical instability drama of 387 code, but it 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 for x86-32 targets with the SSE2 instruction set when -ffast-math is enabled.

also: GCC depresses SSE instructions when -mavx (or another option enabling AVX extensions) is used. instead it generates new AVX instructions or AVX equivalents for all SSE instructions whenever needed. slay, I guess โœจ

  • sse,387
  • sse+387
  • both โ€” tries to use both instruction sets at once. this effectively doubles the amount of available registers, and on chips with separate execution units for 387 and SSE it doubles the execution resources too. use this one with care tho โ€” it's still experimental, because the GCC register allocator doesn't model separate functional units well, so performance comes out unstable. ๐Ÿ™ˆ
  • -mieee-fp
  • -mno-ieee-fp โ€” controls whether the compiler uses IEEE floating-point comparisons. these correctly handle the case where the result of a comparison is unordered. lowkey important ๐Ÿ’…
  • -m80387
  • -mhard-float โ€” generates output containing 80387 instructions for floating point.
  • -mno-80387
  • -msoft-float โ€” generates 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 can't be done directly in cross-compilation. you must make your own arrangements to provide suitable library functions for cross-compilation. your problem now bestie ๐Ÿ˜ญ

on machines where a function returns floating-point results in the 80387 register stack, some floating-point opcodes may be emitted even if -msoft-float is used.

  • -mno-fp-ret-in-387 โ€” don't use the FPU registers for return values of functions.

the usual calling convention has functions return values of types float and double in an FPU register, even if there's no FPU at all. the idea is that the operating system should emulate an FPU.

the option -mno-fp-ret-in-387 makes those values get returned in ordinary CPU registers instead. plot twist ๐Ÿฆ‹

  • -mno-fancy-math-387 โ€” some 387 emulators don't support the sin, cos and sqrt instructions for the 387. specify this option to avoid generating those instructions. this option gets overridden when -march indicates that the target CPU always has an FPU, so the instruction doesn't need emulation. heads up: these instructions are not generated unless you also use the -funsafe-math-optimizations switch.
  • -malign-double
  • -mno-align-double โ€” controls 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 cost of more memory. tradeoffs, baby ๐Ÿ’…

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 they are not binary compatible with structures in code compiled without that switch. no cap.
  • -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 as 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. in arrays or structures conforming to the ABI, that's 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 that neither of these options enable any extra precision over the x87 standard of 80 bits for a long double.

Warning: if you override the default value for your target ABI, this changes the size of structures and arrays containing long double variables, and it also modifies 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. a size of 64 bits makes long double equivalent to the double type โ€” that's the default for 32-bit Bionic C library. a size of 128 bits makes long double 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, and it also modifies the function calling convention for functions taking long double. hence they are not binary-compatible with code compiled without that switch. same energy as above, different flag ๐Ÿ˜ญ
  • -malign-data=type โ€” controls how GCC aligns variables. the supported values for type are:
    • compat โ€” uses increased alignment value compatible with GCC 4.8 and earlier
    • abi โ€” uses the alignment value as specified by the psABI
    • cacheline โ€” uses 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 get placed in large data sections. the default is 65535.
  • -mrtd โ€” uses 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 ๐Ÿ’…

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, bestie, listen up: this calling convention is incompatible with the one normally used on Unix, so you literally 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. Not a vibe.

In addition, seriously incorrect code results if you call a function with too many arguments. (Normally, extra arguments are harmlessly ignored. ๐Ÿ™ˆ)


  • -mregparm=num โ€” controls 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. 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. ๐Ÿ’€

  • -mdaz-ftz, -mno-daz-ftz โ€” the flush-to-zero (FTZ) and denormals-are-zero (DAZ) flags in the MXCSR register are used to control floating-point calculations. The -Ofast, -ffast-math, or -funsafe-math-optimizations options normally link in startup code that sets these flags except when building a shared library (-shared). You can use the -mdaz-ftz and -mno-daz-ftz options to explicitly enable or disable setting these flags, regardless of other options passed to GCC. ๐ŸŒˆ
  • -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. โœจ
  • -mstack-arg-probe โ€” emit stack probing code in the function prologue. ๐Ÿ”
  • -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 8 byte boundary. Since x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and intended to be used in controlled environment where stack space is important limitation. This option leads to wrong code when functions compiled with 16 byte stack alignment (such as functions from a standard library) are called with misaligned stack. In this case, SSE instructions may lead to misaligned memory access traps. In addition, variable arguments are handled incorrectly for 16 byte aligned objects (including x87 long double and __int128), leading to wrong results. You must build all modules with -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 this values on the stack, the stack boundary must be as aligned as that required by any value stored on the stack. Further, every function must be generated such that it keeps the stack aligned. Thus calling a function compiled with a higher preferred stack boundary from a function compiled with a lower preferred stack boundary most likely misaligns the stack. It is recommended that libraries that use callbacks always use the default setting. ๐Ÿ‘‘

This extra alignment does consume extra stack space, and generally increases code size. Code that is sensitive to stack space usage, such as embedded systems and operating system kernels, may want to reduce the preferred alignment to -mpreferred-stack-boundary=2. ๐Ÿ“

  • -mdump-tune-features โ€” this option instructs GCC to dump the names of the x86 performance tuning features and default settings. The names can be used in -mtune-ctrl=feature-list. ๐Ÿ“
  • -mtune-ctrl=feature-list โ€” this option is used to do fine-grain control of 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 is turned off. -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. ๐Ÿ’€
  • -mno-default โ€” this option instructs GCC to turn off all tunable features. See also -mtune-ctrl=feature-list and -mdump-tune-features. ๐Ÿšซ
  • -mcld โ€” this option 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 โ€” this option 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. โœจ
  • -mstv, -mno-stv โ€” enable/disable Scalar to Vectorization pass transforming 64-bit integer computation into vector ones. This optimization is restricted to -O2 and higher. ๐ŸŒธ
  • -mprefer-avx128 โ€” this option instructs GCC to use 128-bit AVX instructions instead of 256-bit AVX instructions in the auto-vectorizer. ๐Ÿฆ‹
  • -mprefer-vector-width=opt โ€” this option instructs GCC to use opt-bit vector width in instructions instead of default on the selected platform. ๐ŸŒˆ
  • -mpartial-vector-fp-math, -mno-partial-vector-fp-math โ€” this option enables GCC to generate floating-point operations that might affect the set of floating-point status flags on partial vectors, where vector elements reside in the low part of the 128-bit SSE register. Unless -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 โ€” this option 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 โ€” this option 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 โ€” okay so this one is lowkey a glow-up for functions marked noreturn (either the "noreturn" attribute or the "_Noreturn" specifier). It tells the compiler: bestie never comes back, so why save all those callee-saved registers in the prologue that the function actually uses? Skip 'em โ€” except the "BP" register, she stays. โš ๏ธ BUT. Big but. This can mess with debugging of the caller of that "noreturn" function, or literally anything further up the call stack. So it is not enabled by default. She's opt-in for a reason, fr fr. ๐Ÿ’€
  • -mcx16 โ€” enables GCC to spit out "CMPXCHG16B" instructions in 64-bit code, so you can do compare-and-exchange on 16-byte aligned 128-bit objects. It's giving โœจatomic updatesโœจ for data structures bigger than one machine word. The compiler uses this instruction for __sync Builtins. However โ€” for __atomic Builtins operating on 128-bit integers, a library call is always used. No cap. ๐Ÿ‘‘
  • -msahf โ€” turns on generation of "SAHF" instructions in 64-bit code. Story time: early Intel Pentium 4 CPUs with Intel 64 support, before the Pentium 4 G1 step dropped in December 2005, were missing the "LAHF" and "SAHF" instructions that AMD64 supports. Those two are load and store instructions (respectively!) for certain status flags. In 64-bit mode, "SAHF" is used to optimize the "fmod", "drem", and "remainder" built-in functions โ€” see Other Builtins for the tea. ๐Ÿซ–
  • -mmovbe โ€” enables use of the "movbe" instruction to optimize byte swapping of four and eight byte entities. Swapping bytes but make it fashion. ๐Ÿ’…
  • -mshstk โ€” the -mshstk option enables shadow stack built-in functions from x86 Control-flow Enforcement Technology (CET). Protection era. ๐Ÿ›ก๏ธ
  • -mcrc32 โ€” enables the built-in functions __builtin_ia32_crc32qi, __builtin_ia32_crc32hi, __builtin_ia32_crc32si and __builtin_ia32_crc32di so they generate the "crc32" machine instruction. Four whole builtins, all eating. ๐Ÿ”ฅ
  • -mmwait โ€” enables the built-in functions __builtin_ia32_monitor, and __builtin_ia32_mwait to generate the "monitor" and "mwait" machine instructions. ๐Ÿ‘€
  • -mrecip โ€” okay this one is the math girlie option. It enables use of "RCPSS" and "RSQRTSS" instructions (plus their vectorized variants "RCPPS" and "RSQRTPS") with an extra Newton-Raphson step to bump the precision, instead of using "DIVSS" and "SQRTSS" (and their vectorized variants) for single-precision floating-point arguments.

Important caveat: these instructions are only generated when -funsafe-math-optimizations is enabled together with -ffinite-math-only and -fno-trapping-math. And heads up โ€” 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). ๐Ÿ˜ญ

Also note that GCC already implements 1.0f/sqrtf(x) in terms of "RSQRTSS" (or "RSQRTPS") with -ffast-math (or the above option combination), and doesn't need -mrecip.

And also also note: GCC emits the above sequence with the 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 either. So basically she's already doing it. Periodt. ๐Ÿ’…

  • -mrecip=opt โ€” this one controls which reciprocal estimate instructions are allowed to 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. everything, all at once, main character energy.
    • default โ€” enable the default instructions, equivalent to -mrecip.
    • none โ€” disable all estimate instructions, equivalent to -mno-recip. the โœจnothingโœจ vibe.
    • 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, for example, -mrecip=all,!sqrt enables all of the reciprocal approximations, except for square root. ๐ŸŽ€

  • -mveclibabi=type โ€” specifies the ABI type to use for vectorizing intrinsics using an external library. Supported values for type are:
    • svml โ€” for the Intel short vector math library
    • aocl โ€” for the math library (LibM) from AMD Optimizing CPU Libraries (AOCL)
    • acml โ€” for the end-of-life AMD core math library (to which AOCL-LibM is the successor) ๐Ÿ’€

To use this option, both -ftree-vectorize and -funsafe-math-optimizations have to be enabled, and an SVML or ACML ABI-compatible library must be specified at link time.

GCC currently 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.

When -mveclibabi=aocl is used, GCC emits "amd_vrs4_acosf", "amd_vrs16_acosf", "amd_vrd8_asin", "amd_vrs4_asinf", "amd_vrs8_asinf", "amd_vrs16_asinf", "amd_vrd2_atan", "amd_vrd8_atan", "amd_vrs4_atanf", "amd_vrs8_atanf", "amd_vrs16_atanf", "amd_vrd2_cos", "amd_vrd4_cos", "amd_vrd8_cos", "amd_vrs4_cosf", "amd_vrs8_cosf", "amd_vrs16_cosf", "amd_vrs4_coshf", "amd_vrs8_coshf", "amd_vrd2_erf", "amd_vrd4_erf", "amd_vrd8_erf", "amd_vrs4_erff", "amd_vrs8_erff", "amd_vrs16_erff", "amd_vrd2_exp", "amd_vrd4_exp", "amd_vrd8_exp", "amd_vrs4_expf", "amd_vrs8_expf", "amd_vrs16_expf", "amd_vrd2_exp10", "amd_vrs4_exp10f", "amd_vrd2_exp2", "amd_vrd4_exp2", "amd_vrd8_exp2", "amd_vrs4_exp2f", "amd_vrs8_exp2f", "amd_vrs16_exp2f", "amd_vrs4_expm1f", "amd_vrd2_log", "amd_vrd4_log", "amd_vrd8_log", "amd_vrs4_logf", "amd_vrs8_logf", "amd_vrs16_logf", "amd_vrd2_log10", "amd_vrs4_log10f", "amd_vrs8_log10f", "amd_vrs16_log10f", "amd_vrd2_log1p", "amd_vrs4_log1pf", "amd_vrd2_log2", "amd_vrd4_log2", "amd_vrd8_log2", "amd_vrs4_log2f", "amd_vrs8_log2f", "amd_vrs16_log2f", "amd_vrd2_pow", "amd_vrd4_pow", "amd_vrd8_pow", "amd_vrs4_powf", "amd_vrs8_powf", "amd_vrs16_powf", "amd_vrd2_sin", "amd_vrd4_sin", "amd_vrd8_sin", "amd_vrs4_sinf", "amd_vrs8_sinf", "amd_vrs16_sinf", "amd_vrd2_tan", "amd_vrd4_tan", "amd_vrd8_tan", "amd_vrs16_tanf", "amd_vrs4_tanhf", "amd_vrs8_tanhf", "amd_vrs16_tanhf" for the corresponding function type.

And when -mveclibabi=acml is used, it emits "__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. That's the whole roster, bestie. ๐Ÿ’–

  • -mabi=name โ€” generate code for the specified calling convention. Permissible values are sysv for the ABI used on GNU/Linux and other systems, and ms for the Microsoft ABI. The default is to use the Microsoft ABI when targeting Microsoft Windows and the SysV ABI on all other systems. You can control this behavior for specific functions by using the function attributes "ms_abi" and "sysv_abi". Pick your fighter. ๐ŸฅŠ
  • -masm=dialect โ€” output assembly instructions using the selected dialect. It 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. Noted, no cap.
  • -mforce-indirect-call โ€” force all calls to functions to be indirect. This is useful when using Intel Processor Trace, where it generates more precise timing information for function calls. Sneaky but valid. ๐Ÿ•ต๏ธ
  • -mmanual-endbr โ€” insert 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. You're driving, not the compiler. ๐Ÿš—
  • -mcet-switch โ€” by default, CET instrumentation is turned off on switch statements that use a jump table and indirect branch track is disabled. Since jump tables are stored in read-only memory, this does not result in a direct loss of hardening. But โ€” if the jump table index is attacker-controlled, the indirect jump may not be constrained by CET. This option turns on CET instrumentation to enable indirect branch track for switch statements with jump tables, which leads to the jump targets reachable via any indirect jumps. Security girlies, take notes. ๐Ÿ“
  • -mcall-ms2sysv-xlogues โ€” due to differences in 64-bit ABIs, any Microsoft ABI function that calls a System V ABI function must consider RSI, RDI and XMM6-15 as clobbered. By default, the code for saving and restoring these registers is emitted inline, resulting in fairly lengthy prologues and epilogues. Using -mcall-ms2sysv-xlogues emits prologues and epilogues that use stubs in the static portion of libgcc to perform these saves and restores, thus reducing function size at the cost of a few extra instructions. Trade-off era. โš–๏ธ
  • -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 cannot be satisfied on all systems. Fancier, but with strings attached. ๐ŸŽ€
  • -mpush-args
  • -mno-push-args โ€” use PUSH operations to store outgoing parameters. This method is shorter and usually equally fast as the method using SUB/MOV operations, and is enabled by default. In some cases disabling it may improve performance because of improved scheduling and reduced dependencies. Sometimes less is more, bestie. โœจ
  • -maccumulate-outgoing-args โ€” if enabled, the maximum amount of space required for outgoing arguments is computed in the function prologue. This is faster on most modern CPUs because of reduced dependencies, improved scheduling and reduced stack usage when the preferred stack boundary is not equal to 2. The drawback is a notable increase in code size. This switch implies -mno-push-args. Big brain, bigger binary. ๐Ÿ’€
  • -mms-bitfields
  • -mno-ms-bitfields โ€” enable/disable bit-field layout compatible with the native Microsoft Windows compiler.

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. Particularly when moving packed data between functions compiled with GCC and the native Microsoft compiler (either via function call or as data in a file), it may be necessary to access either format. ABI diplomacy, honestly. ๐Ÿค

This option is enabled by default for Microsoft Windows targets. You can also control this behavior locally by use of variable or type attributes. For more information, see x86 Attributes.

The Microsoft structure layout algorithm is pretty simple ngl, 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 is 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 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 โ€” bestie, do not align the destination of inlined string operations. This switch reduces code size and improves performance in case the destination is already aligned โ€” but GCC doesn't know about it ๐Ÿ™ˆ.
  • -minline-all-stringops โ€” by default GCC inlines string operations only when the destination is known to be aligned to least a 4-byte boundary. This enables more inlining and increases code size, but may improve performance of code that depends on fast memcpy and memset for short lengths. The option enables inline expansion of strlen for all pointer alignments. โœจ
  • -minline-stringops-dynamically โ€” for string operations of unknown size, use run-time checks with inline code for small blocks and a library call for large blocks. Little bit of both, iconic behavior ๐Ÿ’….
  • -mstringop-strategy=alg โ€” override the internal decision heuristic for the particular algorithm to use for inlining string operations. The allowed values for alg are:
    • rep_byte
    • rep_4byte
    • rep_8byte โ€” expand using i386 rep prefix of the specified size.
    • byte_loop
    • loop
    • unrolled_loop โ€” expand into an inline loop.
    • libcall โ€” always use a library call.
  • -mmemcpy-strategy=strategy โ€” override the internal decision heuristic to decide if __builtin_memcpy should be inlined and what inline algorithm to use when the expected size of the copy operation is known. strategy is a comma-separated list of alg:max_size:dest_align triplets. alg is specified in -mstringop-strategy, max_size specifies the max byte size with which inline algorithm alg is allowed. For the last triplet, the max_size must be -1. The max_size of the triplets in the list must be specified in increasing order. The minimal byte size for alg is 0 for the first triplet and max_size + 1 of the preceding range. ๐Ÿซถ
  • -mmemset-strategy=strategy โ€” this option is similar to -mmemcpy-strategy= except that it controls the __builtin_memset expansion.
  • -momit-leaf-frame-pointer โ€” don't keep the frame pointer in a register for leaf functions. This avoids the instructions to save, set up, and restore frame pointers and makes an extra register available in leaf functions. The option -momit-leaf-frame-pointer removes the frame pointer for leaf functions, which might make debugging harder. ๐Ÿ˜ญ (worth it tho, sometimes)
  • -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 section that contains pointers to each profiling call; this is useful for automatically patching the calls. You can use the mfentry-section= option to set the name of the section; it defaults to __mcount_loc.
  • -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 โ€” with -pg -mfentry, instrument function exits according to type, which may be one of none to not instrument, call to generate a call to __return__, or nop5 to generate a 5-byte nop sequence. This option only instruments true returns ending with a ret, not sibling calls via a jump.
  • -mrecord-return
  • -mno-record-return โ€” generate a __return_loc section pointing to all return instrumentation code.
  • -mfentry-name=name โ€” set name of __fentry__ symbol called at function entry for -pg -mfentry functions.
  • -mfentry-section=name โ€” set name of section to record -mrecord-mcount calls. The default is __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 RAX register when there are no variable arguments passed in vector registers.
  • -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 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. ๐Ÿ”ฅ
  • -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
  • -mstack-protector-guard-symbol=symbol โ€” generate stack protection code using 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 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.

-mstack-protector-guard-symbol=symbol overrides the offset with a symbol reference to a canary in the TLS block.

  • -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. ๐ŸŽ€
  • -mrelax-cmpxchg-loop โ€” bestie, when GCC has to emit a compare-and-swap loop for __sync Builtins and __atomic Builtins because there's no native instruction for it, this makes it optimize for the case where everybody and their mom is fighting over that same value ๐Ÿ’ฅ. It issues an atomic load before the CMPXCHG instruction, and then uses the PAUSE instruction to save CPU power when it restarts the loop. Contended-case glow-up, no cap โœจ
  • -mindirect-branch=choice โ€” converts indirect call and jump according to choice. Default is keep, which literally keeps indirect call and jump unmodified, untouched, unbothered ๐Ÿ’…. 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.
Heads up ๐Ÿšจ: -mcmodel=large is incompatible with -mindirect-branch=thunk and -mindirect-branch=thunk-extern, because the thunk function may not be reachable in the large code model. Like, it literally cannot find it. Gone. Missing. ๐Ÿ’€
Also note that -mindirect-branch=thunk-extern is compatible with -fcf-protection=branch, since the external thunk can be made to enable control-flow check. Iconic behavior, honestly ๐Ÿซถ
  • -mfunction-return=choice โ€” converts function return according to choice. 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. โœ…
And again, -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. Same drama, different flag ๐Ÿ˜ญ
  • -mindirect-branch-register โ€” forces indirect call and jump via register. That's it, that's the whole vibe ๐Ÿ’…
  • -mharden-sls=choice โ€” generates code to mitigate against straight line speculation (SLS) according to choice. 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. Pick your fighter ๐Ÿ‘‘
  • -mindirect-branch-cs-prefix โ€” adds 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. This allows them to potentially be replaced with lfence; call *%r8-r15 or lfence; jmp *%r8-r15 at run time. Little byte-level glow-up, love that for us โœจ
  • -mapx-inline-asm-use-gpr32 โ€” by default, EGPR usage is disabled in inline asm constraints, because GCC cannot be aware of whether the asm instructions support GP32 or not. If your inline asm can handle EGPR, use -mapx-inline-asm-use-gpr32. Trust fall activated ๐Ÿซถ
  • -mgather, -mscatter โ€” enable vectorization for gather and scatter instructions, respectively. Gotta collect 'em all ๐ŸŒˆ

These -m switches are supported in addition to the above on x86-64 processors in 64-bit environments.


  • -m32, -m64, -mx32, -m16 โ€” 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. Tiny mode, tiny energy ๐Ÿฃ

  • -miamcu โ€” generates code that conforms to Intel MCU psABI. It requires the -m32 option to be turned on. Package deal, babes ๐ŸŽ€
  • -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. It's giving "no free real estate today" ๐Ÿšซ
  • -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. The main character, obviously ๐Ÿ‘‘
  • -mcmodel=kernel โ€” generate code for the kernel code model. The kernel runs in the negative 2 GB of the address space. This model has to be used for Linux kernel code. No negotiating on this one ๐Ÿ’…
  • -mcmodel=medium โ€” generate code for the medium model: the program is linked in the lower 2 GB of the address space. Small symbols are also placed there. Symbols with sizes larger than -mlarge-data-threshold are put into large data or BSS sections and can be located above 2GB. Programs can be statically or dynamically linked.
  • -mcmodel=large โ€” generate code for the large model. This model makes no assumptions about addresses and sizes of sections. It just trusts the process ๐Ÿฆ‹
  • -maddress-mode=long โ€” generate code for long address mode. This is only supported for 64-bit and x32 environments. It is the default address mode for 64-bit environments.
  • -maddress-mode=short โ€” generate code for short address mode. This is only supported for 32-bit and x32 environments. It is the default address mode for 32-bit and x32 environments.
  • -mneeded, -mno-needed โ€” emit GNU_PROPERTY_X86_ISA_1_NEEDED GNU property for Linux target to indicate the micro-architecture ISA level required to execute the binary. Receipts, but for your CPU ๐Ÿงพ
  • -mno-direct-extern-access โ€” without -fpic or -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. That's a real one, bestie, don't mix and match ๐Ÿ’€
  • -munroll-only-small-loops, -mno-unroll-only-small-loops โ€” controls conservative small loop unrolling. It is enabled by default with -O2, and unrolls loops with less than 4 instructions by 1 time. This gives better utilization of the instruction decoding pipeline on modern processors. You can disable this with -mno-unroll-only-small-loops, and it is also disabled if the more general options -funroll-loops or -funroll-all-loops are either enabled or explicitly disabled. Petite loops only, we stan ๐ŸŒธ
  • -mdispatch-scheduler โ€” enable instruction scheduling. This is only supported on bdver1, bdver2, bdver3, bdver4, and znver1 processors and additionally requires -fschedule-insns -fsched-pressure. Very specific guest list, iykyk ๐ŸŽŸ๏ธ
  • -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. Bits doing side quests, obsessed โœจ

x86 Windows Options ๐ŸชŸ

Xstormy16 Options ๐ŸŒช๏ธ

These options are defined for Xstormy16:

  • -msim โ€” choose startup files and linker script suitable for the simulator. Simulator mode: activated ๐Ÿ•น๏ธ

Xtensa Options ๐ŸŽ€

These options are supported for Xtensa targets:

  • -mconst16, -mno-const16 โ€” enable or disable use of CONST16 instructions for loading constant values. 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. Swap out the old, in with the new ๐Ÿ’ซ
  • -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. Order matters, and we're keeping it that way ๐Ÿงš
  • -mforce-no-pic, -mno-force-no-pic โ€” for targets like GNU/Linux, where all user-mode Xtensa code must be position-independent code (PIC), this option disables PIC for compiling kernel code. Kernel privileges only ๐Ÿ’…
  • -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 literals close to you, like a bestie ๐Ÿซถ
  • -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-literalsis used. With-mauto-litpoolsthe literals are interspersed in the text section by the assembler. Compiler does not produce explicit.literaldirectives and loads literals into registers withMOVIinstructions instead ofL32Rto let the assembler do relaxation and place literals as necessary. This option allows assembler to create several literal pools per function and assemble very big functions, which may not be possible with-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 aligns itself, no notes needed ๐Ÿ’…

Okay so Xtensa has โœจopinionsโœจ about how your function calls actually go down, and bestie, we're getting into the weeds ๐Ÿ’…


  • -mlongcalls, -mno-longcalls โ€” turn this on and GCC tells the assembler to translate direct calls into indirect calls, unless it can figure out that the target of a direct call lives in the range the call instruction allows. This translation typically happens for calls to functions in other source files. Specifically, the assembler translates a direct CALL instruction into an L32R followed by a CALLX instruction. The default is -mno-longcalls. You'd want this option in programs where the call target can potentially be out of range. ๐ŸŽฏ
Lowkey important: this option is implemented in the assembler, not the compiler, so the assembly code GCC generates still shows direct call instructions โ€” go look at the disassembled object code to see the actual instructions. And note that the assembler uses an indirect call for every cross-file call, not just those that really are out of range. So yeah, it's giving "we're being safe about literally all of them" ๐Ÿ™ˆ
  • -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 โ€” when this one's enabled, function parameters are passed in registers a2 through a7, registers a12 through a15 are caller-saved, and register a15 may be used as a frame pointer. And when this version of the ABI is enabled, the C preprocessor symbol __XTENSA_CALL0_ABI__ gets defined. โœจ
  • -mabi=windowed โ€” when this one's enabled, function parameters are passed in registers a10 through a15, and the called function rotates the register window by 8 registers on entry so that 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. And 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, in clock cycles. This affects, when optimizing for speed, 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 whole section is about the environment variables that change how GCC does its thing ๐Ÿ’–. Some of them work by handing GCC directories or prefixes to look through when it's hunting for various kinds of files. Others just straight up control other aspects of the compilation environment. Both vibes, honestly.

โœจ important little note โœจ you can ALSO tell GCC where to search using options like -B, -I and -L. And those options take precedence over stuff you set via environment variables, which in turn takes precedence over whatever GCC's own configuration says. So the ranking is: options ๐Ÿ‘‘ โ†’ env vars โ†’ GCC's config. no cap.

๐ŸŒˆ LANG, LC_CTYPE, LC_MESSAGES, LC_ALL

these four control how GCC handles localization โ€” aka letting GCC work with different national conventions for diagnostic and informational output ๐ŸŒ. GCC inspects the locale categories LC_CTYPE and LC_MESSAGES if it has been configured to do so. You can set those locale categories to any value your installation supports. A typical value is en_GB.UTF-8 for English in the United Kingdom encoded in UTF-8. slay.

if LC_ALL 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. And if none of these variables are set, GCC defaults to traditional C English behavior. periodt.

๐Ÿซถ heads up though: these environment variables do <b>not</b> affect the encodings of input files and strings in output files produced by GCC. Those are controlled by the -finput-charset and -fexec-charset options, respectively. different job, different variable, iykyk.

๐ŸŽ€ TMPDIR

if TMPDIR is set, it specifies the directory to use for temporary files. GCC uses temp files to hold the output of one stage of compilation that's gonna be the input to the next stage โ€” for example, the output of the preprocessor, which is the input to the compiler proper. it's giving relay race ๐Ÿƒโ€โ™€๏ธ๐Ÿ’จ.

๐Ÿ’… GCC_DIAGNOSTICS_LOG

if GCC_DIAGNOSTICS_LOG is set, then extra info about the diagnostics subsystem gets emitted โœจ. If it's set to an <b>empty value</b>, that info goes to stderr. Otherwise, GCC will attempt to open that file and write the information there.

๐Ÿ’€ the precise content and format of this info is <b>subject to change</b> โ€” it's intended for use by GCC developers, not end-users. so like, devs only, bestie.

๐Ÿฆ‹ GCC_COMPARE_DEBUG

setting GCC_COMPARE_DEBUG is nearly equivalent to passing -fcompare-debug to the compiler driver. See that option's documentation for more details ๐Ÿ‘‘

๐Ÿ’– 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 gets 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 want to. your call, queen.

if GCC_EXEC_PREFIX is not set, GCC attempts to figure out an appropriate prefix based on the pathname it was 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. classic.

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.

and 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. lowkey iconic behavior ngl.

๐ŸŒŸ 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 ๐Ÿ‘‘).

โœจ 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 <b>bytes</b>, starting at byte 1 for the initial column.
  • fixits-v2 โ€” as "fixits-v1", but columns are expressed as <b>display columns</b>, as per -fdiagnostics-column-unit=display.

๐Ÿงš EXPERIMENTAL_SARIF_SOCKET

if EXPERIMENTAL_SARIF_SOCKET is set in the environment, then the compiler will attempt to connect to a UNIX domain stream socket with that name, and send an "OnSarifResult" JSON-RPC 2.0 notification to it for each diagnostic that occurs, where the value of the notification is a SARIF "result" object.

๐Ÿ’€ the compiler will <b>fail immediately</b> if EXPERIMENTAL_SARIF_SOCKET is set and it cannot connect to it. like, no fallback, just over.
๐Ÿ™ˆ this feature is <b>experimental</b> and subject to change or removal without notice. so don't build your whole personality around it.

some additional environment variables affect the behavior of the preprocessor. yes, more of them. hydrate bestie ๐Ÿ’ง

๐ŸŒˆ 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 <b>semicolon</b>, and for almost all other targets it is a <b>colon</b>.

CPATH specifies a list of directories to be searched as if specified with -I, but <b>after</b> 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 <b>after</b> any paths given with -isystem options on the command line.

in all these variables, an <b>empty element</b> 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. cute, right? ๐ŸŽ€

๐Ÿ’œ 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 <b>ignored</b> 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. multitasking queen โœจ

๐ŸŒธ SUNPRO_DEPENDENCIES

this variable is the same as DEPENDENCIES_OUTPUT (see above), except that system header files are <b>not</b> ignored, so it implies -M rather than -MM. However, the dependence on the main input file is <b>omitted</b>. spicy difference, ik.

โญ 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 <b>reproducible</b> ๐Ÿซถ.

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. no vibes-based timestamps, bestie, be precise ๐Ÿ’…


๐Ÿ’€ BUGS ๐Ÿ’€

for instructions on reporting bugs, see <http://bugzilla.redhat.com/bugzilla>. go tell them, 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.

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

like, go read those too. the lore is deep ๐Ÿ“š


๐ŸŒˆ AUTHOR ๐ŸŒˆ

see the Info entry for gcc, or <https://gcc.gnu.org/onlinedocs/gcc/Contributors.html>, for contributors to GCC. absolute legends, every one of them ๐Ÿ’–


Copyright (c) 1988-2026 Free Software Foundation, Inc.

permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with the Invariant Sections being "GNU General Public License" and "Funding Free Software", the Front-Cover texts being (a) (see below), and with the Back-Cover Texts being (b) (see below). A copy of the license is included in the gfdl(7) man page.

(a) The FSF's Front-Cover Text is:

A GNU Manual

(b) The FSF's Back-Cover Text is:

You have freedom to copy and modify this GNU Manual, like GNU
software.  Copies published by the Free Software Foundation raise
funds for GNU development.

and that's the whole entire page, bestie, we made it to the end ๐ŸŽ‰๐Ÿฆ‹ this was gcc-16.2.1, dated 2026-08-19, for GCC(1) โ€” go forth and compile something iconic, you've got this ๐Ÿ’…โœจ

๐Ÿ“ฆ where this page comes from
  • fedora 44: mingw64-gcc-c++ 16.2.1-1.fc44 ยท 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 ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • ๐Ÿ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms