GCC(1)
๐ gcc(1) โ GNU project C and C++ compiler ๐
bestie. sit down. hydrate. we're reading the gcc manual page together and honestly it's a whole journey ๐
โจ NAME โจ
gcc โ the GNU project C and C++ compiler, aka the icon, the legend, the thing that turns your beautiful little text file into a binary that segfaults at 3am ๐ญ
๐ SYNOPSIS ๐
gcc [-c|-S|-E] [-std=standard]
[-g] [-pg] [-Olevel]
[-Wwarn...] [-Wpedantic]
[-Idir...] [-Ldir...]
[-Dmacro[=defn]...] [-Umacro]
[-foption...] [-mmachine-option...]
[-o outfile] [@file] infile...
okay so like โ this is only the most useful options, not the whole menu. The full buffet is down below. And <hotpink>g++ accepts mostly the same options as gcc</hotpink>, so if you're a C++ girlie you're not left out ๐ซถ
๐ฆ DESCRIPTION ๐ฆ
When you invoke GCC, it normally does preprocessing, compilation, assembly and linking. The "overall options" let you stop this whole process at an intermediate stage โ like hitting pause mid-routine. For example, the -c option says do not run the linker. So the output is just object files, freshly output by the assembler โจ
Other options get passed on to one or more stages of processing. Some options control the preprocessor, others control the compiler itself. And then there are yet other options that control the assembler and the linker โ most of those are not documented here, because ngl you rarely need to use any of them ๐
Most of the command-line options 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, no games. And if the description for a particular option does not mention a source language, you can use that option with all supported languages. periodt ๐
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. iykyk ๐ง
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. not the same vibe at all, do not confuse them ๐
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. she's picky, respect it ๐
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. cute, right? ๐
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 gibibyte, 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. Buckle up bestie, this is the master list ๐
โญ 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 so this is the section EVERYONE actually opens the man page for, and tbh it's a whole buffet ๐ญ there are so many of these that the list itself needs a snack. quick heads-up bestie: the -Wno- entries below are their own separate flags listed exactly as they appear, so don't come for me about the "no", iykyk ๐
here's the full roster, no skips, no cuts, periodt:
-fsyntax-onlyโ just check the syntax, that's the whole assignment โจ-fmax-errors=nโ cap the error spam at n, we love a limit ๐-Wpedanticโ the "well, actually" of warning flags-pedantic-errorsโ pedantic but it means it-fpermissiveโ the chill pill flag-wโ lowercase, one letter, absolute silence ๐-Wextraโ the extras, the bonus tracks-Wallโ the icon, the main character, the one everybody uses ๐-Wabi=nโ ABI vibes, version n-Waddressโ address-related callouts-Wno-address-of-packed-memberโ the off-switch for that one-Waggregate-returnโ aggregate returns get the side-eye-Walloc-sizeโ allocation size, keeping it on brand-Walloc-size-larger-than=byte-sizeโ threshold time, in bytes-Walloc-zeroโ zero-size allocation, noted-Wallocaโallocagets its own flag, obvi-Walloca-larger-than=byte-sizeโ same but with a byte limit-Wauto-profileโ auto-profile era ๐ซ-Wno-aggressive-loop-optimizationsโ turning off the aggressive loop stuff-Warith-conversionโ arithmetic conversions, under the microscope-Warray-boundsโ out-of-bounds array behaviour gets flagged-Warray-bounds=nโ same, but pick your level n-Warray-compareโ comparing arrays, spotted-Warray-parameterโ array parameters, noticed-Warray-parameter=nโ array parameters but with a level-Wno-attributesโ attributes, but make it off-Wattribute-alias=nโ attribute aliasing, level n-Wno-attribute-aliasโ the off version-Wno-attribute-warningโ off again, respectfully-Wbidi-chars=[none|unpaired|any|ucn]โ bidi character check, with four modes:none,unpaired,any,ucn๐ฆ-Wbool-compareโ bools getting compared-Wbool-operationโ bools getting operated on-Wno-builtin-declaration-mismatchโ mismatched builtin decls, silenced-Wno-builtin-macro-redefinedโ redefined builtin macros, silenced-Wc90-c99-compatโ C90 vs C99 compatibility tea โ-Wc99-c11-compatโ C99 vs C11-Wc11-c23-compatโ C11 vs C23-Wc23-c2y-compatโ C23 vs C2y, the new era-Wc++-compatโ C vs C++, the classic crossover episode-Wc++11-compatโ C++11 compatibility-Wc++14-compatโ C++14 compatibility-Wc++17-compatโ C++17 compatibility-Wc++20-compatโ C++20 compatibility-Wc++26-compatโ C++26 compatibility, forward-thinking queen ๐-Wno-c++11-extensionsโ extensions off-Wno-c++14-extensionsโ extensions off-Wno-c++17-extensionsโ extensions off-Wno-c++20-extensionsโ extensions off-Wno-c++23-extensionsโ extensions off (yes there are five of these, I don't make the rules)-Wcalloc-transposed-argsโ transposedcallocargs-Wcannot-profileโ literally "cannot profile", a mood-Wcast-alignโ casting and alignment-Wcast-align=strictโ same but strict mode ๐ฅ-Wcast-function-typeโ function pointer casts-Wcast-qualโ casts that drop qualifiers-Wchar-subscriptsโ char subscripts, underrated-Wclobberedโ clobbered variables, yes ma'am-Wcommentโ comment-related concerns-Wcompare-distinct-pointer-typesโ comparing pointers of different types-Wno-complain-wrong-langโ "don't complain about the wrong language"-Wconversionโ conversions, all up in your business-Wno-coverage-mismatchโ coverage mismatch, off-Wno-cppโ preprocessor warnings, off-Wdangling-elseโ the danglingelseclassic ๐ญ-Wdangling-pointerโ dangling pointers-Wdangling-pointer=nโ dangling pointers, level n-Wdate-timeโ__DATE__/__TIME__-ish energy-Wno-deprecatedโ deprecated stuff, off-Wno-deprecated-declarationsโ deprecated declarations, off-Wno-designated-initโ designated init, off-Wno-deprecated-openmpโ deprecated OpenMP, off-Wdisabled-optimizationโ disabled optimizations get reported-Wno-discarded-array-qualifiersโ off-Wno-discarded-qualifiersโ also off-Wno-div-by-zeroโ div by zero, conspicuously off ๐-Wdouble-promotionโ double promotion, promoted to a warning-Wduplicated-branchesโ duplicated branches-Wduplicated-condโ duplicated conditions-Wempty-bodyโ empty bodies-Wno-endif-labelsโ#endiflabels, off-Wenum-compareโ comparing enums-Wenum-conversionโ converting enums-Wenum-int-mismatchโ enum/int mismatch-Werrorโ every warning becomes an error, no chill, iconic ๐-Werror=*โ same but targeted at specific ones-Wexpansion-to-definedโ macro expansion intodefined-Wfatal-errorsโ first error and we're DONE-Wflex-array-member-not-at-endโ flex array member not at the end-Wfloat-conversionโ float conversions-Wfloat-equalโ comparing floats with==, the eternal discourse-Wformatโ theprintffamily check we all know ๐ซถ-Wformat=2โ the deluxe version-Wno-format-contains-nulโ off-Wno-format-diagโ off-Wno-format-extra-argsโ off-Wformat-nonliteralโ non-literal format strings-Wformat-overflow=nโ format overflow, level n-Wformat-securityโ format security, bestie pls-Wformat-signednessโ signedness in formats-Wformat-truncation=nโ truncation, level n-Wformat-y2kโ yes, y2k. it survived the vibes ๐-Wframe-addressโ frame addresses-Wframe-larger-than=byte-sizeโ frame size limit in bytes-Wno-free-nonheap-objectโ off-Wheader-guardโ header guards-Wno-if-not-alignedโ off-Wno-ignored-attributesโ off-Wignored-qualifiersโ ignored qualifiers, noticed-Wno-incompatible-pointer-typesโ off-Whardenedโ hardened mode ๐ก๏ธ-Wimplicitโ implicit stuff-Wimplicit-fallthroughโ theswitchfallthrough of it all-Wimplicit-fallthrough=nโ fallthrough, level n-Wno-implicit-function-declarationโ off-Wno-implicit-intโ off-Winfinite-recursionโ infinite recursion, gonna be a no from me-Winit-selfโ self-initialization-Winlineโ inlining-Wno-int-conversionโ off-Wint-in-bool-contextโ int where a bool should be-Wno-int-to-pointer-castโ off-Wno-invalid-memory-modelโ off-Winvalid-pchโ invalid precompiled headers-Winvalid-utf8โ invalid UTF-8, rude-Wno-unicodeโ off-Wjump-misses-initโ jump skipping initialization-Wkeyword-macroโ keyword macros-Wlarger-than=byte-sizeโ bigger than byte-size-Wleading-whitespace=kindโ leading whitespace, kind kind-Wlogical-not-parenthesesโ!and parens drama-Wlogical-opโ logical operators-Wlong-longโlong long, the traditional one-Wno-lto-type-mismatchโ off-Wmainโ themainfunction gets checked, main character energy indeed ๐-Wmaybe-uninitializedโ maybe uninitialized, the suspense ๐ญ-Wmemset-elt-sizeโ memset element size-Wmemset-transposed-argsโ transposed memset args-Wmisleading-indentationโ indentation that lies to you-Wmissing-attributesโ missing attributes-Wmissing-bracesโ missing braces-Wmissing-field-initializersโ missing field initializers-Wmissing-format-attributeโ missing format attribute-Wmissing-include-dirsโ include dirs that aren't there-Wmissing-noreturnโ missing noreturn-Wmusttail-local-addrโ musttail + local address-Wmaybe-musttail-local-addrโ the "maybe" version, indecisive queen ๐ฆ-Wno-missing-profileโ off-Wno-multicharโ off-Wmultistatement-macrosโ multi-statement macros-Wnonnullโ nonnull args getting null-Wnonnull-compareโ nonnull comparisons-Wnormalized=[none|id|nfc|nfkc]โ normalization modes:none,id,nfc,nfkcโจ-Wnull-dereferenceโ null dereference, the classic-Wno-odrโ ODR, off-Wopenacc-parallelismโ OpenACC parallelism-Wopenmpโ OpenMP-Wopenmp-simdโ OpenMP SIMD-Wno-overflowโ off-Woverlength-stringsโ strings that are too long-Wno-override-init-side-effectsโ off-Wpackedโ packed structs-Wno-packed-bitfield-compatโ off-Wpacked-not-alignedโ packed and not aligned-Wpaddedโ padding ๐-Wparenthesesโ parentheses, use them bestie-Wno-pedantic-ms-formatโ off-Wpointer-arithโ pointer arithmetic-Wno-pointer-compareโ off-Wno-pointer-to-int-castโ off-Wno-pragmasโ off-Wno-pragma-once-outside-headerโ off-Wno-prio-ctor-dtorโ off-Wno-psabiโ off-Wredundant-declsโ redundant declarations, we see you-Wrestrictโrestrictviolations-Wno-return-local-addrโ off-Wreturn-typeโ return types-Wno-scalar-storage-orderโ off-Wsequence-pointโ sequence points-Wshadowโ shadowing, the naming crime ๐ต๏ธ-Wshadow=globalโ global shadowing-Wshadow=localโ local shadowing-Wshadow=compatible-localโ compatible-local shadowing-Wno-shadow-ivarโ off-Wno-shift-count-negativeโ off-Wno-shift-count-overflowโ off-Wshift-negative-valueโ shifting a negative value-Wno-shift-overflowโ off-Wshift-overflow=nโ shift overflow, level n-Wsign-compareโ signed/unsigned comparison, the villain of every codebase ๐-Wsign-conversionโ sign conversions-Wno-sizeof-array-argumentโ off-Wsizeof-array-divโsizeofarray division-Wsizeof-pointer-divโsizeofpointer division-Wsizeof-pointer-memaccessโsizeofpointer memaccess-Wstack-protectorโ stack protector-Wstack-usage=byte-sizeโ stack usage in bytes-Wstrict-aliasingโ strict aliasing-Wstrict-aliasing=nโ strict aliasing, level n-Wstrict-overflowโ strict overflow-Wstrict-overflow=nโ strict overflow, level n-Wstring-compareโ string comparison-Wno-stringop-overflowโ off-Wno-stringop-overreadโ off-Wno-stringop-truncationโ off-Wstrict-flex-arraysโ strict flex arrays-Wsuggest-attribute=attribute-nameโ suggests an attribute, name it in attribute-name-Wswitchโ switches-Wno-switch-boolโ off-Wswitch-defaultโ missingdefault-Wswitch-enumโ switch over enums-Wno-switch-outside-rangeโ off-Wno-switch-unreachableโ off-Wsync-nandโ the__sync_nandsituation-Wsystem-headersโ warnings from system headers too, brave-Wtautological-compareโ comparing something to itself-Wtrailing-whitespaceโ trailing whitespace, the lint of lints-Wtrailing-whitespace=kindโ trailing whitespace, kind kind-Wtrampolinesโ trampolines ๐ช-Wtrigraphsโ trigraphs, ancient lore-Wtrivial-auto-var-initโ trivial auto var init-Wno-tsanโ ThreadSanitizer warnings, off-Wtype-limitsโ type limits-Wundefโ undefined identifiers in#if-Wuninitializedโ uninitialized vars, bestie pls initialize-Wunknown-pragmasโ pragmas nobody recognizes-Wunsuffixed-float-constantsโ float constants with no suffix-Wunterminated-string-initializationโ unterminated string initialization-Wunusedโ the whole unused family, the umbrella-Wunused-but-set-parameterโ set but never used, parameter edition-Wunused-but-set-parameter=nโ same, level n-Wunused-but-set-variableโ set but never used, variable edition-Wunused-but-set-variable=nโ same, level n-Wunused-const-variableโ unused const variable-Wunused-const-variable=nโ same, level n-Wunused-functionโ unused functions-Wunused-labelโ unused labels-Wunused-local-typedefsโ unused local typedefs-Wunused-macrosโ unused macros-Wunused-parameterโ unused parameters-Wno-unused-resultโ off-Wunused-valueโ unused values-Wunused-variableโ unused variables-Wuse-after-freeโ use after free, the horror ๐-Wuse-after-free=nโ same, level n-Wuseless-castโ casts that do literally nothing-Wno-varargsโ off-Wvariadic-macrosโ variadic macros-Wvector-operation-performanceโ vector operation performance-Wvlaโ variable length arrays-Wvla-larger-than=byte-sizeโ VLA bigger than byte-size-Wno-vla-larger-thanโ off-Wvolatile-register-varโ volatile register variables-Wwrite-stringsโ write strings-Wno-xor-used-as-powโ off-Wzero-as-null-pointer-constantโ zero as a null pointer constant, we've all done it-Wzero-length-boundsโ zero-length bounds--all-warningsโ long-form, all of them--extra-warningsโ long-form, the extras--no-warningsโ long-form, none of them--pedanticโ long-form pedantic--pedantic-errorsโ long-form pedantic-errors
๐ Static Analyzer Options ๐
okay so this is the analyzer era, the "let me actually look at your code before you run it" moment ๐ it's a whole ecosystem down here, with dumps and checkers and verbosity levels. no cap, it's a lot.
-fanalyzerโ the whole analyzer, the big one, the moment ๐ฅ-fanalyzer-assume-nothrowโ assume nothing throws-fanalyzer-call-summariesโ call summaries-fanalyzer-checker=nameโ pick a specific checker by name-fno-analyzer-feasibilityโ feasibility, off-fanalyzer-show-events-in-system-headersโ show events happening in system headers-fno-analyzer-state-mergeโ state merging, off-fno-analyzer-state-purgeโ state purging, off-fno-analyzer-suppress-followupsโ followups not suppressed-fanalyzer-transitivityโ transitivity-fno-analyzer-undo-inliningโ inlining undo, off-fanalyzer-verbose-edgesโ verbose edges-fanalyzer-verbose-state-changesโ verbose state changes-fanalyzer-verbosity=levelโ verbosity, level level-fdump-analyzerโ dump it all ๐๏ธ-fdump-analyzer-callgraphโ dump the callgraph-fdump-analyzer-exploded-graphโ exploded graph, dramatic name, love it-fdump-analyzer-exploded-nodesโ exploded nodes-fdump-analyzer-exploded-nodes-2โ exploded nodes, the sequel-fdump-analyzer-exploded-nodes-3โ exploded nodes, threequel-fdump-analyzer-exploded-pathsโ exploded paths-fdump-analyzer-feasibilityโ dump feasibility-fdump-analyzer-infinite-loopโ dump the infinite loop-fdump-analyzer-jsonโ dump it as JSON ๐-fdump-analyzer-state-purgeโ dump state purge-fdump-analyzer-stderrโ dump to stderr-fdump-analyzer-supergraphโ supergraph ๐ซ-fdump-analyzer-untrackedโ dump untracked-Wno-analyzer-double-fcloseโ off-Wno-analyzer-double-freeโ off-Wno-analyzer-exposure-through-output-fileโ off-Wno-analyzer-exposure-through-uninit-copyโ off-Wno-analyzer-fd-access-mode-mismatchโ off-Wno-analyzer-fd-double-closeโ off-Wno-analyzer-fd-leakโ off-Wno-analyzer-fd-phase-mismatchโ off-Wno-analyzer-fd-type-mismatchโ off-Wno-analyzer-fd-use-after-closeโ off-Wno-analyzer-fd-use-without-checkโ off-Wno-analyzer-file-leakโ off-Wno-analyzer-free-of-non-heapโ off-Wno-analyzer-imprecise-fp-arithmeticโ off-Wno-analyzer-infinite-loopโ off-Wno-analyzer-infinite-recursionโ off-Wno-analyzer-jump-through-nullโ off-Wno-analyzer-malloc-leakโ off-Wno-analyzer-mismatching-deallocationโ off-Wno-analyzer-null-argumentโ off-Wno-analyzer-null-dereferenceโ off-Wno-analyzer-out-of-boundsโ off-Wno-analyzer-overlapping-buffersโ off-Wno-analyzer-possible-null-argumentโ off-Wno-analyzer-possible-null-dereferenceโ off-Wno-analyzer-putenv-of-auto-varโ off-Wno-analyzer-shift-count-negativeโ off-Wno-analyzer-shift-count-overflowโ off-Wno-analyzer-stale-setjmp-bufferโ off-Wno-analyzer-tainted-allocation-sizeโ off-Wno-analyzer-tainted-assertionโ off-Wno-analyzer-tainted-array-indexโ off-Wno-analyzer-tainted-divisorโ off-Wno-analyzer-tainted-offsetโ off-Wno-analyzer-tainted-sizeโ off-Wno-analyzer-throw-of-unexpected-typeโ off-Wanalyzer-symbol-too-complexโ symbol too complex, relatable ๐ญ-Wanalyzer-too-complexโ analyzer too complex, also relatable-Wno-analyzer-undefined-behavior-ptrdiffโ off-Wno-analyzer-undefined-behavior-strtokโ off-Wno-analyzer-unsafe-call-within-signal-handlerโ off-Wno-analyzer-use-after-freeโ off-Wno-analyzer-use-of-pointer-in-stale-stack-frameโ off-Wno-analyzer-use-of-uninitialized-valueโ off-Wno-analyzer-va-arg-type-mismatchโ off-Wno-analyzer-va-list-exhaustedโ off-Wno-analyzer-va-list-leakโ off-Wno-analyzer-va-list-use-after-va-endโ off-Wno-analyzer-write-to-constโ off-Wno-analyzer-write-to-string-literalโ off
๐ธ C and Objective-C-only Warning Options ๐ธ
these ones are exclusively for the C and Objective-C girlies โ if you're writing C++ they're just not your lane, and that's okay ๐ซถ
-Wbad-function-castโ bad function casts-Wdeprecated-non-prototypeโ deprecated non-prototype style-Wfree-labelsโ free labels-Wmissing-declarationsโ missing declarations-Wmissing-parameter-nameโ parameter with no name-Wmissing-parameter-typeโ parameter with no type-Wdeclaration-missing-parameter-typeโ declaration missing a parameter type-Wmissing-prototypesโ missing prototypes-Wmissing-variable-declarationsโ missing variable declarations-Wmultiple-parameter-fwd-decl-listsโ multiple parameter forward decl lists-Wnested-externsโ nestedexterns-Wold-style-declarationโ old-style declarations, vintage-Wold-style-definitionโ old-style definitions, also vintage-Wstrict-prototypesโ strict prototypes-Wtraditionalโ traditional mode, ancient times ๐บ-Wtraditional-conversionโ traditional conversions-Wdeclaration-after-statementโ declarations after statements-Wpointer-signโ pointer signedness
๐ Debugging Options ๐
okay debug girlies rise, this is your section โ -g and all its little friends, plus the DWARF lore and the dumpy bits. ngl there is SO much down here but we're getting through it together ๐
-gโ the one, the only, generate debug info ๐-glevelโ-gbut with a level-gdwarfโ DWARF format-gdwarf-versionโ DWARF, but pick a version-gbtfโ BTF-gctfโ CTF-gctflevelโ CTF with a level-gno-prune-btfโ don't prune BTF-ggdbโ the GDB-flavoured version ๐ซถ-gno-record-gcc-switchesโ don't record the gcc switches-gstrict-dwarfโ strict DWARF-gas-loc-supportโ asm loc support-gas-locview-supportโ asm locview support-gcodeviewโ CodeView output-gcolumn-infoโ column info-gdwarf32โ DWARF32-gdwarf64โ DWARF64-gno-statement-frontiersโ no statement frontiers-gno-variable-location-viewsโ no variable location views-gvariable-location-views=incompat5โ variable location views,incompat5(yes, exactly like that)-ginternal-reset-location-viewsโ internal reset location views-ginline-pointsโ inline points-gvmsโ VMS format-gz[=type]โ compress the debug sections, optionally as type โจ-gsplit-dwarfโ split DWARF files-gdescribe-diesโ describe DIEs-fdebug-prefix-map=old=newโ remapoldtonewin debug info-fdebug-types-sectionโ a debug types section-fno-eliminate-unused-debug-typesโ don't eliminate unused debug types-femit-struct-debug-baseonlyโ emit struct debug info, base only-femit-struct-debug-reducedโ emit struct debug info, reduced-femit-struct-debug-detailed[=spec-list]โ emit struct debug info, detailed, with an optional spec-list-fno-eliminate-unused-debug-symbolsโ don't eliminate unused debug symbols-femit-class-debug-alwaysโ always emit class debug info-fno-merge-debug-stringsโ don't merge debug strings-fno-dwarf2-cfi-asmโ no DWARF2 CFI asm-fvar-trackingโ variable tracking-fvar-tracking-assignmentsโ variable tracking assignments-fvar-tracking-uninitโ variable tracking, uninit edition--debugโ long-form debug, the glamorous alias ๐
okay so we're still in OPTIONS and now we're hitting the optimization ones, which are literally the main character energy of gcc. no cap, there are so many flags here that it's giving "i have a spreadsheet for my coffee order." here's every single one, bestie, do not lose focus:
โจ Optimization Options โจ
this is the biggest vibe check in the whole page. it's giving "i have 300 settings and i'm not afraid to use them." every flag is listed exactly, no skips, no edits:
-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-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-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-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
and that's the optimization section, periodt. now let's talk instrumentation.
๐ Program Instrumentation Options ๐
this is the section where you tell gcc to spy on your program for science. it's giving "i'm not nosy, i'm just collecting data." every flag, unchanged:
-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
instrumentation? slayed. moving on.
๐ฆ Preprocessor Options ๐ฆ
this is where the preprocessor lives, bestie. it's the part that runs before your code even knows what hit it. all the flags, exactly:
-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
preprocessor done. now the little assembler corner.
๐ธ Assembler Options ๐ธ
just three, bestie, but they matter:
-Wa,option-Xassembler option--for-assembler=option
๐ Linker Options ๐
this is the linker section and it's highkey iconic. every single option, no cap:
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
๐ง Directory Options ๐ง
directory paths and include stuff, all here:
-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, --no-canonical-prefixes shows up twice in the original, so it shows up twice here too. consistency, bestie.)
๐ฅ Code Generation Options ๐ฅ
last little group in this part, and it's giving "i control how the code actually gets made." all the flags:
-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
okay that's the code gen options done. next part is still coming, don't go anywhere. ๐
๐ ๏ธ Developer Options ๐ ๏ธ
okay bestie, this is the compilerโs backstage-pass zone: dev-only knobs, dumps, reports, and โwhat is GCC even doingโ switches. No cap, every single one is here ๐
-dlettersโ the dev dump switch wherelettersdoes the lilโ dump thing โจ-dumpspecsโ dumps the specs, literally what it says ๐-dumpmachineโ prints the target machine ๐ฅ๏ธ-dumpversionโ prints the version, short and sweet ๐-dumpfullversionโ prints the full version, no truncation energy ๐ธ-fcallgraph-info[=su,da]โ callgraph info, optionally withsu,da๐ฆ-fcheckingโ turns on checking vibes ๐-fchecking=nโ checking at leveln, bestie โจ-fdbg-cnt-listโ lists the debug counter names ๐-fdbg-cnt=counter-value-listโ sets debug counters fromcounter-value-list๐-fdisable-ipa-pass_nameโ disables the IPA pass calledpass_name๐-fdisable-rtl-pass_nameโ disables the RTL pass calledpass_name๐ฅ-fdisable-rtl-pass-name=range-listโ disables that RTL pass forrange-list๐-fdisable-tree-pass_nameโ disables the tree pass calledpass_name๐ฟ-fdisable-tree-pass-name=range-listโ disables that tree pass forrange-list๐-fdump-debugโ dumps debug info ๐-fdump-earlydebugโ dumps early debug info, before the glow-up โจ-fdump-noaddrโ dumps without addresses ๐-fdump-unnumberedโ dumps without numbers ๐ข-fdump-unnumbered-linksโ dumps unnumbered links ๐-fdump-final-insns[=file]โ dumps final insns, optionally intofile๐-fdump-internal-locationsโ dumps internal locations ๐-fdump-ipa-allโ dumps all the IPA stuff ๐-fdump-ipa-cgraphโ dumps the IPA callgraph ๐ธ๏ธ-fdump-ipa-inlineโ dumps IPA inlining info ๐ซถ-fdump-lang-allโ dumps all the language-specific stuff ๐ฃ๏ธ-fdump-lang-switchโ language dump switch, iykyk ๐-fdump-lang-switch-optionsโ language dump switch options ๐๏ธ-fdump-lang-switch-options=filenameโ same but writes tofilename๐-fdump-passesโ dumps the passes ๐-fdump-rtl-passโ dumps the RTL pass, the classic ๐-fdump-rtl-pass=filenameโ dumps the RTL pass intofilename๐-fdump-statisticsโ dumps statistics, numbers girlie ๐-fdump-tree-allโ dumps all the tree passes ๐ณ-fdump-tree-switchโ tree dump switch ๐-fdump-tree-switch-optionsโ tree dump switch options ๐๏ธ-fdump-tree-switch-options=filenameโ tree dump switch options intofilename๐-fcompare-debug[=opts]โ compares debug output, optionally withopts๐-fcompare-debug-secondโ the second compare-debug pass, bestie โ๏ธ-fenable-kind-passโ enables akindof pass by name โ-fenable-kind-pass=range-listโ enables that kind of pass forrange-list๐ฏ-fira-verbose=nโ IRA verbosity leveln๐ฃ๏ธ-flto-reportโ LTO report time ๐-flto-report-wpaโ LTO WPA report time ๐-fmem-report-wpaโ WPA memory report ๐ง-fmem-reportโ memory report, the receipts ๐พ-fpre-ipa-mem-reportโ pre-IPA memory report ๐งฎ-fpost-ipa-mem-reportโ post-IPA memory report ๐งฎ-fopt-infoโ optimization info, the tea โ-fopt-info-options[=file]โ opt-info options, optionally intofile๐-fmultiflagsโ multiflags mode, periodt ๐-fprofile-reportโ profile report ๐-frandom-seed=stringโ sets the random seed fromstring๐ฒ-fsched-verbose=nโ scheduler verbosity leveln๐๏ธ-fsel-sched-verboseโ selective scheduler verbosity ๐ฃ๏ธ-fsel-sched-dump-cfgโ dumps the selective scheduler CFG ๐ธ๏ธ-fsel-sched-pipelining-verboseโ selective scheduler pipelining verbosity ๐ฐ-fstatsโ stats mode ๐-fstack-usageโ stack usage info ๐ฅ-ftime-reportโ time report โฑ๏ธ-ftime-report-detailsโ time report with details ๐-fvar-tracking-assignments-toggleโ toggles var-tracking assignments ๐-gtoggleโ toggles debug info generation ๐-print-autofdo-gcov-versionโ prints the AutoFDO gcov version ๐-print-file-name=libraryโ prints the full path oflibrary๐-print-libgcc-file-nameโ prints thelibgccfile name ๐-print-multi-directoryโ prints the multi directory ๐-print-multi-libโ prints multi-lib info ๐ง-print-multi-os-directoryโ prints the multi OS directory ๐๏ธ-print-multiarchโ prints the multiarch ๐-print-prog-name=programโ prints the name ofprogram๐ท๏ธ-print-search-dirsโ prints search dirs ๐-Qโ the compilerโs โwhat are you doingโ switch ๐-print-sysrootโ prints the sysroot ๐ฑ-print-sysroot-headers-suffixโ prints the sysroot headers suffix ๐ท๏ธ-save-tempsโ saves temp files, no deleting the receipts ๐พ-save-temps=cwdโ saves temps in the current working directory ๐-save-temps=objโ saves temps by the object output ๐ฆ-specs=fileโ usesfileas the specs file ๐-time[=file]โ times stuff, optionally intofileโฑ๏ธ--dump=lettersโ long-form dump switch withlettersโจ--print-autofdo-gcov-versionโ long-form AutoFDO gcov version print ๐--print-file-name=libraryโ long-form print oflibraryโs path ๐--print-libgcc-file-file-nameโ long-formlibgccfile name print, exactly as written bestie ๐--print-multi-directoryโ long-form multi directory print ๐--print-multi-libโ long-form multi-lib print ๐ง--print-multi-os-directoryโ long-form multi OS directory print ๐๏ธ--print-multiarchโ long-form multiarch print ๐--print-prog-name=programโ long-form print ofprogramโs name ๐ท๏ธ--print-search-dirsโ long-form search-dirs print ๐--print-sysrootโ long-form sysroot print ๐ฑ--print-sysroot-headers-suffixโ long-form sysroot headers suffix print ๐ท๏ธ--save-tempsโ long-form save-temps ๐พ--specs=fileโ long-form specs file ๐--param name=valueโ sets parameternametovalue๐๏ธ
๐ Target-Specific Options ๐
these are the per-architecture menus, bestie โ same compiler, different little machine-specific flavors ๐
๐ธ AArch64 Options (AArch64 Options) ๐ธ
-mabi=nameโ ABI isname๐ท๏ธ-mbig-endianโ big-endian mode ๐-mlittle-endianโ little-endian mode ๐-menable-sysreg-checkingโ enables sysreg checking ๐-mgeneral-regs-onlyโ general registers only, no extras ๐-mcmodel=tinyโ code modeltiny๐ฃ-mcmodel=smallโ code modelsmall๐ฅ-mcmodel=largeโ code modellarge๐ฆ-mstrict-alignโ strict alignment vibes ๐-momit-leaf-frame-pointerโ omits the leaf frame pointer ๐-mtls-dialect=descโ TLS dialectdesc๐งต-mtls-dialect=traditionalโ TLS dialecttraditional๐งถ-mtls-size=sizeโ TLS size issize๐-mtp=nameโ thread pointer stylename๐-mfix-cortex-a53-835769โ the Cortex-A53 835769 fix ๐ ๏ธ-mfix-cortex-a53-843419โ the Cortex-A53 843419 fix ๐ ๏ธ-mlow-precision-recip-sqrtโ low-precision reciprocal sqrt ๐งฎ-mlow-precision-sqrtโ low-precision sqrt ๐งฎ-mlow-precision-divโ low-precision divide โ-mmax-vectorizationโ max vectorization mode ๐-mautovec-preference=nameโ autovec preferencename๐๏ธ-mpc-relative-literal-loadsโ PC-relative literal loads ๐ฆ-msign-return-address=scopeโ return-address signing scopescopeโ๏ธ-mbranch-protection=featuresโ branch protectionfeatures๐ก๏ธ-mharden-sls=optsโ SLS hardening withopts๐งฑ-march=nameโ architecture isname๐๏ธ-mcpu=nameโ CPU isname๐ง-mtune=nameโ tune forname๐ถ-moverride=stringโ override stringstring๐๏ธ-mstack-protector-guard=guardโ stack protector guard isguard๐ก๏ธ-mstack-protector-guard-reg=sysregโ guard register issysreg๐-mstack-protector-guard-offset=offsetโ guard offset isoffset๐-mtrack-speculationโ tracks speculation ๐-moutline-atomicsโ outline atomics mode ๐งต-mearly-raโ early RA mode ๐-mearly-ldp-fusionโ early LDP fusion ๐งฌ-mlate-ldp-fusionโ late LDP fusion ๐งฌ-mnarrow-gp-writesโ narrow GP writes โ๏ธ-msve-vector-bits=bitsโ SVE vector bits isbits๐งฎ
๐ผ Adapteva Epiphany Options (Adapteva Epiphany Options) ๐ผ
-mhalf-reg-fileโ half register file mode ๐งบ-mprefer-short-insn-regsโ prefers short insn regs ๐ฉณ-mbranch-cost=numโ branch cost isnum๐ฟ-mcmoveโ cmove mode ๐-mnops=numโ nops isnum๐ด-msoft-cmpsfโ soft cmpsf mode ๐งธ-msplit-lohiโ split lo/hi ๐ช-mpost-incโ post increment mode โ-mpost-modifyโ post modify mode โ๏ธ-mstack-offset=numโ stack offset isnum๐-mround-nearestโ round nearest ๐ฏ-mlong-callsโ long calls mode ๐-mshort-callsโ short calls mode ๐-msmall16โ small16 mode ๐-mfp-mode=modeโ FP mode ismode๐งฎ-mmay-round-for-truncโ may round for trunc ๐-mfp-iarithโ FP iarith mode โ-mvect-doubleโ vector double mode ๐งฌ-max-vect-align=numโ max vector alignment isnum๐-msplit-vecmove-earlyโ split vecmove early ๐-m1reg-regโ 1reg-reg mode 1๏ธโฃ
๐ฅ AMD GCN Options (AMD GCN Options) ๐ฅ
-march=gpuโ architecture isgpu๐๏ธ-mtune=gpuโ tune forgpu๐ถ-mgang-private-size=bytesโ gang-private size isbytes๐ฆ-msram-ecc=[on|off|any]โ SRAM ECC ison,off, orany๐ก๏ธ-mxnack=[on|off|any]โ XNACK ison,off, orany๐งต-Wopenacc-dimsโ OpenACC dims warning ๐
๐ง ARC Options (ARC Options) ๐ง
-mbarrel-shifterโ barrel shifter mode ๐-mjli-alwaysโ JLI always mode ๐-mcpu=cpuโ CPU iscpu๐ง-mA6โ A6 mode ๐ ฐ๏ธ6๏ธโฃ-mARC600โ ARC600 mode ๐ ฐ๏ธ-mA7โ A7 mode ๐ ฐ๏ธ7๏ธโฃ-mARC700โ ARC700 mode ๐ ฐ๏ธ-mdpfpโ DPFP mode ๐งฎ-mdpfp-compactโ DPFP compact ๐งณ-mdpfp-fastโ DPFP fast โก-mno-dpfp-lrsrโ no DPFP LRSR ๐ซ-meaโ EA mode ๐ฑ-mmul32x16โ 32x16 multiply โ๏ธ-mmul64โ 64-bit multiply โ๏ธ-matomicโ atomic mode โ๏ธ-mnormโ norm mode ๐งผ-mspfpโ SPFP mode ๐งฎ-mspfp-compactโ SPFP compact ๐งณ-mspfp-fastโ SPFP fast โก-msimdโ SIMD mode ๐งฌ-msoft-floatโ soft float mode ๐งธ-mswapโ swap mode ๐-mlockโ lock mode ๐-mswapeโ swape mode ๐-mxyโ XY mode ๐งญ-misizeโ isize mode ๐-marclinuxโ ARC Linux mode ๐ง-marclinux_profโ ARC Linux prof mode ๐-mlong-callsโ long calls mode ๐-mmedium-callsโ medium calls mode ๐-msdataโ sdata mode ๐ฆ-mirq-ctrl-savedโ IRQ ctrl saved ๐จ-mrgf-banked-regsโ RGF banked regs ๐ฆ-mlpc-width=widthโ LPC width iswidth๐-G numโ G isnum๐ ถ-mvolatile-cacheโ volatile cache mode ๐ช๏ธ-mtp-regno=regnoโ TP regno isregno๐-mbitopsโ bitops mode ๐งฎ-mcmemโ cmem mode ๐ง-munaligned-accessโ unaligned access mode ๐-mauto-modify-regโ auto modify reg ๐-mno-brccโ no brcc ๐ซ-mcase-vector-pcrelโ case vector PC-relative ๐งญ-mno-cond-execโ no cond exec ๐ซ-mearly-cbranchsiโ early cbranchsi ๐-mindexed-loadsโ indexed loads ๐ฅ-mlra-priority-noneโ LRA priority none ๐-mlra-priority-compactโ LRA priority compact ๐งณ-mlra-priority-noncompactโ LRA priority noncompact ๐งณ-mmillicodeโ millicode mode ๐งฌ-msize-level=levelโ size level islevel๐-mtune=cpuโ tune forcpu๐ถ-mmultcost=numโ mult cost isnumโ๏ธ-mcode-density-frameโ code density frame ๐งฑ-mmpy-option=multoโ mpy option ismultoโ๏ธ-mdiv-remโ div/rem mode โ-mcode-densityโ code density mode ๐งฑ-mll64โ LL64 mode ๐งฌ-mfpu=fpuโ FPU isfpu๐งฎ-mrf16โ RF16 mode ๐งบ-mbranch-indexโ branch index mode ๐ฟ
๐ฆ ARM Options (ARM Options) ๐ฆ
-mapcs-frameโ APCS frame mode ๐ผ๏ธ-mapcsโ APCS mode ๐งต-mabi=nameโ ABI isname๐ท๏ธ-mgeneral-regs-onlyโ general regs only ๐-mno-sched-prologโ no scheduled prolog ๐ซ-mlittle-endianโ little-endian mode ๐-mbig-endianโ big-endian mode ๐-mbe8โ BE8 mode ๐งญ-mbe32โ BE32 mode ๐งญ-mfloat-abi=nameโ float ABI isname๐งฎ-mfp16-format=nameโ FP16 format isname๐-mthumb-interworkโ Thumb interwork mode ๐-mcpu=nameโ CPU isname๐ง-march=nameโ architecture isname๐๏ธ-mfpu=nameโ FPU isname๐งฎ-mtune=nameโ tune forname๐ถ-mstructure-size-boundary=nโ structure size boundary isn๐-mabort-on-noreturnโ abort on noreturn ๐จ-mlong-callsโ long calls mode ๐-msingle-pic-baseโ single PIC base 1๏ธโฃ-mpic-register=regโ PIC register isreg๐-mpic-data-is-text-relativeโ PIC data is text-relative ๐งญ-mnop-fun-dllimportโ no fun dllimport ๐ซ-mpoke-function-nameโ poke function name ๐-mthumbโ Thumb mode ๐-marmโ ARM mode ๐ช-mtpcs-frameโ TPCS frame mode ๐ผ๏ธ-mtpcs-leaf-frameโ TPCS leaf frame mode ๐-mcaller-super-interworkingโ caller super-interworking ๐-mcallee-super-interworkingโ callee super-interworking ๐-mtp=nameโ thread pointer stylename๐-mtls-dialect=dialectโ TLS dialect isdialect๐งต-mword-relocationsโ word relocations mode ๐ฆ-mfix-cortex-m3-ldrdโ Cortex-M3 LDRD fix ๐ ๏ธ-mfix-cortex-a57-aes-1742098โ Cortex-A57 AES 1742098 fix ๐ ๏ธ-mfix-cortex-a72-aes-1655431โ Cortex-A72 AES 1655431 fix ๐ ๏ธ-munaligned-accessโ unaligned access mode ๐-mslow-flash-dataโ slow flash data mode ๐ข-masm-syntax-unifiedโ unified asm syntax ๐งต-mrestrict-itโ restrict IT mode ๐ง-mpure-codeโ pure code mode ๐งผ-mcmseโ CMSE mode ๐ก๏ธ-mfix-cmse-cve-2021-35465โ CMSE CVE-2021-35465 fix ๐ ๏ธ-mstack-protector-guard=guardโ stack protector guard isguard๐ก๏ธ-mstack-protector-guard-offset=offsetโ guard offset isoffset๐-mfdpicโ FDPIC mode ๐งญ-mbranch-protection=featuresโ branch protectionfeatures๐ก๏ธ-mvectorize-with-neon-quadโ vectorize with NEON quad ๐-mvectorize-with-neon-doubleโ vectorize with NEON double ๐
๐ AVR Options (AVR Options) ๐
-mmcu=mcuโ MCU ismcu๐ง-mabsdataโ absdata mode ๐ฆ-maccumulate-argsโ accumulate args mode ๐งบ-mcvtโ CVT mode ๐-mbranch-cost=costโ branch cost iscost๐ฟ-mfuse-add=levelโ fuse add levellevelโ-mfuse-move=levelโ fuse move levellevel๐-mfuse-move2โ fuse move 2 mode ๐-mcall-prologuesโ call prologues mode ๐-mgas-isr-prologuesโ gas ISR prologues mode ๐งต-mint8โ int8 mode 8๏ธโฃ-mflmapโ flmap mode ๐บ๏ธ-mdouble=bitsโ double isbits๐งฎ-mlong-double=bitsโ long double isbits๐งฎ-mno-call-mainโ no call main ๐ซ-mn_flash=sizeโ n_flash issize๐-mfract-convert-truncateโ fract convert truncate mode ๐-mno-interruptsโ no interrupts ๐ซ-mmain-is-OS_taskโ main is OS_task mode ๐งต-mrelaxโ relax mode ๐-mpmem-wrap-aroundโ pmem wrap around mode ๐-mrmwโ RMW mode ๐-mstrict-Xโ strict X mode ๐-mtiny-stackโ tiny stack mode ๐-mrodata-in-ramโ rodata in RAM mode ๐ง-msplit-bit-shiftโ split bit shift mode ๐ช-msplit-ldstโ split ldst mode ๐ช-mshort-callsโ short calls mode ๐-mskip-bugโ skip bug mode ๐-muse-nonzero-bitsโ use nonzero bits mode 1๏ธโฃ-nodevicelibโ no devicelib ๐ซ-nodevicespecsโ no devicespecs ๐ซ-Waddr-space-convertโ address-space conversion warning โ ๏ธ-Wmisspelled-isrโ misspelled ISR warning โ ๏ธ
๐ค Blackfin Options (Blackfin Options) ๐ค
-mcpu=cpu[-sirevision]โ CPU iscpuwith optional[-sirevision], exactly like that ๐ง-msimโ simulator mode ๐ฎ-momit-leaf-frame-pointerโ omits leaf frame pointer ๐-mspecld-anomalyโ specld anomaly mode ๐-mcsync-anomalyโ csync anomaly mode ๐-mlow-64kโ low 64K mode ๐ฝ-mstack-check-l1โ L1 stack check mode ๐ฅ-mid-shared-libraryโ ID shared library mode ๐-mleaf-id-shared-libraryโ leaf ID shared library mode ๐-mshared-library-id=nโ shared library ID isn๐-msep-dataโ separate data mode ๐๏ธ-mlong-callsโ long calls mode ๐-mfast-fpโ fast FP mode โก-minline-pltโ inline PLT mode ๐ฅ-mmulticoreโ multicore mode ๐ง-mcoreaโ CoreA mode ๐ ฐ๏ธ-mcorebโ CoreB mode ๐ ฑ๏ธ-msdramโ SDRAM mode ๐ง-micplbโ ICPLB mode ๐
๐งต C6X Options (C6X Options) ๐งต
-mbig-endianโ big-endian mode ๐-mlittle-endianโ little-endian mode ๐-march=cpuโ architecture iscpu๐๏ธ-msimโ simulator mode ๐ฎ-msdata=sdata-typeโ sdata type issdata-type๐ฆ-mdsbtโ DSBT mode ๐งญ-mlong-callsโ long calls mode ๐
๐ฟ CRIS Options (CRIS Options) ๐ฟ
-mcpu=cpuโ CPU iscpu๐ง-march=cpuโ architecture iscpu๐๏ธ-mtune=cpuโ tune forcpu๐ถ-mmax-stackframe=nโ max stackframe isn๐ฅ-metrax4โ ETRAX 4 mode 4๏ธโฃ-metrax100โ ETRAX 100 mode ๐ฏ-mpdebugโ pdebug mode ๐-mcc-initโ CC init mode ๐งต-mno-side-effectsโ no side effects ๐ซ-mstack-alignโ stack align mode ๐-mdata-alignโ data align mode ๐-mconst-alignโ const align mode ๐-m32-bitโ 32-bit mode 3๏ธโฃ2๏ธโฃ-m16-bitโ 16-bit mode 1๏ธโฃ6๏ธโฃ-m8-bitโ 8-bit mode 8๏ธโฃ-mno-prologue-epilogueโ no prologue/epilogue ๐ซ-mbest-lib-optionsโ best lib options mode ๐-moverride-best-lib-optionsโ override best lib options mode ๐๏ธ-mtrap-using-break8โ trap using break8 mode ๐จ-mtrap-unaligned-atomicโ trap unaligned atomic mode ๐จ-munaligned-atomic-may-use-libraryโ unaligned atomic may use library mode ๐-simโ sim mode ๐ฎ-sim2โ sim2 mode ๐ฎ-mmul-bug-workaroundโ multiply bug workaround ๐
๐ง C-SKY Options (C-SKY Options) ๐ง
-march=archโ architecture isarch๐๏ธ-mcpu=cpuโ CPU iscpu๐ง-mbig-endianโ big-endian mode ๐-mlittle-endianโ little-endian mode ๐-mfpu=fpuโ FPU isfpu๐งฎ-mdouble-floatโ double float mode ๐งฎ-mfdivduโ fdivdu mode โ-mfloat-abi=nameโ float ABI isname๐งฎ-melrwโ elrw mode ๐-mistackโ istack mode ๐ฅ-mmpโ MP mode ๐ง-mcpโ CP mode ๐งต-mcacheโ cache mode ๐๏ธ-msecurityโ security mode ๐ก๏ธ-mtrustโ trust mode ๐ค-mdspโ DSP mode ๐๏ธ-medspโ EDSP mode ๐๏ธ-mvdspโ VDSP mode ๐๏ธ-mdivโ div mode โ-msmartโ smart mode ๐ง-mhigh-registersโ high registers mode โฌ๏ธ-manchorโ anchor mode โ-mpushpopโ push/pop mode ๐ฅ-mmultiple-stldโ multiple st/ld mode ๐-mconstpoolโ constpool mode ๐-mstack-sizeโ stack size mode ๐ฅ-mccrtโ CCRT mode ๐งต-mbranch-cost=nโ branch cost isn๐ฟ-msched-prologโ scheduled prolog mode ๐๏ธ-msimโ simulator mode ๐ฎ
๐ง Cygwin and MinGW Options (Cygwin and MinGW Options) ๐ง
-mconsoleโ console mode ๐ฅ๏ธ-mcrtdll=libraryโ CRT DLL islibrary๐-mdllโ DLL mode ๐ฆ-mnop-fun-dllimportโ no fun dllimport ๐ซ-mthreadsโ threads mode ๐งต-municodeโ Unicode mode ๐-mwin32โ Win32 mode ๐ช-mwindowsโ Windows mode ๐ช-fno-set-stack-executableโ no set stack executable ๐ซ-fwritable-relocated-rdataโ writable relocated rdata mode โ๏ธ-mpe-aligned-commonsโ PE aligned commons mode ๐-muse-libstdc-wrappersโ use libstdc++ wrappers mode ๐
๐ Darwin Options (Darwin Options) ๐
-all_loadโ all_load mode ๐ฅ-allowable_clientโ allowable client mode ๐ค-arch nameโ architecture isname๐๏ธ-arch_errors_fatalโ arch errors fatal mode ๐จ-asm_macosx_version_min=versionโ asm macOS version min isversion๐-bind_at_loadโ bind at load mode ๐-bundleโ bundle mode ๐-bundle_loaderโ bundle loader mode ๐-client_nameโ client name mode ๐ค-compatibility_versionโ compatibility version mode ๐งพ-current_versionโ current version mode ๐งพ-dead_stripโ dead strip mode โ ๏ธ-dependency-fileโ dependency file mode ๐-dylib_fileโ dylib file mode ๐-dylinkerโ dylinker mode ๐-dylinker_install_nameโ dylinker install name mode ๐ท๏ธ-dynamicโ dynamic mode ๐-dynamiclibโ dynamiclib mode ๐-exported_symbols_listโ exported symbols list mode ๐-fapple-kextโ Apple kext mode ๐-fconstant-cfstringsโ constant CFStrings mode ๐งต-ffix-and-continueโ fix and continue mode ๐ ๏ธ-filelistโ filelist mode ๐-findirect-dataโ findirect data mode ๐งญ-flat_namespaceโ flat namespace mode ๐งบ-force_cpusubtype_ALLโ force CPU subtype ALL mode ๐ฅ-force_flat_namespaceโ force flat namespace mode ๐งบ-framework nameโ framework isname๐งฑ-gfullโ gfull mode ๐-gusedโ gused mode ๐-headerpad_max_install_namesโ headerpad max install names mode ๐-iframeworkโ iframework mode ๐งฑ-image_baseโ image base mode ๐ผ๏ธ-init symbol-nameโ init symbol issymbol-name๐-install_nameโ install name mode ๐ท๏ธ-keep_private_externsโ keep private externs mode ๐-matt-stubsโ Matt stubs mode ๐-mconstant-cfstringsโ constant CFStrings mode ๐งต-mdynamic-no-picโ dynamic no-PIC mode ๐-mfix-and-continueโ fix and continue mode ๐ ๏ธ-mkernelโ kernel mode ๐ง-mmacosx-version-min=versionโ macOS version min isversion๐-mone-byte-boolโ one-byte bool mode 1๏ธโฃ-msymbol-stubsโ symbol stubs mode ๐งต-mtarget-linker[=]versionโ target linker[=]versionmode ๐-nodefaultexportโ no default export ๐ซ-nodefaultrpathsโ no default rpaths ๐ซ-pagezero_sizeโ pagezero size mode ๐-preloadโ preload mode ๐ฅ-read_only_relocsโ read-only relocs mode ๐-sectalignโ sectalign mode ๐-sectcreateโ sectcreate mode ๐งฑ-seg_addr_tableโ segment address table mode ๐-seg1addrโ seg1addr mode ๐-segaddrโ segaddr mode ๐-segprotโ segprot mode ๐ก๏ธ-segs_read_only_addrโ segs read-only addr mode ๐-segs_read_write_addrโ segs read-write addr mode โ๏ธ-sub_libraryโ sub_library mode ๐-sub_umbrellaโ sub_umbrella mode โ๏ธ-twolevel_namespaceโ two-level namespace mode 2๏ธโฃ-twolevel_namespace_hintsโ two-level namespace hints mode 2๏ธโฃ-umbrellaโ umbrella mode โ๏ธ-undefinedโ undefined mode โ-unexported_symbols_listโ unexported symbols list mode ๐-weak_framework nameโ weak framework isname๐งฑ-weak_reference_mismatchesโ weak reference mismatches mode ๐งต-whatsloadedโ whatsloaded mode โ-whyloadโ whyload mode โ-Fโ-Fmode ๐ ต-ObjCโ Objective-C mode ๐-ObjC++โ Objective-C++ mode ๐-Wnonportable-cfstringsโ nonportable CFStrings warning โ ๏ธ
๐ DEC Alpha Options (DEC Alpha Options) ๐
-mno-fp-regsโ no FP regs ๐ซ-msoft-floatโ soft float mode ๐งธ-mieeeโ IEEE mode ๐งฎ-mieee-with-inexactโ IEEE with inexact mode ๐งฎ-mieee-conformantโ IEEE conformant mode ๐งฎ-mfp-trap-mode=modeโ FP trap mode ismode๐จ-mfp-rounding-mode=modeโ FP rounding mode ismode๐ฏ-mtrap-precision=modeโ trap precision ismode๐ฏ-mbuild-constantsโ build constants mode ๐งฑ-mcpu=cpu-typeโ CPU iscpu-type๐ง-mtune=cpu-typeโ tune forcpu-type๐ถ-mbwxโ BWX mode ๐งฎ-mmaxโ MAX mode ๐ฏ-mfixโ FIX mode ๐ ๏ธ-mcixโ CIX mode ๐งฎ-msafe-bwaโ safe BWA mode ๐ก๏ธ-msafe-partialโ safe partial mode ๐ก๏ธ-mfloat-vaxโ VAX float mode ๐งฎ-mfloat-ieeeโ IEEE float mode ๐งฎ-mexplicit-relocsโ explicit relocs mode ๐งญ-msmall-dataโ small data mode ๐-mlarge-dataโ large data mode ๐-msmall-textโ small text mode ๐-mlarge-textโ large text mode ๐-mmemory-latency=timeโ memory latency istimeโฑ๏ธ-mtls-kernelโ TLS kernel mode ๐งต-mtls-size=bitsizeโ TLS size isbitsize๐-mlong-double-128โ long double 128 mode 1๏ธโฃ2๏ธโฃ8๏ธโฃ-mlong-double-64โ long double 64 mode 6๏ธโฃ4๏ธโฃ
๐งฌ eBPF Options (eBPF Options) ๐งฌ
-mbig-endianโ big-endian mode ๐-mlittle-endianโ little-endian mode ๐-mframe-limit=bytesโ frame limit isbytes๐-mxbpfโ xBPF mode ๐งฌ-mco-reโ CO-RE mode ๐งญ-mjmpextโ jump extension mode ๐ฆ-mjmp32โ JMP32 mode 3๏ธโฃ2๏ธโฃ-malu32โ ALU32 mode 3๏ธโฃ2๏ธโฃ-mv3-atomicsโ v3 atomics mode โ๏ธ-mbswapโ BSWAP mode ๐-msdivโ SDIV mode โ-msmovโ SMOV mode ๐-mcpu=versionโ CPU isversion๐ง-masm=dialectโ asm dialect isdialect๐งต-minline-memops-threshold=bytesโ inline memops threshold isbytes๐-Wco-reโ CO-RE warning โ ๏ธ
๐ฑ FR30 Options (FR30 Options) ๐ฑ
-msmall-modelโ small model mode ๐-mno-lsimโ no lsim mode ๐ซ
๐ง FRV Options (FRV Options) ๐ง
-mgpr-32โ GPR 32 mode 3๏ธโฃ2๏ธโฃ-mgpr-64โ GPR 64 mode 6๏ธโฃ4๏ธโฃ-mfpr-32โ FPR 32 mode 3๏ธโฃ2๏ธโฃ-mfpr-64โ FPR 64 mode 6๏ธโฃ4๏ธโฃ-mhard-floatโ hard float mode ๐งฎ-msoft-floatโ soft float mode ๐งธ-malloc-ccโ alloc CC mode ๐งต-mfixed-ccโ fixed CC mode ๐-mdwordโ dword mode ๐ฆ-mdoubleโ double mode ๐งฎ-mmediaโ media mode ๐ฌ-mmuladdโ muladd mode โ๏ธ-mfdpicโ FDPIC mode ๐งญ-minline-pltโ inline PLT mode ๐ฅ-mgprel-roโ GPREL RO mode ๐งญ-multilib-library-picโ multilib library PIC mode ๐-mlinked-fpโ linked FP mode ๐-mlong-callsโ long calls mode ๐-malign-labelsโ align labels mode ๐-mlibrary-picโ library PIC mode ๐-macc-4โ ACC 4 mode 4๏ธโฃ-macc-8โ ACC 8 mode 8๏ธโฃ-mpackโ pack mode ๐ฆ-mno-eflagsโ no eflags ๐ซ-mno-cond-moveโ no cond move ๐ซ-mno-optimize-membarโ no optimize membar ๐ซ-mno-sccโ no SCC ๐ซ-mno-cond-execโ no cond exec ๐ซ-mno-vliw-branchโ no VLIW branch ๐ซ-mno-multi-cond-execโ no multi cond exec ๐ซ-mno-nested-cond-execโ no nested cond exec ๐ซ-mtomcat-statsโ Tomcat stats mode ๐ฑ-mTLSโ TLS mode ๐งต-mtlsโ tls mode ๐งต-mcpu=cpuโ CPU iscpu๐ง
๐งธ FT32 Options (FT32 Options) ๐งธ
-msimโ simulator mode ๐ฎ-mnodivโ no div mode ๐ซ-mft32bโ FT32B mode ๐งธ-mcompressโ compress mode ๐๏ธ-mnopmโ nopm mode ๐ด
๐ง GNU/Linux Options (GNU/Linux Options) ๐ง
-mglibcโ glibc mode ๐ง-muclibcโ uClibc mode ๐ง-mmuslโ musl mode ๐ง-mbionicโ Bionic mode ๐ง-mandroidโ Android mode ๐ค-tno-android-ccโ no Android CC mode ๐ซ-tno-android-ldโ no Android LD mode ๐ซ
๐งต H8/300 Options (H8/300 Options) ๐งต
-mrelaxโ relax mode ๐-mhโ H mode ๐ ท-msโ S mode ๐-mnโ N mode ๐ ฝ-msxโ SX mode ๐-ms2600โ S2600 mode 2๏ธโฃ6๏ธโฃ0๏ธโฃ0๏ธโฃ-mquickcallโ quickcall mode ๐-mslowbyteโ slowbyte mode ๐ข-mexrโ EXR mode ๐งฎ-mint32โ int32 mode 3๏ธโฃ2๏ธโฃ-malign-300โ align 300 mode ๐
๐ธ HPPA Options
okay bestie, HPPA time โ here's the whole flag buffet, every single one, no skips:
-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
Itanium said "I'm gonna have SO many flags" and honestly? She delivered. Here's the list ๐
-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
smol architecture, tidy little flag list, we love a minimal queen ๐ฆ
-mbarrel-shift-enabled-mdivide-enabled-mmultiply-enabled-msign-extend-enabled-muser-enabled
๐ LoongArch Options
okay so LoongArch has range โ march, mtune, mabi, mfpu, msindโฆ no wait, -msimd, and a whole crew after it:
-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
three flags, maximum drama, minimum scrolling:
-mshared-mthreads-mlegacy-threads
๐ M32C Options
-mcpu=cpu-msim-memregs=number
๐ฅ M32R/D Options
the M32R/D menu, served fresh, nothing left off the plate:
-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
the 68k family reunion ๐ญ so many cousins. All of them, in order:
-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
-mhardlit-mdiv-mrelax-immediates-mwide-bitfields-m4byte-functions-mcallgraph-data-mslow-bytes-mno-lsim-mlittle-endian-mbig-endian-m210-m340-mstack-increment
๐ MicroBlaze Options
not her being a whole soft-core icon with this many flags:
-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
okay this is THE big one, bestie. Like, MIPS said "let me have every option ever" and then had more. Buckle up, we're going the whole way down, nothing summarized, nothing skipped ๐ซถ
-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
phew. MIPS ate and left no crumbs ๐
๐ธ MMIX Options
Knuth's baby, and she comes with receipts:
-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
-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
tiny list, big main character energy:
-meb-mel-mmul.x-mno-crt0
๐ MSP430 Options
the microcontroller girlies are gonna live for this one:
-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
note bestie, those errata flags literally take name[,name...] lists โ keep the commas, they're load-bearing ๐ซถ
๐ NDS32 Options
-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
GPU-flavoured flags, no cap:
-m64-march=arch-misa=arch-march-map=arch-mptx=version-mmainkernel-moptimize-msoft-stack-msoft-stack-reserve-local=size-muniform-simt-mgomp
๐ OpenRISC Options
-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
vintage icon behaviour, she's literally from the 70s and still showing up โจ
-mfpu-msoft-float-mac0-m40-m45-m10-mint32-mint16-msplit-munix-asm-mdec-asm-mgnu-asm-mlra
๐ง Picolibc Options
these are the long-option girlies, all four of them:
--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. that's it, that's the whole entry, she's pointing you at her other section ๐
๐ PRU Options
-mmcu=mcu-minrt-mno-relax-mloop-mmul-mfillzero-mabi=variant
๐ฆ RISC-V Options
the newest cool girl on the block and she has OPINIONS. full list, in order, exactly as written:
-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
last one in this batch and she's bringing the microcontroller energy:
-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 (RS/6000 and PowerPC Options)
bestie there are like. SO many of these. buckle up ๐
-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
like, -mno-splat-word-constant?? the name alone is giving chaos goblin ๐ญ anyway. slay, moving on โจ
๐ฆ RX Options (RX Options)
-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
short, sweet, to the point. we love a low-maintenance king ๐๐
๐ S/390 and zSeries Options (S/390 and zSeries Options)
mainframe besties stand UP ๐ซถ
-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
ok so -munaliged-symbols is literally spelled that way in the source, like with the typo and everything. not me, not a typo on my end โ copy it exactly or it won't work fr fr ๐
๐ธ SH Options (SH Options)
this list is a whole mood board of CPU generations ๐
-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 (Solaris 2 Options)
-mclear-hwcapโ turn on the hwcap clearing ๐ซ-mno-clear-hwcapโ turn it back off, icon behavior-mimpure-textโ impure text mode, spooky ๐-mno-impure-textโ pure text again, we're cleansed-gsctfโ the-gsctfflag, no notes ๐ฅ
โญ SPARC Options (SPARC Options)
-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
the -mvis โ -mvis4b glow-up is honestly character development ๐ฆโจ
๐ System V Options (System V Options)
-YP,pathsโ specify the paths for the-YPoption, comma-separated bestie-Ym,dirโ point-Ymat a dir
only two options and yet somehow still mysterious. respect ๐
๐ง V850 Options (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
(tiny detail that matters: yes, -m850e2v4 really doesn't have the v prefix while its neighbors do. copy it exactly, i'm begging ๐ญ)
๐ VAX Options (VAX Options)
-munixโ unix vibes-mgnuโ gnu vibes-mdโ-md!-md-floatโ-mdbut float-mgโ-mg!-mg-floatโ-mgbut float-mlraโ lra mode-mvaxc-alignmentโ vaxc alignment-mqmathโ qmath mode
greatest hits of short flag names honestly ๐
๐ Visium Options (Visium Options)
-mdebugโ debug mode-msimโ simulator mode-mfpuโ fpu, on-mhard-floatโ hard float-msoft-floatโ soft float-mcpu=cpu-typeโ pick your cpu-type-mtune=cpu-typeโ tune for that cpu-type-msv-modeโ supervisor mode-muser-modeโ user mode
๐ซถ VMS Options (VMS Options)
-mvms-return-codesโ VMS-style return codes ๐ซ-mdebug-main=prefixโ set the debug main prefix-mmalloc64โ 64-bit malloc energy-mpointer-size=sizeโ pointers are size big, no cap
๐ฅ VxWorks Options (VxWorks Options)
-mrtp -msmp -mvthreads -non-static -Bstatic -Bdynamic -Xbind-lazy
-Xbind-now
look at -Bstatic and -Bdynamic living their best linker lives ๐
โจ x86 Options (x86 Options)
okay this one is the main character of the entire manpage. deep breath. here we go ๐ญ๐
-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
that's it, that's the whole vibe. i'm winded. drink some water bestie ๐๐ง
๐ x86 Windows Options
See Cygwin and MinGW Options. that's literally all it says. go look over there ๐
๐ Xstormy16 Options (Xstormy16 Options)
-msimโ simulator go brrr โจ
one (1) option. minimalism. we stan a low-effort icon ๐
๐ธ Xtensa Options (Xtensa Options)
-mconst16โ const16 mode ๐ซ-mforce-no-picโ force no-pic-mno-serialize-volatileโ don't serialize volatile-mtext-section-literalsโ literals in the text section-mauto-litpoolsโ auto litpools-mno-target-alignโ no target align-mlongcallsโ long calls-mabi=abi-typeโ pick your abi-type-mextra-l32r-costs=cyclesโ extra l32r costs, measured in cycles-mstrict-alignโ strict alignment, behave urself ๐ค
๐ zSeries Options
See S/390 and zSeries Options. yes bestie it's literally the same section, scroll up ๐
๐ Options Controlling the Kind of Output
okay so this is the part where gcc actually explains itself. iconic of it honestly.
Compilation can involve up to four stages: preprocessing, compilation proper, assembly and linking โ always in that order, no skipping, no shuffling, that's the lineup periodt ๐
GCC is capable of preprocessing and compiling several files, either:
- into several assembler input files, or
- into one assembler input file.
then each assembler input file produces an object file, and linking combines all the object files โ the ones that were newly compiled and the ones you passed in as input โ into a single executable file. one big happy family ๐ซถ
For any given input file, the file name suffix determines what kind of compilation is done. the suffix is literally the vibe check ๐ฅ
file.cโ C source code that must be preprocessed.file.iโ C source code that should not be preprocessed. (already preprocessed, don't come for it)file.iiโ C++ source code that should not be preprocessed.file.mโ Objective-C source code. โ ๏ธ note that you must link with thelibobjclibrary 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 thelibobjclibrary to make an Objective-C++ program work. also note that.Mrefers to a literal capital M โ yes the case matters bestie, i said what i said ๐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 (that's the default), or a C, C++ header file to be turned into an Ada spec (via the-fdump-ada-specswitch). two completely different destinies for one little.hfile, main character energy fr fr โจ
and that's the suffix lore. next part's gonna keep going, obviously, because this manpage is a journey and we're only on part 6 of 130 ๐ญ๐
ok so like, the compiler sniffs the file name and goes "ah yes, I know her" ๐ here's the whole little vibe-check table of suffixes:
file.cc,file.cp,file.cxx,file.cpp,file.CPP,file.c++,file.Cโ C++ source code that must be preprocessed. โ ๏ธ note that in.cxx, the last two letters must both be literallyx. Likewise,.Crefers to a literal capitalC(it's case-sensitive bestie, don't play with her).file.mm,file.Mโ Objective-C++ source code that must be preprocessed ๐ฆfile.miiโ Objective-C++ source code that should not be preprocessed.file.hh,file.H,file.hp,file.hxx,file.hpp,file.HPP,file.h++,file.tccโ C++ header file to be turned into a precompiled header or Ada spec. โจfile.f,file.for,file.ftn,file.fiโ Fixed form Fortran source code that should not be preprocessed.file.F,file.FOR,file.fpp,file.FPP,file.FTNโ Fixed form Fortran source code that must be preprocessed (with the traditional preprocessor).file.f90,file.f95,file.f03,file.f08,file.fiiโ Free form Fortran source code that should not be preprocessed ๐ธfile.F90,file.F95,file.F03,file.F08โ Free form Fortran source code that must be preprocessed (with the traditional preprocessor).file.cob,file.COB,file.cbl,file.CBLโ COBOL source code ๐file.goโ Go source code.file.dโ D source code. ๐file.diโ D interface file.file.ddโ D documentation code (Ddoc).file.adsโ Ada source code file that contains a library unit declaration (a declaration of a package, subprogram, or generic, or a generic instantiation), or a library unit renaming declaration (a package, generic, or subprogram renaming declaration). Such files are also called specs.file.adbโ Ada source code file containing a library unit body (a subprogram or package body). Such files are also called bodies.file.sโ Assembler code.file.S,file.sxโ Assembler code that must be preprocessed.otherโ An object file to be fed straight into linking. Any file name with no recognized suffix is treated this way. lowkey the catch-all bin ๐ซถ
Or you can just tell her the language yourself with the -x option, no guessing required:
-xlanguage,--language=language,--languagelanguage โ Specify explicitly the language for the following input files (rather than letting the compiler choose a default based on the file name suffix). This option applies to all following input files until the next-xoption. 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
ngl this is important:-xdoes not imply a particular language standard. Like,-x f77may also require-std=legacyfor some older source codes. it's giving "I picked the language, not the era" ๐ญ
-x noneโ Turn off any specification of a language, so that subsequent files are handled according to their file name suffixes (as if-xhas not been used at all). reset era ๐
If you only want some of the stages of compilation, you can use -x (or filename suffixes) to tell gcc where to start, and one of the options -c, -S, or -E to say where gcc is to stop. Note that some combinations (for example, -x cpp-output -E) instruct gcc to do nothing at all. literally nothing, she's just standing there ๐งโโ๏ธ
-c,--compileโ Compile or assemble the source files, but do not link. The linking stage simply is not done. The ultimate output is in the form of an object file for each source file.
By default, the object file name for a source file is made by replacing the suffix .c, .i, .s, etc., with .o.
Unrecognized input files, not requiring compilation or assembly, are ignored.
-S,--assembleโ Stop after the stage of compilation proper; do not assemble. The output is in the form of an assembler code file for each non-assembler input file specified. โจ
By default, the assembler file name for a source file is made by replacing the suffix .c, .i, etc., with .s.
Input files that don't require compilation are ignored.
-E,--preprocessโ Stop after the preprocessing stage; do not run the compiler proper. The output is in the form of preprocessed source code, which is sent to the standard output. ๐
Input files that don't require preprocessing are ignored.
-ofile,--output=file,--outputfile โ Place the primary output in file file. This applies to whatever sort of output is being produced, whether it be an executable file, an object file, an assembler file or preprocessed C code.
If -o is not specified, the default is to put an executable file in a.out, the object file for source.suffix in source.o, its assembler file in source.s, a precompiled header file in source.suffix.gch, and all preprocessed C source on standard output.
Though -o names only the primary output, it also affects the naming of auxiliary and dump outputs. See the examples below. Unless overridden, both auxiliary outputs and dump outputs are placed in the same directory as the primary output. In auxiliary outputs, the suffix of the input file is replaced with that of the auxiliary output file type; in dump outputs, the suffix of the dump file is appended to the input file suffix. In compilation commands, the base name of both auxiliary and dump outputs is that of the primary output; in compile and link commands, the primary output name, minus the executable suffix, is combined with the input file name. If both share the same base name, disregarding the suffix, the result of the combination is that base name, otherwise, they are concatenated, separated by a dash. ๐
she's doing math with your filenames
gcc -c foo.c ...
will use foo.o as the primary output, and place aux outputs and dumps next to it, e.g., aux file foo.dwo for -gsplit-dwarf, and dump file foo.c.???r.final for -fdump-rtl-final.
If a non-linker output file is explicitly specified, aux and dump files by default take the same base name:
gcc -c foo.c -o dir/foobar.o ...
will name aux outputs dir/foobar.* and dump outputs dir/foobar.c.*.
A linker output will instead prefix aux and dump outputs:
gcc foo.c bar.c -o dir/foobar ...
will generally name aux outputs dir/foobar-foo.* and dir/foobar-bar.*, and dump outputs dir/foobar-foo.c.* and dir/foobar-bar.c.*.
The one exception to the above is when the executable shares the base name with the single input:
gcc foo.c -o dir/foo ...
in which case aux outputs are named dir/foo.* and dump outputs named dir/foo.c.*. ๐ she noticed the match, she's being cute about it
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.
-dumpbasedumpbase,--dumpbasedumpbase โ This option sets the base name for auxiliary and dump output files. It does not affect the name of the primary output file. Intermediate outputs, when preserved, are not regarded as primary outputs, but as auxiliary outputs:
gcc -save-temps -S foo.c
saves the (no longer) temporary preprocessed file in foo.i, and then compiles to the (implied) output file foo.s, whereas:
gcc -save-temps -dumpbase save-foo -c foo.c
preprocesses to in save-foo.i, compiles to save-foo.s (now an intermediate, thus auxiliary output), and then assembles to the (implied) output file foo.o. see how the โจplot twistโจ changed everything
Absent this option, dump and aux files take their names from the input file, or from the (non-linker) output file, if one is explicitly specified: dump output files (e.g. those requested by -fdump-* options) with the input name suffix, and aux output files (those requested by other non-dump options, e.g. "-save-temps", "-gsplit-dwarf", "-fcallgraph-info") without it.
Similar suffix differentiation of dump and aux outputs can be attained for explicitly-given -dumpbase basename.suf by also specifying -dumpbase-ext .suf.
If dumpbase is explicitly specified with any directory component, any dumppfx specification (e.g. -dumpdir or -save-temps=*) is ignored, and instead of appending to it, dumpbase fully overrides it:
gcc foo.c -c -o dir/foo.o -dumpbase alt/foo \
-dumpdir pfx- -save-temps=cwd ...
creates auxiliary and dump outputs named alt/foo.*, disregarding dir/ in -o, the ./ prefix implied by -save-temps=cwd, and pfx- in -dumpdir. she said "no โค๏ธ" to all of them
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.*. no collisions, we love a considerate queen ๐
An empty string specified as dumpbase avoids the influence of the output basename in the naming of auxiliary and dump outputs during compilation, computing default values :
gcc -c foo.c -o dir/foobar.o -dumpbase " ...
will name aux outputs dir/foo.* and dump outputs dir/foo.c.*. Note how their basenames are taken from the input name, but the directory still defaults to that of the output.
The empty-string dumpbase does not prevent the use of the output basename for outputs during linking:
gcc foo.c bar.c -o dir/foobar -dumpbase " -flto ...
The compilation of the source files will name auxiliary outputs dir/foo.* and dir/bar.*, and dump outputs dir/foo.c.* and dir/bar.c.*. LTO recompilation during linking will use dir/foobar. as the prefix for dumps and auxiliary files. ๐ฆ and that's the naming lore, iykyk
-dumpbase-ext auxdropsuf,--dumpbase-ext auxdropsufโ okay so when GCC is forming the name of an auxiliary output file (but not a dump file, bestie ๐ ), it drops the trailing auxdropsuf from dumpbase before appending any suffixes. If you don't specify it, this option defaults to the suffix of a default dumpbase โ i.e. the suffix of the input file when-dumpbaseis not present on the command line, or when dumpbase is combined with dumppfx. ๐
Example:
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 GCC is forming the name of an auxiliary or dump output file, it uses 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. iconic LTO behavior ๐
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โ prints (on standard error output) the commands executed to run the stages of compilation. It also prints the version number of the compiler driver program and of the preprocessor and the compiler proper. ๐-###โ like-vexcept the commands are not executed and arguments are quoted unless they contain only alphanumeric characters or./-_. This is useful for shell scripts to capture the driver-generated command lines. ๐--helpโ prints (on the standard output) a description of the command-line options understood bygcc. If the-voption is also specified, then--helpis also passed on to the various processes invoked bygcc, so that they can display the command-line options they accept. If the-Wextraoption has also been specified (prior to the--helpoption), then command-line options that have no documentation associated with them are also displayed. ๐--target-helpโ prints (on the standard output) a description of target-specific command-line options for each tool. For some targets extra target-specific information may also be printed. ๐ฏ--help={class|[^]qualifier}[,...]โ prints (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-helpoption 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--paramoption.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 selectcommonclass.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. ๐ซ
Combining several classes is possible, although this usually restricts the output so much that there is nothing to display. One case where it does work, however, is when one of the classes is target. For example, to display all the target-specific optimization options, use:
--help=target,optimizers
The --help= option can be repeated on the command line. Each successive use displays its requested class of options, skipping those that have already been displayed. If --help is also specified anywhere on the command line then this takes precedence over any --help= option. ๐
If the -Q option shows up on the command line before the --help= option, then the descriptive text that --help= shows you gets switched up. Instead of describing the options it's displaying, it just tells you whether each one is enabled, disabled, or set to some specific value (assuming the compiler actually knows that at the point where the --help= option gets used).
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 it's totally possible to find out which optimizations are enabled at -O2 by using:
-Q -O2 --help=optimizers
Or, alternatively, you can discover which binary optimizations are enabled by -O3 by using:
gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
diff /tmp/O2-opts /tmp/O3-opts | grep enabled
--versionโ Displays the version number and copyrights of the invoked GCC. ๐-pass-exit-codes,--pass-exit-codesโ Normally thegccprogram exits with the code of1if any phase of the compiler returns a non-success return code. If you specify-pass-exit-codes, thegccprogram instead returns with the numerically highest error produced by any phase returning an error indication. The C, C++, and Fortran front ends return4if an internal compiler error is encountered.-pipe,--pipeโ Uses pipes rather than temporary files for communication between the various stages of compilation. Ngl this fails to work on some systems where the assembler can't read from a pipe, but the GNU assembler has no trouble at all. ๐ซถ-wrapperโ Invokes 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 ....
-ffile-prefix-map=old=newโ When compiling files residing in directory old, records 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-mapoptions. 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-mapand-fcanon-prefix-map.-fcanon-prefix-mapโ For the-f*-prefix-mapoptions, 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-mapcauses such comparisons to be done on canonicalized paths of old and the referenced filename. โจ-fplugin=name.soโ Loads the plugin code in file name.so, assumed to be a shared object to bedlopen'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=valuebelow). Each plugin should define the callback functions specified in the Plugins API.-fplugin-arg-name-key=valueโ Defines an argument called key with a value of value for the plugin called name.-fdump-ada-spec[-slim]โ For C and C++ source and include files, generates corresponding Ada specs. ๐-fada-spec-parent=unitโ In conjunction with-fdump-ada-spec[-slim]above, generates Ada specs as child units of parent unit.-fdump-go-spec=fileโ For input files in any language, generates corresponding Go declarations in file. This 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.@fileโ Reads command-line options from file. The options read are inserted in place of the original@fileoption. If file doesn't exist, or can't be read, then the option gets 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. ๐
๐ธ 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. ๐
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).
But โ and this is the part people trip over โ 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++. ๐ฆ
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.
โจ Options Controlling C Dialect โจ
The following options control the dialect of C (or languages derived from C, such as C++, Objective-C and Objective-C++) that the compiler accepts:
-ansi,--ansiโ In C mode, this is equivalent to-std=c90. In C++ mode, it's equivalent to-std=c++98.-std=โ Determines the language standard. This option is currently only supported when compiling C or C++. ๐
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 don't 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 don't have a meaning in ISO C90, such as omitting the middle term of a "?:" expression. On the other hand, when a GNU dialect of a standard is specified, all features supported by the compiler are enabled, even when those features change the meaning of the base standard. As a result, some strict-conforming programs may be rejected. ๐ญ The particular standard is used by -Wpedantic to identify which features are GNU extensions given that version of the standard. For example -std=gnu90 -Wpedantic warns about C++ style // comments, while -std=gnu99 -Wpedantic does not.
A value for this option must be provided; possible values are:
c90,c89,iso9899:1990โ Supports all ISO C90 programs (certain GNU extensions that conflict with ISO C90 are disabled). Same as-ansifor 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 namesc9xandiso9899:199xare 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 namec1xis deprecated.c17,c18,iso9899:2017,iso9899:2018โ ISO C17, the 2017 revision of the ISO C standard (published in 2018). This standard is same as C11 except for corrections of defects (all of which are also applied with-std=c11) and a new value of"__STDC_VERSION__", and so is supported to the same extent as C11.c23,c2x,iso9899:2024โ ISO C23, the 2023 revision of the ISO C standard (published in 2024). The namec2xis deprecated.c2yโ The next version of the ISO C standard, still under development. The support for this version is experimental and incomplete. ๐gnu90,gnu89โ GNU dialect of ISO C90 (including some C99 features).gnu99,gnu9xโ GNU dialect of ISO C99. The namegnu9xis deprecated.gnu11,gnu1xโ GNU dialect of ISO C11. The namegnu1xis deprecated.gnu17,gnu18โ GNU dialect of ISO C17.gnu23,gnu2xโ GNU dialect of ISO C23. This is the default for C code. The namegnu2xis deprecated. โญ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 namegnu2xis deprecated. ๐c++98,c++03โ The 1998 ISO C++ standard plus the 2003 technical corrigendum and some additional defect reports. Same as-ansifor C++ code.gnu++98,gnu++03โ GNU dialect of-std=c++98.c++11,c++0xโ The 2011 ISO C++ standard plus amendments. The namec++0xis deprecated.gnu++11,gnu++0xโ GNU dialect of-std=c++11. The namegnu++0xis deprecated. ๐
c++14,c++1yโ the 2014 ISO C++ standard plus amendments. Heads up: the namec++1yis deprecated.gnu++14,gnu++1yโ GNU dialect of-std=c++14. Also: the namegnu++1yis deprecated.c++17,c++1zโ the 2017 ISO C++ standard plus amendments. The namec++1zis deprecated, bestie.gnu++17,gnu++1zโ GNU dialect of-std=c++17. The namegnu++1zis deprecated.c++20,c++2aโ the 2020 ISO C++ standard plus amendments. C++20 modules support is still experimental and needs to be enabled with the-fmodulesoption. The namec++2ais deprecated.gnu++20,gnu++2aโ GNU dialect of-std=c++20. This is the default for C++ code, periodt. C++20 modules support is still experimental and needs to be enabled with-fmodules. The namegnu++2ais deprecated.c++23,c++2bโ the 2023 ISO C++ standard plus amendments (published in 2024). Support is experimental, and could change in incompatible ways in future releases ๐ญ. The namec++2bis deprecated.gnu++23,gnu++2bโ GNU dialect of-std=c++23. Support is experimental, and could change in incompatible ways in future releases. The namegnu++2bis 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-infofilename โ writes prototyped declarations to the given filename for all functions declared and/or defined in a translation unit, including the ones chilling in header files. It's silently ignored in any language other than C, no cap.
Besides declarations, the file tells you โ in comments โ the origin of each declaration (source file and line), whether the declaration was implicit, prototyped or unprototyped (I, N for new or O for old, respectively, in the first character after the line number and the colon), and whether it came from a declaration or a definition (C or F, respectively, in the following character). And for function definitions, you also get a K&R-style list of arguments followed by their declarations, inside comments, after the declaration ๐.
-fno-asmโ do not recognizeasm,inlineortypeofas a keyword, so your code can use those words as identifiers. You can use the keywords__asm__,__inline__and__typeof__instead. In C,-ansiimplies-fno-asm.
In C++, inline is a standard keyword and is not affected by this switch. You may want to use the -fno-gnu-keywords flag instead, which disables typeof but not asm and inline. In C99 mode (-std=c99 or -std=gnu99), this switch only affects the asm and typeof keywords, since inline is a standard keyword in ISO C99. In C23 mode (-std=c23 or -std=gnu23), this switch only affects the asm keyword, since typeof is a standard keyword in ISO C23. iykyk ๐
-fno-builtin,-fno-builtin-functionโ don't recognize built-in functions that don't begin with__builtin_as prefix.
GCC normally generates special code to handle certain built-in functions more efficiently; for instance, calls to alloca may become single instructions which adjust the stack directly, and calls to memcpy may become inline copy loops. The resulting code is often both smaller and faster, but since the function calls no longer appear as such, you cannot set a breakpoint on those calls, nor can you change the behavior of the functions by linking with a different library ๐. In addition, when a function is recognized as a built-in function, GCC may use information about that function to warn about problems with calls to that function, or to generate more efficient code, even if the resulting code still contains calls to that function. For example, warnings are given with -Wformat for bad calls to printf when printf is built in and strlen is known not to modify global memory.
With the -fno-builtin-function option only the built-in function function is disabled. function must not begin with __builtin_. If a function is named that is not built-in in this version of GCC, this option is ignored. There is no corresponding -fbuiltin-function option; if you wish to enable built-in functions selectively when using -fno-builtin or -ffreestanding, you may define macros such as:
#define abs(n) __builtin_abs ((n))
#define strcpy(d, s) __builtin_strcpy ((d), (s))
-fcond-mismatchโ allow conditional expressions with mismatched types in the second and third arguments. The value of such an expression isvoid. This option is not supported for C++ ๐ซถ.-ffreestandingโ assert that compilation targets a freestanding environment. This implies-fno-builtin. A freestanding environment is one in which the standard library may not exist, and program startup may not necessarily be atmain. 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. Kind of a niche flex but okay ๐ฅ.-fgnu-tmโ when the option-fgnu-tmis specified, the compiler generates code for the Linux variant of Intel's current Transactional Memory ABI specification document (Revision 1.1, May 6 2009). This is an experimental feature whose interface may change in future versions of GCC, as the official specification changes. Please note that not all architectures are supported for this feature.
For more information on GCC's support for transactional memory,
Note that the transactional memory feature is not supported with non-call exceptions (-fnon-call-exceptions).
-fgnu89-inlineโ the option-fgnu89-inlinetells GCC to use the traditional GNU semantics forinlinefunctions when in C99 mode.
Using this option is roughly equivalent to adding the gnu_inline function attribute to all inline functions.
The option -fno-gnu89-inline explicitly tells GCC to use the C99 semantics for inline when in C99 or gnu99 mode (i.e., it specifies the default behavior). This option is not supported in -std=c90 or -std=gnu90 mode.
The preprocessor macros __GNUC_GNU_INLINE__ and __GNUC_STDC_INLINE__ may be used to check which semantics are in effect for inline functions. Handy, fr fr โจ.
-fhostedโ assert that compilation targets a hosted environment. This implies-fbuiltin. A hosted environment is one in which the entire standard library is available, and in whichmainhas a return type ofint. 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. Like, don't ๐.-fms-extensionsโ accept some non-standard constructs used in Microsoft header files.
In C++ code, this allows member names in structures to be similar to previous types declarations.
typedef int UOW;
struct ABC {
UOW UOW;
};
Some cases of unnamed fields in structures and unions are only accepted with this option.
Note that this option is off for all targets except for x86 targets using ms-abi.
-fpermitted-flt-eval-methods=style โ ISO/IEC TS 18661-3 defines new permissible values forFLT_EVAL_METHODthat 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 ofFLT_EVAL_METHOD. As such, 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 determining 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 information can be used to add required dependencies between compilation rules of dependent sources based on their contents rather than requiring such information be reflected within the build tools as well. Lowkey genius ngl ๐ง.
-fdeps-file=file โ where to write structured dependency information.-fdeps-format=format โ the format to use for structured dependency information.p1689r5is the only supported format right now. Note that when this argument is specified, the output of-MFis stripped of some information (namely C++ modules) so that it does not use extended makefile syntax not understood by most tools.-fdeps-target=file โ analogous to-MTbut 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++. Sorry C++ girlies ๐.
-fsigned-bitfields,-funsigned-bitfields,-fno-signed-bitfields,-fno-unsigned-bitfieldsโ these four besties decide whether a bit-field is signed or unsigned when the declaration is out here being indecisive and doesn't saysignedorunsignedat all ๐. Default? Signed, because that's the consistent vibe โ basic integer types likeintare signed types, so it just matches. Periodt.-fsigned-char,-funsigned-charโ okay so-fsigned-charlets the typecharbe signed, literally just likesigned char, and-funsigned-charletscharbe unsigned, likeunsigned char๐ .
Note that -fsigned-char is equivalent to -fno-unsigned-char, which is the negative form of -funsigned-char. Likewise, -fno-signed-char is equivalent to -funsigned-char. Sneaky little mirror situation, iykyk ๐ช.
Every target GCC supports has a default for what char should be, and it's typically spelled out in the processor-specific ABI document for that target. So it's either like unsigned char by default or like signed char by default โ no in-between, no deciding for yourself.
Ideally a portable program should always use signed char or unsigned char when it actually depends on the signedness of an object. But likeโฆ so many programs were written to use plain char and expect it signed, or expect it unsigned, depending on the machines they were written for ๐ญ. These options let you make such a program work with the opposite default. Iconic rescue behavior.
And 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 giving main character with a borrowed personality ๐.
-fstrict-flex-arrays(C and C++ only),-fstrict-flex-arrays=level(C and C++ only) โ controls when to treat the trailing array of a structure as a flexible array member for the purpose of accessing the elements of such an array. The value oflevelcontrols the level of strictness ๐ฆ.
-fstrict-flex-arrays is equivalent to -fstrict-flex-arrays=3, which is the strictest โ a trailing array is treated as a flexible array member only when it is declared as a flexible array member per C99 standard onwards. Maximum standards-conformity energy โจ.
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, honestly ๐.
There are two more levels in between 0 and 3, provided to support older code that uses the GCC zero-length array extension ([0]) or one-element array as flexible array members ([1]). 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 ๐
Heads up bestie: the-fstrict_flex_arraysoption interacts with the-Wstrict-flex-arraysoption. (Yes, that one's written with underscores, not a typo on my part โ copy it exactly ๐)
-fsso-struct=endiannessโ sets the default scalar storage order of structures and unions to the specified endianness ๐. Accepted values arebig-endian,little-endianandnativefor the native endianness of the target (the default). Note: this option is not supported for C++ ๐ซ.
โ ๏ธ Warning: the -fsso-struct switch causes GCC to generate code that is not binary compatible with code generated without it if the specified endianness is not the native endianness of the target. Like, actually not compatible. Do not play with this one casually fr fr ๐
โจ Options Controlling C++ Dialect โจ
This section describes the command-line options that are only meaningful for C++ programs ๐. You can also use most of the GNU compiler options regardless of what language your program is in. For example, you might compile a file 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 ๐ซถ.
Some options for compiling C programs, such as -std, are also relevant for C++ programs.
Here is a list of options that are only for compiling C++ programs ๐:
--compile-std-moduleโ build the compiled module interfaces for the<bits/stdc++.h>header unit and thestdandstd.compatmodules before compiling any source files explicitly specified on the command line. This is intended to be useful for building simple programs that useimport std;with a single command ๐ฅ. One command, whole module situation, slay.-fabi-version=nโ use versionnof 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 giving "moving target but make it spec-compliant" ๐.
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 ๐ญ oops.
Version 13, which first appeared in G++ 8.2, fixes the accidental change in version 12. Cleanup era โจ.
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.
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. The way these two negotiate is honestly kind of iconic ๐
.
-fno-access-controlโ turn off all access checking ๐จ. This switch is mainly useful for working around bugs in the access control code. Not a lifestyle choice, just a bug workaround, ngl.-faligned-new,-faligned-new=alignmentโ enable support for C++17newof types that require more alignment thanvoid* ::operator new(std::size_t)provides ๐ธ. A numeric argument such as-faligned-new=32can be used to specify how much alignment (in bytes) is provided by that function, but few users will need to override the default ofalignof(std::max_align_t).
This flag is enabled by default for -std=c++17 โญ.
-fno-assume-sane-operators-newโ okay bestie, this one is about the C++ standard letting you replace the globalnew,new[],deleteanddelete[]operators, even though a lot of C++ programs donโt replace them and just use the implementation-provided version. The C++ standard also allows omitting those calls if theyโre made from new or delete expressions, and by extension the same is assumed if__builtin_operator_newor__builtin_operator_deletefunctions are used. This option gives you control over some optimizations around calls to those operators. With-fassume-sane-operators-new-delete, GCC may assume that calls to the replaceable global operators from new or delete expressions, or from__builtin_operator_newor__builtin_operator_deletecalls, donโt read or modify any global variables or variables whose address could escape to the operators โ thatโs global state, except forerrnofor thenewandnew[]operators. This allows most optimizations across those calls and is something the implementation-provided operators satisfy unlessmallocimplementation details are observable in the code or unlessmallochooks are used, but it might not be satisfied if a program replaces those operators. This behavior is enabled by default. With-fno-assume-sane-operators-new-delete, GCC must assume all these calls โ whether from new or delete expressions or called directly โ may read and write global state unless proven otherwise, e.g. when GCC compiles their implementation. Use this option if those operators are or may be replaced and code needs to expect such behavior. โจ-fchar8_t,-fno-char8_tโ enables support forchar8_tas adopted for C++20. This includes adding a newchar8_tfundamental type, changing the types of UTF-8 string and character literals, new signatures for user-defined literals, associated standard library updates, and new__cpp_char8_tand__cpp_lib_char8_tfeature 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;
The change to the types of UTF-8 string and character literals introduces incompatibilities with ISO C++11 and later standards. For example, the following code is well-formed under ISO C++11, but is ill-formed when -fchar8_t is specified:
const char *cp = u8"xx";// error: invalid conversion from
// `const char8_t*' to `const char*'
int f(const char*);
auto v = f(u8"xx"); // error: invalid conversion from
// `const char8_t*' to `const char*'
std::string s{u8"xx"}; // error: no matching function for call to
// `std::basic_string<char>::basic_string()'
using namespace std::literals;
s = u8"xx"s; // error: conversion from
// `basic_string<char8_t>' to non-scalar
// type `basic_string<char>' requested
-fcheck-newโ checks that the pointer returned byoperator newis non-null before attempting to modify the storage allocated. This check is normally unnecessary because the C++ standard specifies thatoperator newonly returns 0 if it is declaredthrow(), in which case the compiler always checks the return value even without this option. In all other cases, whenoperator newhas a non-empty exception specification, memory exhaustion is signalled by throwingstd::bad_alloc. See alsonew (nothrow). ๐ซถ-fconceptsโ enables support for the C++ Concepts feature for constraining template arguments. With-std=c++20and above, Concepts are part of the language standard, so-fconceptsdefaults 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.
Heads up bestie: -fconcepts-ts is gone in GCC 15. Not a drill โ convert to C++20 concepts. ๐ญ
-fconcepts-diagnostics-depth=nโ sets the maximum error replay depth during recursive diagnosis of a constraint satisfaction failure. The default is 1. ๐-fconstexpr-depth=nโ sets the maximum nested evaluation depth for C++11 constexpr functions ton. A limit is needed to detect endless recursion during constant expression evaluation. The minimum specified by the standard is 512. ๐ฅ-fconstexpr-cache-depth=nโ sets the maximum level of nested evaluation depth for C++11 constexpr functions that will be cached ton. This is a heuristic that trades off compilation speed โ when the cache avoids repeated calculations โ against memory consumption โ when the cache grows very large from highly recursive evaluations. The default is 8. Very few users are likely to want to adjust it, but if your code does heavy constexpr calculations you might want to experiment to find which value works best for you. ๐ฆ-fconstexpr-fp-exceptโ Annex F of the C standard specifies that IEC559 floating point exceptions encountered at compile time should not stop compilation. C++ compilers have historically not followed this guidance, instead treating floating point division by zero as non-constant even though it has a well defined value. This flag tells the compiler to give Annex F priority over other rules saying that a particular operation is undefined. ๐ธ
constexpr float inf = 1./0.; // OK with -fconstexpr-fp-except
-fconstexpr-loop-limit=nโ sets the maximum number of iterations for a loop in C++14 constexpr functions ton. A limit is needed to detect infinite loops during constant expression evaluation. The default is 262144 (1<<18). ๐-fconstexpr-ops-limit=nโ sets 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โ enables support for the C++ Contracts feature, as specified in the C++26 working draft (N5003). โญ
On violation of an enforced or observed contract โ see -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โ sets the semantic with which contracts will be evaluated tosemantic. ๐
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, execution of the code will continue. At compile-time the checks are performed forconstexprevaluations, and 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, execution of the code is terminated preventing it from continuing past the failed case. At compile-time the checks are applied toconstexprand, 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, execution is terminated immediately without calling any handler. At compile-time there is no difference in behaviour between this option and theenforcecase, since no handler is invoked at compile time.
-fcontracts-conservative-ipaโ 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. ๐-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โ enables insertion of checks at call sites, a.k.a. 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โ 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++20and above, coroutines are literally part of the language standard, so-fcoroutinesdefaults to on. โจ-fdiagnostics-all-candidatesโ lets the C++ front end note all candidates during an overload resolution failure, including when a deleted function is selected. More receipts for your template chaos, bestie. ๐-fdump-lang-,-fdump-lang-switch,-fdump-lang-switch-options,-fdump-lang-switch-options=filenameโ control the dumping of C++-specific information. Theoptionsandfilenameportions behave as described in the-fdump-treeoption. The following switch values are accepted:allโ enable all of the below. ๐classโ dump class hierarchy information. Virtual table information is emitted unless'slim'is specified.moduleโ dump module information. Optionslineno(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. no cap, just vibes ๐tinstโ dump the sequence of template instantiations, indented to show the depth of recursion. Thelinenooption adds the source location where the instantiation was triggered, and thedetailsoption also dumps pre-instantiation substitutions such as those performed during template argument deduction. Lines in the.tinstdump start withIfor an instantiation,Sfor another substitution, andR[IS]for the reopened context of a deferred instantiation. ๐ง
-fno-elide-constructorsโ the C++ standard allows an implementation to omit creating a temporary that is only used to initialize another object of the same type. Specifying this option disables that optimization, and forces G++ to call the copy constructor in all cases. This option also causes G++ to call trivial member functions which otherwise would be expanded inline. In C++17, the compiler is required to omit these temporaries, but this option still affects trivial member functions. ๐ซถ-fno-enforce-eh-specsโ donโt generate code to check for violation of exception specifications at run time. This option violates the C++ standard, but may be useful for reducing code size in production builds, much like definingNDEBUG. 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. โ ๏ธ-fextern-tls-init,-fno-extern-tls-initโ the C++11 and OpenMP standards allowthread_localandthreadprivatevariables to have dynamic (runtime) initialization. To support this, any use of such a variable goes through a wrapper function that performs any necessary initialization. When the use and definition of the variable are in the same translation unit, this overhead can be optimized away, but when the use is in a different translation unit there is significant overhead even if the variable doesnโt actually need dynamic initialization. If the programmer can be sure that no use of the variable in a non-defining TU needs to trigger dynamic initialization (either because the variable is statically initialized, or a use of the variable in the defining TU will be executed before any uses in another TU), they can avoid this overhead with the-fno-extern-tls-initoption. 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 tostd::move,std::forward,std::addressof,std::to_underlyingandstd::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-inlineis active. ๐-fno-gnu-keywordsโ do not recognizetypeofas 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 toconsteval, 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 implicitlyconstexpr, if they satisfy the requirements for aconstexprfunction. This option can be used in C++14 mode or later. This can result in initialization changing from dynamic to static and other optimizations. ๐-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-modulesis 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 theCXX_MODULE_MAPPERenvironment 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โ disableWpedanticwarnings about constructs used in MFC, such as implicitintand 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=10or 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 includeffs,alloca,_exit,index,bzero,conjf, and other related functions. ๐-fnothrow-optโ treat athrow()exception specification as if it were anoexceptspecification 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 toterminaterather thanunexpected. โ ๏ธ-fno-operator-namesโ do not treat the operator name keywordsand,bitand,bitor,compl,not,orandxoras 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 when an error message points at a specialization of a function template, the compiler normally shows off by printing the whole signature, then the template arguments, then any typedefs or typenames chillin' in the signature (likevoid f(T) [with T = int]instead of justvoid f(int)) so you can actually tell which template is being messy. And when the error is about a class template specialization, it leaves out any template arguments that match the defaults for that template. But if either of those flexes makes the error harder to read instead of easier? This flag turns both off. You're welcome ๐-frange-for-ext-tempsโ bestie this one extends the lifetime of C++ range-based for temporaries โจ With-std=c++23and up, that's literally just the language standard now, so temporaries live until the end of the loop by default, no cap. This option lets you turn that behavior on in earlier versions of the standard too. So iconic.-freflectionโ enables experimental C++26 Reflection ๐ช (yes, experimental, so likeโฆ handle with care, it's giving beta energy).-fno-rttiโ stops the compiler from generating that info about every class with virtual functions that the C++ run-time type identification features (dynamic_castandtypeid) need. If you don't use those parts of the language, this flag saves you some space ๐ Note that exception handling uses the same information, but G++ generates it as needed. Also: thedynamic_castoperator still works for casts that don't need run-time type info, i.e. casts tovoid *or to unambiguous base classes.
Real talk: mixing code compiled with-frttiand code compiled with-fno-rttimay justโฆ not work ๐ญ Like, programs may fail to link if a class compiled with-fno-rttiis used as a base for a class compiled with-frtti. Be careful, bestie.
-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 ๐ฅ Super useful for user-defined replacement deallocation functions that, for example, use the size of the object to make deallocation faster. It's enabled by default under -std=c++14 and above. Oh and -Wsized-deallocation warns you 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 fits 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. Also, this option has no effect for an enumeration type with a fixed underlying type.-fstrong-eval-order,-fstrong-eval-order=kindโ evaluates member access, array subscripting, and shift expressions left-to-right, and evaluates assignment right-to-left, exactly as adopted for C++17 ๐ซถ-fstrong-eval-orderis the same thing as-fstrong-eval-order=all, and it's enabled by default with-std=c++17or later.-fstrong-eval-order=someenables just the ordering of member access and shift expressions, and it's the default for C++ dialects before C++17.-fstrong-eval-order=noneis equivalent to-fno-strong-eval-order.
-ftemplate-backtrace-limit=nโ caps the maximum number of template instantiation notes for a single warning or error atn. Default is10. No more scrolling for a thousand years ๐-ftemplate-depth=nโ sets the maximum instantiation depth for template classes ton. You need a limit on template instantiation depth to detect endless recursions during template class instantiation (iykyk). ANSI/ISO C++ conforming programs must not rely on a maximum depth greater than17(changed to1024in C++11). Default value is900, because the compiler can run out of stack space before hitting1024in some situations ๐ญ-fno-threadsafe-staticsโ do not emit the extra code that uses the routines specified in the C++ ABI for thread-safe initialization of local statics. Use this if you wanna shrink your code size slightly and your code genuinely doesn't need to be thread-safe ๐ง-fuse-cxa-atexitโ registers destructors for objects with static storage duration with the__cxa_atexitfunction instead of theatexitfunction. This one's required for fully standards-compliant handling of static destructors, but it only works if your C library supports__cxa_atexit๐-fno-use-cxa-get-exception-ptrโ don't use the__cxa_get_exception_ptrruntime routine. This makesstd::uncaught_exceptionincorrect ๐ฌ but it's necessary if the runtime routine isn't available.-fvisibility-inlines-hiddenโ this switch declares that you, the user, are not out here comparing pointers to inline functions or methods where the addresses of the two functions are taken in different shared objects. Periodt.
The effect: GCC may effectively mark inline methods with __attribute__ ((visibility ("hidden"))) so they don't show up in a DSO's export table and don't need a PLT indirection when used inside the DSO. Turning this on can have a dramatic effect on load and link times of a DSO ๐ฅ because it massively reduces the size of the dynamic export table when the library makes heavy use of templates.
Heads up though: this switch isn't quite the same as marking the methods hidden directly, because it doesn't affect static variables local to the function, and it doesn't make the compiler deduce that the function is defined in only one shared object.
You can mark a method as having visibility explicitly to cancel the effect of the switch for that method โ like, if you genuinely do wanna compare pointers to one particular inline method, mark it as having default visibility. And marking the enclosing class with explicit visibility? Does nothing, sorry ๐ซ
Explicitly instantiated inline methods are unaffected by this option, since their linkage might otherwise cross a shared library boundary.
-fvisibility-ms-compatโ this flag tries to use visibility settings to make GCC's C++ linkage model compatible with Microsoft Visual Studio's. The changes it makes to GCC's linkage model:- It sets the default visibility to
hidden, like-fvisibility=hidden. - Types, but not their members, are not hidden by default.
- 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're permitted when this option is not used.
- It sets the default visibility to
In new code it's better to use -fvisibility=hidden and export the classes you actually want externally visible ๐ Unfortunately, code can rely on the Visual Studio behavior, maybe accidentally.
Among the consequences of these changes: static data members of the same type with the same name but defined in different shared objects are different, so changing one doesn't change the other ๐ฑ and pointers to function members defined in different shared objects may not compare equal. And when this flag is given, defining types with the same name differently is a violation of the ODR. So likeโฆ don't.
-fno-weakโ don't use weak symbol support, even if the linker provides it. By default G++ uses weak symbols when they're available. This option exists only for testing and should not be used by end-users; it results in inferior code and has no benefits ๐ It may be removed in a future release of G++. So basically: not for you, bestie.-fext-numeric-literals(C++ and Objective-C++ only) โ accept imaginary, fixed-point, or machine-defined literal number suffixes as GNU extensions. When this option is turned off, those suffixes are treated as C++11 user-defined literal numeric suffixes. It's on by default for all pre-C++11 dialects and all GNU dialects:-std=c++98,-std=gnu++98,-std=gnu++11,-std=gnu++14. It's off by default for ISO C++11 onwards (-std=c++11, ...).-nostdinc++โ don't 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 you about include translation events โจ The first notes accepted include translations, the second notes declined include translations, and theheaderform informs you about include translations relating to that specific header. Ifheaderis of the formuseror<system>, it gets resolved to a specific user or system header using the include path ๐-flang-info-module-cmi,-flang-info-module-cmi=moduleโ inform you about Compiled Module Interface pathnames. The first notes all read CMI pathnames. Themoduleform notes reading a specific module's CMI. Andmodulemay 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 lets you specify alternate C++ runtime libraries ๐ Two options are available:libstdc++(the default, native C++ runtime for G++) andlibc++, 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) โ warns when a type with an ABI tag is used in a context that doesn't have that ABI tag. See C++ Attributes for more info about ABI tags ๐ท๏ธ-Wno-abbreviated-auto-in-template-argโ disables the error for anautoplaceholder type used within a template argument list to declare a C++20 abbreviated function template, e.g.
void f(S<auto>);
this bit was proposed in the Concepts TS but did not make it into C++20, bestie โ in the standard, a placeholder in a parameter declaration has to show up as a decl-specifier. The error can also be softened down to a warning with -fpermissive or -Wno-error=abbreviated-auto-in-template-arg.
-Wcomma-subscript (C++ and Objective-C++ only) ๐
Warns you when a comma expression shows up inside a subscripting expression. That usage got deprecated in C++20 and is on its way out in C++23. But heads up: a comma expression wrapped in ( ) is not deprecated. Example:
void f(int *a, int b, int c) {
a[b,c]; // deprecated in C++20, invalid in C++23
a[(b,c)]; // OK
}
In C++23 it's valid to have comma separated expressions in a subscript when an overloaded subscript operator is found and supports the right number and types of arguments. G++ will accept the formerly valid syntax for code that is not valid in C++23 but used to be valid but deprecated in C++20, with a pedantic warning that can be disabled with -Wno-comma-subscript.
Enabled by default with -std=c++20 unless -Wno-deprecated, and after -std=c++23 regardless of -Wno-deprecated. Before -std=c++20, it's enabled with explicit -Wdeprecated.
This warning gets upgraded to an error by -pedantic-errors in C++23 mode or later. ๐ญ
-Wctad-maybe-unsupported (C++ and Objective-C++ only) ๐ฆ
Warns when you're doing class template argument deduction (CTAD) on a type that has no explicitly written deduction guides. It's basically flagging the cases where CTAD only succeeded because the compiler synthesized the implicit deduction guides โ which might not be what the programmer actually intended, iykyk. Certain style guides allow CTAD only on types that specifically "opt-in"; i.e., on types that are designed to support CTAD. You can suppress 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. 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. It's giving "sealed box, no keys" energy.
-Wdangling-reference (C++ and Objective-C++ only) ๐
Warns when a reference is bound to a temporary whose lifetime has ended. Like:
int n = 1;
const int& r = std::max(n - 1, n + 1); // r is dangling
In the example above, two temporaries are created, one for each argument, and a reference to one of the temporaries is returned. However, both temporaries are destroyed at the end of the full expression, so the reference r is dangling. This warning also detects dangling references in member initializer lists:
const int& f(const int& i) { return i; }
struct S {
const int &r; // r is dangling
S() : r(f(10)) { }
};
Member functions are checked as well, but only their object argument:
struct S {
const S& self () { return *this; }
};
const S& s = S().self(); // s is dangling
Certain functions are safe in this respect, for example std::use_facet: they take and return a reference, but they don't return one of its arguments, which can fool the warning. Such functions can be excluded from the warning by wrapping them in a #pragma:
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdangling-reference"
const T& foo (const T&) { ... }
#pragma GCC diagnostic pop
The #pragma can also surround the class; in that case, the warning will be disabled for all the member functions.
-Wdangling-reference also warns about code like
auto p = std::minmax(1, 2);
where std::minmax returns std::pair<const int&, const int&>, and both references dangle after the end of the full expression that contains the call to std::minmax.
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 a non-virtual destructor. Deleting an instance of a derived class through a pointer to a base class is unsafe if the base class does not have a virtual destructor โ that's a whole undefined-behavior jump scare. 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 it also deprecates if the class has a user-provided destructor.
-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. For example:
enum E1 { e };
enum E2 { f };
int k = f - e;
-Wdeprecated-enum-enum-conversion is enabled by default with -std=c++20. In pre-C++20 dialects, this warning can be enabled by -Wenum-conversion 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. For example:
enum E1 { e };
enum E2 { f };
bool b = e <= 3.7;
-Wdeprecated-enum-float-conversion is enabled by default with -std=c++20. In pre-C++20 dialects, this warning can be enabled by -Wenum-conversion 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.
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) ๐
Stops warning 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 so 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 localinitializer_listvariable, 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 theinitializer_listin the heap has a dangling pointer. - When an
initializer_listvariable 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 theinitializer_listvariable 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
beginpointer from theinitializer_listargument, this doesn't extend the lifetime of the array, so if a class variable is constructed from a temporaryinitializer_list, the pointer is left dangling by the end of the variable declaration statement.
-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 one's enabled as a pedantic warning by default in C++20 and earlier, bestie. In C++23, -Winvalid-constexpr can be turned on, and then it becomes an ordinary warning instead. Like so:
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โ verifies that all the imported macro definitions are actually valid at the end of compilation. Ngl this one is not enabled by default, because it takes extra processing to figure out. But it's genuinely useful when you're putting together sets of header-units, since it makes sure your macros stay consistent. ๐-Wno-literal-suffix(C++ and Objective-C++ only) โ tells GCC to chill and not 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, all so it stays backwards compatible with code that uses formatting macros from<inttypes.h>. Example time:
#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 the warnings you get when a user-defined literal operator is declared with a literal suffix identifier that doesn't begin with an underscore โ because those identifiers are reserved for future standardization, iykyk.
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, as the standard demands. A narrowing conversion from a constant produces an error, and one from a non-constant produces a warning โ but-Wno-narrowingsuppresses the diagnostic entirely. Heads up though: this doesn't change the meaning of well-formed code, and narrowing conversions are still ill-formed in SFINAE contexts. ๐
With -Wnarrowing in C++98, you get a warning when a narrowing conversion that C++11 prohibits happens inside { }, like:
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 it's calling a function that doesn't have a non-throwing exception specification (i.e.throw()ornoexcept) but the compiler knows that function never actually throws. The audacity, honestly. ๐ญ-Wnoexcept-type(C++ and Objective-C++ only) โ warns if that C++17 feature that makesnoexceptpart of a function type changes the mangled name of a symbol compared to C++14. Enabled by-Wabiand-Wc++17-compat. Here's the 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>. The more you know ๐
-Wclass-memaccess(C++ and Objective-C++ only) โ warns when the destination of a raw memory function call likememsetormemcpyis an object of class type, and when writing into that object might bypass the class's non-trivial or deleted constructor or copy assignment, violate const-correctness or encapsulation, or corrupt virtual table pointers. Modifying the representation of objects like that can violate invariants that member functions of the class are out here maintaining, bestie. ๐
For example, the memset call below is undefined behaviour because it modifies a non-trivial class object โ so it gets diagnosed. The safe way to initialize or clear the storage of objects like this is to use the appropriate constructor or assignment operator, if one's available.
std::string str = "abc";
memset (&str, 0, sizeof str);
The -Wclass-memaccess option is enabled by -Wall. And if you explicitly cast the pointer to the class object to void * or to a type that the raw memory function can safely access, the warning goes away. ๐ซถ
-Wnon-virtual-dtor(C++ and Objective-C++ only) โ warns when a class has virtual functions and an accessible non-virtual destructor, either on itself or in an accessible polymorphic base class. In that case it's possible โ but unsafe โ to delete an instance of a derived class through a pointer to the class itself or the base class. ๐ฌ This warning is automatically enabled if-Weffc++is specified. But the-Wdelete-non-virtual-dtoroption (enabled by-Wall) should be preferred, because it warns about the unsafe cases without the false positives. Periodt.-Wregister(C++ and Objective-C++ only) โ warns on uses of theregisterstorage class specifier, except when it's part of the GNU Explicit Register Variables extension. Using theregisterkeyword as a storage class specifier has been deprecated in C++11 and removed in C++17, so like... it's giving legacy. ๐ Enabled by default with-std=c++17.-Wreorder(C++ and Objective-C++ only) โ warns when the order of member initializers in your code doesn't match the order they actually have to be executed in. Example:
struct A {
int i;
int j;
A(): j (0), i (1) { }
};
The compiler rearranges the member initializers for i and j to match the declaration order of the members, and emits a warning about it. This warning is enabled by -Wall. โจ
-Wno-pessimizing-move(C++ and Objective-C++ only) โ warns when a call tostd::moveis actively preventing copy elision. ๐ญ The typical scenario where copy elision can happen is when you return from a function with a class return type, the expression being returned is the name of a non-volatile automatic object, it's not a function parameter, and it has the same type as the function's return type.
struct T {
...
};
T fn()
{
T t;
...
return std::move (t);
}
But in this example, that std::move call is literally blocking copy elision. Not the flex you thought it was. ๐
This warning is enabled by -Wall.
-Wno-redundant-move(C++ and Objective-C++ only) โ warns about redundant calls tostd::move, i.e. when a move operation would've happened even without thestd::movecall. This happens because the compiler is forced to treat the object as if it were an rvalue in certain situations โ like 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. And because G++ implements Core Issue 1579, here's another example:
struct T { // convertible to U
...
};
struct U {
...
};
U fn()
{
T t;
...
return std::move (t);
}
In this one, copy elision isn't applicable because the type of the expression being returned and the function's return type differ โ yet G++ treats the return value as if it were designated by an rvalue. Sneaky. ๐ฆ
This warning is enabled by -Wextra.
-Wrange-loop-construct(C++ and Objective-C++ only) โ warns when a C++ range-based for-loop is making an unnecessary copy. This can happen when the range declaration isn't 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. Small victories. ๐
This warning also fires when a loop variable in a range-based for-loop is initialized with a value of a different type, resulting in a copy. Example:
void fn() {
int arr[10];
for (const double &x : arr) { ... }
}
In the example above, on every single iteration of the loop a temporary value of type double is created and destroyed, and the reference const double & gets bound to it. Every. Single. Time. ๐
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 dropped without causing ambiguity. For example:
struct foo;
struct foo *p; // warn that keyword struct can be eliminated
On the other hand, in this example there's no warning:
struct foo;
void foo (); // "hides" struct foo
void bar (struct foo&); // no warning, keyword struct is necessary
See, context is everything. โจ
-Wno-subobject-linkage(C++ and Objective-C++ only) โ don't 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. Because if a type A depends on a type B with no linkage or internal linkage, defining A in multiple translation units would be an ODR violation โ the meaning of B is different in each translation unit, bestie. ๐ญ
If A only shows up in a single translation unit, the best way to silence the warning is to give it internal linkage too, by sticking it in an anonymous namespace as well. The compiler doesn't give this warning for types defined in the main .C file, since those are unlikely to have multiple definitions. -Wsubobject-linkage is enabled by default. ๐ซถ
-Weffc++(C++ and Objective-C++ only) โ warns about violations of these 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,.
Basically the canon, fr fr. ๐
Okay bestie, the previous option is still going โ it's got one more thing to tell you:
This flag also switches on -Wnon-virtual-dtor, which is, like, one of the actually-good C++ recommendations too. But the check gets extended: it'll also warn you when an accessible non-polymorphic base class is missing a virtual destructor. Extra credit energy ๐
When you pick this option, lowkey be aware: the standard library headers do not obey all of these guidelines. So use grep -v to filter out those warnings. Don't come for me, come for the STL ๐ซถ
-Wno-exceptions(C++ and Objective-C++ only) โ turns OFF the warning for when an exception handler gets shadowed by another handler. Which, honestly? That warning is a little snitch that can point out a wrong ordering of your exception handlers. Silence it at your own risk ๐ฅ-Wsfinae-incomplete(C++ and Objective-C++ only) โ warns you about a class that turns out to be incomplete, or a function withautoreturn 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 give you different results depending on whether they first happen before or after that definition. Messy ๐ญ
This warning is enabled by default, no cap. And -Wsfinae-incomplete=2 adds an extra warning right at the point of substitution failure, so you can actually track down the problems the default mode flagged. Level-up behavior โญ
-Wstrict-null-sentinel(C++ and Objective-C++ only) โ warns when you use an uncasted"NULL"as a sentinel. If you're compiling with GCC and only GCC, this is a totally valid sentinel, because"NULL"is defined to"__null". And yeah, it's a null pointer constant rather than a null pointer, but it's guaranteed to be the same size as a pointer. The catch? This use is not portable across different compilers. So it works until it doesn't ๐-Wno-non-c-typedef-for-linkage(C++ and Objective-C++ only) โ disables the pedwarn for unnamed classes that have a typedef name for linkage purposes but contain C++-specific members, base classes, default member initializers or lambda expressions โ including those on nested member classes. Here's the vibe:
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 for when non-template friend functions are declared inside a template. Back in very old versions of GCC, like, before the ISO standard was implemented, declarations such asfriend int foo(int)โ where the name of the friend is an unqualified-id โ could be interpreted as a particular specialization of a template function. The warning exists to diagnose those compatibility problems, and it's enabled by default. Ancient history, but the warning stayed ๐-Wold-style-cast(C++ and Objective-C++ only) โ warns you if an old-style (C-style) cast to a non-void type shows up inside a C++ program. The new-style casts (dynamic_cast,static_cast,reinterpret_cast, andconst_cast) are way less vulnerable to unintended effects and so much easier to search for. Glow-up, honestly โจ-Woverloaded-virtual(C++ and Objective-C++ only)-Woverloaded-virtual=nโ warns when a function declaration hides virtual functions from a base class. Example time:
struct A {
virtual void f();
};
struct B: public A {
void f(int); // does not override
};
Here the A class version of f is hidden in B, and code like this:
B* b;
b->f();
just fails to compile. Sad! ๐ญ
In cases where the different signatures are not an accident, the simplest solution is to add a using-declaration to the derived class to un-hide the base function โ like, add using A::f; to B. Easy fix, chef's kiss ๐
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. Reasonable!
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. iykyk ๐
-Wno-pmf-conversions(C++ and Objective-C++ only) โ disables the diagnostic for converting a bound pointer to member function into a plain pointer. Bye-bye, warning ๐-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, yeah, it is what it is ๐ค-Wtemplates(C++ and Objective-C++ only) โ warns when a primary template declaration is encountered. Some coding rules disallow templates entirely, and this is how you'd enforce that rule. The warning is inactive inside a system header file (like the STL), so you can still use the STL. And you can also instantiate or specialize templates โ that's fine, bestie ๐ฆ-Wmismatched-new-delete(C++ and Objective-C++ only) โ warns about mismatches between calls tooperator neworoperator deleteand the corresponding call to the allocation or deallocation function. That includes invocations of C++operator deletewith pointers returned from either mismatched forms ofoperator new, or from other functions that allocate objects for whichoperator deleteisn't a suitable deallocator โ plus calls to other deallocation functions with pointers returned fromoperator newwhere the deallocation function isn't suitable. It's giving "wrong tool for the job" ๐ฅ
For example, the delete expression in the function below gets diagnosed because it doesn't match the array form of the new expression the pointer argument came from. Same deal โ 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.
And just so you know: -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*);
Now, it is not wrong to declare a class with the class-key struct, like the example above shows. The -Wmismatched-tags option is just here to help you achieve a consistent style of class declarations. And in code meant to be portable to Windows-based compilers, this warning helps prevent unresolved references caused by the difference in mangling of symbols declared with different class-keys. You can use the option on its own or in conjunction with -Wredundant-tags ๐
-Wmultiple-inheritance(C++ and Objective-C++ only) โ warns when a class is defined with multiple direct base classes. Some coding rules disallow multiple inheritance, and this is how you enforce that rule. Inactive inside a system header file (like the STL), so you can still use the STL. And you can also define classes that indirectly use multiple inheritance โ that's fine ๐ธ-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, such as the STL, so one can still use the STL. One may also define classes that indirectly use virtual inheritance. Same energy as above, honestly ๐ง-Wno-virtual-move-assignโ suppresses warnings about inheriting from a virtual base with a non-trivial C++11 move assignment operator. And bestie, this is dangerous: 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, then yeah, this warning can be disabled. Fair.-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, such as the STL, so one can still use the STL. One may also use using directives and qualified names. So like, no new namespaces, but you can still use them ๐-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 withWno-error=or-fpermissive๐ซถ-Wno-template-id-cdtor(C++ and Objective-C++ only) โ disables the warning about using simple-template-id as the declarator-id of a constructor or destructor, which became invalid in C++20 via DR 2237. 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's also enabled by -Wc++20-compat. Slay ๐
-Wtemplate-names-tu-localโ warns you when a template body hides an exposure of a translation-unit-local entity ๐ in most cases, referring to a translation-unit-local entity (like an internal linkage declaration) inside an entity that gets emitted into a module's CMI is straight-up an error. But โ and this is the plot twist โ inside the initializer of a variable, or in the body of a non-inline function, it's not an exposure, so no error gets emitted, no drama.
Why do we care? Because this can make variable or function templates accidentally become unusable if they reference such an entity, since other translation units that import the template will never be able to instantiate it ๐ญ this warning tries to catch those cases before they ruin your day. The presence of an explicit instantiation silences the warning. Iconic behaviour, honestly.
This flag is enabled by -Wextra.
-Wno-expose-global-module-tu-localโ okay so an exposure of a translation-unit-local entity from a module interface is invalid, because it may cause ODR violations and manifest in link errors or other unexpected behaviour ๐ however (and this is the messy part), lots of existing libraries declare TU-local entities in their interface, and avoiding exposures of these entities may be difficult in some cases.
As an extension, GCC allows exposures of internal variables and functions that were declared in the global module fragment โจ this warning indicates when such an invalid exposure has occurred, and can be silenced using diagnostic pragmas either at the site of the exposure, or at the point of declaration of the internal declaration. This also applies to export using declarations naming such entities.
When combined with -Wtemplate-names-tu-local, GCC will also warn about non-exposure references to TU-local entities in template bodies ๐ซถ such templates can still be instantiated in other TUs, but the above risks regarding exposures of translation-unit-local entities apply.
This warning is enabled by default, and is upgraded to an error by -pedantic-errors.
-Wno-external-tu-localโ warns when you're naming a TU-local entity outside of the translation unit it was declared in ๐ such declarations will be ignored during name lookup. This can occur when performing ADL from a template declared in the same TU as the internal function:
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 toterminate๐ญ like, why are we even throwing bestie.-Wno-vexing-parse(C++ and Objective-C++ only) โ warns about the most vexing parse syntactic ambiguity ๐ this warns about the cases when a declaration looks like a variable definition, but the C++ language requires it to be interpreted as a function declaration. For instance:
void f(double a) {
int i(); // extern int i (void);
int n(int(a)); // extern int n (int);
}
Another example:
struct S { S(int); };
void f(double a) {
S x(int(a)); // extern struct S x (int);
S y(int()); // extern struct S y (int (*) (void));
S z(); // extern struct S z (void);
}
The warning will suggest options how to deal with such an ambiguity โ e.g., it can suggest removing the parentheses or using braces instead ๐ honestly a little life coach.
This warning is enabled by default.
-Wno-class-conversion(C++ and Objective-C++ only) โ do not warn when a conversion function converts an object to the same type, to a base class of that type, or to void ๐ such a conversion function will never be called. It's giving "why do you even exist" energy.-Wvolatile(C++ and Objective-C++ only) โ warns about deprecated uses of thevolatilequalifier โจ this includes postfix and prefix++and--expressions ofvolatile-qualified types, using simple assignments where the left operand is avolatile-qualified non-class type for their value, compound assignments where the left operand is avolatile-qualified non-class type,volatile-qualified function return type,volatile-qualified parameter type, and structured bindings of avolatile-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 thealignof(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. Slay, more coverage ๐
-Wno-placement-new-Wplacement-new=nโ warns about placement new expressions with undefined behavior, like constructing an object in a buffer that is smaller than the type of the object ๐ญ for example, the placement new expression below is diagnosed because it attempts to construct an array of 64 integers in a buffer only 64 bytes large:
char buf [64];
new (buf) int[64];
This warning is enabled by default.
-Wplacement-new=1โ this is the default warning level of-Wplacement-new. At this level the warning is not issued for some strictly undefined constructs that GCC allows as extensions for compatibility with legacy code ๐ for example, the followingnewexpression 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 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-valuefor short) warn about polymorphic class types that are caught by value. With-Wcatch-value=2warn about all class types that are caught by value. With-Wcatch-value=3warn about all types that are not caught by reference.-Wcatch-valueis enabled by-Wall.-Wconditionally-supported(C++ and Objective-C++ only) โ warns for conditionally-supported (C++11 [intro.defs]) constructs ๐ธ like, "supportedโฆ conditionally" bestie, pick a lane.-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 ๐ like girl, that's the whole point of the fragment.-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-Wextraoption.
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 the ellipsis, honestly.-Wno-invalid-offsetof(C++ and Objective-C++ only) โ suppresses warnings from applying theoffsetofmacro to a non-POD type ๐ธ according to the 2014 ISO C++ standard, applyingoffsetofto a non-standard-layout type is undefined. In existing C++ implementations, however,offsetoftypically 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 ๐ซถ go off, I guess.
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 the other way around, whatever ๐
. Enabled by -Wextra along with -fsized-deallocation.
-Wsuggest-final-typesโ this one warns you about types that have virtual methods but would be so much better if you'd just slap the C++11finalspecifier on them, or (if you can swing it) declare them in an anonymous namespace. Why? Because then GCC can go full main-character mode and devirtualize those polymorphic calls way more aggressively ๐ฅ. Heads up: this warning hits different with link-time optimization, since that's when the class hierarchy graph info is actually complete. iykyk.-Wsuggest-final-methodsโ same energy but for virtual methods instead of types. It warns about virtual methods that would be higher quality if the method got the C++11finalspecifier, or if its type were declared in an anonymous namespace or withfinal๐. Again, way more effective with link-time optimization, because that's when the class hierarchy graph info is complete. Pro tip from the manpage itself: consider the-Wsuggest-final-typessuggestions first, then rebuild with your new annotations. Order matters bestie โจ.-Wsuggest-overrideโ warns you about overriding virtual functions that aren't marked with theoverridekeyword. That's it. That's the whole vibe.-Wno-conversion-null(C++ and Objective-C++ only) โ do NOT warn about conversions betweenNULLand non-pointer types. Because-Wconversion-nullis on by default, this is how you shut it up ๐.
โจ Options Controlling Objective-C and Objective-C++ Dialects โจ
(NOTE: This manual does not describe the Objective-C and Objective-C++ languages themselves.
Okay so this whole section is about the command-line options that are only meaningful for Objective-C and Objective-C++ programs. But like โ you can still use most of the language-independent GNU compiler options too, obviously. For example, you might compile a file some_class.m like this:
gcc -g -fgnu-runtime -O -c some_class.m
In that example, -fgnu-runtime is an option that's meant only for Objective-C and Objective-C++ programs โ but the other options? Those work with literally any language GCC supports, slay ๐.
Also 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). Crossover episode ๐ฆ.
Here's the 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 you write with the@"..."syntax ๐. The default class name isNXConstantStringif the GNU runtime is being used, andNSConstantStringif the NeXT runtime is being used (see below). On Darwin / macOS platforms, the-fconstant-cfstringsoption โ if it's also present โ overrides the-fconstant-string-classsetting and causes@"..."literals to be laid out as constant CoreFoundation strings. And fyi,-fconstant-cfstringsis just an alias for the target-specific-mconstant-cfstringsequivalent.-fgnu-runtimeโ generate object code that's 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. Also, the macro__NEXT_RUNTIME__gets 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 notnil. This lets the runtime use more efficient entry points โจ. Caveat: 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. Currently this option is only supported 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 you don't specify anything, 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_constructinstance method which runs non-trivial default constructors on any such instance variables, in order, and then returnsself๐ซถ. Similarly, check if any instance variable is a C++ object with a non-trivial destructor, and if so, synthesize a special- (void) .cxx_destructmethod which runs all such default destructors, in reverse order.
The - (id) .cxx_construct and - (void) .cxx_destruct methods generated this way only operate on instance variables declared in the current Objective-C class โ not the ones inherited from superclasses. It's the Objective-C runtime's job to invoke all such methods across an object's inheritance hierarchy. The - (id) .cxx_construct methods get invoked by the runtime immediately after a new object instance is allocated; the - (void) .cxx_destruct methods get 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 C++ offers. This option is required to use the Objective-C keywords@try,@throw,@catch,@finallyand@synchronized๐ฅ. It's 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 doesn't 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 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 โ those are 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 isn't recognized by GCC 4.0 gets rejected. Super useful if you need to make sure your Objective-C code can compile with older versions of GCC โจ.-freplace-objc-classesโ emit a special marker instructingld(1)not to statically link in the resulting object file, and allowdyld(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 โ no 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 toobjc_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-linkflag suppresses this behavior and causes calls toobjc_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 toobjc_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-ivarsflag 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 that 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 gets issued for every method in the protocol that the class doesn't implement. 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 ๐ . But if you use the-Wno-protocoloption, then methods inherited from the superclass count as implemented, and no warning is issued for them.-Wobjc-root-class(Objective-C and Objective-C++ only) โ this one's looking out for your root classes ๐. It hollers if a class interface has no superclass at all. Like, most classes are gonna inherit fromNSObject(orObject), bestie, that's the whole vibe. But if you're deliberately declaring a class that's meant to be a root class? Just mark its interface with__attribute__((objc_root_class))and the warning gets suppressed, easy. ๐-Wselector(Objective-C and Objective-C++ only) โ warns you when multiple methods of different types for the same selector show up during compilation ๐ซ . The check runs on that list of methods in the final stage of compilation. On top of that, it also checks each selector that appears in a@selector(...)expression, plus that a corresponding method for that selector actually got found during compilation. โ ๏ธ But here's the catch, and it's kind of a big one: because these checks scan the method table only at the end of compilation, you won't get these warnings at all if the final stage never gets reached โ like if an error is found during compilation, or if you're using-fsyntax-only. So no cap, if it dies early, you get nothing. ๐ญ-Wstrict-selector-match(Objective-C and Objective-C++ only) โ warns if multiple methods with differing argument and/or return types are found for a given selector when you're trying to send a message with that selector to a receiver of typeidorClass. When this flag is off (which, btw, is the default behavior โจ), the compiler just omits those warnings if any differences it found are confined to types that share the same size and alignment. So same-size-same-alignment drama = not its problem.-Wundeclared-selector(Objective-C and Objective-C++ only) โ warns when a@selector(...)expression is referring to a selector that was never declared ๐. A selector counts as undeclared if no method with that name has been declared before the@selector(...)expression โ whether that's explicitly in an@interfaceor@protocoldeclaration, or implicitly in an@implementationsection. And the timing? This option always does its checks the instant a@selector(...)expression shows up, while-Wselectoronly does its checks in the final stage of compilation. Different energy, honestly. It also enforces that coding style convention that methods and selectors must be declared before being used โ so it's lowkey your lint bestie too. ๐-print-objc-runtime-infoโ generates a C header describing the largest structure that is passed by value, if any. That's it, that's the whole thing. ๐
๐ Options Controlling OpenMP and OpenACC ๐
So, GCC supports OpenMP extensions to the C, C++, and Fortran languages with the -fopenmp option โจ. Same deal for OpenACC โ those extensions are supported in all three languages with -fopenacc. Parallelism is literally the main character here. ๐ง
-foffload=disable-foffload=default-foffload=target-listโ these tell GCC which OpenMP and OpenACC offload targets it should generate code for ๐ฏ. The default behavior โ which is exactly what-foffload=defaultgives you โ is to generate code for all supported offload targets. The-foffload=disableform generates code only for the host fallback, while-foffload=target-listgenerates code only for the specified comma-separated list of offload targets.
Offload targets get specified in GCC's internal target-triplet format. Pro tip: 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 specified options to the compilers for all enabled offloading targets ๐ซถ. Wanna send options that apply only to a specific target or targets? Use the-foffload-options=target-list=optionsform. The target-list is a comma-separated list in the same format as for the-foffload=option. Iconic symmetry, we love to see it.
Typical command lines look like:
-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 accin C/C++ and!$accin free-form Fortran, plus!$acc,c$accand*$accin fixed-form Fortran. ๐ Heads up: this option implies-pthread, and thus is only supported on targets that have support for-pthread. No pthread, no party.-fopenacc-dim=geomโ sets the default compute dimensions for parallel offload regions that don't explicitly specify them. The geom value is a triple of:-separated sizes, in this order: gang, worker, and vector ๐ฏ. You can omit a size to use a target-specific default value. Mwah, flexible king.-fopenmpโ enables handling of OpenMP directives#pragma omp,[[omp::decl(...)]],[[omp::directive(...)]], and[[omp::sequence(...)]]in C/C++ ๐ฅ. In Fortran, it enables!$ompand the conditional compilation sentinel!$. And in fixed source form Fortran, those sentinels can also start withcor*.
Also: this option implies -pthread, so again โ only supported on targets that have support for -pthread. And -fopenmp implies -fopenmp-simd too. It's giving "and I brought my friend." ๐
-fopenmp-simdโ enables handling of OpenMP'ssimd,declare simd,declare reduction,assume,ordered,scanandloopdirective, and of combined or composite directives withsimdas constituent, with#pragma omp,[[omp::directive(...)]],[[omp::sequence(...)]]and[[omp::decl(...)]]in C/C++, and!$ompin Fortran ๐ฆ. It additionally enables the conditional compilation sentinel!$in Fortran. In fixed source form Fortran, the sentinels can also start withcor*. All the other OpenMP directives get ignored. And unless-fopenmpis additionally specified, theloopregion binds to the current task region, independent of the specifiedbindclause. Kind of a whole situation, but okay. ๐-fopenmp-target-simd-clone-fopenmp-target-simd-clone=device-typeโ so beyond generating SIMD clones for functions marked with thedeclare simddirective, GCC also generates clones for functions marked with the OpenMPdeclare targetdirective that are suitable for vectorization when this option is in effect ๐. The device-type may be one ofnone,host,nohost, andanyโ which correspond to keywords for thedevice_typeclause of thedeclare targetdirective, and clones are generated for the intersection of devices specified.-fopenmp-target-simd-cloneis equivalent to-fopenmp-target-simd-clone=any, and-fno-openmp-target-simd-cloneis 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. Okay so the defaults switch up on you depending on optimization level โ clock that. โญ
๐ Options to Control Diagnostic Messages Formatting ๐
Traditionally, diagnostic messages were formatted irrespective of the output device's aspect (e.g. its width, ...). Rude, honestly ๐ค. You can use the options described below to control the formatting algorithm for diagnostic messages โ like how many characters per line, and how often source location information should be reported. ๐ธ
Heads up bestie: some language front ends may not honor these options. So like... vibe check your front end first.
-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 is done โ each error message appears on a single line. That, btw, is the default for all front ends.
Note โ this option also affects the display of the #error and #warning pre-processor directives, and the deprecated function/type/variable attribute. It does not, however, affect the pragma GCC warning and pragma GCC error pragmas. ๐
-fdiagnostics-plain-outputโ requests that diagnostic output look as plain as possible, which may be useful when runningdejagnuor other utilities that need to parse diagnostics output and prefer that it remain more stable over time ๐ซถ.-fdiagnostics-plain-outputis 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. In the future, if GCC changes the default appearance of its diagnostics, the corresponding option to disable the new behavior will be added to this list. So this list might grow on you, no cap. ๐-fdiagnostics-show-location=onceโ only meaningful in line-wrapping mode. Instructs the diagnostic messages reporter to emit source location information once โ that is, in case the message is too long to fit on a single physical line and has to be wrapped, the source location won't be emitted (as prefix) again, over and over, in subsequent continuation lines ๐. This is the default behavior.-fdiagnostics-show-location=every-lineโ only meaningful in line-wrapping mode. Instructs the diagnostic messages reporter to emit the same source location information (as prefix) for physical lines that result from the process of breaking a message which is too long to fit on a single line ๐. Every line gets the prefix. Obsessed with consistency.-fdiagnostics-color[=WHEN]-fno-diagnostics-colorโ use color in diagnostics ๐. WHEN isnever,always, orauto. The default depends on how the compiler has been configured โ it can be any of the above WHEN options, or alsoneverif theGCC_COLORSenvironment variable isn't present in the environment, andautootherwise.automakes GCC use color only when the standard error is a terminal, and when not executing in an emacs shell. The forms-fdiagnostics-colorand-fno-diagnostics-colorare aliases for-fdiagnostics-color=alwaysand-fdiagnostics-color=never, respectively.
The colors are defined by the environment variable GCC_COLORS. Its value is a colon-separated list of capabilities and Select Graphic Rendition (SGR) substrings. SGR commands are interpreted by the terminal or terminal emulator. (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: 01;31 is bold red, 01;35 is bold magenta, 01;36 is bold cyan, 32 is green, 34 is blue, 01 is bold, and 31 is red. Setting GCC_COLORS to the empty string disables colors, periodt. The supported capabilities are literally these bestie:
error=โ the SGR substring forerror:markers ๐warning=โ the SGR substring forwarning:markersnote=โ the SGR substring fornote:markerspath=โ the SGR substring for colorizing paths of control-flow events as printed via-fdiagnostics-path-format=, like the identifiers of individual events and lines indicating interprocedural calls and returns ๐ฆrange1=โ the SGR substring for the first additional rangerange2=โ the SGR substring for the second additional rangelocus=โ the SGR substring for location information,file:lineorfile:line:columnetc. ๐quote=โ the SGR substring for information printed within quotesfnname=โ the SGR substring for names of C++ functionstargs=โ the SGR substring for C++ function template parameter bindingsfixit-insert=โ the SGR substring for fix-it hints suggesting text to be inserted or replacedfixit-delete=โ the SGR substring for fix-it hints suggesting text to be deleteddiff-filename=โ the SGR substring for filename headers within generated patchesdiff-hunk=โ the SGR substring for the starts of hunks within generated patchesdiff-delete=โ the SGR substring for deleted lines within generated patchesdiff-insert=โ the SGR substring for inserted lines within generated patchestype-diff=โ the SGR substring for highlighting mismatching types within template arguments in the C++ frontendvalid=โ the SGR substring for highlighting valid elements within text art diagramsinvalid=โ the SGR substring for highlighting invalid elements within text art diagramshighlight-a=,highlight-b=โ SGR substrings for contrasting two different things within diagnostics, like a pair of mismatching types. See-fdiagnostics-show-highlight-colors.
-fdiagnostics-urls[=WHEN]โ okay so this one uses escape sequences to embed URLs in diagnostics ๐. For example, when-fdiagnostics-show-optionemits text showing the command-line option controlling a diagnostic, it embeds a URL for documentation of that option.
WHEN is never, always, or auto. auto makes GCC use URL escape sequences only when the standard error is a terminal, and when not executing in an emacs shell or any graphical terminal which is known to be incompatible with this feature, see below ๐.
The default depends on how the compiler has been configured. It can be any of the above WHEN options.
GCC can also be configured (via the --with-diagnostics-urls=auto-if-env configure-time option) so that the default is affected by environment variables. Under such a configuration, GCC defaults to using auto if either GCC_URLS or TERM_URLS environment variables are present and non-empty in the environment of the compiler, or never if neither are ๐ธ.
However, even with -fdiagnostics-urls=always the behavior is dependent on those environment variables: If GCC_URLS is set to empty or no, do not embed URLs in diagnostics. If set to st, URLs use ST escape sequences. If set to bel, the default, URLs use BEL escape sequences. Any other non-empty value enables the feature. If GCC_URLS is not set, use TERM_URLS as a fallback. Note: ST is an ANSI escape sequence, string terminator ESC \, BEL is an ASCII character, CTRL-G that usually sounds like a beep ๐.
At this time GCC tries to detect also a few terminals that are known to not implement the URL feature, and have bugs or at least had bugs in some versions that are still in use, where the URL escapes are likely to misbehave, i.e. print garbage on the screen. That list is currently xfce4-terminal, certain known to be buggy gnome-terminal versions, the linux console, and mingw. This check can be skipped with the -fdiagnostics-urls=always ๐ญ.
-fno-diagnostics-show-optionโ by default, each diagnostic emitted includes text indicating the command-line option that directly controls the diagnostic (if such an option is known to the diagnostic machinery). Specifying the-fno-diagnostics-show-optionflag suppresses that behavior, no cap.-fno-diagnostics-show-caretโ by default, each diagnostic emitted includes the original source line and a caret^indicating the column. This option suppresses this information. The source line is truncated to n characters, if the-fmessage-length=noption is given. When the output is done to the terminal, the width is limited to the width given by theCOLUMNSenvironment variable or, if 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 information, such as 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). Iconic honestly.
-fno-diagnostics-show-event-linksโ by default, when printing execution paths (via-fdiagnostics-path-format=inline-events), GCC will print lines connecting related events, such as 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 associatedCWE(https://cwe.mitre.org/index.html) identifier. GCC itself only provides such metadata for some of the-fanalyzerdiagnostics. GCC plugins may also provide diagnostics with such metadata. By default, if this information is present, it will be printed with the diagnostic. This option suppresses the printing of this metadata ๐ซถ.-fno-diagnostics-show-rulesโ diagnostic messages can optionally have rules associated with them, such as from a coding standard, or a specification. GCC itself does not do this for any of its diagnostics, but plugins may do so. By default, if this information is present, it will be printed with the diagnostic. This option suppresses the printing of this metadata.-fno-diagnostics-show-highlight-colorsโ GCC can use color for emphasis and contrast when printing diagnostic messages and quoting the user's source ๐จ.
For example, in
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
%iandintin the message and theintin the quoted source are colored usinghighlight-a(bold green by default), and - the
const char *in the message and in the quoted source are both colored usinghighlight-b(bold blue by default).
The intent is to draw the reader's eyes to the relationships between the various aspects of the diagnostic message and the source, using color to group related elements and distinguish between mismatching ones ๐โจ.
This additional colorization is enabled by default if color printing is enabled (as per -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 this 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 to6๐.-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-contextand-fno-diagnostics-show-contextare aliases for-fdiagnostics-show-context=1and-fdiagnostics-show-context=0, respectively ๐.-fdiagnostics-parseable-fixitsโ emits fix-it hints in a machine-parseable format, suitable for consumption by IDEs ๐ค. For each fix-it, a line will be printed after the relevant diagnostic, starting with the stringfix-it:. For example:
fix-it:"test.c":{45:3-45:21}:"gtk_widget_show_all"
okay so back to the fix-it deets because these matter bestie ๐
The location is expressed as a half-open range, expressed as a count of bytes, starting at byte 1 for the initial column. In the above example, bytes 3 through 20 of line 45 of "test.c" are to be replaced with the given string:
00000000011111111112222222222
12345678901234567890123456789
gtk_widget_showall (dlg);
^^^^^^^^^^^^^^^^^^
gtk_widget_show_all
The filename and replacement string escape backslash as "\\", tab as "\t", newline as "\n", double quotes as "\"", non-printable characters as octal (e.g. vertical tab as "\013").
An empty replacement string indicates that the given range is to be removed. An empty range (e.g. "45:3-45:3") indicates that the string is to be inserted at the given position. โจ iconic little edge cases tbh
-fdiagnostics-generate-patchโ Print fix-it hints to stderr in unified diff format, after any diagnostics are printed. Like, it literally hands you the patch ๐ For example:
--- test.c
+++ test.c
@ -42,5 +42,5 @
void show_cb(GtkDialog *dlg)
{
- gtk_widget_showall(dlg);
+ gtk_widget_show_all(dlg);
}
The diff may or may not be colorized, following the same rules as for diagnostics (see -fdiagnostics-color). no cap, it's the same color rules ๐
-fdiagnostics-show-template-treeโ In the C++ frontend, when printing diagnostics showing mismatching template types, such as:
could not convert 'std::map<int, std::vector<double> >()'
from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
the -fdiagnostics-show-template-tree flag enables printing a tree-like structure showing the common and differing parts of the types, such as:
map<
[...],
vector<
[double != float]>>
The parts that differ are highlighted with color ("double" and "float" in this case). literally a whole tree just to drag your types ๐ญ๐ณ
-fno-elide-typeโ By default when the C++ frontend prints diagnostics showing mismatching template types, common parts of the types are printed as"[...]"to simplify the error message. For example:
could not convert 'std::map<int, std::vector<double> >()'
from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
Specifying the -fno-elide-type flag suppresses that behavior. This flag also affects the output of the -fdiagnostics-show-template-tree flag. so it's giving "show me EVERYTHING, no shorthand" ๐
-fdiagnostics-path-format=KINDโ Specify how to print paths of control-flow events for diagnostics that have such a path associated with them. ๐ฆ
KIND is none, separate-events, or inline-events, the default.
none means to not print diagnostic paths.
separate-events means to print a separate "note" diagnostic for each event within 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 to print the events "inline" within the source code. This view attempts to consolidate the events into runs of sufficiently-close events, printing them as labelled ranges within the source.
For example, the same events as above might be printed as:
'test': events 1-3
25 | list = PyList_New(0);
| ^~~~~~~~~~~~~
| |
| (1) when 'PyList_New' fails, returning NULL
26 |
27 | for (i = 0; i < count; i++) {
| ~~~
| |
| (2) when 'i < count'
28 | item = PyLong_FromLong(random());
29 | PyList_Append(list, item);
| ~~~~~~~~~~~~~~~~~~~~~~~~~
| |
| (3) when calling 'PyList_Append', passing NULL from (1) as argument 1
Interprocedural control flow is shown by grouping the events by stack frame, and using indentation to show how stack frames are nested, pushed, and popped. genuinely so satisfying to look at ๐ซถ
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 option provides additional information when printing control-flow paths associated with a diagnostic. ๐
If this is option is provided then the stack depth will be printed for each run of events within -fdiagnostics-path-format=inline-events. If provided with -fdiagnostics-path-format=separate-events, then the stack depth and function declaration will be appended when printing each event.
This is intended for use by GCC developers and plugin developers when debugging diagnostics that report interprocedural control flow. yeah it's a devs-only lil treat ๐ง
-fno-show-columnโ Do not print column numbers in diagnostics. This may be necessary if diagnostics are being scanned by a program that does not understand the column numbers, such asdejagnu. fr fr sometimes the columns just confuse the poor script ๐ญ-fdiagnostics-column-unit=UNITโ Select the units for the column number. This affects traditional diagnostics (in the absence of-fno-show-column).
The default UNIT, display, considers the number of display columns occupied by each character. This may be larger than the number of bytes required to encode the character, in the case of tab characters, or it may be smaller, in the case of multibyte characters. For example, the character "GREEK SMALL LETTER PI (U+03C0)" occupies one display column, and its UTF-8 encoding requires two bytes; the character "SLIGHTLY SMILING FACE (U+1F642)" occupies two display columns, and its UTF-8 encoding requires four bytes. the pi is skinny but the smiley is wide, periodt ๐ฅง๐
Setting UNIT to byte changes the column number to the raw byte count in all cases, as was traditionally output by GCC prior to version 11.1.0.
-fdiagnostics-column-origin=ORIGINโ Select the origin for column numbers, i.e. the column number assigned to the first column. The default value of1corresponds to traditional GCC behavior and to the GNU style guide. Some utilities may perform better with an origin of0; any non-negative value may be specified. pick your fave starting number bestie ๐-fdiagnostics-escape-format=FORMATโ When GCC prints pertinent source lines for a diagnostic it normally attempts to print the source bytes directly. However, some diagnostics relate to encoding issues in the source file, such as malformed UTF-8, or issues with Unicode normalization. These diagnostics are flagged so that GCC will escape bytes that are not printable ASCII when printing their pertinent source lines. ๐ฆ
This option controls how such bytes should be escaped.
The default FORMAT, unicode displays Unicode characters that are not printable ASCII in the form <U+XXXX>, and bytes that do not correspond to a Unicode character validly-encoded in UTF-8-encoded will be displayed as hexadecimal in the form <XX>.
For example, a source line containing the string before followed by the Unicode character U+03C0 ("GREEK SMALL LETTER PI", with UTF-8 encoding 0xCF 0x80) followed by the byte 0xBF (a stray UTF-8 trailing byte), followed by the string after will be printed for such a diagnostic as:
before<U+03C0><BF>after
Setting FORMAT to bytes will display all non-printable-ASCII bytes in the form <XX>, thus showing the underlying encoding of non-ASCII Unicode characters. For the example above, the following will be printed:
before<CF><80><BF>after
-fdiagnostics-text-art-charset=CHARSETโ Some diagnostics can contain "text art" diagrams: visualizations created from text, intended to be viewed in a monospaced font. ๐จ
This option selects which characters should be used for printing such diagrams, if any. CHARSET is none, ascii, unicode, or emoji.
The none value suppresses the printing of such diagrams. The ascii value will ensure that such diagrams are pure ASCII ("ASCII art"). The unicode value will allow for conservative use of unicode drawing characters (such as box-drawing characters). The emoji value further adds the possibility of emoji in the output (such as emitting U+26A0 WARNING SIGN followed by U+FE0F VARIATION SELECTOR-16 to select the emoji variant of the character). โ ๏ธโจ
The default is emoji, except when the environment variable LANG is set to C, in which case the default is ascii. honestly the emoji default is so main character of GCC ๐
-fno-diagnostics-show-nestingโ Okay so some GCC diagnostics have an internal tree-like structure of nested sub-diagnostics, like when C++ templates are getting instantiated and everything gets dramatic. By default GCC uses indentation and bullet points in its text output to show the nesting structure of these diagnostics, moves location information to separate lines to make the structure clearer, and eliminates redundant repeated information. Selecting-fno-diagnostics-show-nestingsuppresses this indentation, reformatting, and elision, restoring an older โlookโ for the diagnostics. ๐ซถ-fno-diagnostics-show-nesting-locationsโ Whenfdiagnostics-show-nestingis enabled, file names and line- and column- numbers are displayed on separate lines from the messages. This location information can be disabled altogether with-fno-diagnostics-show-nesting-locations. This option exists for use by GCC developers, for writing DejaGnu test cases. ๐-fdiagnostics-show-nesting-levelsโ Whenfdiagnostics-show-nestingis enabled, usefdiagnostics-show-nesting-levelsto also display numbers showing the depth of the nesting. This option exists for use by GCC developers for debugging nested diagnostics, but it may be of use to plugin authors. ๐ฅ-fdiagnostics-format=FORMATโ Select a different format for printing diagnostics.FORMATistext,sarif-stderr, orsarif-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. โจ
-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-colorfor this text output.show-nesting=[yes|no]โ Enable a mode that emphasizes hierarchical relationships within diagnostics messages, as per-fdiagnostics-show-nesting. Defaults toyes.show-nesting-locations=[yes|no]โ Ifshow-nesting=yes, then by default locations are shown; set this key tonoto 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 withshow-nesting=yes. Set this key toyesto 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 tosource.sarif.serialization=[json]โ Specify the serialization format to use when writing out the SARIF. Currently this can only bejson, but it 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 to2.1.2.2-prereleaseuses 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 tono. Ifstate-graphs=yes, then attempt to capture detailed state information from-fanalyzerin 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 toyes.file=FILENAMEโ Specify the filename to write the HTML output to, potentially with a leading absolute or relative path. If not specified, it defaults tosource.html.javascript=[yes|no]โ Add an embedded<script>to the generated HTML providing a barebones UI for viewing results. Defaults toyes.
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 tono. Ifshow-state-diagrams=yes, then attempt to usedotto generate SVG diagrams in the generated HTML, visualizing the state at each event in a diagnostic path. These are visible by pressingjandkto 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 tono. Ifshow-graph-dot-src=yesthen ifshow-state-diagrams=yes, the generated state diagrams will also show the.dotsource input to GraphViz used for the diagram.show-graph-sarif=[yes|no]โ This is a debugging feature and defaults tono. Ifshow-graph-sarif=yesthen ifshow-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]โ Ifcfgs=yesfor 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 withintheRun.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=. ๐-fno-diagnostics-json-formattingโ By default, when JSON is emitted for diagnostics (via-fdiagnostics-format=sarif-stderror-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. ๐ญ
โจ 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. Basically: not always a full-on crime, but the vibe check says something might be off. ๐จ
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. Literally just the syntax vibe check.-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 is0(the default), there is no limit on the number of error messages produced. If-Wfatal-errorsis also specified, then-Wfatal-errorstakes precedence over this option. ๐-w,--no-warningsโ Inhibit all warning messages. Not a single warning is getting through, bestie.-Werrorโ Turn all warnings into errors. Every warning is now main character energy. ๐-Werror=โ Turn the specified warning into an error. The specifier for a warning is appended; for example-Werror=switchturns the warnings controlled by-Wswitchinto errors. This switch takes a negative form, to be used to negate-Werrorfor specific warnings; for example-Wno-error=switchmakes-Wswitchwarnings not be errors, even when-Werroris 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.
-Wfatal-errorsโ bestie, this one is the "i'm done" button ๐ญ the second the compiler hits its first error it just aborts the whole compilation instead of trying to keep going and printing a million more error messages. no cap, sometimes you just need it to stop talking.
So here's the tea on warnings โ you can request a ton of specific warnings with options that start with -W โ like -Wunused-variable to get warned about variables you declared and then never used (we've all been there ๐). And every single one of these specific warning options also has a negative form starting with -Wno- that turns it off โ so like, -Wno-unused-variable. The way this manual works is it only lists one of the two forms, whichever one is not the default. iykyk.
For more language-specific options you also wanna peek at C++ Dialect Options and Objective-C and Objective-C++ Dialect Options. And plot twist: you can get even more warnings by enabling the static analyzer โจ
Some options โ looking at you, -Wall and -Wextra โ turn on other options, like -Wunused, which then turns on further options, like -Wunused-variable. It's giving cascade ๐ฆ. The combined effect of positive and negative forms is that more specific options have priority over less specific ones, no matter where they sit in the command line. For options of the same specificity, the last one wins. And options turned on or off via pragmas take effect as if they were tacked onto the very end of the command line. periodt.
When you ask for an unrecognized warning option (e.g. -Wunknown-warning), GCC gives an error saying it doesn't recognize it. But the -Wno- form is lowkey different: no diagnostic gets produced for -Wno-unknown-warning unless other diagnostics are already being produced. That's on purpose, so you can use new -Wno- options with old compilers โ but if something goes wrong, the compiler will warn you that an unrecognized option is hanging around.
Real talk: the effectiveness of some warnings depends on optimizations also being enabled. For example, -Wsuggest-final-types is way more effective with link-time optimization. Some other warnings might not get issued at all unless optimization is on. And while optimization in general improves the efficacy of warnings about control and data-flow problems, in some cases it can also cause false positives ๐ so, vibe check your output.
โจ -Wpedantic, -pedantic, --pedantic โจ
Okay so this one is the strict-ISO-C-and-C++ hall monitor ๐ it issues all the warnings demanded by strict ISO C and ISO C++, diagnoses all programs that use forbidden extensions, and drags some other programs that don't follow ISO C and ISO C++ too. It follows whichever version of the ISO C or C++ standard you specified with any -std option.
Valid ISO C and ISO C++ programs should compile properly with or without this option (though a rare few need -ansi or a -std option specifying the standard version). But without this option, certain GNU extensions and traditional C/C++ features are supported as well โ and with this option, they get diagnosed (or straight-up rejected with -pedantic-errors). ๐ฅ
Some things -Wpedantic does not do:
- It doesn't cause warning messages for use of the alternate keywords whose names begin and end with
__. That alternate format can also be used to disable warnings for non-ISO__intNtypes, i.e.__intN__. Pedantic warnings are also disabled in the expression that follows__extension__. - But likeโฆ only system header files should use these escape routes. Application programs should avoid them, bestie, pls ๐ซถ
Some warnings about non-conforming programs are controlled by options other than -Wpedantic. In many cases they're implied by -Wpedantic but can be disabled separately by their specific option, e.g. -Wpedantic -Wno-pointer-sign.
And when the standard specified with -std represents a GNU extended dialect of C, like gnu90 or gnu99, there's a corresponding base standard โ the version of ISO C that the GNU extended dialect is based on. Warnings from -Wpedantic are given where they're required by the base standard. (And it wouldn't make sense for such warnings to be given only for features not in the specified GNU C dialect, because by definition the GNU dialects of C include all the features the compiler supports with the given option โ there'd be literally nothing to warn about ๐)
๐ธ -pedantic-errors, --pedantic-errors ๐ธ
Whenever the base standard (see -Wpedantic) requires a diagnostic, this gives you an error โ in some cases where there's undefined behavior at compile-time, and in some other cases that don't prevent compilation of programs that are valid according to the standard.
Not me needing to be super clear: this is not equivalent to -Werror=pedantic. That latter option is unlikely to be useful, since it only makes errors out of the diagnostics 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 you don't also wanna 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 ๐ฆ
This one is the chill pill ๐ it downgrades some required diagnostics about nonconformant code from errors to warnings. So using -fpermissive lets some nonconforming code 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)
Fun fact ๐ -fpermissive is the default for historic C language modes (-std=c89, -std=gnu89, -std=c90, -std=gnu90).
๐ -Wall, --all-warnings ๐
This enables all the warnings about constructions that some users consider questionable, and that are easy to avoid (or modify to prevent the warning) โ even in conjunction with macros. It 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
Heads up bestie โ ๏ธ some warning flags are not implied by-Wall. Some of them warn about constructions users generally don't 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's no simple way to modify the code to suppress the warning. Some of them are enabled by-Wextrabut many of them must be enabled individually. iykyk ๐
๐ -Wextra, --extra-warnings ๐
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 โจ)
-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-Wunusedor-Wall)-Wunused-but-set-parameter(only with-Wunusedor-Wall)
And like, -Wextra also prints warning messages for the following cases, bestie:
- 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 warns you about code affected by ABI changes โ yes, the scary binary-compatibility stuff ๐
. This includes code that may not be compatible with the vendor-neutral C++ ABI as well as the psABI for the particular target. The latter warnings are also controlled separately by -Wpsabi, which is implied by -Wabi.
Since G++ now defaults to updating the ABI with each major release, normally -Wabi warns only about C++ ABI compatibility problems if there is a check added later in a release series for an ABI issue discovered since the initial release. -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, although an effort has been made to warn about all such cases, there are probably some cases that are not warned about, even though G++ is generating incompatible code ๐ญ. There may also be cases where warnings are emitted even though the code that is generated is compatible. It's giving "we tried our best."
You should rewrite your code to avoid these warnings if you are concerned about the fact that code generated by G++ may not be binary compatible with code generated by other compilers.
Known incompatibilities in -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))andnoreturnwere mangled as type qualifiers, anddecltypeof 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_argto complain. On most targets this does not actually affect the parameter passing ABI, as there is no way to pass an argument smaller thanint.
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 anullptr_tparameter, 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, such as changes in alignment requirements or how function arguments are passed. On several targets, including AArch64, ARM, x86, MIPS, RS6000/PowerPC, and S/390, these details have changed between different versions of GCC and/or different versions of the C or C++ language standards in ways that affect binary compatibility of compiled code. With -Wpsabi, GCC can detect potentially incompatible usages and warn you about them. processor-specific drama, detected โจ
-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. it does not care about your char opinions, bestie
๐ -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.
๐ซถ real talk: don't just fully silence this one, it's there for a reason.
โญ -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. bye bye little warnings โจ
๐ -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. the literal betrayed you, fr fr
๐
-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โ okay so this is the format-string vibe check ๐ It checks calls toprintf,scanf, and friends to make sure the arguments you pass actually have types that fit the format string, and that the conversions in the format string make sense. This covers standard functions plus others specified by format attributes, across theprintf,scanf,strftime, andstrfmonfamilies โ and yes,strfmonis an X/Open extension, not in the C standard โ plus other target-specific families. Which functions get checked without format attributes being specified depends on the selected standard version, and those checks of functions without the attribute are disabled by-ffreestandingor-fno-builtin.
The formats are checked against the features supported by GNU libc version 2.2. That includes all ISO C90 and C99 features, plus features from the Single Unix Specification and some BSD and GNU extensions. Other library implementations may not support all these features; GCC does not support warning about features that go beyond a particular libraryโs limitations. But if you use -Wpedantic with -Wformat, you get warnings about format features not in the selected standard version โ except not for strfmon formats, because those arenโt in any version of the C standard. iykyk โจ
-Wformat=1,-Wformatโ the classic level-one format check ๐ Option-Wformatis equivalent to-Wformat=1, and-Wno-formatis equivalent to-Wformat=0. Since-Wformatalso checks for null format arguments for several functions,-Wformatalso implies-Wnonnull. Some aspects of this level of format checking can be disabled by these options:-Wno-format-contains-nul,-Wno-format-diag,-Wno-format-extra-args, and-Wno-format-zero-length. And yes,-Wformatis enabled by-Wall.-Wformat=2โ level two, extra format checks, main character energy ๐ Enable-Wformatplus additional format checks. Currently equivalent to-Wformat -Wformat-nonliteral -Wformat-security -Wformat-y2k.
-Wno-format-contains-nulโ If-Wformatis specified, do not warn about format strings that contain NUL bytes. simple as that, bestie ๐ซถ-Wno-format-diagโ If-Wformatis specified, do not warn about format strings that are unsuitable for GCC diagnostics. not every string is built for the diagnostics spotlight ๐-Wno-format-extra-argsโ If-Wformatis specified, do not warn about excess arguments to aprintforscanfformat function. The C standard specifies that such arguments are ignored. iconic, they literally donโt matter ๐
Where the unused arguments lie between used arguments that are specified with $ operand number specifications, normally warnings are still given, since the implementation could not know what type to pass to va_arg to skip the unused arguments. However, in the case of scanf formats, this option suppresses the warning if the unused arguments are all pointers, since the Single Unix Specification says that such unused arguments are allowed. periodt, the spec said so ๐
-Wformat-overflow,-Wformat-overflow=levelโ buffer-overflow warning time, but make it formatted I/O ๐ฅ Warn about calls to formatted input/output functions such assprintfandvsprintfthat might overflow the destination buffer. When the exact number of bytes written by a format directive cannot be determined at compile-time, it is estimated based on heuristics that depend on thelevelargument and on optimization. While enabling optimization will in most cases improve the accuracy of the warning, it may also result in false positives. ngl, compiler warnings have trust issues too ๐ญ-Wformat-overflow,-Wformat-overflow=1โ Level 1 of-Wformat-overflow, enabled by-Wformat, employs a conservative approach that warns only about calls that most likely overflow the buffer. At this level, numeric arguments to format directives with unknown values are assumed to have the value of one, and strings of unknown length are assumed to be empty. Numeric arguments that are known to be bounded to a subrange of their type, or string arguments whose output is bounded either by their directiveโs precision or by a finite set of string literals, are assumed to take on the value within the range that results in the most bytes on output. For example, the call tosprintfbelow is diagnosed because even with bothaandbequal to zero, the terminating NUL character ('\0') appended by the function to the destination buffer will be written past its end. Increasing the size of the buffer by a single byte is sufficient to avoid the warning, though it may not be sufficient to avoid the overflow. so close, yet so buffer-y ๐ฆ
void f (int a, int b)
{
char buf [13];
sprintf (buf, "a = %i, b = %i\n", a, b);
}
-Wformat-overflow=2โ Level 2 warns also about calls that might overflow the destination buffer given an argument of sufficient length or magnitude. At level 2, unknown numeric arguments are assumed to have the minimum representable value for signed types with a precision greater than 1, and the maximum representable value otherwise. Unknown string arguments whose length cannot be assumed to be bounded either by the directiveโs precision, or by a finite set of string literals they may evaluate to, or the character array they may point to, are assumed to be 1 character long. level 2 is not playing around ๐
At level 2, the call in the example above is again diagnosed, but this time because with a equal to a 32-bit INT_MIN the first %i directive will write some of its digits beyond the end of the destination buffer. To make the call safe regardless of the values of the two variables, the size of the destination buffer must be increased to at least 34 bytes. GCC includes the minimum size of the buffer in an informational note following the warning. 34 bytes or bust โญ
An alternative to increasing the size of the destination buffer is to constrain the range of formatted values. The maximum length of string arguments can be bounded by specifying the precision in the format directive. When numeric arguments of format directives can be assumed to be bounded by less than the precision of their type, choosing an appropriate length modifier to the format specifier will reduce the required buffer size. For example, if a and b in the example above can be assumed to be within the precision of the short int type, then using either the %hi format directive or casting the argument to short reduces the maximum required size of the buffer to 24 bytes.
void f (int a, int b)
{
char buf [23];
sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
}
-Wno-format-zero-lengthโ If-Wformatis specified, do not warn about zero-length formats. The C standard specifies that zero-length formats are allowed. empty format string? valid. slay. ๐-Wformat-nonliteralโ If-Wformatis specified, also warn if the format string is not a string literal and so cannot be checked, unless the format function takes its format arguments as ava_list. if I canโt read it, I canโt check it ๐-Wformat-securityโ If-Wformatis specified, also warn about uses of format functions that represent possible security problems. At present, this warns about calls toprintfandscanffunctions where the format string is not a string literal and there are no format arguments, as inprintf (foo);. This may be a security hole if the format string came from untrusted input and contains%n. this is the โbestie, do NOT trust that stringโ warning ๐จ (This is currently a subset of what-Wformat-nonliteralwarns about, but in future warnings may be added to-Wformat-securitythat are not included in-Wformat-nonliteral.)-Wformat-signednessโ If-Wformatis specified, also warn if the format string requires an unsigned argument and the argument is signed, and vice versa. signed vs unsigned, the eternal group-chat drama ๐ญ-Wformat-truncation,-Wformat-truncation=levelโ truncation warnings, because sometimes your output just gets cut off mid-sentence โ๏ธ Warn about calls to formatted input/output functions such assnprintfandvsnprintfthat might result in output truncation. When the exact number of bytes written by a format directive cannot be determined at compile-time, it is estimated based on heuristics that depend on thelevelargument and on optimization. While enabling optimization will in most cases improve the accuracy of the warning, it may also result in false positives. Except as noted otherwise, the option uses the same logic as-Wformat-overflow. same energy, different function family ๐ฆ-Wformat-truncation,-Wformat-truncation=1โ Level 1 of-Wformat-truncation, enabled by-Wformat, employs a conservative approach that warns only about calls to bounded functions whose return value is unused and that will most likely result in output truncation. if youโre not even checking the return value, bestieโฆ ๐-Wformat-truncation=2โ Level 2 warns also about calls to bounded functions whose return value is used and that might result in truncation given an argument of sufficient length or magnitude. level 2 said โand what if the input is huge?โ ๐ฅ
-Wformat-y2kโ If-Wformatis specified, also warn aboutstrftimeformats that may yield only a two-digit year. year 2000 called, it wants its ambiguity back ๐-Wnonnullโ Warn about passing a null pointer for arguments marked as requiring a non-null value by thenonnullfunction attribute. if it says non-null, please do not send null ๐ซถ
-Wnonnull is included in -Wall and -Wformat. It can be disabled with the -Wno-nonnull option.
-Wnonnull-compareโ Warn when comparing an argument marked with thenonnullfunction attribute against null inside the function. the โwhy are you checking for null when you already promised non-nullโ warning ๐ญ
-Wnonnull-compare is included in -Wall. It can be disabled with the -Wno-nonnull-compare option.
-Wnull-dereferenceโ Warn if the compiler detects paths that trigger erroneous or undefined behavior due to dereferencing a null pointer. This option is only active when-fdelete-null-pointer-checksis active, which is enabled by optimizations in most targets. The precision of the warnings depends on the optimization options used. undefined behavior is not the vibe, no cap ๐จ-Wno-musttail-local-addrโ Do not warn about passing a pointer (or in C++, a reference) to a local variable or label to argument of amusttailcall. Those variables go out of scope before the tail call instruction. theyโre literally gone before the call, so chill ๐ง-Wmaybe-musttail-local-addrโ Warn when address of a local variable can escape to amusttailcall, unless it goes out of scope already before themusttailcall. vibe check: does this local address escape? ๐
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)
Warns you when the compiler doesn't elide the copy from a local variable into a function's return value โ but only in the contexts where [class.copy.elision] would have allowed it. Bestie, this elision has a whole government name: the Named Return Value Optimization. ๐
So like, look at this cutie:
std::vector<int> f()
{
std::vector<int> v1, v2;
// ...
if (cond) return v1;
else return v2; // warning: not eliding copy
}
The compiler literally cannot elide copies from both v1 and v2 here, so it elides neither. Tragic, but fair. ๐ญ
๐ -Winfinite-recursion
Warns you about infinitely recursive calls โ the "oops I called myself forever" situation. ๐ The warning is effective at all optimization levels, but ngl it requires optimization in order to detect infinite recursion in calls <italic>between two or more functions*. So like, mutual recursion shenanigans? Yeah, that needs the optimizer's help.
-Winfinite-recursion is included in -Wall. ๐
Compare it with -Wanalyzer-infinite-recursion, which gives you a similar diagnostic but is implemented in a completely different way (as part of -fanalyzer). Same vibe, different machinery. โจ
๐ช -Winit-self (C, C++, Objective-C and Objective-C++ only)
Warns about uninitialized variables that are initialized with themselves. Yes bestie, int i = i; is exactly as cursed as it looks. ๐
Heads up: this option can only be used together with -Wuninitialized. No solo runs. ๐
For example, GCC only warns about i being uninitialized in this snippet 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 one controls warnings for when a declaration doesn't specify a type at all. Rude, honestly.
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)
Same energy, different crime: this controls warnings when a function is used before being declared. Bestie, at least say hi first?? ๐ญ
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)
The combo meal ๐ โ same as -Wimplicit-int and -Wimplicit-function-declaration. This warning is enabled by -Wall.
๐ก๏ธ -Whardened
Warns you when -fhardened did not enable an option from its own set (go read -fhardened for the lineup, iykyk). So 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. The set said no and you overrode it, basically. ๐
This warning is enabled by default, and it 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. Shortcuts, slay.
๐ณ๏ธ -Wimplicit-fallthrough=n
Warns you when a switch case falls through into the next one. Like this lil guy:
switch (cond)
{
case 1:
a = 1;
break;
case 2:
a = 2;
case 3:
a = 3;
break;
}
This warning does not fire when the last statement of a case cannot fall through โ e.g. when there's a return statement, or a call to a function declared with the noreturn attribute. Goodbye is goodbye. ๐
-Wimplicit-fallthrough= also takes control flow statements, such as ifs, into account, 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. โจ
Instead of these attributes, it's also possible to add a fallthrough comment to silence the warning. The whole body of the C or C++ style comment should match the given regular expressions listed below. The option argument n specifies what kind of comments are accepted:
-Wimplicit-fallthrough=0โ disables the warning altogether.-Wimplicit-fallthrough=1โ matches.*regular expression, any comment is used as fallthrough comment.-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.
The comment needs to be followed after optional whitespace and other comments by case or default keywords, or by a user label that precedes some case or default label. ๐
switch (cond)
{
case 1:
bar (0);
/* FALLTHRU */
default:
...
}
The -Wimplicit-fallthrough=3 warning is enabled by -Wextra. ๐ฆ
๐ -Wno-if-not-aligned (C, C++, Objective-C and Objective-C++ only)
Controls whether warnings triggered by the warn_if_not_aligned attribute should be issued. These warnings are enabled by default. ๐
๐ท๏ธ -Wignored-qualifiers (C and C++ only)
Warns when the return type of a function has a type qualifier such as const. Bestie, for ISO C such a type qualifier has no effect, since the value returned by a function is not an lvalue. For C++, the warning is only emitted for scalar types or void. ๐
ISO C prohibits qualified void return types on function definitions, so such return types always receive a warning even without this option. Periodt.
This warning is also enabled by -Wextra. โจ
๐ -Wno-ignored-attributes (C and C++ only)
This option controls warnings when an attribute is ignored. It's different from the -Wattributes option in that it warns whenever the compiler decides to drop an attribute โ not that the attribute is either unknown, used in a wrong place, etc. Subtle but iconic distinction. ๐
This warning is enabled by default. ๐ธ
๐ -Wmain
Warns when the type of main is suspicious. Like, main should be a function with external linkage, returning int, taking either zero arguments, two, or three arguments of appropriate types. That's the whole dress code, bestie. ๐
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)
Warns you 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 doesn't use braces, followed by an unguarded statement with the same indentation. It's giving "looks fine, is a lie." ๐
In the following example, the call to bar is misleadingly indented as if it were guarded by the if conditional:
if (some_condition ())
foo ();
bar (); /* Gotcha: this is not guarded by the "if". */
In the case of mixed tabs and spaces, the warning uses the -ftabstop= option to determine if the statements line up (defaulting to 8). ๐
The warning is not issued for code involving multiline preprocessor logic such as the following example.
if (flagA)
foo (0);
#if SOME_CONDITION_THAT_DOES_NOT_HOLD
if (flagB)
#endif
foo (1);
Okay bestie, this warning is not issued after a #line directive, since that typically indicates autogenerated code, and no assumptions can be made about the layout of the file that the directive references. ๐
This warning is enabled by -Wall in C and C++.
-Wmissing-attributesโ Warns when a declaration of a function is missing one or more attributes that a related function is declared with and whose absence may adversely affect the correctness or efficiency of generated code. For example, the warning is issued for declarations of aliases that use attributes to specify less restrictive requirements than those of their targets. This typically represents a potential optimization opportunity. By contrast, the-Wattribute-alias=2option controls warnings issued when the alias is more restrictive than the target, which could lead to incorrect code generation. Attributes considered includealloc_align,alloc_size,cold,const,hot,leaf,malloc,nonnull,noreturn,nothrow,pure,returns_nonnull, andreturns_twice. โจ
In C++, the warning is issued when an explicit specialization of a primary template declared with attribute alloc_align, alloc_size, assume_aligned, format, format_arg, malloc, or nonnull is declared without it. Attributes deprecated, error, and warning suppress the warning.. ๐ซ
You can use the copy attribute to apply the same set of attributes to a declaration as that on another declaration without explicitly enumerating the attributes. This attribute can be applied to declarations of functions, variables, or types. 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 is diagnosed because it is missing one of the attributes. ๐ญ
template <class T>
T* __attribute__ ((malloc, alloc_size (1)))
allocate (size_t);
template <>
void* __attribute__ ((malloc)) // missing alloc_size
allocate<void> (size_t);
-Wmissing-bracesโ Warns if an aggregate or union initializer is not fully bracketed. In the following example, the initializer forais not fully bracketed, but that forbis fully bracketed. ๐
int a[2][2] = { 0, 1, 2, 3 };
int b[2][2] = { { 0, 1 }, { 2, 3 } };
This warning is enabled by -Wall.
-Wmissing-include-dirs(C, C++, Objective-C, Objective-C++ and Fortran only) โ Warns if a user-supplied include directory does not exist. This option is disabled by default for C, C++, Objective-C and Objective-C++. For Fortran, it is partially enabled by default by warning for-Iand-J, only. ๐ธ-Wno-missing-profileโ This option controls warnings if feedback profiles are missing when using the-fprofile-useoption. This option diagnoses those cases where a new function or a new file is added between compiling with-fprofile-generateand with-fprofile-use, without regenerating the profiles. In these cases, the profile feedback data files do not contain any profile feedback information for the newly added function or file respectively. Also, in the case when profile count data (.gcda) files are removed, GCC cannot use any profile feedback information. In all these cases, warnings are issued to inform you that a profile generation step is due. Ignoring the warning can result in poorly optimized code.-Wno-missing-profilecan be used to disable the warning, but this is not recommended and should be done only when non-existent profile data is justified. ๐-Wmismatched-deallocโ Warns for calls to deallocation functions with pointer arguments returned from allocation functions for which the former isn't a suitable deallocator. A pair of functions can be associated as matching allocators and deallocators by use of attributemalloc. Unless disabled by the-fno-builtinoption the standard functionscalloc,malloc,realloc, andfree, as well as the corresponding forms of C++operator newandoperator deleteare implicitly associated as matching allocators and deallocators. In the following examplemydeallocis the deallocator for pointers returned frommyalloc. ๐ฆ
void mydealloc (void*);
__attribute__ ((malloc (mydealloc, 1))) void*
myalloc (size_t);
void f (void)
{
void *p = myalloc (32);
// ...use p...
free (p); // warning: not a matching deallocator for myalloc
mydealloc (p); // ok
}
In C++, the related option -Wmismatched-new-delete diagnoses mismatches involving either operator new or operator delete.
Option -Wmismatched-dealloc is included in -Wall. ๐ฅ
-Wmultistatement-macrosโ Warns about unsafe multiple statement macros that appear to be guarded by a clause such asif,else,for,switch, orwhile, in which only the first statement is actually guarded after the macro is expanded. ๐
For example:
#define DOIT x++; y++
if (c)
DOIT;
will increment y unconditionally, not just when c holds. This can usually be fixed by wrapping the macro in a do-while loop:
#define DOIT do { x++; y++; } while (0)
if (c)
DOIT;
This warning is enabled by -Wall in C and C++.
-Wparenthesesโ Warns if parentheses are omitted in certain contexts, such as when there is an assignment in a context where a truth value is expected, or when operators are nested whose precedence people often get confused about. ๐ตโ๐ซ
Also warn if a comparison like x<=y<=z appears; this is equivalent to (x<=y ? 1 : 0) <= z, which is a different interpretation from that of ordinary mathematical notation.
Also warn for dangerous uses of the GNU extension to ?: with omitted middle operand. When the condition in the ?: operator is a boolean expression, the omitted value is always 1. Often programmers expect it to be a value computed inside the conditional expression instead.
For C++ this also warns for some cases of unnecessary parentheses in declarations, which can indicate an attempt at a function call instead of a declaration:
{
// Declares a local variable called mymutex.
std::unique_lock<std::mutex> (mymutex);
// User meant std::unique_lock<std::mutex> lock (mymutex);
}
This warning is enabled by -Wall. ๐
-Wno-self-move(C++ and Objective-C++ only) โ This warning warns when a value is moved to itself withstd::move. Such astd::movetypically has no effect. ๐ซถ
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 of violations of sequence point rules in the C and C++ standards. ๐จ
The C and C++ standards define the order in which expressions in a C/C++ program are evaluated in terms of 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 is not specified when between sequence points modifications to the values of objects take effect. Programs whose behavior depends on this have undefined behavior; the C and C++ standards specify that "Between the previous and next sequence point an object shall have its stored value modified at most once by the evaluation of an expression. Furthermore, the prior value shall be read only to determine the value to be stored." If a program breaks these rules, the results on any particular implementation are entirely unpredictable. ๐ญ
Examples of code with undefined behavior are a = a++;, a[n] = b[n++] and a[i++] = i;. Some more complicated cases are not diagnosed by this option, and it may give an occasional false positive result, but in general it has been found fairly effective at detecting this sort of problem in programs.
The C++17 standard will define the order of evaluation of operands in more cases: in particular it requires that the right-hand side of an assignment be evaluated before the left-hand side, so the above examples are no longer undefined. But this option will still warn about them, to help people avoid writing code that is undefined in C and earlier revisions of C++.
The standard is worded confusingly, therefore there is some debate over the precise meaning of the sequence point rules in subtle cases. Links to discussions of the problem, including proposed formal definitions, may be found on the GCC readings page, at https://gcc.gnu.org/readings.html. ๐ง
This warning is enabled by -Wall for C and C++.
-Wno-return-local-addrโ Do not warn about returning a pointer (or in C++, a reference) to a variable that goes out of scope after the function returns. ๐-Wreturn-mismatchโ bestie, this one's aboutreturnstatements that don't match the function's vibe ๐ค It warns aboutreturnstatements with no expression in functions that don't returnvoid. Also flags areturnwith an expression inside a function whose return type isvoidโ unless the expression's type is alsovoid. As a GNU extension, that second case is accepted with no warning at all unless-Wpedanticis on. Ngl, tryna use the return value of a non-voidfunction (other thanmain, obvs) that just kinda falls off the end by hitting the closing curly brace? That's undefined behavior, periodt. This warning is C-specific and enabled by default โจ In C99 and later dialects it's treated as an error. You can downgrade it to a warning with-fpermissive(along with other warnings), or just this one alone with-Wno-error=return-mismatch. ๐-Wreturn-typeโ warns whenever a function is defined with a return type that defaults toint(unless-Wimplicit-intis active, 'cause that one takes precedence ๐). Also warns if execution might reach the end of the function body, or if the function has no return statement at all. Same undefined-behavior caveat as above: tryna use the return value of a non-voidfunction other thanmainthat flows off the end and hits the closing curly brace = undefined ๐ซฃ And unlike in C, in C++ flowing off the end of a non-voidfunction other thanmainis undefined behavior even when the value isn't used. This one's enabled by default in C++ and by-Wallotherwise. ๐-Wno-shift-count-negativeโ controls warnings when a shift count is negative. Enabled by default. โจ-Wno-shift-count-overflowโ controls warnings when a shift count is greater than or equal to the bit width of the type. Enabled by default. โจ-Wshift-negative-valueโ warns if you left shift a negative value ๐ฅ enabled by-Wextrain C99 (and newer) and C++11 to C++17 modes.-Wno-shift-overflow,-Wshift-overflow=nโ these options control warnings about left shift overflows. Let's break it down:-Wshift-overflow=1โ this is the warning level of-Wshift-overflowand is enabled by default in C99 and C++11 modes (and newer). This 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 in C++20 mode (and newer) since signed left shifts always wrap. ๐-Wshift-overflow=2โ this level also warns about left-shifting 1 into the sign bit, unless C++14 mode (or newer) is active. ๐
-Wswitchโ warns whenever aswitchstatement has an index of enumerated type and is missing acasefor one or more of the named codes of that enumeration. (Adefaultlabel prevents this warning, iykyk.)caselabels that don't correspond to enumerators also provoke warnings with this option, unless the enumeration is marked with theflag_enumattribute. Enabled by-Wall. โจ-Wswitch-defaultโ warns whenever aswitchstatement has nodefaultcase. ๐-Wswitch-enumโ warns whenever aswitchstatement has an index of enumerated type and lacks acasefor one or more named codes of that enumeration.caselabels that don't correspond to enumerators also provoke warnings here too, unless the enumeration is marked with theflag_enumattribute. The only difference from-Wswitchis that this one warns about an omitted enumeration code even if there's adefaultlabel. ๐-Wno-switch-boolโ don't warn when aswitchstatement has an index of boolean type and the case values are outside the range of a boolean type. You can also suppress this warning by casting the controlling expression to a type other thanbool. For example:
switch ((int) (a == 4))
{
...
}
This warning is enabled by default for C and C++ programs. ๐
-Wno-switch-outside-rangeโ controls warnings when aswitchcase has a value outside its respective type range. Enabled by default for C and C++ programs. โจ-Wno-switch-unreachableโ don't warn when aswitchstatement contains statements between the controlling expression and the first case label, which will never be executed. Example:
switch (cond)
{
i = 15;
...
case 5:
...
}
-Wswitch-unreachable does not warn if the statement between the controlling expression and the first case label is just a declaration:
switch (cond)
{
int i;
...
case 5:
i = 5;
...
}
This warning is enabled by default for C and C++ programs. ๐ฆ
-Wsync-nand(C and C++ only) โ warns when the__sync_fetch_and_nandand__sync_nand_and_fetchbuilt-in functions are used. These functions changed semantics in GCC 4.4, so like... heads up ๐ซฃ-Wtrivial-auto-var-initโ warns when-ftrivial-auto-var-initcan't initialize the automatic variable. A common situation is an automatic variable declared between the controlling expression and the first case label of aswitchstatement. ๐ญ-Wunused-but-set-parameterโ same as-Wunused-but-set-parameter=3, and-Wno-unused-but-set-parameteris the same as-Wunused-but-set-parameter=0. ๐-Wunused-but-set-parameter=nโ warns whenever a function parameter is assigned to but otherwise unused (aside from its declaration). To suppress this warning, use theunusedattribute.-Wunused-but-set-parameter=0disables the warning. With=1, all uses except initialization and left-hand side of assignment which isn't further used disable the warning. With=2, additionally uses of the parameter in++and--operators don't count as uses. And finally with=3, additionally uses in parm@=rhs outside of rhs don't count as uses. See the-Wunused-but-set-variable=noption for examples. ๐
This -Wunused-but-set-parameter=3 warning is also enabled by -Wunused together with -Wextra. ๐ฅ
-Wunused-but-set-variableโ same as-Wunused-but-set-variable=3, and-Wno-unused-but-set-variableis the same as-Wunused-but-set-variable=0. ๐-Wunused-but-set-variable=nโ warns whenever a local variable is assigned to but otherwise unused (aside from its declaration). This-Wunused-but-set-variable=3warning is enabled by-Wall. To suppress it, use theunusedattribute.=0disables the warning. With=1, all uses except initialization and left-hand side of assignment which isn't further used disable the warning. With=2, additionally uses of the variable in++and--operators don't count as uses. And finally with=3, additionally uses in parm@=rhs outside of rhs don't count as uses. This-Wunused-but-set-variable=3warning is also enabled by-Wunused, which is enabled by-Wall. ๐
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โ warns whenever a static function is declared but not defined, or a non-inline static function is unused. Enabled by-Wall. โจ-Wunused-labelโ warns whenever a label is declared but not used. Enabled by-Wall. To suppress, use theunusedattribute. ๐ท๏ธ-Wunused-local-typedefs(C, Objective-C, C++ and Objective-C++ only) โ warns when a typedef locally defined in a function isn't used. Enabled by-Wall. ๐-Wunused-parameterโ warns whenever a function parameter is unused aside from its declaration. This option is not enabled by-Wunusedunless-Wextrais also specified. To suppress, use theunusedattribute. ๐ซถ-Wno-unused-resultโ don't warn if a caller of a function marked with thewarn_unused_resultattribute doesn't use its return value. The default is-Wunused-result. ๐-Wunused-variableโ warns whenever a local or static variable is unused aside from its declaration. This option implies-Wunused-const-variable=1for C, but not for C++. Enabled by-Wall. To suppress, use theunusedattribute. ๐ธ-Wunused-const-variable,-Wunused-const-variable=nโ warns whenever a constant static variable is unused aside from its declaration. To suppress, use theunusedattribute. ๐-Wunused-const-variable=1โ warns about unused static const variables defined in the main compilation unit, but not about static const variables declared in any header included.-Wunused-const-variable=1is enabled by either-Wunused-variableor-Wunusedfor C, but not for C++. In C this declares variable storage, but in C++ this isn't an error since const variables take the place of#defines. ๐ฆ
-Wunused-const-variable=2โ this level also warns you about unused constantstaticvariables hiding in headers (system headers stay excluded, bestie, they're untouchable ๐). It's literally the same as the short form-Wunused-const-variable. You have to ask for this level explicitly in both C and C++ because ngl, cleaning up every header you include can be a whole situation ๐ญ-Wunused-valueโ warns whenever a statement computes a result that's explicitly not used. Wanna silence it? Just cast that unused expression to"void", iconic move. This covers an expression-statement, or the left-hand side of a comma expression that contains no side effects. For example, an expression such as"x[i,j]"causes a warning, while"x[(void)i,j]"does not. โจ
This warning is enabled by -Wall.
-Wunusedโ all the above-Wunusedoptions combined, except the ones documented as needing to be specified explicitly. So it's giving "greatest hits album" but not the deluxe tracks ๐
To get a warning about an unused function parameter, you must either specify -Wextra -Wunused (note that -Wall implies -Wunused), or separately specify -Wunused-parameter and/or -Wunused-but-set-parameter. No free rides, bestie.
-Wunused enables only -Wunused-const-variable=1 rather than -Wunused-const-variable, and only for C, not C++. C++ girlies gotta opt in themselves ๐
๐ฆ -Wuse-after-free (C, Objective-C, C++ and Objective-C++ only)
-Wuse-after-free-Wuse-after-free=n
Warns you about uses of pointers to dynamically allocated objects that have been rendered indeterminate by a call to a deallocation function. Translation: you freed it, so let it go ๐ The warning is enabled at all optimization levels but may yield different results with optimization than without. -Wuse-after-free is equivalent to -Wuse-after-free=1. โจ
-Wuse-after-free=1โ at level 1 the warning attempts to diagnose only unconditional uses of pointers made indeterminate by a deallocation call or a successful call to"realloc", regardless of whether or not the call resulted in an actual reallocation of memory. This includes double-"free"calls as well as uses in arithmetic and relational expressions. Although undefined, uses of indeterminate pointers in equality (or inequality) expressions are not diagnosed at this level. Lowkey the gentle intro level ๐-Wuse-after-free=2โ at level 2, in addition to unconditional uses, the warning also diagnoses conditional uses of pointers made indeterminate by a deallocation call. As at level 2, uses in equality (or inequality) expressions are not diagnosed. For example, the second call to"free"in the following function is diagnosed at this level:
struct A { int refcount; void *data; };
void release (struct A *p)
{
int refcount = --p->refcount;
free (p);
if (refcount == 0)
free (p->data); // warning: p may be used after free
}
-Wuse-after-free=3โ at level 3, the warning also diagnoses uses of indeterminate pointers in equality expressions. All uses of indeterminate pointers are undefined but equality tests sometimes appear after calls to"realloc"as an attempt to determine whether the call resulted in relocating the object to a different address. They are diagnosed at a separate level to aid gradually transitioning legacy code to safe alternatives. For example, the equality test in the function below is diagnosed at this level:
void adjust_pointers (int**, int);
void grow (int **p, int n)
{
int **q = (int**)realloc (p, n *= 2);
if (q == p)
return;
adjust_pointers ((int**)q, n);
}
To avoid the warning at this level, store offsets into allocated memory instead of pointers. This approach obviates needing to adjust the stored pointers after reallocation. Big brain energy fr fr ๐ง โจ
-Wuse-after-free=2is included in-Wall. ๐
-Wuseless-cast(C, Objective-C, C++ and Objective-C++ only) โ warns when an expression is cast to its own type. Like, why are you casting yourself to yourself, main character? ๐ This warning does not occur when a class object is converted to a non-reference type as that is a way to create a temporary:
struct S { };
void g (S&&);
void f (S&& arg)
{
g (S(arg)); // make arg prvalue so that it can bind to S&&
}
-Wuninitializedโ warns if an object with automatic or allocated storage duration is used without having been initialized. In C++, it also warns if a non-static reference or non-static"const"member appears in a class without constructors. Ghosted values get called out ๐ป
In addition, passing a pointer (or in C++, a reference) to an uninitialized object to a "const"-qualified argument of a built-in function known to read the object is also diagnosed by this warning. (-Wmaybe-uninitialized is issued for ordinary functions.)
If you want to warn about code that uses the uninitialized value of the variable in its own initializer, use the -Winit-self option. Self-sabotage detected ๐จ
These warnings occur for individual uninitialized elements of structure, union or array variables as well as for variables that are uninitialized as a whole. They do not occur for variables or elements declared "volatile". Because these warnings depend on optimization, the exact variables or elements for which there are warnings depend on the precise optimization options and version of GCC used. So like, your mileage literally varies by build, no cap.
Note that there may be no warning about a variable that is used only to compute a value that itself is never used, because such computations may be deleted by data flow analysis before the warnings are printed. GCC said "that whole plotline? cut it" ๐ฌ๐
In C++, this warning also warns about using uninitialized objects in member-initializer-lists. For example, GCC warns about "b" being uninitialized in the following snippet:
struct A {
int a;
int b;
A() : a(b) { }
};
-Wno-invalid-memory-modelโ this option controls warnings for invocations of__atomicBuiltins,__syncBuiltins, and the C11 atomic generic functions with a memory consistency argument that is either invalid for the operation or outside the range of values of the"memory_order"enumeration. For example, since the"__atomic_store"and"__atomic_store_n"built-ins are only defined for the relaxed, release, and sequentially consistent memory orders the following code is diagnosed:
void store (int *i)
{
__atomic_store_n (i, 0, memory_order_consume);
}
-Winvalid-memory-model is enabled by default. ๐ซถ
-Wmaybe-uninitializedโ for an object with automatic or allocated storage duration, if there exists a path from the function entry to a use of the object that is initialized, but there exist some other paths for which the object is not initialized, the compiler emits a warning if it cannot prove the uninitialized paths are not executed at run time. "maybe" is doing so much heavy lifting here bestie ๐ญ
In addition, passing a pointer (or in C++, a reference) to an uninitialized object to a "const"-qualified function argument is also diagnosed by this warning. (-Wuninitialized is issued for built-in functions known to read the object.) Annotating the function with attribute "access (none)" indicates that the argument isn't used to access the object and avoids the warning. Cute little "she doesn't even go here" annotation ๐
These warnings are only possible in optimizing compilation, because otherwise GCC does not keep track of the state of variables. On the other hand, -Wmaybe-uninitialized is known not to warn in many situations (false negatives) due to optimizations taking advantage of undefinedness of uninitialized uses like constant propagation. So it's giving flaky, honestly ๐ธ
These warnings are made optional because GCC may not be able to determine when the code is correct in spite of appearing to have an error. Here is one example of how this can happen:
{
int x;
switch (y)
{
case 1: x = 1;
break;
case 2: x = 4;
break;
case 3: x = 5;
}
foo (x);
}
If the value of "y" is always 1, 2 or 3, then "x" is always initialized, but GCC doesn't know this. To suppress the warning, you need to provide a default case with assert(0) or similar code. Just tell the compiler what's up, bestie ๐ข
This option also warns when a non-volatile automatic variable might be changed by a call to "longjmp". The compiler sees only the calls to "setjmp". It cannot know where "longjmp" will be called; in fact, a signal handler could call it at any point in the code. As a result, you may get a warning even when there is in fact no problem because "longjmp" cannot in fact be called at the place that would cause a problem. Trust issues: mutual ๐ซ
Some spurious warnings can be avoided if you declare all the functions you use that never return as "noreturn". Iconic little hint.
This warning is enabled by -Wall or -Wextra. โจ
-Wunknown-pragmasโ warns when a"#pragma"directive is encountered that is not understood by GCC. If this command-line option is used, warnings are even issued for unknown pragmas in system header files โ like, it's not scared of system headers, periodt. This is not the case if the warnings are only enabled by the-Wallcommand-line option.-Wno-pragmasโ do not warn about misuses of pragmas, such as incorrect parameters, invalid syntax, or conflicts between pragmas. See also-Wunknown-pragmas. Pragmas get a pass today ๐-Wno-pragma-once-outside-headerโ do not warn when"#pragma once"is used in a file that is not a header file, such as a main file. She's allowed to be there, actually ๐-Wno-prio-ctor-dtorโ do not warn if a priority from 0 to 100 is used for constructor or destructor. The use of constructor and destructor attributes allow you to assign a priority to the constructor/destructor to control its order of execution before"main"is called or after it returns. The priority values must be greater than 100 as the compiler reserves priority values between 0--100 for the implementation. So 0โ100 is the compiler's lane, stay out of it ๐ซ๐-Wstrict-aliasingโ only does anything when-fstrict-aliasingis active, bestie. It warns you about code that might break the strict aliasing rules the compiler is using to optimize. Heads up: it does not catch every case, it just tries to catch the more common pitfalls. It's included in-Wall, and it's literally the same thing as-Wstrict-aliasing=3.-Wstrict-aliasing=nโ same deal, only active when-fstrict-aliasingis active ๐ warns about code that might break the strict aliasing rules the compiler uses for optimization. Higher levels = higher accuracy (fewer false positives). Higher levels also = more effort, kinda like how-Oworks. And yeah,-Wstrict-aliasingis equivalent to-Wstrict-aliasing=3.
Level 1: Most aggressive, quick, least accurate. Possibly useful when higher levels don't warn but -fstrict-aliasing still breaks the code, because it has very few false negatives. However, it has many false positives. It warns for all pointer conversions between possibly incompatible types, even if never dereferenced. Runs in the front end only.
Level 2: Aggressive, quick, not too precise. May still have many false positives (not as many as level 1 though), and few false negatives (but possibly more than level 1). Unlike level 1, it only warns when an address is taken. Warns about incomplete types. Runs in the front end only.
Level 3 (default for -Wstrict-aliasing): Should have very few false positives and few false negatives. Slightly slower than levels 1 or 2 when optimization is enabled. Takes care of the common pun+dereference pattern in the front end: *(int*)&some_float. If optimization is enabled, it also runs in the back end, where it deals with multiple statement cases using flow-sensitive points-to information. Only warns when the converted pointer is dereferenced. Does not warn about incomplete types. โจ
-Wstrict-overflow-Wstrict-overflow=nโ this one's only active when signed overflow is undefined. It warns about cases where the compiler optimizes based on the assumption that signed overflow does not occur ๐ Note that it does not warn about all cases where the code might overflow: it only warns about cases where the compiler implements some optimization. So likeโฆ this warning depends on the optimization level, iykyk.
An optimization that assumes signed overflow does not occur is perfectly safe if the values of the variables involved are such that overflow never does, in fact, occur. So this warning can easily give a false positive: a warning about code that is not actually a problem. To help focus on important issues, several warning levels are defined. No warnings are issued for the use of undefined signed overflow when estimating how many iterations a loop requires โ in particular when determining whether a loop will be executed at all.
-Wstrict-overflow=1โ Warn about cases that are both questionable and easy to avoid. For example the compiler simplifiesx + 1 > xto1. This level of-Wstrict-overflowis 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, becauseabs (INT_MIN)overflows toINT_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 > 1is simplified tox > 0.-Wstrict-overflow=4โ Also warn about other simplifications not covered by the above cases. For example:(x * 10) / 5is simplified tox * 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 > yis simplified tox + 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โ Warns for calls tostrcmpandstrncmpwhose 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 ofstrncmp). Such calls could be mistakes. For example, the call tostrcmpbelow is diagnosed because its result is necessarily non-zero irrespective of the contents of the arraya:
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โ Warns for code that can be statically determined to cause buffer overflows or memory overruns, like calls tomemcpyandstrcpythat 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 likememcpyalways 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 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โ 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_SOURCEmacro is defined to a non-zero value.-Wstringop-overflow=2โ 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โ 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โ 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=3this setting of the option may result in warnings for benign code.
-Wno-stringop-overreadโ Warns for calls to string manipulation functions such asmemchr, orstrcpythat are determined to read past the end of the source sequence. Option-Wstringop-overreadis enabled by default. ๐ฆ-Wno-stringop-truncationโ Do not warn for calls to bounded string manipulation functions such asstrncat,strncpy, andstpncpythat 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);
}
Like, same energy for the next strncpy situation: this call copies to d only the characters that come before the terminating NUL, and then doesn't append the NUL at the end. Assuming the result of strncpy is necessarily a NUL-terminated string is a super common mistake, so the call gets diagnosed. If you're not expecting a NUL-terminated result and wanna dodge the warning, just call memcpy instead. ๐ซถ
void copy (char *d, const char *s)
{
strncpy (d, s, strlen (s));
}
And in this next one, the call to strncpy passes 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 result of the copy will not be NUL-terminated. So yeah, that call is also diagnosed. To avoid the warning, specify sizeof buf - 1 as the bound and set the last element of the buffer to NUL. ๐
void copy (const char *s)
{
char buf[80];
strncpy (buf, s, sizeof buf);
...
}
Now, if you've got a character array that's genuinely meant to store a sequence of bytes with no terminating NUL, you can annotate that array with attribute nonstring to avoid this warning. Cute, right? BUT โ and this is the important part โ such arrays are not suitable arguments to functions that expect NUL-terminated strings. To help catch accidental misuse of those arrays, GCC issues warnings unless it can prove the use is safe. ๐
-Wstrict-flex-arrays (C and C++ only) ๐ธ
Warns about improper usages of flexible array members, according to the level of the strict_flex_array (level) attribute attached to the trailing array field of a structure โ if that attribute's available โ otherwise according to the level of the option -fstrict-flex-arrays=level. Heads up: -Wstrict-flex-arrays is only effective when level is greater than 0.
level=1โ warnings get issued for a trailing array reference of a structure that has 2 or more elements, if the trailing array is referenced as a flexible array member.level=2โ in addition tolevel=1, extra warnings get issued for a trailing one-element array reference of a structure, if the array is referenced as a flexible array member.level=3โ in addition tolevel=2, extra warnings get 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 (that's the default for -O2 and above), but some warnings may be diagnosed even without optimization. โจ
-Wsuggest-attribute=attribute-name ๐ฆ
Warns for cases where adding an attribute might be beneficial. The *attribute-name*s currently supported are listed below, bestie.
-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 attributespure,const,noreturn,mallocorreturns_nonnull. The compiler only warns for functions visible in other compilation units, or (in the case ofpureandconst) 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, callingabortor trapping. This analysis requires option-fipa-pure-const, which is enabled by default at-Oand higher. Higher optimization levels improve the accuracy of the analysis. ๐ฅ-Wsuggest-attribute=format,-Wmissing-format-attributeโ warn about function pointers that might be candidates forformatattributes. NGL, these are only possible candidates, not absolute ones. GCC guesses that function pointers withformatattributes that are used in assignment, initialization, parameter passing or return statements should have a correspondingformatattribute 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 aformatattribute to avoid the warning.
GCC also warns about function definitions that might be candidates for format attributes. Again โ only possible candidates. GCC guesses that format attributes might be appropriate for any function that calls a function like vprintf or vscanf, but that might not always be the case, and some functions for which format attributes are appropriate may not be detected. It's giving "vibes-based heuristic" ngl. ๐
-Wsuggest-attribute=coldโ warn about functions that might be candidates forcoldattribute. This one's based on static detection and generally only warns about functions which always lead to a call to anothercoldfunction, like wrappers of C++throwor fatal error reporting functions leading toabort. ๐
-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 โ including those to the built-in forms of the functions aligned_alloc, alloca, calloc, malloc, and realloc.
-Walloc-zero ๐
Warns about calls to allocation functions decorated with attribute alloc_size that specify zero bytes โ including those to the built-in forms of the functions aligned_alloc, alloca, calloc, malloc, and realloc.
Ok so listen: because the behavior of these functions when called with a zero size differs among implementations (and in the case of realloc has been deprecated), relying on it may result in subtle portability bugs and should be avoided. Periodt. โญ
-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.
Here's the deal: the first argument to calloc is documented to be number of elements in array, while the second argument is size of each element, so calloc (n, sizeof (int)) is preferred over calloc (sizeof (int), n). If having sizeof in the earlier argument and not the latter is intentional, the warning can be suppressed by using calloc (sizeof (struct S) + 0, n) or calloc (1 * sizeof (struct S), 4) or just using sizeof in the later argument as well. ๐
-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 the option can be disabled either by specifying byte-size of SIZE_MAX or more, or by -Wno-alloc-size-larger-than.
-Wno-alloc-size-larger-than ๐
Disable -Walloc-size-larger-than= warnings. The option is equivalent to -Walloc-size-larger-than=SIZE_MAX or larger.
-Walloca ๐ฅ
This option warns on all uses of alloca in the source. Like, all of them. No cap.
-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 option warns on calls to alloca with an integer argument whose value is either zero, or that is not bounded by a controlling predicate that limits its value to at most byte-size. It also warns for calls to alloca where the bound value is unknown. Arguments of non-integer types are considered unbounded even if they appear to be constrained to the expected range. ๐ซ
For example, a bounded case of alloca could be:
void func (size_t n)
{
void *p;
if (n <= 1000)
p = alloca (n);
else
p = malloc (n);
f (p);
}
In the above example, passing -Walloca-larger-than=1000 would not issue a warning because the call to alloca is known to be at most 1000 bytes. However, if -Walloca-larger-than=500 were passed, the compiler would emit a warning. ๐
Unbounded uses, on the other hand, are uses of alloca with no controlling predicate constraining its integer argument. Like this:
void func ()
{
void *p = alloca (n);
f (p);
}
If -Walloca-larger-than=500 were passed, the above would trigger a warning โ but this time because of the lack of bounds checking.
Also, note that even seemingly correct code involving signed integers could cause a warning. Rude, I know:
void func (signed int n)
{
if (n < 500)
{
p = alloca (n);
f (p);
}
}
In the above example, n could be negative, causing a larger than expected argument to be implicitly cast into the alloca call. ๐ฌ
This option also warns when alloca is used in a loop. ๐
-Walloca-larger-than=PTRDIFF_MAX is enabled by default but is usually only effective when -ftree-vrp is active (default for -O2 and above).
See also -Wvla-larger-than=byte-size. ๐
-Wno-alloca-larger-than ๐ธ
Disable -Walloca-larger-than= warnings. 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 B<-Wconversion>
c = c + 1; // only warns with B<-Warith-conversion>
}
-Warray-bounds,-Warray-bounds=n โ bestie, this one yells at you when you index outside an array or take an offset that's out of bounds ๐ . It's switched on by-Wall. It hits way harder when-ftree-vrpis active (which is the default at-O2and above), but a subset of these still get reported even with zero optimization. Ngl, it's giving "the compiler sees your crimes" energy.
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: a flexible array member per C99 standard onwards ([]), a GCC zero-length array extension ([0]), or a one-element array ([1]). The tea here: because of that, out-of-bounds subscripts or offsets into zero-length arrays or one-element arrays are not warned by default ๐.
You can add -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-boundsand it's enabled by-Wall; the higher levels are not included, so you have to explicitly request them, mwah ๐.-Warray-bounds=2โ this level also warns about the intermediate results of pointer arithmetic that may yield out-of-bounds values. Heads up though: this level may give a larger number of false positives, and it's deactivated by default. It's giving "paranoid bestie" and honestly? valid.
-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 so, bestie:
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, because in C++ such initializations are an error ๐ญ. C++ said "absolutely not" fr fr.
-Warray-compareโ warns about equality and relational comparisons between two operands of array type. This comparison was deprecated in C++20, so likeโฆ it's giving legacy behavior. Example time:
int arr1[5];
int arr2[5];
bool same = arr1 == arr2;
-Warray-compare is enabled by -Wall. Slay, it caught that for you โจ.
-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.
Okay so here's the lore ๐ง: 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". Inconsistent much? ๐
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 โ they're basically matching outfits, no cap ๐
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. Also: the short form of the option -Warray-parameter is equivalent to -Warray-parameter=2, and the negative form -Wno-array-parameter is equivalent to -Warray-parameter=0. cute little symmetry, we love to see it ๐
-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. It's giving "you set them up and they don't match" ๐ญ-Wattribute-alias=1โ the default warning level of the-Wattribute-aliasoption diagnoses incompatibilities between the type of the alias declaration and that of its target. Such incompatibilities are typically indicative of bugs. Red flag behavior fr.-Wattribute-alias=2โ at this level-Wattribute-aliasalso 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-attributesoption, which controls diagnostics when the alias declaration is less restrictive than the target, rather than more restrictive.
Attributes considered include "alloc_align", "alloc_size", "cold", "const", "hot", "leaf", "malloc", "nonnull", "noreturn", "nothrow", "pure", "returns_nonnull", and "returns_twice". That's the whole guest list, bestie ๐ซถ
-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. Your call, queen ๐
-Wbidi-chars=[none|unpaired|any|ucn]โ warns about possibly misleading UTF-8 bidirectional control characters in comments, string literals, character constants, and identifiers. Bestie this one is genuinely scary ๐ญ such characters can change left-to-right writing direction into right-to-left (and vice versa), which can cause confusion between the logical order and visual order. This may be dangerous; for instance, it may seem that a piece of code is not commented out, whereas it in fact is. Straight-up gaslighting code ๐
There are three levels of warning supported by GCC:
- The default is
-Wbidi-chars=unpaired, which warns about improperly terminated bidi contexts. -Wbidi-chars=noneturns the warning off.-Wbidi-chars=anywarns 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. Little conditional logic moment, iykyk ๐ธ
-Wbool-compareโ warns about boolean expression compared with an integer value different from"true"/"false". For instance, the following comparison is always false, bestie, likeโฆ whoever wrote this was not having a good day:
int n = 5;
...
if ((n > 1) == 2) { ... }
This warning is enabled by -Wall. Iconic catch tbh ๐
-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 โ and honestly? why would you even ๐ญ (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. It's giving "why are you like this" energy fr fr.
-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;
Like bestieโฆ both roads lead to *p. Pick a lane ๐
-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) { ... }
The second one is never gonna hit, queen. Deceased ๐
-Wframe-addressโ warns when the__builtin_frame_addressor__builtin_return_addressis called with an argument greater than0. Such calls may return indeterminate values or crash the program ๐ญ The warning is included in-Wall. Do not do this, bestie, I'm begging ๐ซถ-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. Sometimes you just gotta drop the qualifier and move on, no questions asked ๐-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. Same vibe, different array ๐ฆ-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. So likeโฆ -pedantic-errors said "no fun allowed" ๐
-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-castand-Wno-pointer-to-int-castmay be used. Implicit vs explicit, bestie โ the compiler cares about the difference even if your situationship doesn't ๐
okay so by default, in C99 and later dialects of C, GCC treats this whole issue as an error. Rude but fair. You can downgrade that error into a lil warning with -fpermissive (which does the same for certain other errors too, bestie, it's a package deal), or โ if you only want this one softened โ with -Wno-error=int-conversion. And heads up: -pedantic-errors upgrades this warning right back into an error. ๐
-Wzero-as-null-pointer-constantโ screams when a literal0gets used as a null pointer constant. Just saynullptrbabe. โจ-Wzero-length-boundsโ warns you about accesses to elements of zero-length array members that might overlap other members of the same object. Declaring interior zero-length arrays is discouraged because accessing them is undefined โ like, undefined undefined. ๐
For example, the first two stores in function bad get diagnosed because the array elements overlap the subsequent members b and c. The third store gets diagnosed by -Warray-bounds instead, because it's beyond the bounds of the enclosing object:
struct X { int a[0]; int b, c; };
struct X x;
void bad (void)
{
x.a[0] = 0; // -Wzero-length-bounds
x.a[1] = 1; // -Wzero-length-bounds
x.a[2] = 2; // -Warray-bounds
}
Option -Wzero-length-bounds is enabled by -Warray-bounds. ๐ซถ
-Wno-div-by-zeroโ do not warn about compile-time integer division by zero. And floating-point division by zero isn't warned about either, because it can legitimately be how you obtain infinities and NaNs. so true, let her cook ๐-Wsystem-headersโ prints warning messages for constructs found in system header files. Normally warnings from system headers are suppressed, on the assumption that they usually don't indicate real problems and would only make the compiler output harder to read. Using this command-line option tells GCC to emit warnings from system headers as if they occurred in user code. Chaos mode: enabled. But note โ using-Walltogether with this option does not warn about unknown pragmas in system headers; for that,-Wunknown-pragmasmust also be used. iykyk ๐ญ-Wtautological-compareโ warns if a self-comparison always evaluates to true or false. It catches all those classic oopsie mistakes like:
int i = 1;
...
if (i > i) { ... }
It also warns about bitwise comparisons that always evaluate to true or false, for instance:
if ((a & 16) == 10) { ... }
will always be false. not the bitwise delusion ๐ญ
This warning is enabled by -Wall. ๐
-Wtrailing-whitespace-Wtrailing-whitespace=kind โ warn about trailing whitespace at the end of lines, including inside of comments, but excluding trailing whitespace in raw string literals.-Wtrailing-whitespaceis equivalent to-Wtrailing-whitespace=blanksand warns just about trailing space and horizontal tab characters.-Wtrailing-whitespace=anywarns about those or trailing form feed or vertical tab characters.-Wno-trailing-whitespaceor-Wtrailing-whitespace=nonedisables the warning, which is the default. This is a coding style warning. ๐-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. No warning is emitted on lines which contain solely whitespace (although-Wtrailing-whitespace=warning might be emitted), and no warnings are emitted inside of raw string literals. Warnings are also emitted for leading whitespace inside of multi-line comments.-Wleading-whitespace=spaceswarns about leading whitespace other than spaces, for projects which want to indent just by spaces.-Wleading-whitespace=tabswarns about leading whitespace other than horizontal tabs, for projects which want to indent just by horizontal tabs.-Wleading-whitespace=blankswarns 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 argument of-ftabstop=n,8by default).-Wleading-whitespace=nonedisables the warning, which is the default. This is a coding style warning. ๐ธ-Wtrampolinesโ warns about trampolines generated for pointers to nested functions. A trampoline is a small piece of data or code that is created at run time on the stack when the address of a nested function is taken, and is used to call the nested function indirectly. For some targets it's made up of data only and thus requires no special treatment. But for most targets it's made up of code, and thus requires the stack to be made executable in order for the program to work properly. executable stack, bestie, that's a whole vibe and not the good kind ๐-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. If you're doing this, then you need to compute (by analyzing the code, or in some other way) the maximum or likely maximum error that the computation introduces, and allow for it when performing comparisons (and when producing output, but that's a different problem). In particular, instead of testing for equality, you should check to see whether the two values have ranges that overlap โ and that's done with the relational operators, so equality comparisons are probably mistaken. fr fr, floats are liars ๐ง
-Wtraditional(C and Objective-C only) โ warns about certain constructs that behave differently in traditional C and ISO C. Also warns about ISO C constructs that have no traditional C equivalent, and/or problematic constructs that should be avoided. The full lore:- Macro parameters that appear within string literals in the macro body. In traditional C, macro replacement takes place within string literals, but in ISO C it does not.
- In traditional C, some preprocessor directives did not exist. Traditional preprocessors only considered a line to be a directive if the
#appeared in column 1 on the line. Therefore-Wtraditionalwarns 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#pragmanot understood by traditional C by indenting them. Some traditional implementations do not recognize#elif, so this option suggests avoiding it altogether. - A function-like macro that appears without arguments.
- The unary plus operator.
- The
Uinteger constant suffix, or theForLfloating-point constant suffixes. (Traditional C does support theLsuffix on integer constants.) Note, these suffixes appear in macros defined in the system headers of most modern systems, e.g. the_MIN/_MAXmacros in<limits.h>. Use of these macros in user code might normally lead to spurious warnings, however GCC's integrated preprocessor has enough context to avoid warning in these cases. - A function declared external in one block and then used after the end of the block.
- A
switchstatement has an operand of typelong. - A non-
staticfunction declaration follows astaticone. This construct is not accepted by some traditional C compilers. - The ISO type of an integer constant has a different width or signedness from its traditional type. This warning is only issued if the base of the constant is ten. I.e. hexadecimal or octal values, which typically represent bit patterns, are not warned about.
- Usage of ISO string concatenation is detected.
- Initialization of automatic aggregates.
- Identifier conflicts with labels. Traditional C lacks a separate namespace for labels.
- Initialization of unions. If the initializer is zero, the warning is omitted. This is done under the assumption that the zero initializer in user code appears conditioned on e.g.
__STDC__to avoid missing initializer warnings and relies on default initialization to zero in the traditional C case. - Conversions by prototypes between fixed/floating-point values and vice versa. The absence of these prototypes when compiling with traditional C causes serious problems. This is a subset of the possible conversion warnings; for the full set use
-Wtraditional-conversion. - Use of ISO C style function definitions. This warning intentionally is not issued for prototype declarations or variadic functions because these ISO C features appear in your code when using libiberty's traditional C compatibility macros,
PARAMSandVPARAMS. This warning is also bypassed for nested functions because that feature is already a GCC extension and thus not relevant to traditional C compatibility.
-Wtraditional-conversion(C and Objective-C only) โ 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. old-school C said no ๐
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 is shadowed. Note that in C++, the compiler warns if a local variable shadows an explicit typedef, but not if it shadows a struct/class/enum. If this warning is enabled, it includes also all instances of local shadowing โ which means-Wno-shadow=localand-Wno-shadow=compatible-localare ignored when-Wshadowis used. Same as-Wshadow=global. ๐ฆ-Wno-shadow-ivar(Objective-C only) โ bestie, do not warn when a local variable shadows an instance variable inside an Objective-C method. Let it live. ๐-Wshadow=globalโ warn for any shadowing at all, periodt. Same as-Wshadow. ๐-Wshadow=localโ ok so this one warns when a local variable shadows another local variable or parameter. Just the local-on-local drama, nothing else.-Wshadow=compatible-localโ warn when a local variable shadows another local variable or parameter whose type is compatible with that of the shadowing variable. In C++, "type compatible" here literally 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 incompatible type, it's most likely intentional, not a bug or a typo โ like, the way that this example shows:
for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
{
for (int i = 0; i < N; ++i)
{
...
}
...
}
Since the two variable "i" in the example above have incompatible types, enabling only -Wshadow=compatible-local does not emit a warning. Highkey iconic behaviour. 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. Use of this flag instead of -Wshadow=local can possibly reduce the number of warnings triggered by intentional shadowing. ngl there's a catch tho: this also means that shadowing const char *i by char *i does not emit a warning. ๐
This warning is also enabled by -Wshadow=local.
-Wlarger-than=byte-sizeโ warn whenever an object is defined whose size exceeds byte-size.-Wlarger-than=PTRDIFF_MAXis enabled by default. Warnings controlled by the option can be disabled either by specifying byte-size ofSIZE_MAXor more or by-Wno-larger-than. ๐
Also warn for calls to bounded functions such as memchr or strnlen that specify a bound greater than the largest possible object, which is PTRDIFF_MAX bytes by default. These warnings can only be disabled by -Wno-larger-than.
-Wno-larger-thanโ disable-Wlarger-than=warnings. The option is equivalent to-Wlarger-than=SIZE_MAXor larger. ๐ซถ-Wframe-larger-than=byte-sizeโ warn if the size of a function frame exceeds byte-size. Heads up bestie: the computation done to determine the stack frame size is approximate and not conservative. The actual requirements may be somewhat greater than byte-size even if you do not get a warning. Plus, any space allocated viaalloca, variable-length arrays, or related constructs is not included by the compiler when determining whether or not to issue a warning. ๐ญ
-Wframe-larger-than=PTRDIFF_MAX is enabled by default. Warnings controlled by the option can be disabled either by specifying byte-size of SIZE_MAX or more or by -Wno-frame-larger-than.
-Wno-frame-larger-thanโ disable-Wframe-larger-than=warnings. The option is equivalent to-Wframe-larger-than=SIZE_MAXor 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. Like, for example, because the call tostpcpyreturns a pointer to the terminating nul character and not to the beginning of the object, the call tofreebelow is diagnosed. caught in 4k fr fr ๐ธ
void f (char *p)
{
p = stpcpy (p, "abc");
// ...
free (p); // warning
}
-Wfree-nonheap-object is included in -Wall. ๐
-Wstack-usage=byte-sizeโ warn if the stack usage of a function might exceed byte-size. Unlike the frame one, the computation done to determine the stack usage here is conservative. And any space allocated viaalloca, variable-length arrays, or related constructs is included by the compiler when determining whether or not to issue a warning. ๐ธ
The message is in keeping with the output of -fstack-usage:
- If the stack usage is fully static but exceeds the specified amount, it's:
warning: stack usage is 1120 bytes
- If the stack usage is (partly) dynamic but bounded, it's:
warning: stack usage might be 1648 bytes
- If the stack usage is (partly) dynamic and not bounded, it's:
warning: stack usage might be unbounded
-Wstack-usage=PTRDIFF_MAX is enabled by default. Warnings controlled by the option can be disabled either by specifying byte-size of SIZE_MAX or more or by -Wno-stack-usage.
-Wno-stack-usageโ disable-Wstack-usage=warnings. The option is equivalent to-Wstack-usage=SIZE_MAXor larger. ๐-Wunsafe-loop-optimizationsโ warn if the loop cannot be optimized because the compiler cannot assume anything on the bounds of the loop indices. With-funsafe-loop-optimizationswarn if the compiler makes such assumptions. lowkey unhinged but ok ๐-Wno-pedantic-ms-format(MinGW targets only) โ when used in combination with-Wformatand-pedanticwithout GNU extensions, this option disables the warnings about non-ISOprintf/scanfformat width specifiersI32,I64, andIused on Windows targets, which depend on the MS runtime. ๐ช-Wpointer-arithโ warn about anything that depends on the "size of" a function type or ofvoid. GNU C assigns these types a size of 1, for convenience in calculations withvoid *pointers and pointers to functions. In C++, warn also when an arithmetic operation involvesNULL. This warning is also enabled by-Wpedantic. ๐
This warning is upgraded to an error by -pedantic-errors. ๐ค
-Wno-pointer-compareโ do not warn if a pointer is compared with a zero character constant. This usually means that the pointer was meant to be dereferenced, iykyk. For example:
const char *p = foo ();
if (p == '\0')
return 42;
Note that the code above is invalid in C++11. โ ๏ธ
This warning is enabled by default.
-Wno-tsanโ disable warnings about unsupported features in ThreadSanitizer. ๐งต
ThreadSanitizer does not support std::atomic_thread_fence and can report false positives.
-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, callingabs(3.14)triggers the warning because the appropriate function to call to compute the absolute value of a double argument isfabs. 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#ifdirective. Such identifiers are replaced with zero. ๐ณ๏ธ-Wexpansion-to-definedโ warn wheneverdefinedis encountered in the expansion of a macro (including the case where the macro is expanded by an#ifdirective). Such usage is not portable. This warning is also enabled by-Wpedanticand-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#elseor an#endifare 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. bestie that's not the vibe ๐ซ-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 longtype,booltype, 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,_Atomictype qualifier,_Thread_localstorage-class specifier,_Alignasspecifier,Alignofoperator,_Generickeyword, 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) โ okay so this one warns you about stuff that isn't in ISO C11 but is in ISO C23. Like: leaving the string out of_Static_assert, using[[]]attribute syntax, decimal floating-point types, that whole vibe. It's independent of the standards mode you're in, bestie. Also, warnings get switched off inside the expression right after__extension__. Heads up: the name-Wc11-c2x-compatis deprecated.
And when you're not compiling in C23 mode, -pedantic-errors upgrades these warnings to errors. ๐ญ
-Wc23-c2y-compat(C and Objective-C only) โ-Wc23-c2y-compat(C and Objective-C only) โ warns about features that aren't in ISO C23 but are in ISO C2Y. Example:_Genericselecting with a type name instead of an expression. Also independent of standards mode, and warnings are disabled in the expression following__extension__.
Same deal: when not compiling in C2Y mode, -pedantic-errors bumps these to errors.
yes, that option is listed twice in the original. iconic of it honestly. ๐
-Wc++-compat(C and Objective-C only) โ warns about ISO C constructs that fall outside the common subset of ISO C and ISO C++, like asking for an implicit conversion fromvoid *to a pointer to a non-voidtype.-Wc++11-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 1998 and ISO C++ 2011, e.g. identifiers that were fine in ISO C++ 1998 but are keywords in ISO C++ 2011. This one turns on-Wnarrowingand is enabled by-Wall.-Wc++14-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 2011 and ISO C++ 2014. Enabled by-Wall.-Wc++17-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 2014 and ISO C++ 2017. Enabled by-Wall.-Wc++20-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 2017 and ISO C++ 2020. Enabled by-Wall.-Wc++26-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 2023 and the upcoming ISO C++ 2026. Enabled by-Wall.-Wno-c++11-extensions(C++ and Objective-C++ only) โ don't warn about C++11 constructs when you're compiling with an older C++ standard. Real talk though: even without this option, some C++11 constructs only get diagnosed if you use-Wpedantic.-Wno-c++14-extensions(C++ and Objective-C++ only) โ don't warn about C++14 constructs in code compiled with an older C++ standard. Same caveat: some C++14 constructs only get diagnosed with-Wpedantic.-Wno-c++17-extensions(C++ and Objective-C++ only) โ don't warn about C++17 constructs under an older C++ standard. (And yeah โ some of them only show up with-Wpedantic.)-Wno-c++20-extensions(C++ and Objective-C++ only) โ don't warn about C++20 constructs under an older C++ standard. Some C++20 constructs still only get diagnosed with-Wpedantic.-Wno-c++23-extensions(C++ and Objective-C++ only) โ don't warn about C++23 constructs under an older C++ standard. Yep, you guessed it: some only get diagnosed with-Wpedantic.-Wno-c++26-extensions(C++ and Objective-C++ only) โ don't warn about C++26 constructs when compiling with an older C++ standard. And again, some C++26 constructs only get diagnosed if-Wpedanticis in play.
-Wcast-qualโ warns whenever a pointer gets cast in a way that strips a type qualifier off the target type. Example: casting aconst char *to a plain oldchar *.
It also warns when a cast introduces a type qualifier in an unsafe way. Like casting char ** to const char ** โ that's unsafe, bestie, and here's the whole crime scene:
/* 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 such that the required alignment of the target gets increased. For example, warn if achar *is cast to anint *on machines where integers 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 gets cast to an incompatible function pointer. In a cast involving function types with a variable argument list, only the types of the initial arguments that are actually provided get considered. Any parameter of pointer-type matches any other pointer-type. Benign differences in integral types are ignored โ likeintvs.longon ILP32 targets. Type qualifiers are ignored too. The function typevoid (*) (void)is special and matches everything, which you can use to silence this warning. And in a cast involving pointer-to-member types, this warns whenever the 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 have expected to be called. ๐
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 typeconst char[length]so that copying the address of one into a non-constchar *pointer produces a warning. These warnings help you catch, at compile time, code that might try to write into a string constant โ but only if you've been super careful about usingconstin declarations and prototypes. Otherwise it's just a nuisance. That's literally why-Walldoesn't request these warnings.
In C++, it warns about the deprecated conversion from string literals to char *. This warning is enabled by default for C++ programs.
And it gets upgraded to an error by -pedantic-errors in C++11 mode or later. ๐ฅ
-Wclobberedโ warns about variables that might get changed bylongjmporvfork. Also enabled by-Wextra.-Wno-complain-wrong-langโ so by default, language front ends complain when a command-line option is valid but not applicable to that front end. You can turn that off with-Wno-complain-wrong-lang, which is mostly useful when you're invoking a single compiler driver on 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 you can disable with -Wno-complain-wrong-lang.
It can also disable warnings like cc1plus: note: CTF debug info requested, but not supported for 'GNU C++20' frontend โ that one gets produced by -gctf or -gsctf for unsupported languages.
-Wcompare-distinct-pointer-types(C and Objective-C only) โ warns if pointers of distinct types get compared without a cast. Enabled by default. ๐ซถ-Wconversionโ warns about implicit conversions that might alter a value. That includes conversions between real and integer, likeabs (x)whenxisdouble; conversions between signed and unsigned, likeunsigned ui = -1; and conversions to smaller types, likesqrtf (M_PI). It does not warn for explicit casts likeabs ((int) x)andui = (unsigned) -1, or when the value isn't changed by the conversion, like inabs (2.0). Warnings about conversions between signed and unsigned integers can be turned off with-Wno-sign-conversion.
For C++, it also warns about confusing overload resolution for user-defined conversions, and conversions that never use a type conversion operator: conversions to void, to the same type, to a base class, or to a reference to them. In C++, warnings about signed/unsigned conversions are off by default unless you explicitly enable -Wsign-conversion.
Oh and โ warnings about conversion from arithmetic on a small type back to that same type are only given with -Warith-conversion.
-Wdangling-elseโ warns about constructions where it's ambiguous whichifstatement anelsebranch belongs to. Here's the classic:
{
if (a)
if (b)
foo ();
else
bar ();
}
In C/C++, every else branch belongs to the innermost possible if statement โ which in this example is if (b). That is often not what the programmer expected, as the indentation in the example above shows. When that confusion is possible, GCC issues a warning if this flag is specified. To kill the warning, add explicit braces around the innermost if statement so there's no way the else can belong to the enclosing if. Result:
{
if (a)
{
if (b)
foo ();
else
bar ();
}
}
This warning is enabled by -Wparentheses.
-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 it may give different results with optimization than without. ๐-Wdangling-pointer=1โ at level 1, the warning diagnoses only unconditional uses of dangling pointers.
-Wdangling-pointer=2โ bestie, level 2 is level 1 plus it also calls out conditional uses of dangling pointers, not just the unconditional ones ๐
So like, the short form -Wdangling-pointer is literally the same thing as -Wdangling-pointer=2, and -Wno-dangling-pointer and -Wdangling-pointer=0 both do the same "turn it all off" thing. Oh and -Wdangling-pointer=2 is included in -Wall โจ
This next example triggers the warning at level 1 โ the address of the unnamed temporary is unconditionally referenced outside of its scope, which is a big nope:
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;
}
And in this function, storing 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 last one, the array a is out of scope when the pointer s is used ๐ญ and 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โ yells at you when the macros__TIME__,__DATE__or__TIMESTAMP__show up, because they might ruin your bitwise-identical reproducible compilations ๐ฐ๏ธ like, no cap, reproducibility is the vibe.-Wempty-bodyโ warns if there's an empty body in anif,elseordo whilestatement. This one is also enabled by-Wextra๐ซถ-Wno-endif-labelsโ do not warn about stray tokens after#elseand#endif. simple as that ๐-Wenum-compareโ warns about comparisons between values of different enumerated types. In C++ enumerated type mismatches in conditional expressions get diagnosed too, and the warning is on by default. In C, this warning is enabled by-Wallโจ-Wenum-conversionโ warns when a value of enumerated type is implicitly converted to a different enumerated type. In C this one is enabled by-Wextra๐-Wenum-int-mismatch(C and Objective-C only) โ warns 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. But since the choice of the underlying type of an enumerated type is implementation-defined, these mismatches may cause portability issues ๐ฌ In C++ such mismatches are literally an error. In C, this warning is enabled by -Wall and -Wc++-compat ๐
-Wjump-misses-init(C, Objective-C only) โ warns if agotostatement or aswitchstatement jumps forward across the initialization of a variable, or jumps backward to a label after the variable has been initialized. It only warns about variables that are initialized when they're declared, iykyk. 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โ warns 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's also enabled by-Wextra.-Wsign-conversionโ warns 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, slay ๐ In C, this option is enabled also by-Wconversion.-Wflex-array-member-not-at-end(C and C++ only) โ warns 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โ warns 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โ warns about divisions of twosizeofoperators 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 probably 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โ warns for suspicious divisions of twosizeofexpressions 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. aboutsizeof (ptr) / sizeof (ptr[0])ifptris not an array, but a pointer. This warning is enabled by-Wall.-Wsizeof-pointer-memaccessโ warns for suspicious length parameters to certain string and memory built-in functions if the argument usessizeof. It triggers for example formemset (ptr, 0, sizeof (ptr));ifptris not an array, but a pointer, and suggests a possible fix ๐ก Or aboutmemcpy (&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 thesizeofoperator 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โ warns for suspicious calls to thememsetbuilt-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โ warns for suspicious calls to thememsetbuilt-in function where the second argument is not zero and the third argument is zero. For example, the callmemset (buf, sizeof buf, 0)is diagnosed becausememset (buf, 0, sizeof buf)was meant instead ๐คฆโโ๏ธ The diagnostic is only emitted if the third argument is a literal zero. Otherwise, if it's an expression that is folded to zero, or a cast of zero to some type, it's far less likely that the arguments have been mistakenly transposed, and no warning is emitted. This warning is enabled by-Wall.-Waddressโ warns about suspicious uses of address expressions ๐ These include comparing the address of a function or a declared object to the null pointer constant, 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. The -Waddress warning is enabled by -Wall ๐ฅ
-Wno-address-of-packed-memberโ do not warn when the address of a packed member of a struct or union is taken, which usually results in an unaligned pointer value ๐ This is enabled by default.-Wlogical-opโ warns about suspicious uses of logical operators in expressions. This includes using logical operators in contexts where a bitwise operator is likely to be expected ๐ค It also warns when the operands of a logical operator are the same:
extern int a;
if (a < 0 && a < 0) { ... }
-Wlogical-not-parenthesesโ warns 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) { ... }
It's genuinely possible to shush that warning by wrapping the LHS in parentheses:
if ((!a) > 1) { ... }
This warning is enabled by -Wall.
-Waggregate-returnโ warns you if any function that returns a structure or union gets defined or called. (And in languages where returning an array is a thing, that also sets it off. ๐ )-Wno-aggressive-loop-optimizationsโ turns off the warning you'd get when the compiler spots undefined behavior in a loop with a constant number of iterations. Like, the compiler is being a lil detective ๐ and you're telling it to chill.-Waggressive-loop-optimizationsis enabled by default.-Wno-attributesโ silences the warning for an unexpected"__attribute__"โ think unrecognized attributes, function attributes slapped onto variables, that whole situation. Heads up though: this does not stop errors for incorrect use of supported attributes. ๐ซถ
Warnings about ill-formed uses of standard attributes get upgraded to errors by -pedantic-errors.
Also! With -Wno-attributes=, you can suppress warnings about unknown scoped attributes (C++11 and C23). For example, -Wno-attributes=vendor::attr disables the warning about this declaration:
[[vendor::attr]] void f();
And you can kill warnings for all attributes in a namespace with -Wno-attributes=vendor::, which stops the warning for both of these:
[[vendor::safe]] void f();
[[vendor::unsafe]] void f2();
Real talk:-Wno-attributes=does not imply-Wno-attributes. They're different things bestie, don't mix them up. ๐
-Wno-builtin-declaration-mismatchโ warns if a built-in function is declared with an incompatible signature or as a non-function, or when a built-in function declared with a type that doesn't include a prototype is called with arguments whose promoted types don't match what the function expects. And when-Wextrais specified, it also warns when a built-in function that takes arguments is declared without a prototype. The-Wbuiltin-declaration-mismatchwarning is on by default. To dodge the warning, include the appropriate header so the prototypes of built-in functions are in scope. ๐
Example time โ the call to "memset" below gets diagnosed by the warning because the function expects a value of type "size_t" as its argument, but the type of 32 is "int". With -Wextra, the declaration of the function gets diagnosed too:
extern void* memset ();
void f (void *d)
{
memset (d, '\0', 32);
}
-Wno-builtin-macro-redefinedโ no warning if 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 or standard attribute identifiers get diagnosed as well. This warning is enabled by default for C++26 if"-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 if it shows up at the end of a compound statement. C23 and later dialects of C allow those labels, and they're available as a GCC extension in all the other dialects. ๐ฆ
This warning is also enabled by -Wc11-c23-compat. And it gets turned into an error if you're building for a C version before C23 with -pedantic-errors.
-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 multiple inclusion guard, and 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 often just a misspelled guard name โ either in the"#ifndef"/"#if !defined"directive or in the subsequent"#define"directive. ๐ญ 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 totally fine, no warning, if it's preceded by a declaration that specifies the argument types. ๐ซถ)-Wold-style-declaration(C and Objective-C only) โ warns about obsolescent usages in a declaration, per the C Standard. For example, it warns if storage-class specifiers like"static"aren't the first things in a declaration. This warning is 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 an old-style definition in C23 mode, because it's equivalent to(void)in that case โ but it is considered an old-style definition for older standards. ๐-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. This warning is also enabled by-Wextra. ๐ธ-Wdeprecated-non-prototype(C and Objective-C only) โ warns if a function declared with an empty parameter list()is called with one or more arguments, or if a function definition with one or more parameters is encountered after such a declaration. Both of these 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, specifying only its type. You can use this to document that a parameter is 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 declared without a 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) โ no warning if a function declaration contains a parameter name without a type. Those declarations don't provide a function prototype, and they block most type checking in function calls. ๐
This warning is enabled by default. In C99 and later dialects of C, it's treated as an error. The error can be downgraded to a warning with -fpermissive (along with certain other errors), or for this error alone with -Wno-error=declaration-missing-parameter-type.
This warning is upgraded to an error by -pedantic-errors. ๐ฅ
-Wmissing-prototypes(C and Objective-C only) โ warns if a global function is defined without a previous prototype declaration. Warning shows up even if the definition itself provides a prototype. Use this to detect global functions that don't have a matching prototype declaration in a header file. This option isn't valid for C++ because all function declarations provide prototypes, and a non-matching declaration declares an overload rather than conflicting with an earlier declaration. For C++, use-Wmissing-declarationsto detect missing declarations. ๐-Wmissing-variable-declarations(C and Objective-C only) โ warns if a global variable is defined without a previous declaration. Use this to detect 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, and does so even if the definition itself provides a prototype. Use this to detect global functions that aren't declared in header files. In C, no warnings for functions with previous non-prototype declarations โ use-Wmissing-prototypesto detect missing prototypes. In C++, no warnings for function templates, inline functions, or functions in anonymous namespaces. ๐-Wmissing-field-initializersโ warns if a structure's initializer has some fields missing. 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 does not warn about designated initializers, so this modification doesn't trigger it:
struct s { int f, g, h; };
struct s x = { .f = 3, .g = 4 };
In C this option also doesn't warn about the universal zero initializer { 0 }:
struct s { int f, g, h; };
struct s x = { 0 };
Same energy in C++ โ this option doesn't warn about the empty { } initializer, e.g.:
struct s { int f, g, h; };
s x = { };
This warning is included in -Wextra. Wanna get 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.
This warning can be disabled with -Wno-missing-requires. ๐
-Wno-missing-template-keywordโ the member access tokens.,->and::must be followed by the"template"keyword if the parent object is dependent and the member being named is a template. Like so:
template <class X>
void DoStuff (X x)
{
x.template DoSomeOtherStuff<X>(); // Good.
x.DoMoreStuff<X>(); // Warning, x is dependent.
}
In rare cases it's possible to 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 a multicharacter constant like'FOOF'shows up. Likeโฆ usually these are lowkey a typo in the user's code ๐ because they have implementation-defined values and honestly should not be used in portable code, periodt.-Wnormalized=[none|id|nfc|nfkc]โ okay so this is the whole "do these two identifiers actually look the same" situation. 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 get two different character sequences that look identical ๐. To avoid confusion, the ISO 10646 standard sets out some normalization rules which, when applied, ensure that two sequences that look the same get turned 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. It's equivalent to -Wnormalized.
Unfortunately ๐ญ there are some characters allowed in identifiers by ISO C and ISO C++ that, when turned into NFC, are not allowed in identifiers. That is, there's no way to use these symbols in portable ISO C or C++ and have all your identifiers in NFC. -Wnormalized=id suppresses the warning for these characters. It is hoped that future versions of the standards involved will correct this, which is why this option is not the default.
You can switch the warning off for all characters by writing -Wnormalized=none or -Wno-normalized. You should 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 as well, and GCC warns if your code is not in NFKC if 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, and 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. iykyk ๐
-Wno-attribute-warningโ don't warn about usage of functions declared with the"warning"attribute. By default, this warning is enabled. You can use-Wno-attribute-warningto disable the warning, or-Wno-error=attribute-warningto disable the error when compiled with the-Werrorflag. pick your fighter ๐ซถ-Wno-deprecatedโ don't 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. that's a whole list, we love an overachiever โจ
-Wno-deprecated-declarationsโ don't warn about uses of functions, variables, or types marked as deprecated by using the"deprecated"attribute.-Wno-deprecated-openmpโ don't warn about deprecated OpenMP code.-Wno-overflowโ don't warn about compile-time overflow in constant expressions.-Wno-odrโ warn about One Definition Rule violations during link-time optimization. Enabled by default. (yes the name is confusing, no we don't make the rules ๐คทโโ๏ธ)-Wopenacc-parallelismโ warn about potentially suboptimal choices related to OpenACC parallelism. not me judging your parallelism choices ๐-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=unlimitedoption can be used to relax the cost model. slay, tune that 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) โ don't 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 variablef.xinstruct baris misaligned even thoughstruct bardoes not 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โ bestie, storytime ๐: 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 fieldaandbin 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 onstruct 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. glow-up your structs fr ๐-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. like bestie we GET it, you already said that ๐-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 intoa[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's included in -Wall.
-Wnested-externs(C and Objective-C only) โ warn if an"extern"declaration is encountered within a function. like why is extern in here, it's giving lost ๐ง-Winlineโ warn if a function that's declared as inline cannot be inlined. Even with this option, the compiler does not warn about failures to inline functions declared in system headers.
The compiler uses a variety of heuristics to determine whether or not to inline a function. For example, the compiler takes into account the size of the function being inlined and the amount of inlining that has already been done in the current function. Therefore, seemingly insignificant changes in the source program can cause the warnings produced by -Winline to appear or disappear. chaotic behavior ngl ๐
-Winterference-size,-Wno-interference-sizeโ warn about questionable uses of the C++17"constexpr"variablesstd::hardware_destructive_interference_sizeandstd::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). ๐ consistency is key
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. ๐ important!!
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, like conditional expressions (?:) using non-boolean integer constants in boolean context, likeif (a <= b ? 2 : 3). Or left shifting of signed integers in boolean context, likefor (a = 0; 1 << a; a++);. Likewise for all kinds of multiplications regardless of the data type. This warning is enabled by-Wall. sir that is not a boolean ๐ญ-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-castis enabled by default.-Wno-pointer-to-int-cast(C and Objective-C only) โ bestie, this one shuts up the warning you get when you cast a pointer to an integer type of a different size ๐ซถ like it's not judging you, it's just not gonna nag.-Winvalid-pchโ warns you when there's a precompiled header sitting in the search path that it straight up cannot use ๐ญ imagine finding a snack in your bag and it's expired. tragic. this tells you.-Winvalid-utf8โ yells if it finds an invalid UTF-8 character. this one's lowkey on by default for C++23 if you're using-finput-charset=UTF-8, and gets upgraded to an actual error by-pedantic-errors๐ so like, it stops being a vibe check and becomes a whole thing.-Wno-unicodeโ don't diagnose invalid forms of delimited or named escape sequences that get treated as separate tokens.Wunicodeis enabled by default โจ so this is the "actually, leave me alone about it" switch.-Wlong-longโ warns if thelong longtype shows up. it's enabled by either-Wpedanticor-Wtraditionalin ISO C90 and C++98 modes. to inhibit the warning messages, use-Wno-long-long๐
heads up: this warning gets upgraded to an error by -pedantic-errors. so dramatic.
-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-Wpedanticor-Wtraditional. to inhibit the warning messages, use-Wno-variadic-macros๐-Wno-varargsโ do not warn upon questionable usage of the macros used to handle variable arguments likeva_start. these warnings are enabled by default, so this is you telling it "i know what i'm doing" (iconic, possibly delusional, but iconic).-Wvector-operation-performanceโ warns if a vector operation is not implemented via the SIMD capabilities of the architecture. mainly useful for performance tuning ๐ฅ vector operation can be implemented:piecewiseโ the scalar operation is performed on every vector elementin parallelโ the vector operation is implemented using scalars of wider type, which normally is more performance efficientas a single scalarโ the vector fits into a scalar type
-Wvlaโ warns if a variable-length array is used in the code.-Wno-vlaprevents the-Wpedanticwarning of the variable-length array ๐ฆ
yup, upgraded to an error by -pedantic-errors. it's giving consequences.
-Wvla-larger-than=byte-size โ if you use this option, the compiler warns for declarations of variable-length arrays whose size is either unbounded, or bounded by an argument that allows the array size to exceed byte-size bytes. it's similar to how-Walloca-larger-than=byte-size works, but with variable-length arrays ๐
ngl, GCC may optimize small variable-length arrays of a known value into plain arrays, so this warning may not get triggered for such arrays.
-Wvla-larger-than=PTRDIFF_MAX is enabled by default but is typically only effective when -ftree-vrp is active (default for -O2 and above).
see also -Walloca-larger-than=byte-size โจ
-Wno-vla-larger-thanโ disables-Wvla-larger-than=warnings. it's equivalent to-Wvla-larger-than=SIZE_MAXor larger ๐-Wvla-parameterโ warns about redeclarations of functions involving arguments of Variable Length Array types of inconsistent kinds or forms, and enables the detection of out-of-bounds accesses to such parameters by warnings such as-Warray-bounds๐
if the first function declaration uses the VLA form, the bound specified in the array is assumed to be the minimum number of elements expected to be provided in calls to the function and the maximum number of elements accessed by it. failing to provide arguments of sufficient size or accessing more than the maximum number of elements may be diagnosed ๐ญ
for example, the warning triggers for the following redeclarations because the first one allows an array of any size to be passed to f while the second one specifies that the array argument must have at least n elements. in addition, calling f with the associated VLA bound parameter in excess of the actual VLA bound triggers a warning as well ๐
void f (int n, int[n]);
// warning: argument 2 previously declared as a VLA
void f (int, int[]);
void g (int n)
{
if (n > 4)
return;
int a[n];
// warning: access to a by f may be out of bounds
f (sizeof a, a);
...
}
-Wvla-parameter is included in -Wall. the -Warray-parameter option triggers warnings for similar problems involving ordinary array arguments ๐
-Wvolatile-register-varโ warns if a register variable is declared volatile. the volatile modifier does not inhibit all optimizations that may eliminate reads and/or writes to register variables ๐จ this warning is enabled by-Wall.-Wno-xor-used-as-pow(C, C++, Objective-C and Objective-C++ only) โ disables warnings about uses of^, the exclusive or operator, where it appears the code meant exponentiation. specifically, the warning occurs when the left-hand side is the decimal constant2or10and 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. so yeah, easy mix-up, no shame.
this warning can be silenced by converting one of the operands to hexadecimal as well as by compiling with -Wno-xor-used-as-pow ๐
-Wdisabled-optimizationโ warns if a requested optimization pass is disabled. this warning does not generally indicate that there is anything wrong with your code ๐ซถ it merely indicates that GCC's optimizers are unable to handle the code effectively. often the problem is that your code is too big or too complex; GCC refuses to optimize programs when the optimization itself is likely to take inordinate amounts of time ๐ฎโ๐จ-Wpointer-sign(C and Objective-C only) โ warns for pointer argument passing or assignment with different signedness. this option is only supported for C and Objective-C. it's implied by-Walland by-Wpedantic, which can be disabled with-Wno-pointer-sign๐ธ
upgraded to an error by -pedantic-errors, bestie. watch out.
-Wstack-protectorโ this option is only active when-fstack-protectoris active ๐ก๏ธ it warns about functions that are not protected against stack smashing. not me being the one function without a shieldโฆ-Woverlength-stringsโ warns about string constants that are longer than the "minimum maximum" length specified in the C standard ๐ modern compilers generally allow string constants that are much longer than the standard's minimum limit, but very portable programs should avoid using longer strings โจ
the limit applies after string constant concatenation, and does not count the trailing NUL. in C90, the limit was 509 characters; in C99, it was raised to 4095. C++98 does not specify a normative minimum maximum, so we do not diagnose overlength strings in C++ ๐
this option is implied by -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 does not have a suffix. when used together with-Wsystem-headersit warns about such constants in system header files ๐ this can be useful when preparing code to use with theFLOAT_CONST_DECIMAL64pragma from the decimal floating-point extension to C99.-Wno-lto-type-mismatchโ during the link-time optimization, do not warn about type mismatches in global declarations from different compilation units. requires-fltoto 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 thedesignated_initattribute ๐
๐ต๏ธ Options That Control Static Analysis ๐ต๏ธ
-fanalyzerโ okay this one is a whole main character โจ it enables a static analysis of program flow which looks for "interesting" interprocedural paths through the code, and issues warnings for problems found on them ๐
real talk: this analysis is much more expensive than other GCC warnings. like, highkey expensive.
in technical terms, it performs coverage-guided symbolic execution of the code being compiled. it is neither sound nor complete โ so yes it can have false positives and false negatives ๐ it's a bug-finding tool, rather than a tool for proving program correctness. very much "i have a hunch" energy, not "i have a proof" energy.
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
important: this option is only available if GCC was configured with analyzer support enabled ๐
-Wanalyzer-symbol-too-complexโ if-fanalyzeris enabled, the analyzer uses various heuristics to attempt to track the state of memory, but these can be defeated by sufficiently complicated code ๐ญ
By default, the analysis silently stops tracking values of expressions if they exceed an internal limit, and falls back to an imprecise representation for such expressions. The -Wanalyzer-symbol-too-complex option warns if this occurs.
-Wanalyzer-too-complexโ okay so if-fanalyzeris on, the analyzer pulls out various heuristics to try to explore the control flow and data flow in the program, but bestie, sufficiently complicated code can just defeat those heuristics, no cap.
By default the analysis silently stops if the code is too complicated for the analyzer to fully explore and it reaches an internal limit. The -Wanalyzer-too-complex option warns if this occurs. ๐
-Wno-analyzer-allocation-sizeโ this warning requires-fanalyzer, which enables it; to disable it, use-Wno-analyzer-allocation-size.
This diagnostic warns for paths through the code in which a pointer to a buffer is assigned to point at a buffer with a size that is not a multiple of sizeof (*pointer). It's giving wrong-math energy fr.
See CWE-131: Incorrect Calculation of Buffer Size (https://cwe.mitre.org/data/definitions/131.html).
-Wno-analyzer-deref-before-checkโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-deref-before-checkto disable it.
This diagnostic warns for paths through the code in which a pointer is checked for NULL after it has already been dereferenced, suggesting that the pointer could have been NULL. Such cases suggest that the check for NULL is either redundant, or that it needs to be moved to before the pointer is dereferenced. Like bestie, the order of operations is not optional here ๐ญ
This diagnostic also considers values passed to a function argument marked with __attribute__((nonnull)) as requiring a non-NULL value, and thus will complain if such values are checked for NULL after returning from such a function call.
This diagnostic is unlikely to be reported when any level of optimization is enabled, as GCC's optimization logic will typically consider such checks for NULL as being redundant, and optimize them away before the analyzer "sees" them. Hence optimization should be disabled when attempting to trigger this diagnostic. ๐
-Wno-analyzer-double-fcloseโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-double-fcloseto disable it.
This diagnostic warns for paths through the code in which a FILE * can have fclose called on it more than once. Closing it twice? Not the slay you think it is ๐
See CWE-1341: Multiple Releases of Same Resource or Handle (https://cwe.mitre.org/data/definitions/1341.html).
-Wno-analyzer-double-freeโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-double-freeto disable it.
This diagnostic warns for paths through the code in which a pointer can have a deallocator called on it more than once, either free, or a deallocator referenced by attribute malloc. Double-free is not main character energy, it's iconic in the bad way ๐
See CWE-415: Double Free (https://cwe.mitre.org/data/definitions/415.html).
-Wno-analyzer-exposure-through-output-fileโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-exposure-through-output-fileto disable it.
This diagnostic warns for paths through the code in which a security-sensitive value is written to an output file (such as writing a password to a log file). Bestie. Bestie. Not the password in the log file ๐ฅ
See CWE-532: Information Exposure Through Log Files (https://cwe.mitre.org/data/definitions/532.html).
-Wanalyzer-exposure-through-uninit-copyโ this warning requires both-fanalyzerand the use of a plugin to specify a function that copies across a "trust boundary". Use-Wno-analyzer-exposure-through-uninit-copyto disable it.
This diagnostic warns for "infoleaks" โ paths through the code in which uninitialized values are copied across a security boundary (such as code within an OS kernel that copies a partially-initialized struct on the stack to user space). Uninit data crossing a trust boundary is giving leak era and we are not here for it ๐
See CWE-200: Exposure of Sensitive Information to an Unauthorized Actor (https://cwe.mitre.org/data/definitions/200.html).
-Wno-analyzer-fd-access-mode-mismatchโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-access-mode-mismatchto disable it.
This diagnostic warns for paths through code in which a read on a write-only file descriptor is attempted, or vice versa. Reading a write-only fd? The audacity ๐ญ
This diagnostic also warns for code paths in a which a function with attribute fd_arg_read (N) is called with a file descriptor opened with O_WRONLY at referenced argument N or a function with attribute fd_arg_write (N) is called with a file descriptor opened with O_RDONLY at referenced argument N.
-Wno-analyzer-fd-double-closeโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-double-closeto disable it.
This diagnostic warns for paths through code in which a file descriptor can be closed more than once. Once is plenty, queen ๐
See CWE-1341: Multiple Releases of Same Resource or Handle (https://cwe.mitre.org/data/definitions/1341.html).
-Wno-analyzer-fd-leakโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-leakto disable it.
This diagnostic warns for paths through code in which an open file descriptor is leaked. Hold onto your friends, not your fds ๐ซถ
See CWE-775: Missing Release of File Descriptor or Handle after Effective Lifetime (https://cwe.mitre.org/data/definitions/775.html).
-Wno-analyzer-fd-phase-mismatchโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-phase-mismatchto disable it.
This diagnostic warns for paths through code in which an operation is attempted in the wrong phase of a file descriptor's lifetime. For example, it will warn on attempts to call accept on a stream socket that has not yet had listen successfully called on it. Skipping a step? In this economy? โจ
See CWE-666: Operation on Resource in Wrong Phase of Lifetime (https://cwe.mitre.org/data/definitions/666.html).
-Wno-analyzer-fd-type-mismatchโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-type-mismatchto disable it.
This diagnostic warns for paths through code in which an operation is attempted on the wrong type of file descriptor. For example, it will warn on attempts to use socket operations on a file descriptor obtained via open, or when attempting to use a stream socket operation on a datagram socket. Wrong vibe, wrong fd, wrong everything ๐ธ
-Wno-analyzer-fd-use-after-closeโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-use-after-closeto disable it.
This diagnostic warns for paths through code in which a read or write is called on a closed file descriptor. It's closed, bestie, let it go ๐ญ
This diagnostic also warns for paths through code in which 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โ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-use-without-checkto disable it.
This diagnostic warns for paths through code in which a file descriptor is used without being checked for validity. Do your vibe check first, fr fr ๐
This diagnostic also warns for paths through code in which 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โ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-file-leakto disable it.
This diagnostic warns for paths through the code in which a <stdio.h> FILE * stream object is leaked.
See CWE-775: Missing Release of File Descriptor or Handle after Effective Lifetime (https://cwe.mitre.org/data/definitions/775.html).
-Wno-analyzer-free-of-non-heapโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-free-of-non-heapto disable it.
This diagnostic warns for paths through the code in which free is called on a non-heap pointer (e.g. an on-stack buffer, or a global). You cannot free the stack, that's literally not its era ๐
See CWE-590: Free of Memory not on the Heap (https://cwe.mitre.org/data/definitions/590.html).
-Wno-analyzer-imprecise-fp-arithmeticโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-imprecise-fp-arithmeticto disable it.
This diagnostic warns for paths through the code in which floating-point arithmetic is used in locations where precise computation is needed. Floating point where you need exact math is giving chaos ๐ This diagnostic only warns on use of floating-point operands inside the calculation of an allocation size at the moment.
-Wno-analyzer-infinite-loopโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-infinite-loopto disable it.
This diagnostics warns for paths through the code which appear to lead to an infinite loop. We love a loop, we do not love a loop that never ends ๐
Specifically, the analyzer will issue this warning when it "sees" a loop in which:
- no externally-visible work could be being done within the loop
- there is no way to escape from the loop
- the analyzer is sufficiently confident about the program state throughout the loop to know that the above are true
One way for this warning to be emitted is when there is an execution path through a loop for which taking the path on one iteration implies that the same path will be taken on all subsequent iterations.
For example, consider:
while (1)
{
char opcode = *cpu_state.pc;
switch (opcode)
{
case OPCODE_FOO:
handle_opcode_foo (&cpu_state);
break;
case OPCODE_BAR:
handle_opcode_bar (&cpu_state);
break;
}
}
The analyzer will complain for the above case because if opcode ever matches none of the cases, the switch will follow the implicit default case, making the body of the loop be a "no-op" with cpu_state.pc unchanged, and thus using the same value of opcode on all subseqent iterations, leading to an infinite loop. It literally just keeps going forever, no notes ๐
See CWE-835: Loop with Unreachable Exit Condition ('Infinite Loop') (https://cwe.mitre.org/data/definitions/835.html).
-Wno-analyzer-infinite-recursionโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-infinite-recursionto disable it.- this diagnostic is out here warning u about paths through the code that look like they lead to infinite recursion ๐๐ต
ok so like, specifically: when the analyzer "sees" a recursive call, it compares the state of memory at the entry to the new frame with the state at the entry to the previous frame of that function on the stack. warning gets issued if nothing in memory appears to be changing โ any changes observed to parameters or globals are assumed to lead to termination of the recursion, and thus suppress the warning. so basically if u're actually mutating stuff, it chills out ๐งโโ๏ธ
heads up bestie: this diagnostic is likely to miss cases of infinite recursion that are converted to iteration by the optimizer before the analyzer "sees" them. hence optimization should be disabled when attempting to trigger this diagnostic ๐
compare with -Winfinite-recursion, which provides a similar diagnostic but is implemented in a different way (sisters, not twins โจ).
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-nullto disable it.
this diagnostic warns for paths through the code in which a "NULL" function pointer is called ๐ซ like, u called nothing, babe. that's not a function.
-Wno-analyzer-malloc-leakโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-malloc-leakto disable it.
this diagnostic warns for paths through the code in which a pointer allocated via an allocator is leaked: either "malloc", or a function marked with attribute "malloc" ๐๏ธโจ memory said "i'll be back" and then never came back.
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-deallocationto disable it.
this diagnostic warns for paths through the code in which the wrong deallocation function is called on a pointer value, based on which function was used to allocate that pointer value. so ur code is out here buying shoes from one store and trying to return them to another ๐ฅฟโก๏ธ๐ the diagnostic will warn about mismatches between "free", scalar "delete" and vector "delete[]", and those marked as allocator/deallocator pairs using attribute "malloc".
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-boundsto disable it.
this diagnostic warns for paths through the code in which a buffer is definitely read or written out-of-bounds ๐ง๐ญ the diagnostic applies for cases where the analyzer is able to determine a constant offset, and for accesses past the end of a buffer (also a constant capacity). further, the diagnostic does limited checking for accesses past the end when the offset as well as the capacity is symbolic.
see CWE-119: Improper Restriction of Operations within the Bounds of a Memory Buffer (https://cwe.mitre.org/data/definitions/119.html).
and for cases where the analyzer is able, it will emit a text art diagram visualizing the spatial relationship between the memory region that the analyzer predicts would be accessed, versus the range of memory that is valid to access ๐๐ผ๏ธ so like: whether they overlap, are touching, are close or far apart; which one is before or after in memory, the relative sizes involved, the direction of the access (read vs write), and, in some cases, the values of data involved. iconic honestly. 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-buffersto disable it.
this diagnostic warns for paths through the code in which overlapping buffers are passed to an API for which the behavior on such buffers is undefined ๐ฌ
specifically, the diagnostic occurs on calls to the following functions
"memcpy""strcat""strcpy"
for cases where the buffers are known to overlap. two buffers walked into the same room and the vibes were undefined ๐
-Wno-analyzer-possible-null-argumentโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-possible-null-argumentto disable it.
this diagnostic warns for paths through the code in which a possibly-NULL value is passed to a function argument marked with "__attribute__((nonnull))" as requiring a non-NULL value ๐ "this seat is taken" and u sat down anyway.
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-dereferenceto disable it.
this diagnostic warns for paths through the code in which a possibly-NULL value is 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-argumentto disable it.
this diagnostic warns for paths through the code in which a value known to be NULL is passed to a function argument marked with "__attribute__((nonnull))" as requiring a non-NULL value ๐ญ no guessing here, the analyzer knows.
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-dereferenceto disable it.
this diagnostic warns for paths through the code in which a value known to be NULL is dereferenced ๐
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-varto disable it.
this diagnostic warns for paths through the code in which a call to "putenv" is passed a pointer to an automatic variable or an on-stack buffer ๐ฅด bestie that stack frame is leaving, it cannot be holding ur env var, it's giving "texting someone who already changed their number".
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-negativeto disable it.
this diagnostic warns for paths through the code in which a shift is attempted with a negative count ๐ตโ๐ซ shifting by negative amounts is not a vibe. it is analogous to the -Wshift-count-negative diagnostic implemented in the C/C++ front ends, but is implemented based on analyzing interprocedural paths, rather than merely parsing the syntax tree. however, the analyzer does not prioritize detection of such paths, so false negatives are more likely relative to other warnings ๐ so like... don't rely on it catching everything, mmkay?
-Wno-analyzer-shift-count-overflowโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-shift-count-overflowto disable it.
this diagnostic warns for paths through the code in which a shift is attempted with a count greater than or equal to the precision of the operand's type ๐ it is analogous to the -Wshift-count-overflow diagnostic implemented in the C/C++ front ends, but is implemented based on analyzing interprocedural paths, rather than merely parsing the syntax tree. however (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-bufferto disable it.
this diagnostic warns for paths through the code in which "longjmp" is called to rewind to a "jmp_buf" relating to a "setjmp" call in a function that has returned ๐ฐ๏ธ๐ like rewinding to a location that literally does not exist anymore.
when "setjmp" is called on a "jmp_buf" to record a rewind location, it records the stack frame. the stack frame becomes invalid when the function containing the "setjmp" call returns. attempting to rewind to it via "longjmp" would reference a stack frame that no longer exists, and likely lead to a crash (or worse) ๐ฑ yeah. or worse. that's the whole warning.
-Wno-analyzer-tainted-allocation-sizeโ this warning requires-fanalyzerwhich enables it; use-Wno-analyzer-tainted-allocation-sizeto disable it.
this diagnostic warns for paths through the code in which a value that could be under an attacker's control is used as the size of an allocation without being sanitized ๐ฏ so that an attacker could inject an excessively large allocation and potentially cause a denial of service attack. not the kind of "big energy" we want, ngl.
see CWE-789: Memory Allocation with Excessive Size Value (https://cwe.mitre.org/data/definitions/789.html).
-Wno-analyzer-tainted-assertionโ this warning requires-fanalyzerwhich enables it; use-Wno-analyzer-tainted-assertionto disable it.
this diagnostic warns for paths through the code in which a value that could be under an attacker's control is used as part of a condition without being first sanitized, and that condition guards a call to a function marked with attribute "noreturn" (such as the function "__builtin_unreachable") ๐จ such functions typically indicate abnormal termination of the program, such as for assertion failure handlers. 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 ๐ important bestie!!
for the purpose of this warning, any function marked with 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 โ ๏ธ (same energy as before, the optimizer keeps eating the evidence)
see CWE-617: Reachable Assertion (https://cwe.mitre.org/data/definitions/617.html).
the warning can also report problematic constructions such as
switch (some_tainted_value) {
case 0:
/* [...etc; various valid cases omitted...] */
break;
default:
__builtin_unreachable (); /* BUG: attacker can trigger this */
}
...even though, ngl, strictly speaking that's not an assertion failure. ๐
-Wno-analyzer-tainted-array-indexโ okay so this one needs-fanalyzerto even exist (that's what turns it on), and you use-Wno-analyzer-tainted-array-indexto turn it off ๐ . What it flags: any path through the code where a value that could be under an attacker's control gets used as an array index without being sanitized first โ which means an attacker could inject an out-of-bounds access. Iconic of them, honestly. See CWE-129: Improper Validation of Array Index (https://cwe.mitre.org/data/definitions/129.html).-Wno-analyzer-tainted-divisorโ requires-fanalyzer(that's the enabler bestie);-Wno-analyzer-tainted-divisordisables it. It warns on paths where a possibly-attacker-controlled value 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โ requires-fanalyzer, which enables it;-Wno-analyzer-tainted-offsetturns it off. Warns for paths 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โ requires-fanalyzer, which enables it;-Wno-analyzer-tainted-sizedisables it. Warns for paths where a value that could be under an attacker's control is used as the size of an operation such asmemsetwithout 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โ requires-fanalyzerwhich enables it;-Wno-analyzer-throw-of-unexpected-typedisables it. Quick lore drop: dynamic exception specifications are only available in C++14 and earlier ๐. This diagnostic warns for paths through the code in which a an exception is thrown from a function with a dynamic exception specification where the exception does not comply with the specification.-Wno-analyzer-undefined-behavior-ptrdiffโ requires-fanalyzer, which enables it;-Wno-analyzer-undefined-behavior-ptrdiffdisables it. Warns for paths in which a pointer subtraction happens where the pointers refer to different chunks of memory. That code is literally relying on undefined behavior, bestie โ 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โ requires-fanalyzer, which enables it;-Wno-analyzer-undefined-behavior-strtokdisables it. Warns for paths in which a call is made tostrtokwith undefined behavior. Specifically (and this is the part people always miss ๐ญ): passingNULLas the first parameter for the initial call tostrtokwithin a process has undefined behavior.-Wno-analyzer-unsafe-call-within-signal-handlerโ requires-fanalyzer, which enables it;-Wno-analyzer-unsafe-call-within-signal-handlerdisables it. Warns for paths in which a function known to be async-signal-unsafe (such asfprintf) is called from a signal handler. No cap, do not do this. See CWE-479: Signal Handler Use of a Non-reentrant Function (https://cwe.mitre.org/data/definitions/479.html).-Wno-analyzer-use-after-freeโ requires-fanalyzer, which enables it;-Wno-analyzer-use-after-freedisables it. Warns for paths in which a pointer is used after a deallocator is called on it: eitherfree, or a deallocator referenced by attributemalloc. ๐ See CWE-416: Use After Free (https://cwe.mitre.org/data/definitions/416.html).-Wno-analyzer-use-of-pointer-in-stale-stack-frameโ requires-fanalyzer, which enables it;-Wno-analyzer-use-of-pointer-in-stale-stack-framedisables it. Warns for paths in which a pointer is dereferenced that points to a variable in a stale stack frame. ๐ซ-Wno-analyzer-va-arg-type-mismatchโ requires-fanalyzer, which enables it;-Wno-analyzer-va-arg-type-mismatchdisables it. Warns for interprocedural paths through the code where the analyzer catches an attempt to useva_argto extract a value passed to a variadic call, but with a type that does not 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โ requires-fanalyzer, which enables it;-Wno-analyzer-va-list-exhausteddisables it. Warns for interprocedural paths where the analyzer catches an attempt to useva_argto access the next value passed to a variadic call, but all of the values in theva_listhave already been consumed. empty. gone. nothing left ๐ See CWE-685: Function Call With Incorrect Number of Arguments (https://cwe.mitre.org/data/definitions/685.html).-Wno-analyzer-va-list-leakโ requires-fanalyzer, which enables it;-Wno-analyzer-va-list-leakdisables it. Warns for interprocedural paths where the analyzer detects thatva_startorva_copyhas been called on ava_listwithout a corresponding call tova_end. ๐ง-Wno-analyzer-va-list-use-after-va-endโ requires-fanalyzer, which enables it;-Wno-analyzer-va-list-use-after-va-enddisables it. Warns for interprocedural paths where the analyzer detects an attempt to use ava_listafterva_endhas been called on it.va_list.-Wno-analyzer-write-to-constโ requires-fanalyzer, which enables it;-Wno-analyzer-write-to-constdisables it. Warns for paths where the analyzer detects an attempt to write through a pointer to aconstobject. BUT โ ๏ธ โ the analyzer does not prioritize detection of such paths, so false negatives are more likely relative to other warnings.-Wno-analyzer-write-to-string-literalโ requires-fanalyzer, which enables it;-Wno-analyzer-write-to-string-literaldisables it. Warns for paths where the analyzer detects an attempt to write through a pointer to a string literal. Same disclaimer as above bestie: the analyzer does not prioritize detection of such paths, so false negatives are more likely relative to other warnings. ๐-Wno-analyzer-use-of-uninitialized-valueโ requires-fanalyzer, which enables it;-Wno-analyzer-use-of-uninitialized-valuedisables it. Warns for paths in which an uninitialized value is used. ๐ญ See CWE-457: Use of Uninitialized Variable (https://cwe.mitre.org/data/definitions/457.html).
The analyzer has hardcoded knowledge about the behavior of the following memory-management functions:
alloca- The built-in functions
__builtin_alloc,__builtin_alloc_with_align,__builtin_calloc,__builtin_free,__builtin_malloc,__builtin_memcpy,__builtin_memcpy_chk,__builtin_memset,__builtin_memset_chk,__builtin_realloc,__builtin_stack_restore, and__builtin_stack_save callocfreemallocmemsetoperator deleteoperator delete []operator newoperator new []reallocstrdupstrndup
...and of the following functions for working with file descriptors:
openclosecreatdup,dup2anddup3isattypipe, andpipe2readwritesocket,bind,listen,accept, andconnect
...and of the following functions for working with <stdio.h> streams:
- The built-in functions
__builtin_fprintf,__builtin_fprintf_unlocked,__builtin_fputc,__builtin_fputc_unlocked,__builtin_fputs,__builtin_fputs_unlocked,__builtin_fwrite,__builtin_fwrite_unlocked,__builtin_printf,__builtin_printf_unlocked,__builtin_putc,__builtin_putchar,__builtin_putchar_unlocked,__builtin_putc_unlocked,__builtin_puts,__builtin_puts_unlocked,__builtin_vfprintf, and__builtin_vprintf fopenfcloseferrorfgetsfgets_unlockedfilenofreadgetcgetcharfprintfprintffwrite
...and of the following functions:
- The built-in functions
__builtin_expect,__builtin_expect_with_probability,__builtin_strchr,__builtin_strcpy,__builtin_strcpy_chk,__builtin_strlen,__builtin_va_copy, and__builtin_va_start - The GNU extensions
erroranderror_at_line getpasslongjmpputenvsetjmpsiglongjmpsignalsigsetjmpstrcatstrchrstrlen
Also โจ โ various functions with an __analyzer_ prefix have special meaning to the analyzer, and those are described in the GCC Internals manual. Various internal parameters, settable via --param, are used to control the exploration; those are also documented in the GCC Internals manual. iykyk ๐ฆ
The following options control the analyzer.
-fanalyzer-assume-nothrowโ okay so by default, if-fexceptionsis enabled, the analyzer assumes that a call to any function without the"nothrow"attribute could throw an exception ๐ซถ. That's genuinely helpful for catching execution paths that leak because exceptions bypass your clean-up code, but ngl it can also give you false positives when you're using headers where the author just never added the"nothrow"attribute ๐. If-fanalyzer-assume-nothrowis enabled, the analyzer assumes external functions do not throw exceptions. Lowkey useful for reducing "noise" from the analyzer when you enable-fexceptionson C code โ but it could hide true issues if an exception could be raised by something your C code calls. So like, use with intention ๐-fanalyzer-call-summariesโ simplifies interprocedural analysis by computing the effect of certain calls instead of exploring, like, every single path through the function from callsite to each possible return โจ. If enabled, call summaries are only used for functions with more than one call site, and that are sufficiently complicated. Fancy and efficient, we love to see it.-fanalyzer-checker=nameโ restricts the analyzer to run just the named checker, and enables it. One checker, main character energy, no distractions ๐-fanalyzer-debug-text-art-headingsโ this one is for analyzer developers ๐ ๏ธ. If enabled, the analyzer adds extra annotations to any diagrams it generates.-fno-analyzer-feasibilityโ this option is for analyzer developers. By default the analyzer verifies that there's a feasible control flow path for each diagnostic it emits: that the conditions that hold are not mutually exclusive. Diagnostics for which no feasible path can be found are rejected. This filtering can be suppressed with-fno-analyzer-feasibility, for debugging issues in this code ๐-fanalyzer-fine-grainedโ does nothing. Preserved for backward compatibility. Literally just vibing there ๐-fanalyzer-show-duplicate-countโ analyzer-developer option: if multiple diagnostics have been detected as being duplicates of each other, it emits a note when reporting the best diagnostic, giving the number of additional diagnostics that were suppressed by the deduplication logic ๐-fanalyzer-show-events-in-system-headersโ by default the analyzer emits simplified diagnostic paths by hiding events fully located within a system header ๐. With-fanalyzer-show-events-in-system-headers, such events are no longer suppressed. Show me everything, bestie.-fno-analyzer-simplify-supergraphโ analyzer developers only ๐ ๏ธ. By default, the analyzer performs various simplifications to the program supergraph before analyzing it. With-fno-analyzer-simplify-supergraph, this simplification can be suppressed, for debugging issues with it.-fno-analyzer-state-mergeโ for the analyzer devs. By default the analyzer attempts to simplify analysis by merging sufficiently similar states at each program point as it builds its "exploded graph" ๐ฅ. With-fno-analyzer-state-merge, this merging can be suppressed, for debugging state-handling issues.-fno-analyzer-state-purgeโ analyzer developers, this one's yours. By default the analyzer attempts to simplify analysis by purging aspects of state at a program point that appear to no longer be relevant โ e.g. the values of locals that aren't accessed later in the function and which aren't relevant to leak analysis ๐งน. With-fno-analyzer-state-purge, this purging of state can be suppressed, for debugging state-handling issues.-fno-analyzer-suppress-followupsโ analyzer developers again ๐ ๏ธ. By default the analyzer stops exploring an execution path after encountering certain diagnostics, so it doesn't issue a whole cascade of follow-up diagnostics. The diagnostics that terminate analysis along a path are:-Wanalyzer-null-argument-Wanalyzer-null-dereference-Wanalyzer-use-after-free-Wanalyzer-use-of-pointer-in-stale-stack-frame-Wanalyzer-use-of-uninitialized-value
With -fno-analyzer-suppress-followups, the analyzer continues to explore such paths even after such diagnostics โ which may be helpful for debugging issues in the analyzer, or for microbenchmarks for detecting undefined behavior ๐ฅ
-fanalyzer-transitivityโ this option enables transitivity of constraints within the analyzer โจ-fno-analyzer-undo-inliningโ analyzer developers ๐ ๏ธ.-fanalyzerruns relatively late compared to other code analysis tools, and some optimizations have already been applied to the code. In particular, function inlining may have occurred, leading to the interprocedural execution paths emitted by the analyzer containing function frames that don't correspond to those in the original source code ๐ญ. By default the analyzer attempts to reconstruct the original function frames, and to emit events showing the inlined calls. With-fno-analyzer-undo-inlining, this attempt to reconstruct the original frame information can be disabled, which may be of help when debugging issues in the analyzer.-fanalyzer-verbose-edgesโ for analyzer developers. Enables more verbose, lower-level detail in the descriptions of control flow within diagnostic paths ๐-fanalyzer-verbose-state-changesโ analyzer devs: enables more verbose, lower-level detail in the descriptions of events relating to state machines within diagnostic paths ๐-fanalyzer-verbosity=levelโ this one controls the complexity of the control flow paths that are emitted for analyzer diagnostics. Thelevelcan be one of:0โ at this level, interprocedural call and return events are displayed, along with the most pertinent state-change events relating to a diagnostic. For example, for a double-"free"diagnostic, both calls to"free"will be shown.1โ as per the previous level, but also show events for the entry to each function.2โ as per the previous level, but also show events relating to control flow that are significant to triggering the issue (e.g."true path taken"at a conditional). This level is the default โญ3โ as per the previous level, but show all control flow events, not just significant ones.4โ intended for analyzer developers; it adds various other events intended for debugging the analyzer ๐ ๏ธ
-fdump-analyzerโ dumps internal details about what the analyzer is doing tofile.analyzer.txt๐. Note that-fdump-analyzer-stderroverrides this option.-fdump-analyzer-stderrโ dumps internal details about what the analyzer is doing tostderr. This option overrides-fdump-analyzer.-fdump-analyzer-callgraphโ dumps a representation of the call graph suitable for viewing with GraphViz tofile.callgraph.dot๐-fdump-analyzer-exploded-graphโ dumps a representation of the "exploded graph" suitable for viewing with GraphViz tofile.eg.dot. Nodes are color-coded based on state-machine states to emphasize state changes ๐จ-fdump-analyzer-exploded-nodesโ emits diagnostics showing where nodes in the "exploded graph" are in relation to the program source ๐-fdump-analyzer-exploded-nodes-2โ dumps a textual representation of the "exploded graph" tofile.eg.txt๐-fdump-analyzer-exploded-nodes-3โ dumps a textual representation of the "exploded graph" to one dump file per node, tofile.eg-id.txt. This is typically a large number of dump files ๐ญ-fdump-analyzer-exploded-pathsโ dumps a textual representation of the "exploded path" for each diagnostic tofile.idx.kind.epath.txt๐ค๏ธ-fdump-analyzer-feasibilityโ dumps internal details about the analyzer's search for feasible paths. The details are written in a form suitable for viewing with GraphViz to filenames of the formfile.*.fg.dot,file.*.tg.dot, andfile.*.fpath.txtโจ-fdump-analyzer-infinite-loopโ dumps internal details about the analyzer's search for infinite loops. The details are written in a form suitable for viewing with GraphViz to filenames of the formfile.*.infinite-loop.dot๐-fdump-analyzer-jsonโ dumps a compressed JSON representation of analyzer internals tofile.analyzer.json.gz. The precise format is subject to change โ ๏ธ-fdump-analyzer-state-purgeโ as per-fdump-analyzer-supergraph, dumps a representation of the "supergraph" suitable for viewing with GraphViz, but annotates the graph with information on what state will be purged at each node. The graph is written tofile.state-purge.dot๐งน-fdump-analyzer-supergraphโ dumps representations of the "supergraph" suitable for viewing with GraphViz tofile.supergraph.index.kind.dot. These show all of the control flow graphs in the program, at various stages of the analysis. The precise set of dumps and what they show is subject to change โ ๏ธ-fdump-analyzer-untrackedโ emits custom warnings with internal details intended for analyzer developers ๐ ๏ธ
๐ Options for Debugging Your Program ๐
To tell GCC to emit extra information for use by a debugger, in almost all cases you only need to add -g to your other options ๐ซถ. Some debug formats can co-exist (like DWARF with CTF) when each of them is enabled explicitly by adding the respective command line option to your other options.
GCC allows you to use -g with -O โจ. The shortcuts taken by optimized code may occasionally be surprising, so like, brace yourself: some variables you declared may not exist at all ๐ญ; flow of control may briefly move where you did not expect it; some statements may not be executed because they compute constant results or their values are already at hand; some statements may execute in different places because they have been moved out of loops. Nevertheless, it is possible to debug optimized output. This makes it reasonable to use the optimizer for programs that might have bugs. Slay.
If you are not using some other optimization option, consider using -Og with -g ๐ก. With no -O option at all, some compiler passes that collect information useful for debugging do not run at all, so -Og may result in a better debugging experience.
-g,--debugโ produce debugging information in the operating system's native format (stabs,COFF,XCOFF, orDWARF).GDBcan work with this debugging information ๐
On most systems that use stabs format, -g also turns on some extra debugging info that literally only GDB can use ๐ซถ โ it makes debugging work better in GDB but probably makes other debuggers crash or flat-out refuse to read the program ๐. If you want to control for certain whether that extra info gets generated, use -gvms (peep below).
-ggdbโ produces debugging info specifically for GDB, meaning it uses the most expressive format available (DWARF, stabs, or the native format if neither of those is supported), including GDB extensions if at all possible. GDB gets the deluxe treatment โจ-gdwarf,-gdwarf-versionโ produces debugging info in DWARF format (if that's supported). The value of version may be either2,3,4or5; the default version for most targets is5โ with the exceptions of VxWorks, TPF and Darwin / macOS, which default to version2, and AIX, which defaults to version4. iykyk ๐
Note that with DWARF Version 2, some ports require and always use some non-conflicting DWARF 3 extensions in the unwind tables. Yeah, it's giving "complicated" ๐ญ
Version 4 may require GDB 7.0 and -fvar-tracking-assignments for maximum benefit. Version 5 requires GDB 8.0 or higher. Check your GDB's vibe before you commit ๐
GCC no longer supports DWARF Version 1 โ it's 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. The names are just stuck in the past, bestie ๐
-gbtfโ request BTF debug information. BTF is the default debugging format for the eBPF target. On other targets, like x86, BTF debug information can be generated along with DWARF debug information when both of the debug formats are enabled explicitly via their respective command line options. Two formats, one object file, no cap ๐ฆ-gprune-btf,-gno-prune-btfโ prunes 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. In addition,structanduniontypes which are only referred to via pointers from members of otherstructoruniontypes shall be pruned and replaced withBTF_KIND_FWD, as though those types were only present in the input as forward declarations.
This option substantially reduces the size of produced BTF information, but at significant loss in the amount of detailed type information ๐ญ It'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. Default behavior, iconic ๐
-gctf,-gctflevelโ request CTF debug information and use level to specify how much CTF debug information should be produced. If-gctfis specified without a value for level, the default level of CTF debug information is2.
CTF debug information can be generated along with DWARF debug information when both of the debug formats are enabled explicitly via their respective command line options.
Level 0 produces no CTF debug information at all. Thus, -gctf0 negates -gctf. Poof, gone ๐จ
Level 1 produces CTF information for tracebacks only. This includes callsite information, but does not include type information.
Level 2 produces type information for entities (functions, data objects etc.) at file-scope or global-scope only.
-gvmsโ produces debugging information in Alpha/VMS debug format (if that is supported). This is the format used by DEBUG on Alpha/VMS systems. Retro vibes only ๐ง-gcodeviewโ produces debugging information in CodeView debug format (if that is supported). This is the format used by Microsoft Visual C++ on Windows. Windows besties, this one's for you ๐-glevel,-ggdblevel,-gvmslevelโ request debugging information and also use level to specify how much information. The default level is2. Okay so levels, let's go:
Level 0 produces no debug information at all. Thus, -g0 negates -g. Nothing. Nada. ๐
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 โญ
Level 3 includes extra information, such as all the macro definitions present in the program. Some debuggers support macro expansion when you use -g3. Maximum lore ๐ฅ
If you use multiple -g options, with or without level numbers, the last such option is the one that's effective. Last one wins, periodt ๐
Heads up:-gdwarfdoes not accept a concatenated debug level, to avoid confusion with-gdwarf-level. Instead use an additional-gleveloption to change the debug level for DWARF. No sneaky shortcuts here ๐
-fno-eliminate-unused-debug-symbolsโ by default, no debug information is produced for symbols that aren't actually used. Use this option if you want debug information for all symbols. Every last one ๐ซถ-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. Bloat era, honestly ๐ญ-fno-merge-debug-stringsโ directs the linker to not merge together strings in the debugging information that are identical in different object files. Merging is not supported by all assemblers or linkers. Merging decreases the size of the debug information in the output file at the cost of increasing link processing time. Merging is enabled by default. Speed vs. size, the eternal struggle ๐ฆ-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-mapand-fcanon-prefix-map. Path glow-up โจ-fvar-trackingโ runs the variable tracking pass. It computes where variables are stored at each position in code. Better debugging information is then generated (if the debugging information format supports this information).
It's enabled by default when compiling with optimization (-Os, -O, -O2, ...), debugging information (-g) and the debug info format supports it. Free upgrade, we love to see 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 information while optimizing. Use of-gdwarf-4is 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. So much effort for nothing ๐ญ By default, this flag is enabled together with -fvar-tracking, except when selective scheduling is enabled.
-fvar-tracking-uninit,-fno-var-tracking-uninitโ perform variable tracking and also mark uninitialized variables in the debug information. 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. Mix and match, bestie ๐-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.dwofiles. Split it, don't link it ๐-gdwarf32,-gdwarf64โ if DWARF debugging information is enabled, the-gdwarf32selects the 32-bit DWARF format and the-gdwarf64selects 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. Pick 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 the nameless a little something ๐ซถ-gpubnamesโ generate DWARF.debug_pubnamesand.debug_pubtypessections.-ggnu-pubnamesโ generate.debug_pubnamesand.debug_pubtypessections 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. Niche but iconic โจ-gno-pubnamesโ don't generate DWARF.debug_pubnamesand.debug_pubtypessections. The anti-option, we respect it ๐-fdebug-types-sectionโ when using DWARF Version 4 or higher, type DIEs can be put into their own.debug_typessection instead of making them part of the.debug_infosection. 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_typessections yet, and on some objects.debug_typesproduces larger instead of smaller debugging information. Not me getting bigger after optimizing ๐ญ-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 theDW_AT_producerattribute 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-switchesfor another way of storing compiler options into the object file. Receipts, in the debug info ๐-gstrict-dwarfโ no later-DWARF-version shenanigans for you ๐ซ. This bans using extensions from a later DWARF standard version than whatever you picked with-gdwarf-version. On most targets, using non-conflicting DWARF extensions from later standard versions is allowed โ this option says "not today."-gno-strict-dwarfโ the chill one ๐ . Allows using extensions of later DWARF standard version than the one selected with-gdwarf-version.-gas-loc-supportโ telling the compiler "bestie, the assembler gets.locdirectives" ๐. It may then use them so the assembler generates 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. Enabled by default if, at GCC configure time, the assembler is found to support such directives.-gno-as-loc-supportโ force GCC to generate DWARF2+ line number tables internally, if DWARF2+ line number tables are to be generated. DIY era ๐ ๏ธ.-gas-locview-supportโ inform the compiler that the assembler supports "view" assignment and reset assertion checking in.locdirectives. Enabled by default if, at GCC configure time, the assembler is found to support them.-gno-as-locview-supportโ force GCC to assign view numbers internally, if-gvariable-location-viewsare explicitly requested.-gcolumn-info,-gno-column-infoโ emit location column information into DWARF debugging information, rather than just file and line. Enabled by default โจ.-gstatement-frontiers,-gno-statement-frontiersโ 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 ofis_stmtmarkers in the line number table. 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.
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's a proposed representation for view numbers that is not backward compatible with the location list format introduced in DWARF 5, and you can switch it on with -gvariable-location-views=incompat5. This option may be removed in the future, and 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". 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's supported ๐๏ธ. If type is not given, the default type depends on the capabilities of the assembler and linker used. type may be one ofnone(don't compress debug sections),zlib(use zlib compression in ELF gABI format), orzstd(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,-gzis 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 the 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-reducedfor a less aggressive option. See-femit-struct-debug-detailedfor 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 the 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-baseonlyfor a more aggressive option. See-femit-struct-debug-detailedfor 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_framesection 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's 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, bestie โ this is where the compiler stops being a literal translator and starts having opinions ๐ฅ.
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 ๐ฏ. It's giving "no surprises" energy, and honestly? Iconic.
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 โ๏ธ. Trade-offs, always trade-offs.
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 ๐ โ main character move, honestly.
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 ๐ค.
Real talk before we get into the levels: depending on the target and how GCC was configured, a slightly different set of optimizations may be enabled at each -O level than those listed here. Like, your build might be built different ๐
. You can invoke GCC with -Q --help=optimizers to find out the exact set of optimizations that are enabled at each level โ icon behaviour, honestly.
-O,-O1,--optimizeโ optimizes, bestie. Optimizing compilation takes somewhat more time, and a lot more memory for a large function.
With -O, the compiler tries to reduce code size and execution time, without performing any optimizations that take a great deal of compilation time.
-O is the recommended optimization level for large machine-generated code as a sensible balance between time taken to compile and memory use: higher optimization levels perform optimizations with greater algorithmic complexity than at -O.
-O turns on the following optimization flags:
-fauto-inc-dec -fbranch-count-reg -fcombine-stack-adjustments
-fcompare-elim -fcprop-registers -fdce -fdefer-pop -fdelayed-branch
-fdse -fforward-propagate -fguess-branch-probability -fif-conversion
-fif-conversion2 -finline-functions-called-once -fipa-modref
-fipa-profile -fipa-pure-const -fipa-reference
-fipa-reference-addressable -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, like it's not even trying to be chill about it. GCC performs nearly all supported optimizations that do not involve a space-speed tradeoff. As compared to-O, this option increases both compilation time and the performance of the generated code.
-O2 turns on all optimization flags specified by -O1. It also turns on the following optimization flags:
-falign-functions -falign-jumps -falign-labels -falign-loops
-fcaller-saves -fcode-hoisting -fcrossjumping -fcse-follow-jumps
-fcse-skip-blocks -fdelete-null-pointer-checks -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
๐ซถ heads up, bestie: please note the warning under-fgcseabout invoking-O2on programs that use computed gotos. Not me forgetting to tell you, that's literally where it lives.
-O3โ optimize yet more, the main character of optimization levels ๐ฅ.-O3turns on all optimizations specified by-O2and also turns on the following optimization flags:
-fgcse-after-reload -fipa-cp-clone -floop-interchange
-floop-unroll-and-jam -fpeel-loops -fpredictive-commoning
-fsplit-loops -fsplit-paths -ftree-loop-distribution
-ftree-partial-pre -funswitch-loops -fvect-cost-model=dynamic
-fversion-loops-for-strides
-O0โ reduce compilation time and make debugging produce the expected results. This is the default ๐.
At -O0, GCC completely disables most optimization passes; they are not run even if you explicitly enable them on the command line, or are listed by -Q --help=optimizers as being enabled by default. Many optimizations performed by GCC depend on code analysis or canonicalization passes that are enabled by -O, and it would not be useful to run individual optimization passes in isolation. So no, turning them on manually does not make them a thing. Periodt.
-Osโ optimize for size ๐.-Osenables all-O2optimizations except those that often increase code size:
-falign-functions -falign-jumps -falign-labels -falign-loops
-fprefetch-loop-arrays -freorder-blocks-algorithm=stc
It also enables -finline-functions, causes the compiler to tune for code size rather than execution speed, and performs further optimizations designed to reduce code size. Small but mighty vibes, iykyk.
-Ofastโ disregard strict standards compliance, we're going feral.-Ofastenables all-O3optimizations. It also enables optimizations that are not valid for all standard-compliant programs. It turns on-ffast-math,-fallow-store-data-racesand the Fortran-specific-fstack-arrays, unless-fmax-stack-var-sizeis specified, and-fno-protect-parens. It turns off-fsemantic-interposition.
๐ fr fr though: "not valid for all standard-compliant programs" is not a vibe, it's a legit caveat. Standards compliance is out the window at this level.
-Ogโ optimize while keeping in mind debugging experience ๐ฆ.-Ogshould be the optimization level of choice for the standard edit-compile-debug cycle, offering a reasonable blend of optimization, fast compilation and debugging experience especially for code with a high abstraction penalty. In contrast to-O0, this enables-fvar-tracking-assignmentsand-fvar-trackingwhich handle debug information in the prologue and epilogue of functions better than-O0.
Like -O0, -Og completely skips a number of optimization passes so that individual options controlling them have no effect. Otherwise -Og enables all -O1 optimization flags except for those 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 may increase the number of instructions executed if those instructions require fewer bytes to encode.-Ozbehaves similarly to-Osincluding enabling most-O2optimizations.
If you use multiple -O options, with or without level numbers, the last such option is the one that is effective. Last one wins, no take-backs ๐
Options of the form -fflag specify machine-independent flags. Most flags have both positive and negative forms; the negative form of -ffoo is -fno-foo. In the table below, only one of the forms is listedโthe one you typically use. You can figure out the other form by either removing no- or adding it. Math, but make it compiler flags ๐งฎโจ.
The following options control specific optimizations. They are either activated by -O options or are related to ones that are. You can use the following flags in the rare cases when "fine-tuning" of optimizations to be performed is desired.
-fno-defer-popโ for machines that must pop arguments after a function call, always pop the arguments as soon as each function returns. At levels-O1and higher,-fdefer-popis the default; this allows the compiler to let arguments accumulate on the stack for several function calls and pop them all at once.-fforward-propagateโ perform a forward propagation pass on RTL. The pass tries to combine two instructions and checks if the result can be simplified. If loop unrolling is active, two passes are performed and the second is scheduled after loop unrolling.
This option is enabled by default at optimization levels -O1, -O2, -O3, -Os.
-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 detect such cases and avoid the penalty by changing the order of the load and store and then fixing up the loaded value.
Disabled by default.
-ffp-contract=styleโ-ffp-contract=offdisables floating-point expression contraction.-ffp-contract=fastenables floating-point expression contraction such as forming of fused multiply-add operations if the target has native support for them.-ffp-contract=onenables floating-point expression contraction if allowed by the language standard. This is implemented for C and C++, where it enables contraction within one expression, but not across different statements.
The default is -ffp-contract=off for C in a standards compliant mode (-std=c11 or similar), -ffp-contract=fast otherwise.
-ffp-int-builtin-inexactโ allow the built-in functionsceil,floor,roundandtrunc, and theirfloatandlong doublevariants, to generate code that raises theinexactfloating-point exception for noninteger arguments. ISO C99 and C11 allow these functions to raise theinexactexception, but ISO/IEC TS 18661-1:2014, the C bindings to IEEE 754-2008, as integrated into ISO C23, does not allow these functions to do so ๐ง.
The default is -fno-fp-int-builtin-inexact, disallowing the exception to be raised, unless C17 or an earlier C standard is selected. This option does nothing unless -ftrapping-math is in effect.
Even if -fno-fp-int-builtin-inexact is used, if the functions generate a call to a library function then the inexact exception may be raised if the library implementation does not follow TS 18661.
-fomit-frame-pointerโ omit the frame pointer in functions that don't need one. This avoids the instructions to save, set up and restore the frame pointer; on many targets it also makes an extra register available. Free real estate, lowkey ๐ .
On some targets this flag has no effect because the standard calling sequence always uses a frame pointer, so it cannot be omitted.
Note that -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 calculating CRC (performing polynomial long division) and replace them with a faster implementation ๐ฅ. Detect 8, 16, 32, and 64 bit CRC, with a constant polynomial without the leading 1 bit, for both bit-forward and bit-reversed cases. If the target supports a CRC instruction and the polynomial used in the source code matches the polynomial used in the CRC instruction, generate that CRC instruction. Otherwise, if the target supports a carry-less-multiplication instruction, generate CRC using it; otherwise generate table-based CRC.
Enabled by default at -O2 and higher. Slay.
-foptimize-sibling-callsโ optimize sibling and tail recursive calls. That's it, that's the flag ๐ซถ.-foptimize-strlenโ rewrites all those classic C string functions โstrlen,strchr,strcpy, and even their_FORTIFY_SOURCEtwins โ into snappier equivalents. Same job, faster fit. ๐
On at -O2 and -O3.
-finline-atomics,-fno-inline-atomicsโ inlines__atomicoperations whenever a lock-free instruction sequence is available. Like, if the hardware can do it without a lock, GCC just smooshes it right in. This one is on by default, periodt.-finline-stringops[=fn]โ expands memory and string ops inline โ for now onlymemsetโ even when the length is variable or so big it'd need a loop. Chef's kiss combo with-ffreestandingand-fno-builtin. โจ
Sometimes this lets GCC generate code that flexes known alignment and length multipliers, but even then it can be less efficient than a tuned runtime implementation, and it can also balloon your code size so much that a slower-but-shared implementation ends up running faster purely because it plays nicer with code caches. Off by default. ๐
-fno-inlineโ no inline expansion for anybody, except the functions tagged with thealways_inlineattribute. This is the default when you're not optimizing.
Want to rescue a single function from inlining? Tag it noinline and it's exempt.
-finline-small-functionsโ pulls functions into their callers when the body is smaller than the function-call code would be โ so the whole program gets smaller. GCC heuristically picks which functions are simple enough to be worth it. Heads up: this applies to all functions, even the ones you never declaredinline.
On at -O2, -O3, -Os.
-findirect-inliningโ inlines the indirect calls too, the ones that previous inlining revealed to be known at compile time. No effect unless inlining itself is already on via-finline-functionsor-finline-small-functions.
On at -O2, -O3, -Os.
-finline-functionsโ considers every function for inlining, declaredinlineor not; GCC heuristically decides which ones are worth integrating.
If literally every call to a function gets integrated and that function is declared static, it normally doesn't get output as assembler code on its own โ it's fully absorbed. ๐ซถ
On at -O2, -O3, -Os. Also switched on by -fprofile-use and -fauto-profile.
-finline-functions-called-onceโ considers allstaticfunctions that are called exactly once for inlining into their caller, even without theinlinemark. If the call gets integrated, the function isn't emitted as assembler code separately.
On at -O1, -O2, -O3 and -Os โ but not -Og.
-fearly-inliningโ inlinesalways_inlinefunctions and functions whose body looks smaller than the call overhead early, before-fprofile-generateinstrumentation and the real inlining pass happen. This makes profiling way cheaper and usually makes inlining faster on programs with big chains of nested wrapper functions.
On by default.
-fipa-sraโ interprocedural scalar replacement of aggregates: removes unused parameters and swaps parameters passed by reference for parameters passed by value. Glow-up for your call signatures. ๐
On at -O2, -O3 and -Os.
-finline-limit=nโ GCC caps how big an inlinable function can be by default; this flag gives you coarse control over that cap. n is the size of functions that can be inlined, counted in pseudo instructions.
Inlining is actually controlled by a bunch of internal parameters, documented in the GCC Internals manual, and honestly you shouldn't normally set those directly.
Note: there may be no value of -finline-limit that gives you the default behavior. Yeah. It's like that.
Note: "pseudo instruction" here is an abstract measurement of a function's size. It is in no way a count of assembly instructions, and its exact meaning can change from one release to the next. Do not come for it, it's doing its best. ๐ญ
-fno-keep-inline-dllexportโ a more fine-grained version of-fkeep-inline-functions, applying only to functions declared with thedllexportattribute or declspec.-fkeep-inline-functionsโ in C, emitsstaticfunctions declaredinlineinto the object file even if the function got inlined into all of its callers. Doesn't touch functions using theextern inlineextension in GNU C90. In C++, emits any and all inline functions into the object file.-fkeep-static-functionsโ emitsstaticfunctions into the object file even if they're never used. Keeping them for the plot. ๐-fkeep-static-constsโ emits variables declaredstatic constwhen optimization is off, even if nothing references them.
GCC enables this by default. Want to force the compiler to actually check whether a variable is referenced, optimization or not? Use -fno-keep-static-consts.
-fmerge-constantsโ tries to merge identical constants (string constants and floating-point constants) across compilation units.
This is the default for optimized compilation when the assembler and linker support it. Use -fno-merge-constants to block the behavior.
On at -O1, -O2, -O3, -Os.
-fmerge-all-constantsโ tries to merge identical constants and identical variables.
Implies -fmerge-constants. On top of that, it also considers things like constant-initialized arrays, or initialized constant variables with integral or floating-point types. But listen โ languages like C or C++ require every variable, including multiple instances of the same variable in recursive calls, to have distinct locations. So this option gives you non-conforming behavior. It's giving rulebreaker. ๐
-fmodulo-schedโ does swing modulo scheduling right before the first scheduling pass. This pass stares at innermost loops and reorders their instructions by overlapping different iterations.-fmodulo-sched-allow-regmovesโ more aggressive SMS-based modulo scheduling, with register moves allowed. Setting this flag deletes certain anti-dependence edges, which triggers reg-move generation based on life-range analysis. Only effective with-fmodulo-schedenabled.-fno-branch-count-regโ disables the optimization pass that hunts for chances to usedecrement and branchinstructions on a count register instead of the whole decrement-a-register / compare-against-zero / branch-on-result sequence. Only meaningful on architectures that support such instructions: x86, PowerPC, IA-64 and S/390 are on the list. Also note that-fno-branch-count-regdoes not strip the decrement and branch instructions other optimization passes already introduced into the generated instruction stream.
The default is -fbranch-count-reg at -O1 and higher, except for -Og.
-fno-function-cseโ doesn't put function addresses in registers; every instruction that calls a constant function has to spell out the function's address explicitly.
Less efficient code, but some strange hacks that alter assembler output can get confused by the optimizations that happen when this option is off.
The default is -ffunction-cse
-ffuse-ops-with-volatile-accessโ allows limited optimization of operations with volatile memory access when doing so doesn't change the semantics outlined in
The default is -ffuse-ops-with-volatile-access
No cap, that sentence just ends there in the source. That's the whole sentence. I'm not making it up, bestie. ๐ซ
-fno-zero-initialized-in-bssโ if the target has a BSS section, GCC by default drops variables initialized to zero into BSS. Saves space in the resulting code. โจ
This option turns that off, because some programs explicitly rely on their variables landing in the data section โ like, so the resulting executable can find the beginning of that section and/or make assumptions based on it.
The default is -fzero-initialized-in-bss except in Ada.
-fthread-jumpsโ optimizes by checking whether a jump branches to a spot where another comparison subsumed by the first one is sitting. If so, the first branch gets redirected to either the destination of the second branch or a point immediately after it โ depends on whether the condition is known true or false.
On at -O1, -O2, -O3, -Os.
-fsplit-wide-typesโ when a type occupies multiple registers โ thinklong longon a 32-bit system โ splits those registers apart and allocates them independently. Usually better code for those types, but it can make debugging harder. ๐
On at -O1, -O2, -O3, -Os.
-fsplit-wide-types-earlyโ fully splits wide types early instead of very late. Does nothing unless-fsplit-wide-typesis on.
This is the default on some targets.
-fcse-follow-jumpsโ in common subexpression elimination (CSE), scans through jump instructions when the jump's target isn't reached by any other path. Like, when CSE bumps into anifstatement with anelseclause, it follows the jump when the condition tested is false.
On at -O2, -O3, -Os.
-fcse-skip-blocksโ similar to-fcse-follow-jumps, but it makes CSE follow jumps that conditionally skip over blocks. When CSE hits a simpleifwith no else clause,-fcse-skip-blocksmakes it follow the jump around the body of theif.
On at -O2, -O3, -Os.
-frerun-cse-after-loopโ re-runs common subexpression elimination after the loop optimizations have done their thing.
On at -O2, -O3, -Os.
-fgcseโ runs a global common subexpression elimination pass. This pass also does global constant and copy propagation. ๐
Note: when you're compiling a program that uses computed gotos (a GCC extension), you may get better run-time performance by disabling the global common subexpression elimination pass โ just add -fno-gcse to the command line.
On at -O2, -O3, -Os.
-fgcse-lmโ okay so when this one is on, global common subexpression elimination gets a little โจadventurousโจ and tries to move loads that are only killed by stores into themselves. Basically it takes a loop with a load/store sequence and goes "nah bestie, let's make it a load outside the loop and a copy/store inside the loop" ๐
Enabled by default when -fgcse is enabled. iykyk ๐
-fgcse-smโ turn this on and a store motion pass runs after global common subexpression elimination. This pass is the one that's like "stores, babes, let's get you out of the loop" ๐ช When you pair it with-fgcse-lm, loops containing a load/store sequence can become a load before the loop and a store after the loop. Obsessed tbh.
Not enabled at any optimization level. ๐
-fgcse-lasโ with this enabled, the global common subexpression elimination pass eliminates redundant loads that come after stores to the same memory location โ and it does both partial and full redundancies ๐
Not enabled at any optimization level.
-fgcse-after-reloadโ when this is enabled, a redundant load elimination pass is performed after reload. The whole purpose? Cleaning up redundant spilling ๐งนโจ
Enabled by -O3, -fprofile-use and -fauto-profile.
-faggressive-loop-optimizationsโ this tells the loop optimizer to use language constraints to derive bounds for the number of iterations of a loop. Translation: it assumes your loop code doesn't invoke undefined behavior, like causing signed integer overflows or out-of-bound array accesses ๐ฌ The bounds it derives are then used to guide loop unrolling and peeling and loop exit test optimizations.
This option is enabled by default.
Bestie, note the assumption. If your code is out here causing signed integer overflows or reading out of bounds, that's undefined behavior territory and this option is not going to be your friend ๐
-funconstrained-commonsโ this one tells the compiler that variables declared in common blocks (e.g. Fortran) may later be overridden with longer trailing arrays. Which prevents certain optimizations that depend on knowing the array bounds ๐ซถ-fcrossjumpingโ perform cross-jumping transformation โจ It unifies equivalent code and saves code size. The resulting code may or may not perform better than without cross-jumping โ ngl, no promises on speed, it's a size thing ๐โโ๏ธ
Enabled at levels -O2, -O3, -Os.
-fauto-inc-decโ combines increments or decrements of addresses with memory accesses ๐ฅ This pass is always skipped on architectures that don't have instructions to support this, so if your chip can't, it just sits there like "not me, not my problem" ๐ Enabled by default at-O1and higher on architectures that support this.-fdceโ perform dead code elimination (DCE) on RTL. Enabled by default at-O1and higher. Rude and efficient, we love her ๐๏ธ-fdseโ perform dead store elimination (DSE) on RTL. Enabled by default at-O1and higher. The store-side sibling of-fdce, living her best life ๐ฆ-fif-conversionโ attempt to transform conditional jumps into branch-less equivalents ๐ This includes use of conditional moves, min, max, set flags and abs instructions, and some tricks doable by standard arithmetics. The use of conditional execution on chips where it's available is controlled by-fif-conversion2.
Enabled at levels -O1, -O2, -O3, -Os, but not with -Og. Periodt.
-fif-conversion2โ use conditional execution (where available) to transform conditional jumps into branch-less equivalents โจ Same vibe, the sequel.
Enabled at levels -O1, -O2, -O3, -Os, but not with -Og.
-fdeclone-ctor-dtorโ ok so the C++ ABI requires multiple entry points for constructors and destructors: one for a base subobject, one for a complete object, and one for a virtual destructor that callsoperator deleteafterwards ๐ญ For a hierarchy with virtual bases, the base and complete variants are clones, which means two copies of the function. With this option, the base and complete variants are changed to be thunks that call a common implementation โ deduplicated, iconic, no cap ๐
Enabled by -Os.
-fdelete-null-pointer-checksโ assume that programs cannot safely dereference null pointers, and that no code or data element resides at address zero ๐ซ This option enables simple constant folding optimizations at all optimization levels. On top of that, other optimization passes in GCC use this flag to control global dataflow analyses that eliminate useless checks for null pointers; these assume that a memory access to address zero always results in a trap, so that if a pointer is checked after it has already been dereferenced, it cannot be null.
Note however that in some environments this assumption is not true. Use -fno-delete-null-pointer-checks to disable this optimization for programs that depend on that behavior. Fr fr, check your environment ๐
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โ attempt to convert calls to virtual functions to direct calls ๐ฏ This is done 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โ attempt to convert calls to virtual functions to speculative direct calls ๐ฎ Based on the analysis of the type inheritance graph, it determines for a given call the set of likely targets. If the set is small, preferably of size 1, it changes the call into a conditional deciding between direct and indirect calls. These speculative calls enable more optimizations, such as inlining. And when they seem useless after further optimization, they're converted back into original form โ she said "jk, never mind" ๐-fdevirtualize-at-ltransโ streams extra information needed for aggressive devirtualization when running the link-time optimizer in local transformation mode ๐ก This option enables more devirtualization but significantly increases the size of streamed data. For this reason it is disabled by default. Big brain but big data, pick your struggle ๐ซ-fexpensive-optimizationsโ perform a number of minor optimizations that are relatively expensive ๐ธ Yeah, "minor" and "expensive" in the same sentence, she contains multitudes.
Enabled at levels -O2, -O3, -Os.
-fext-dce,-fno-ext-dceโ perform dead code elimination on zero and sign extensions, with special dataflow analysis โจ Cleanup for your extension instructions, with the fancy analysis and everything ๐ง-freeโ attempt to remove redundant extension instructions ๐ This is especially helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit registers after writing to their lower 32-bit half. Like, it literally does it for you, so the redundant ones can go ๐ซถ
Enabled for Alpha, AArch64, LoongArch, PowerPC, RISC-V, SPARC, h83000 and x86 at levels -O2, -O3, -Os.
-fno-lifetime-dseโ in C++ the value of an object is only affected by changes within its lifetime: when the constructor begins, the object has an indeterminate value, and any changes during the lifetime of the object are dead when the object is destroyed ๐ Normally dead store elimination takes advantage of this; if your code relies on the value of the object storage persisting beyond the lifetime of the object, you can use this flag to disable this optimization.
To preserve stores before the constructor starts (e.g. because your operator new clears the object storage) but still treat the object as dead after the destructor, you can use -flifetime-dse=1. The default behavior can be explicitly selected with -flifetime-dse=2. And -flifetime-dse=0 is equivalent to -fno-lifetime-dse. The whole little family, all accounted for ๐
-flive-range-shrinkageโ attempt to decrease register pressure through register live range shrinkage ๐ฉน Helpful for fast processors with small or moderate size register sets. Squish, bestie, squish.-fira-algorithm=algorithmโ use the specified coloring algorithm for the integrated register allocator ๐จ The algorithm argument can bepriority, which specifies Chow's priority coloring, orCB, which specifies Chaitin-Briggs coloring. Chaitin-Briggs coloring is not implemented for all architectures, but for those targets that do support it, it is the default because it generates better code. Slay.-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-Osor-O0๐
-fira-hoist-pressureโ use IRA to evaluate register pressure in the code hoisting pass for decisions to hoist expressions ๐๏ธโโ๏ธ This option usually results in smaller code, but it can slow the compiler down. Trade-off era.
This option is enabled at level -Os for all targets.
-fira-loop-pressureโ use IRA to evaluate register pressure in loops for decisions to move loop invariants ๐ This option usually results in generation of faster and smaller code on machines with large register files (>= 32 registers), but it can slow the compiler down. Fancy but pricey ๐
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 a separate stack slot, and as a result function stack frames are larger. No sharing, no shrinkage โ bigger frames, that's the deal.-fno-ira-share-spill-slotsโ disable sharing of stack slots allocated for pseudo-registers. Each pseudo-register that does not get a hard register gets a separate stack slot, and as a result function stack frames are larger. Same energy, different slots ๐ญ-flra-rematโ enable CFG-sensitive rematerialization in LRA โจ Instead of loading values of spilled pseudos, LRA tries to rematerialize (recalculate) values if it is profitable. Recalculate > reload, when the math works out.
Enabled at levels -O2, -O3, -Os.
-fdelayed-branchโ if supported for the target machine, attempt to reorder instructions to exploit instruction slots available after delayed branch instructions ๐ If your target doesn't support it, she simply doesn't show up.
Enabled at levels -O1, -O2, -O3, -Os, but not at -Og.
-fschedule-insnsโ ok so if the target machine supports it, GCC will try to reorder your instructions so you don't get those sad little execution stalls where the data you need just isn't there yet ๐. It's a lifesaver for machines with slow floating-point or memory-load instructions, because it lets other instructions go out and party until the load or FP result is actually needed. Conventionally it's on at-O2and-O3, but ngl a ton of targets override that: on x86 it's disabled at all levels, and on AArch64 it's only enabled at-O3. Target-dependent behavior, bestie, that's just how it is โจ-fschedule-insns2โ literally the same vibe as-fschedule-insns, but it asks for an additional pass of instruction scheduling after register allocation has happened ๐. Especially useful on machines with a relatively small number of registers, and where memory load instructions take more than one cycle. Enabled at-O2,-O3,-Os.-fno-sched-interblockโ turns off instruction scheduling across basic blocks. That scheduling is normally enabled when you're scheduling before register allocation, i.e. with-fschedule-insnsor at-O2or higher ๐ฅ-fno-sched-specโ disables speculative motion of non-load instructions, which is normally enabled when scheduling before register allocation, i.e. with-fschedule-insnsor at-O2or higher. No speculative vibes today ๐-fsched-pressureโ enables register-pressure-sensitive insn scheduling before register allocation ๐ . It only makes sense when scheduling before register allocation is on, i.e. with-fschedule-insnsor at-O2or higher. Using it can genuinely improve the generated code and shrink it, by preventing register pressure from rising above the number of available hard registers and the subsequent spills in register allocation. Iconic, honestly.-fsched-spec-loadโ allows speculative motion of some load instructions ๐ฆ. Only makes sense when scheduling before register allocation, i.e. with-fschedule-insnsor at-O2or higher.-fsched-spec-load-dangerousโ allows speculative motion of more load instructions ๐ญ (yes, the flag is literally named dangerous, it's giving main character energy). Only makes sense when scheduling before register allocation, i.e. with-fschedule-insnsor at-O2or 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 โญ.-fno-sched-stalled-insnsmeans no insns are moved prematurely, and-fsched-stalled-insns=0means there's no limit on how many queued insns can be moved prematurely.-fsched-stalled-insnswith 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 ๐ง. This only does anything during the second scheduling pass, and only if-fsched-stalled-insnsis used.-fno-sched-stalled-insns-depis equivalent to-fsched-stalled-insns-dep=0, and-fsched-stalled-insns-depwith 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 gives you faster schedules. Heads up though: 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 it only makes sense when scheduling after register allocation, i.e. with-fschedule-insns2or at-O2or higher.
-fsched-group-heuristicโ enables the group heuristic in the scheduler, which favors the instruction that belongs to a schedule group ๐ธ. Enabled by default whenever scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher.-fsched-critical-path-heuristicโ enables the critical-path heuristic, which favors instructions on the critical path ๐. Enabled by default whenever scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher.-fsched-spec-insn-heuristicโ enables the speculative instruction heuristic, which favors speculative instructions with greater dependency weakness โจ. Enabled by default whenever scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher.-fsched-rank-heuristicโ enables the rank heuristic, which favors the instruction belonging to a basic block with greater size or frequency ๐ฅ. Enabled by default whenever scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher.-fsched-last-insn-heuristicโ enables the last-instruction heuristic, which favors the instruction that's less dependent on the last instruction scheduled ๐. Enabled by default whenever scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher.-fsched-dep-count-heuristicโ enables the dependent-count heuristic, which favors the instruction that has more instructions depending on it ๐. Enabled by default whenever scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher.
-fspeculatively-call-stored-functionsโ this one is lowkey wild ๐ฆ. It 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 unlock more optimizations, like inlining. And if they seem useless after further optimization, they get converted back into their original form. No harm done ๐-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, which runs instead of the first scheduler pass โญ-fselective-scheduling2โ schedule instructions using the selective scheduling algorithm, which runs instead of the second scheduler pass โญโญ-fsel-sched-pipeliningโ enables software pipelining of innermost loops during selective scheduling ๐. This has no effect unless one of-fselective-schedulingor-fselective-scheduling2is turned on.-fsel-sched-pipelining-outer-loopsโ when pipelining loops during selective scheduling, also pipeline outer loops ๐ซ. This has no effect unless-fsel-sched-pipeliningis turned on.
-fsemantic-interpositionโ some object formats, like ELF, let the dynamic linker interpose symbols ๐. Basically that means for symbols exported from the DSO, the compiler can't do interprocedural propagation, inlining, or other optimizations, because the function or variable in question might change on it. While that feature is useful โ say, for rewriting memory allocation functions with a debugging implementation โ it's expensive when it comes to 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 declaredinline(where interposition is never allowed to change semantics) and for symbols explicitly declared weak.-fshrink-wrapโ emits function prologues only before the parts of the function that actually need them, instead of at the top of the function ๐. Enabled by default at-Oand higher.-fshrink-wrap-separateโ shrink-wraps separate parts of the prologue and epilogue separately, so those parts are only executed when needed โจ. On by default, but it has no effect unless-fshrink-wrapis also turned on and the target supports this.-fcaller-savesโ enables allocation of values to registers that get clobbered by function calls, by emitting extra instructions to save and restore the registers around such calls ๐ . That allocation only happens when it seems to result in better code. This option is always enabled by default on certain machines โ usually the ones that have no call-preserved registers to use instead. Enabled at levels-O2,-O3,-Os.-fcombine-stack-adjustmentsโ tracks stack adjustments (pushes and pops) and stack memory references, then tries to find ways to combine them ๐ฅ. Enabled by default at-O1and higher.-fipa-raโ uses caller-save registers for allocation if those registers aren't used by any called function ๐. In that case you don't need to save and restore them around calls. This is only possible if the called functions are part of the same compilation unit as the current function and they're compiled before it. Enabled at levels-O2,-O3,-Os, but it's disabled if the generated code will be instrumented for profiling (-p, or-pg), or if the callee's register usage can't be known exactly โ which happens on targets that don't expose prologues and epilogues in RTL.-fconserve-stackโ attempt to minimize stack usage ๐. The compiler tries to use less stack space, even if that makes the program slower. This option implies setting thelarge-stack-frameparameter to100and thelarge-stack-frame-growthparameter to400.
-ftree-reassocโ perform reassociation on trees ๐ณ. Enabled by default at-O1and higher.-fcode-hoistingโ perform code hoisting ๐. Code hoisting tries to move the evaluation of expressions executed on all paths to the function exit as early as possible. It's especially useful as a code size optimization, but it often helps for code speed as well. Enabled by default at-O2and higher.-ftree-preโ perform partial redundancy elimination (PRE) on trees โจ. Enabled by default at-O2and-O3.-ftree-partial-preโ makes partial redundancy elimination (PRE) more aggressive ๐ค. Enabled by default at-O3.-ftree-forwpropโ does forward propagation on trees โจ this flag is enabled by default at-O1and higher.-ftree-freโ does full redundancy elimination (FRE) on trees ๐ the difference between FRE and PRE is that FRE only considers expressions that are computed on all paths leading to the redundant computation. This analysis is faster than PRE, though it exposes fewer redundancies. This flag is enabled by default at-O1and higher.-ftree-phipropโ does hoisting of loads from conditional pointers on trees ๐ this pass is enabled by default at-O1and higher.-fhoist-adjacent-loadsโ speculatively hoists loads from both branches of an if-then-else if the loads are from adjacent locations in the same structure and the target architecture has a conditional move instruction ๐ฆ this flag is enabled by default at-O2and higher.-ftree-copy-propโ does copy propagation on trees ๐ this pass eliminates unnecessary copy operations. This flag is enabled by default at-O1and higher.-fipa-pure-constโ discovers which functions are pure or constant ๐ธ enabled by default at-O1and higher.-fipa-referenceโ discovers which static variables do not escape the compilation unit ๐ enabled by default at-O1and higher.-fipa-reference-addressableโ discovers read-only, write-only and non-addressable static variables ๐ enabled by default at-O1and higher.-fipa-reorder-for-localityโ groups call chains close together in the binary layout to improve code locality and minimize jump distances between frequently called functions ๐ฅ unlike-freorder-functionsthis pass considers the call chains between functions and groups them together, rather than grouping all hot/normal/cold/never-executed functions into separate sections. Unlike-fprofile-reorder-functionsit aims to improve code locality throughout the runtime of the program rather than focusing on program startup. This option is incompatible with an explicit-flto-partition=option since it enforces a custom partitioning scheme. If using this option it is recommended to also use profile feedback, but this option is not enabled by default otherwise.-fipa-stack-alignmentโ reduces stack alignment on call sites if possible ๐ enabled by default.-fipa-ptaโ does interprocedural pointer analysis and interprocedural modification and reference analysis ๐ซถ this option can cause excessive memory and compile-time usage on large compilation units. It is not enabled by default at any optimization level.-fipa-profileโ does interprocedural profile propagation ๐ซ the functions called only from cold functions are marked as cold. Also functions executed once (such as"cold","noreturn", static constructors or destructors) are identified. Cold functions and loop less parts of functions executed once are then optimized for size. Enabled by default at-O1and higher.-fipa-modrefโ does interprocedural mod/ref analysis ๐ง this optimization analyzes the side effects of functions (memory locations that are modified or referenced) and enables better optimization across the function call boundary. This flag is enabled by default at-O1and higher.-fipa-cpโ does interprocedural constant propagation โญ this optimization analyzes the program to determine when values passed to functions are constants and then optimizes accordingly. This optimization can substantially increase performance if the application has constants passed to functions. This flag is enabled by default at-O2,-Osand-O3. It is also enabled by-fprofile-useand-fauto-profile.-fipa-cp-cloneโ does function cloning to make interprocedural constant propagation stronger ๐ฅ when enabled, interprocedural constant propagation performs function cloning when externally visible function can be called with constant arguments. Because this optimization can create multiple copies of functions, it may significantly increase code size. This flag is enabled by default at-O3. It is also enabled by-fprofile-useand-fauto-profile.-fipa-bit-cpโ when enabled, does interprocedural bitwise constant propagation ๐ this flag is enabled by default at-O2and by-fprofile-useand-fauto-profile. It requires that-fipa-cpis enabled.-fipa-vrpโ when enabled, does interprocedural propagation of value ranges ๐ธ this flag is enabled by default at-O2. It requires that-fipa-cpis enabled.-fipa-icf-functions,-fipa-icf-variables,-fipa-icfโ does 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. The optimization works more effectively with link-time optimization enabled.
Although the behavior is similar to the Gold Linker's ICF optimization, GCC ICF works on different levels and thus the optimizations are not same โ there are equivalences that are found only by GCC and equivalences found only by Gold.
-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 of the passes runs before register allocation and the other after register allocation. The main aim of the passes is to substitute definitions into all uses.
Most targets enable this flag by default at -O2 and -Os.
-flive-patching=levelโ controls GCC's optimizations to produce output suitable for live-patching ๐ if the compiler's optimization uses a function's body or information extracted from its body to optimize/change another function, the latter is called an impacted function of the former. If a function is patched, its impacted functions should be patched too.
The impacted functions are determined by the compiler's interprocedural optimizations. For example, a caller is impacted when inlining a function into its caller, cloning a function and changing its caller to call this new clone, or extracting a function's pureness/constness information to optimize its direct or indirect callers, etc.
Usually, the more IPA optimizations enabled, the larger the number of impacted functions for each function. In order to control the number of impacted functions and more easily compute the list of impacted function, IPA optimizations can be partially enabled at two different levels.
The level argument should be one of the following:
inline-cloneโ only enables inlining and cloning optimizations, which includes inlining, cloning, interprocedural scalar replacement of aggregates and partial inlining ๐ซถ as a result, when patching a function, all its callers and its clones' callers are impacted, therefore need to be patched as well.
-flive-patching=inline-clone disables the following optimization flags: -fwhole-program -fipa-pta -fipa-reference -fipa-ra -fipa-icf -fipa-icf-functions -fipa-icf-variables -fipa-bit-cp -fipa-vrp -fipa-pure-const -fipa-reference-addressable -fipa-stack-alignment -fipa-modref
inline-only-staticโ only enables inlining of static functions ๐ as a result, when patching a static function, all its callers are impacted and so need to be patched as well.
In addition to all the flags that -flive-patching=inline-clone disables, -flive-patching=inline-only-static disables the following additional optimization flags: -fipa-cp-clone -fipa-sra -fpartial-inlining -fipa-cp
When -flive-patching is specified without any value, the default value is inline-clone.
This flag is disabled by default.
Note that-flive-patchingis not supported with link-time optimization (-flto). ๐ญ
-fisolate-erroneous-paths-dereferenceโ detects paths that trigger erroneous or undefined behavior due to dereferencing a null pointer (with-fdelete-null-pointer-checksenabled) 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. This flag is enabled by default at-O2and 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 areturns_nonnullornonnullattribute ๐ 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-O2in the future.-ftree-sinkโ does forward store motion on trees ๐ธ this flag is enabled by default at-O1and higher.-ftree-bit-ccpโ does 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-O1and higher, except for-Og. It requires that-ftree-ccpis enabled.-ftree-ccpโ does sparse conditional constant propagation (CCP) on trees โญ this pass only operates on local scalar variables and is enabled by default at-O1and 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. The flag is enabled by default at-O1and higher.-fssa-phioptโ does pattern matching on SSA PHI nodes to optimize conditional code ๐ this pass is enabled by default at-O1and higher, except for-Og.-ftree-switch-conversionโ does conversion of simple initializations in a switch to initializations from a scalar array โจ this flag is enabled by default at-O2and higher.-ftree-tail-mergeโ looks for identical code sequences ๐ฅ when found, replaces one with a jump to the other. This optimization is known as tail merging or cross jumping. This flag is enabled by default at-O2and higher. The compilation time in this pass can be limited usingmax-tail-merge-comparisonsparameter andmax-tail-merge-iterationsparameter.-ftree-cselimโ does conditional store elimination on trees ๐ณ like it's cleaning out a closet. Enabled by default at-O1and higher, but only on targets that actually have conditional move instructions. iykyk ๐-ftree-dceโ dead code elimination (DCE) on trees ๐ชฆ bestie, if it's dead we're literally not keeping it. On by default at-O1and higher.-ftree-builtin-call-dceโ conditional dead code elimination (DCE), but specifically for calls to built-in functions that might seterrnoyet are otherwise free of side effects ๐ซถ. On by default at-O2and higher โ unless-Osis also specified, in which case nope ๐.-ffinite-loopsโ tells the compiler to assume a loop with an exit will eventually take that exit and not loop forever โณ. That means it can straight-up remove loops that otherwise have no side-effects, because it's not counting "eventual endless looping" as a side effect. Enabled by default at-O2for C++ with-std=c++11or higher. main character assumption energy fr ๐-ftree-dominator-optsโ a whole lil spa day of simple scalar cleanups based on a dominator tree traversal ๐ธ: constant/copy propagation, redundancy elimination, range propagation and expression simplification. It also does jump threading (to reduce jumps to jumps ๐ฆ). Enabled by default at-O1and higher.-ftree-dseโ dead store elimination (DSE) on trees ๐๏ธ. A dead store is when you store into a memory location and then it gets overwritten by another store with no loads in between โ so the earlier store can just be deleted, she's irrelevant. Enabled by default at-O1and higher.-ftree-chโ loop header copying on trees ๐. It's a slay because it increases the effectiveness of code motion optimizations, and it also saves one jump. Enabled by default at-O1and higher. Not enabled for-Os, since it usually increases code size (the tradeoff was not worth it, ngl).-ftree-loop-optimizeโ loop optimizations on trees ๐. Enabled by default at-O1and higher.-ftree-loop-linear,-floop-strip-mine,-floop-blockโ loop nest optimizations โจ. Same as-floop-nest-optimize. To use this code transformation, GCC has to be configured with--with-islto enable the Graphite loop transformation infrastructure. So like, check that first bestie ๐ซถ-fgraphite-identityโ enables the identity transformation for graphite ๐ช. For every SCoP we generate the polyhedral representation and transform it back to gimple. Using-fgraphite-identitywe can check the costs or benefits of theGIMPLE -> GRAPHITE -> GIMPLEtransformation. Some minimal optimizations are also performed by the code generator isl, like index splitting and dead code elimination in loops ๐-floop-nest-optimizeโ enables the isl based loop nest optimizer ๐. It's a generic loop nest optimizer based on the Pluto optimization algorithms, and it calculates a loop structure optimized for data-locality and parallelism. This option is experimental โ ๏ธ like bestie it works but she's still in beta.-floop-parallelize-allโ uses the Graphite data dependence analysis to identify loops that can be parallelized ๐ฅ. It parallelizes all the loops that can be analyzed to not contain loop carried dependences โ without checking that it's actually profitable to parallelize the loops. no vibe check, just vibes ๐ญ-ftree-coalesce-varsโ while transforming the program out of the SSA representation, it attempts to reduce copying by coalescing versions of different user-defined variables, instead of just compiler temporaries ๐ง. Heads up though: this may severely limit the ability to debug an optimized program compiled with-fno-var-tracking-assignments๐. In the negated form, this flag prevents SSA coalescing of user variables. Enabled by default if optimization is enabled, and it does very little otherwise (she's basically chilling).-ftree-loop-if-convertโ attempts to transform conditional jumps in the innermost loops into branch-less equivalents ๐. The intent is to remove control-flow from the innermost loops so the vectorization pass has an easier time handling these loops. Enabled by default if vectorization is enabled.-ftree-loop-distributionโ performs loop distribution ๐. This can improve cache performance on big loop bodies and allow further loop optimizations, like parallelization or vectorization, to take place. Example time, bestie โ this loop:
DO I = 1, N
A(I) = B(I) + C
D(I) = E(I) * F
ENDDO
is transformed to:
DO I = 1, N
A(I) = B(I) + C
ENDDO
DO I = 1, N
D(I) = E(I) * F
ENDDO
This flag is enabled by default at -O3. It is 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-O2and higher, and by-fprofile-useand-fauto-profile.
This pass distributes the initialization loops and generates a call to memset zero. For example, the loop:
DO I = 1, N
A(I) = 0
B(I) = A(I) + I
ENDDO
is transformed to:
DO I = 1, N
A(I) = 0
ENDDO
DO I = 1, N
B(I) = A(I) + I
ENDDO
and the initialization loop is transformed into a call to memset zero โจ the way that loop just became a memset? iconic.
-floop-interchangeโ performs loop interchange outside of graphite ๐ฆ. This flag can improve cache performance on loop nest and allow further loop optimizations, like vectorization, to take place. So like, 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];
is transformed to:
for (int i = 0; i < N; i++)
for (int k = 0; k < N; k++)
for (int j = 0; j < N; j++)
c[i][j] = c[i][j] + a[i][k]*b[k][j];
This flag is enabled by default at -O3. It is also enabled by -fprofile-use and -fauto-profile ๐
-floop-unroll-and-jamโ applies unroll and jam transformations on feasible loops ๐. In a loop nest this unrolls the outer loop by some factor and fuses the resulting multiple inner loops. Enabled by default at-O3. It is also enabled by-fprofile-useand-fauto-profile.-ftree-loop-imโ performs loop invariant motion on trees ๐. This pass moves only invariants that are hard to handle at RTL level (function calls, operations that expand to nontrivial sequences of insns). With-funswitch-loopsit 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 number of iterations in loops where figuring out the number of iterations requires complicated analysis ๐ตโ๐ซ. Later optimizations then may 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 in such a way that its value when exiting the loop can be determined using only its initial value and the number of loop iterations, it replaces uses of the final value by such a computation โ provided it is sufficiently cheap ๐ธ. This reduces data dependencies and may allow further simplifications. Enabled by default at-O1and higher.-fivoptsโ performs induction variable optimizations on trees ๐ (strength reduction, induction variable merging and induction variable elimination). Enabled by default at-O1and higher.-ftree-parallelize-loops,-ftree-parallelize-loops=nโ parallelizes loops, i.e., splits their iteration space to run in multiple threads ๐งต๐ฅ. This is only possible for loops whose iterations are independent and can be arbitrarily reordered. The optimization is only profitable on multiprocessor machines, for loops that are CPU-intensive, rather than constrained e.g. by memory bandwidth. This option implies-pthread, and thus is 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 โ lowkey the whole point, and we love her for it ๐
-ftree-ptaโ performs function-local points-to analysis on trees ๐. Enabled by default at-O1and 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-O1and higher, except for-Og.-fstore-mergingโ performing merging of narrow stores to consecutive memory addresses ๐ฆ. This pass merges contiguous stores of immediate values narrower than a word into fewer wider stores to reduce the number of instructions. Enabled by default at-O2and higher as well as-Os. efficiency queen ๐-ftree-terโ performs temporary expression replacement during the SSA->normal phase ๐. Single use/single def temporaries are replaced at their use location with their defining expression. This results in non-GIMPLE code, but gives the expanders much more complex trees to work on, resulting in better RTL generation โจ. Enabled by default at-O1and higher.-ftree-slsrโ performs straight-line strength reduction on trees ๐. This recognizes related expressions involving multiplications and replaces them by less expensive calculations when possible. Enabled by default at-O1and higher.-ftree-vectorizeโ performs vectorization on trees ๐. This flag enables-ftree-loop-vectorizeand-ftree-slp-vectorizeif not explicitly specified.-ftree-loop-vectorizeโ performs loop vectorization on trees ๐โจ. Enabled by default at-O2and by-ftree-vectorize,-fprofile-use, and-fauto-profile. go off bestie ๐-ftree-slp-vectorizeโ bestie, this 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. Free speed, no cap.-ftrivial-auto-var-init=choiceโ okay so this one is a whole thing, so buckle up ๐ This initializes automatic variables or temporary objects with either a pattern or with zeroes, to increase the security and predictability of a program by preventing uninitialized memory disclosure and use.
Here's the tea though: GCC still considers an automatic variable that doesn't have an explicit initializer as uninitialized. -Wuninitialized and -Wanalyzer-use-of-uninitialized-value will still report warning messages on such automatic variables 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.patternโ initialize automatic variables with values which will likely transform logic bugs into crashes down the line, are easily recognized in a crash dump and without being values that programmers can rely on for useful program semantics. The current value is byte-repeatable pattern with byte"0xFE". The values used for pattern initialization might be changed in the future.zeroโ initialize automatic variables with zeroes.
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 ๐ฆ
Lowkey important note: 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โ alter the cost model used for vectorization, bestie. The model argument should be one ofunlimited,dynamic,cheaporvery-cheapโญ- With the
unlimitedmodel the vectorized code-path is assumed to be profitable. - With the
dynamicmodel 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
cheapmodel 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 thedynamicmodel. - The
very-cheapmodel disables vectorization of loops when any runtime check for data dependence or alignment is required; it also disables vectorization of epilogue loops but otherwise is equal to thecheapmodel.
- With the
The default cost model depends on other optimization flags and is either dynamic or cheap.
-fsimd-cost-model=modelโ same energy but specifically for vectorization of loops marked with the OpenMPsimddirective ๐ The model argument should be one ofunlimited,dynamic,cheap. All values of model have the same meaning as described in-fvect-cost-modeland by default a cost model defined with-fvect-cost-modelis used.-ftree-vrpโ perform Value Range Propagation on trees ๐ฅ This is similar to the constant propagation pass, but instead of values, ranges of values are propagated. This allows the optimizers to remove unnecessary range checks like array bound checks and null pointer checks. This is enabled by default at-O2and higher. Null pointer check elimination is only done if-fdelete-null-pointer-checksis enabled, iykyk.-fsplit-pathsโ split paths leading to loop backedges โ๏ธ This can improve dead code elimination and common subexpression elimination. This is enabled by default at-O3and 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.
-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, not the whole thing, we're being selective โจ This option has any effect only when inlining itself is turned on by the-finline-functionsor-finline-small-functionsoptions.
Enabled at levels -O2, -O3, -Os.
-fpredictive-commoningโ perform predictive commoning optimization, i.e., reusing computations (especially memory loads and stores) performed in previous iterations of loops ๐
This option is enabled at level -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. So like, yolo, but responsibly.
Disabled at level -Os.
-fno-printf-return-valueโ do not substitute constants for known return value of formatted output functions such assprintf,snprintf,vsprintf, andvsnprintf(but notprintfoffprintf) ๐ 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-valueis in effect, both the branch and the body of theifstatement (but not the call tosnprint) can be optimized away wheniis 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-peepholeand-fno-peephole2is 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, bestie, we're keeping it honest ๐
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, pick your fighter ๐ The algorithm argument can besimple, which does not increase code size (except sometimes due to secondary effects like alignment), orstc, 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.ofiles, to improve paging and cache locality performance ๐
That whole optimization just dips out automatically when exception handling or unwind tables are around (like, on targets that use setjump/longjump or some target-specific scheme), and it also bails for linkonce sections, for functions with a user-defined section attribute, and on any architecture that doesn't support named sections ๐
. Oh and when -fsplit-stack is in play this option is not enabled by default (to dodge linker errors, bestie), but you can totally enable it explicitly if your linker is actually working ๐ซถ.
Enabled for x86 at levels -O2, -O3, -Os โจ.
-freorder-functionsโ reorders functions in the object file so the code locality gets better ๐. Unlike-fipa-reorder-for-locality, this one prioritises grouping all functions within a category (hot/normal/cold/never-executed) together. It does this using the special subsections.text.hotfor the most frequently executed functions and.text.unlikelyfor the ones that (probably) never run. The reordering is done by the linker, so the object file format must support named sections and the linker must place them reasonably. Ngl, this option isn't effective unless you either give it profile feedback (peep-fprofile-arcsfor the deets) or manually annotate functions with thehotorcoldattributes ๐.
Enabled at levels -O2, -O3, -Os โญ.
-fstrict-aliasingโ lets the compiler assume the strictest aliasing rules that apply to the language being compiled ๐. For C (and C++), this activates optimizations based on the type of the expressions. Specifically: you can't access an object of one type through an expression of a different type, unless the types are compatible types, differ only in signedness or qualifiers, or the expression has a character type. Accessing scalar objects via a corresponding vector type is also allowed โจ.
For example, an unsigned int can alias an int, but it can not alias a void* or a double. A character type may alias any other type ๐.
Pay special attention to code like this, okay? ๐
union a_union {
int i;
double d;
};
int f() {
union a_union t;
t.d = 3.0;
return t.i;
}
Reading from a different union member than the one you most recently wrote to (it's called "type-punning", iykyk) is super common. Even with -fstrict-aliasing, type-punning is allowed in C provided the memory is accessed through the union type ๐ซถ. In ISO C++, type-punning through a union type is undefined behavior, but GCC supports it as an extension. So the code above works as expected. However, this next one might not ๐ญ:
int f() {
union a_union t;
int* ip;
t.d = 3.0;
ip = &t.i;
return *ip;
}
Similarly, accessing 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-aliasingoption is enabled at levels-O2,-O3,-Os. Watch yourself!
-fipa-strict-aliasingโ controls whether the rules of-fstrict-aliasingget applied across function boundaries ๐ฆ. Small note: if multiple functions get inlined into a single function, those memory accesses are no longer considered to be crossing a function boundary ๐ .
The -fipa-strict-aliasing option is enabled by default and is effective only in combination with -fstrict-aliasing โจ.
-falign-functions-falign-functions=n-falign-functions=n:m-falign-functions=n:m:n2-falign-functions=n:m:n2:m2โ 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 of code performance, and alignment is ignored for functions considered cold. If you need alignment for all functions, use-fmin-function-alignmentinstead ๐.
If m isn't specified, it defaults to n.
Examples, because these hit different: -falign-functions=32 aligns functions to the next 32-byte boundary, -falign-functions=24 aligns to the next 32-byte boundary only if it can do so by skipping 23 bytes or less, and -falign-functions=32:7 aligns to the next 32-byte boundary only if it can do so 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, periodt ๐
.
If n isn't specified or is zero, it uses a machine-dependent default. The maximum allowed n option value is 65536 ๐.
Enabled at levels -O2, -O3 โญ.
-flimit-function-alignmentโ with this one on, the compiler tries to avoid unnecessarily overaligning functions ๐. It attempts to tell the assembler to align by the amount specified by-falign-functions, but not to skip more bytes than the size of the function. Clever, honestly.-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 โจ.
The 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, it uses 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 get executed a lot, this makes up for any execution of those dummy padding instructions. It's an optimization of code performance, and alignment is ignored for loops considered cold ๐ฅถ.
If -falign-labels is greater than this value, then its value is used instead.
Parameters are analogous to -falign-functions. -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, it uses 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, but only for branch targets that can only be reached by jumping ๐ฆ. In this case, no dummy operations need to be executed. It's an optimization of code performance, and alignment is ignored for jumps considered cold ๐ฅถ.
If -falign-labels is greater than this value, then its value is used instead.
Parameters are analogous to -falign-functions. -fno-align-jumps and -falign-jumps=1 are equivalent and mean loops are not aligned ๐
.
If n isn't specified or is zero, it uses a machine-dependent default. The maximum allowed n option value is 65536 ๐ซถ.
Enabled at levels -O2, -O3 โญ.
-fmin-function-alignmentโ specifies the minimal alignment of functions to the next power-of-two greater than or equal to n ๐. Unlike-falign-functions, this alignment also gets applied to all functions (even the cold ones ๐ฅถ). And the alignment is also not affected by-flimit-function-alignment๐.-fno-allocation-dceโ don't remove unused C++ allocations (usingoperator newandoperator delete) during dead code elimination ๐.
See also -fmalloc-dce ๐.
-fallow-store-data-racesโ allows the compiler to do optimizations that may introduce new data races on stores, without proving that the variable can't be concurrently accessed by other threads ๐ฅ. 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 already sitting in memory to be re-written with that same value ๐
. That kind of re-writing is safe single-threaded 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-timehas no effect, while-fno-unit-at-a-timeimplies-fno-toplevel-reorderand-fno-section-anchors.
Enabled by default โจ.
-fno-toplevel-reorderโ don't reorder top-level functions, variables, andasmstatements ๐ . Output them in the same order 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_unreachableinto 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 it 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 so this one constructs webs (as in the register-allocation kind, not the spider kind ๐ธ๏ธ) and gives each web its very own pseudo register. Why do we care? Because it lets the register allocation pass work directly on pseudos, and it also lowkey strengthens a bunch of other optimization passes โ CSE, the loop optimizer, and the trivial dead code remover all eat this up. ๐ The catch? It can make debugging straight-up impossible, because variables no longer stay in a "home register". So like, iconic for shipping, cursed forgdbgirlies. ๐ญ
Fun fact: it's enabled by default with -funroll-loops. โจ
-fwhole-programโ this is the compiler equivalent of "no thoughts, just vibes, this file IS the whole program". ๐ It assumes the current compilation unit represents the entire program being compiled. So every public function and variable โ exceptmainand the ones merged by the attributeexternally_visibleโ becomes a static function, and they get optimized way more aggressively by the interprocedural optimizers. Slay, but be careful, it's giving main character syndrome for real.
With -flto this option has 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's still useful if no linker plugin is used, or during the incremental link step when final code is produced (with -flto -flinker-output=nolto-rel).
-flto[=n]โ the big one, bestie. ๐ฅ This runs the standard link-time optimizer. When you invoke it with source code, it generates GIMPLE (one of GCC's internal representations) and writes it to special ELF sections in the object file. Then when the object files get 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. It's literally giving "we are one" energy. ๐ซถ
To use the link-time optimizer, -flto and optimization options should be specified at compile time and during the final link. It's 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
So 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. And because both foo.o and bar.o are merged into a single image, all the interprocedural analyses and optimizations in GCC work across the two files as if they were a single one. That means, for example, that the inliner is able to inline functions in bar.o into functions in foo.o and vice-versa. Crossover episode, we love to see it. ๐
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. Pick your fighter. โ๏ธ
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. She's organized like that. ๐
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. So like, do it at both stages or don't bother, fr fr. ๐
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:
B<-fPIC> + B<-fpic> = B<-fpic>
B<-fPIC> + B<-fno-pic> = B<-fno-pic>
B<-fpic/-fPIC> + (no option) = (no option)
B<-fPIC> + B<-fPIE> = B<-fPIE>
B<-fpic> + B<-fPIE> = B<-fpie>
B<-fPIC/-fpic> + B<-fpie> = B<-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. Like, the compiler is not taking feedback on this one, bestie. ๐ซ
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 of code not consistent with the setting at compile time. Slightly chaotic, but that's the vibe check. ๐ธ
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. (Read: don't do it, it's giving messy. ๐)
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. So like, it'll warn you, but the chaos is still on you. ๐ญ
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. Multicultural queen behavior. ๐
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. It's giving teamwork, it's giving collaboration. ๐ซถ
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. Best of both worlds, exactly like we deserve. โจ
Okay so bestie, link-time optimizations do not require the whole program to be present to operate. If the program doesnโt require any symbols to be exported, it is possible to combine -flto and -fwhole-program to let the interprocedural optimizers use more aggressive assumptions, which may lead to improved optimization opportunities. Use of -fwhole-program is not needed when the linker plugin is active (see -fuse-linker-plugin). ๐
The current implementation of LTO makes no attempt to generate bytecode that is portable between different types of hosts. The bytecode files are versioned and there is a strict version check, so bytecode files generated in one version of GCC do not work with an older or newer version of GCC. ๐ญ
Link-time optimization does not work well with generation of debugging information on systems other than those using a combination of ELF and DWARF. Noted, bestie. ๐ซถ
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 either1to1to specify a partitioning mirroring the original source files, orbalancedto specify partitioning into equally sized chunks (whenever possible), ormaxto create a new partition for every symbol where possible, orcacheto balance chunk sizes while keeping related symbols together for better caching in incremental LTO. Specifyingnoneas an algorithm disables partitioning and streaming completely. The default value isbalanced. While1to1can be used as a workaround for various code ordering issues, themaxpartitioning is intended for internal testing only. The valueonespecifies that exactly one partition should be used, while the valuenonebypasses 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; 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. Forzstd, valid values are0(no compression) to19(maximum compression), whilezlibsupports values from0to9. Values outside this range are clamped to either the 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 markedextern. ๐-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 ingoldor in GNUld2.21or 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-fltofor 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 (GNUld2.21or newer orgold). ๐ฅ-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-fltoand is ignored at link time.-fno-fat-lto-objectsimproves 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,arandranlibneed to support linker plugins to allow a full-featured build environment (capable of building static libraries etc). GCC provides thegcc-ar,gcc-nm,gcc-ranlibwrappers 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-pluginshas the same effect as usage of the command wrappers (gcc-ar,gcc-nmandgcc-ranlib). The default is-fno-fat-lto-objectson 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
Okay so picking right back up with the AutoFDO tea โโจ: path is the name of a file containing AutoFDO profile information. If you leave it out, it defaults to fbdata.afdo in the current directory. ๐
To actually produce an AutoFDO profile data file, you gotta run your program with the perf utility on a supported GNU/Linux target system. For more info, see <https://perfwiki.github.io/main/>. ๐ง๐
E.g.
perf record -e br_inst_retired:near_taken -b -o perf.data \
-- your_program
Then use the create_gcov tool to convert the raw profile data into a format GCC can use. You also have to supply the unstripped binary for your program to this tool. See <https://github.com/google/autofdo>. ๐ ๏ธโจ
E.g.
create_gcov --binary=your_program.unstripped --profile=perf.data \
--gcov=profile.afdo
-fauto-profile-inliningโ when auto-profile is available, inline all relevant functions which was inlined in the tran run before reading the profile feedback. This improves context sensitivity of the profile. Enabled by default. ๐๐
The following options control compiler behavior regarding floating-point arithmetic ๐งฎโจ. These options trade off between speed and correctness. All must be specifically enabled โ no sneaky defaults doing the work for you, bestie.
-fexcess-precision=styleโ this option 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 where floating-point types get interchanged. 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; this means operations may be carried out in a wider precision than the types specified in the source if that would result in faster code, and it is unpredictable when rounding to the types specified in the source code takes place. When compiling C or C++, if -fexcess-precision=standard is specified then excess precision follows the rules specified in ISO C99 or C++; in particular, both casts and assignments cause values to be rounded to their semantic types (whereas -ffloat-store only affects assignments). This option is enabled by default for C or C++ if a strict conformance option such as -std=c99 or -std=c++17 is used. -ffast-math enables -fexcess-precision=fast by default regardless of whether a strict conformance option is used. If -fexcess-precision=16 is specified, constants and the results of expressions with types _Float16 and __bf16 are computed without excess precision. โก๐ฌ
-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. 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-storehandles rounding to IEEE format only on assignments and not casts as-fexcess-precision=standarddoes. ๐ง ๐พ-ffast-mathโ sets the options-fno-math-errno,-funsafe-math-optimizations,-ffinite-math-only,-fno-rounding-math,-fno-signaling-nans,-fcx-limited-rangeand-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 seterrnoafter 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-zerosand-fno-trapping-mathbe in effect. Moreover, it doesn't make much sense with-frounding-math. For Fortran the option is automatically enabled when both-fno-signed-zerosand-fno-trapping-mathare 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 examplex / ycan be replaced withx * (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.0and-0.0values, which then prohibits simplification of expressions such asx+0.0or0.0*x(even with-ffinite-math-only). This option implies that the sign of a zero result isn't significant. ๐ฅถ0๏ธโฃ
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-nansbe 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 makes floating-point constants be treated as single precision instead of quietly getting upgraded to double-precision constants. no sneaky silent promotion ๐-fcx-limited-rangeโ when it's on, you're telling the compiler: "nah, we don't need a range reduction step when doing complex division." also it skips checking whether the result of a complex multiplication or division is"NaN + I*NaN"with a rescue attempt for that situation. it's turned on by-ffast-math. โจ
this option controls the default setting of the ISO C99 "CX_LIMITED_RANGE" pragma. but also โ important โ the option applies to all languages, not just C. ๐
-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"with an attempt to rescue it in that case. ๐ซถ- *
-fcx-method=method* โ complex multiplication and division follow whatever method you state. the method argument should be one oflimited-range,fortranorstdc. ๐
the default is to honor language specific constraints, which means fortran for Fortran and stdc otherwise. iykyk
okay so the next batch of options? they control optimizations that may improve performance, but none of the -O options enable them. and heads up, this section includes experimental options that may produce broken code ๐
-fbranch-probabilitiesโ after you've run a program compiled with-fprofile-arcs, you can compile it a second time using-fbranch-probabilitiesto get better optimizations based on how many times each branch was actually taken. when a program compiled with-fprofile-arcsexits, it saves arc execution counts to a file calledsourcename.gcdafor 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. file naming details live over in-fprofile-arcs. ๐
with -fbranch-probabilities, GCC puts a REG_BR_PROB note on each JUMP_INSN and CALL_INSN. those 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. slay.
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, which collects the first time of execution of a function and orders those functions in ascending order. the goal? optimize program startup through more efficient loading of text segments. literally main character energy for your startup time. โญ
enabled with -fprofile-use.
-fvptโ if combined with-fprofile-arcs, this tells the compiler to add code to gather info about values of expressions. ๐ง
with -fbranch-probabilities, it reads back the data gathered and actually performs the optimizations based on them. currently the optimizations include specialization of division operations using the knowledge about the value of the denominator.
enabled with -fprofile-use and -fauto-profile.
-frename-registersโ attempts to avoid false dependencies in scheduled code by using registers left over after register allocation. this optimization most benefits processors with lots of registers. but depending on the debug info format your target adopted, it can make debugging impossible, since variables no longer stay in a "home register". ๐ญ
enabled by default with -funroll-loops.
-fschedule-fusionโ does 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 when they're adjacent to each other in the instruction flow. ๐ฅ
enabled at levels -O2, -O3, -Os.
-fdep-fusionโ detects macro-op fusible pairs made of single-use instructions and their uses, and places those pairs together in the instruction stream to increase fusion opportunities in hardware. this pass runs once before register allocation, and another time before register renaming. ๐
enabled at levels -O2, -O3, -Os.
-ftracerโ performs tail duplication to enlarge superblock size. this transformation simplifies the control flow of the function, which lets other optimizations do a better job. โจ
enabled by -fprofile-use and -fauto-profile.
-funroll-loopsโ unrolls loops whose number of iterations can be determined at compile time or upon entry to the loop.-funroll-loopsimplies-frerun-cse-after-loop,-fweband-frename-registers. it also turns on complete loop peeling (i.e. complete removal of loops with a small constant number of iterations). this option makes code larger, and may or may not make it run faster. ๐
enabled by -fprofile-use and -fauto-profile.
-funroll-all-loopsโ unrolls all loops, even if their number of iterations is uncertain when the loop is entered. this usually makes programs run more slowly ๐ฌ.-funroll-all-loopsimplies the same options as-funroll-loops.-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โ controls 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=1is used, only calls to"free"are allowed, while with-fmalloc-dce=2comparisons with"NULL"pointer are also 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-O1and 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-imhas to be enabled as well. enabled at level-O1and higher, except for-Og. ๐ธ-fsplit-loopsโ splits a loop into two if it contains a condition that's always true for one side of the iteration space and false for the other. ๐ช
enabled by -fprofile-use and -fauto-profile.
-funswitch-loopsโ moves 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, it creates 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โ these two put each function or data item into its own section in the output file, if the target supports arbitrary sections. the name of the function or the name of the data item determines the section's name in the output file. โจ
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.
okay bestie, listen: only use these options when there are significant benefits from doing so. when you specify them, the assembler and linker create larger object and executable files and are also slower. these options affect code generation โ they prevent optimizations by the compiler and assembler using relative locations inside a translation unit, since the locations are unknown until link time. an example of such an optimization is relaxing calls to short call instructions. ๐ญ
-fstdarg-optโ optimizes the prologue of variadic argument functions with respect to usage of those arguments. ๐ซถ-fsection-anchorsโ tries to reduce the number of symbolic address calculations by using shared"anchor"symbols to address nearby objects. this transformation can help reduce the number of GOT entries and GOT accesses on some targets. ๐
for example, the implementation of the following function "foo":
static int a, b, c;
int foo (void) { return a + b + c; }
usually calculates the addresses of all three variables, but if you compile it with -fsection-anchors, it accesses the variables from a common anchor point instead. the effect is similar to the following pseudocode (which isn't valid C):
int foo (void)
{
register int *xr = &x;
return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
}
not all targets support this option. ๐
-fzero-call-used-regs=choiceโ zeroes out call-used registers when a function returns, which boosts program security by either mitigating Return-Oriented Programming (ROP) attacks or stopping info from leaking through registers. The possible values of choice are the same as for thezero_call_used_regsattribute, and the default isskip. You can control this behavior for a specific function by using the function attributezero_call_used_regs. ๐ก๏ธโจ
โจ Program Instrumentation Options โจ
GCC supports a bunch of command-line options that control adding run-time instrumentation to the code it normally generates. Like, one purpose of instrumentation is collecting profiling statistics for finding program hot spots, code coverage analysis, or profile-guided optimizations. Another whole class of program instrumentation is adding run-time checking to detect programming errors like invalid pointer dereferences or out-of-bounds array accesses, plus deliberately hostile attacks such as stack smashing or C++ vtable hijacking. There is also a general hook that can be used to implement other forms of tracing or function-level instrumentation for debug or program analysis purposes. ๐ ๐ฆ
-p,--profile,-fprofile,-pgโ generate extra code to write profile information suitable for the analysis programprof(for-p,--profile, and-fprofile) orgprof(for-pg). You must use this option when compiling the source files you want data about, and you must also use it when linking. You can use the function attributeno_instrument_functionto suppress profiling of individual functions when compiling with these options. ๐-fprofile-arcsโ adds code so that program flow arcs are instrumented. During execution the program records how many times each branch and call is executed and how many times it is taken or returns. On targets that support constructors with priority support, profiling properly handles constructors, destructors and C++ constructors (and destructors) of classes which are used as a type of a global variable. When the compiled program exits it saves this data to a file calledauxname.gcdafor each source file. The data may be used for profile-directed optimizations (-fbranch-probabilities), or for test coverage analysis (-ftest-coverage). Each object file's auxname is generated from the name of the output file, if explicitly specified and it is not the final executable, otherwise it is the basename of the source file. In both cases any suffix is removed (e.g.foo.gcdafor input filedir/foo.c, ordir/foo.gcdafor output file specified as-o dir/foo.o). Note that if a command line directly links source files, the corresponding.gcdafiles will be prefixed with the unsuffixed name of the output file. E.g.gcc a.c b.c -o binarywould generatebinary-a.gcdaandbinary-b.gcdafiles. ๐-fcondition-coverageโ adds code so that program conditions are instrumented. During execution the program records what terms in a conditional contributes to a decision, which can be used to verify that all terms in a Boolean function are tested and have an independent effect on the outcome of a decision. The result can be read withgcov --conditions. ๐ง-fpath-coverageโ adds code so that the paths taken are tracked. During execution the program records the prime paths taken. The number of paths grows very fast with complexity, and to avoid exploding compile times GCC will give up instrumentation if the approximate number of paths exceeds the limit controlled by-fpath-coverage-limit. The result can be read withgcov --prime-paths --prime-paths-lines --prime-paths-source, ๐-fpath-coverage-limit=limitโ the threshold at which point-fpath-coveragegives up on instrumenting a function. This limit is approximate and conservative, as GCC uses a pessimistic heuristic which slightly overcounts the running number of paths, and gives up if the threshold is reached before finding all the paths. This option is not for fine grained control over which functions to instrument โ rather it is intended to limit the effect of path explosion and keep compile times reasonable. The default is250000. ๐--coverage,-coverageโ this option is used to compile and link code instrumented for coverage analysis. The options-coverageand--coverageare 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. ๐- Compile the source files with
-fprofile-arcsplus optimization and code generation options. For test coverage analysis, use the additional-ftest-coverageoption. You do not need to profile every source file in a program. - Compile the source files additionally with
-fprofile-abs-pathto create absolute path names in the.gcnofiles. This allowsgcovto find the correct sources in projects where compilations occur with different working directories. - Link your object files with
-lgcovor-fprofile-arcs(the latter implies the former). - 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,
forkcalls are detected and correctly handled without double counting. Moreover, an object file can be recompiled multiple times and the corresponding.gcdafile merges as long as the source file and the compiler options are unchanged. - For profile-directed optimizations, compile the source files again with the same optimization and code generation options plus
-fbranch-probabilities. - For test coverage analysis, use
gcovto produce human readable information from the.gcnoand.gcdafiles. Refer to thegcovdocumentation for further information.
- Compile the source files with
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โ produce a notes file that thegcovcode-coverage utility can use to show program coverage. Each source file's note file is calledauxname.gcno. Refer to the-fprofile-arcsoption above for a description of auxname and instructions on how to generate test coverage data. Coverage data matches the source files more closely if you do not optimize. ๐-fprofile-abs-pathโ automatically convert relative source file names to absolute path names in the.gcnofiles. This allowsgcovto find the correct sources in projects where compilations occur with different working directories. ๐ฅ-fprofile-dir=pathโ set 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-arcsand used by-fprofile-useand-fbranch-probabilitiesand 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 thesourcename.gcdafile and use it as the file name of a.gcdafile. 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 is 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 variableVAR. ๐
-fprofile-generate,-fprofile-generate=pathโ enable options usually used for instrumenting application to produce profile useful for later recompilation with profile feedback based optimization. You must use-fprofile-generateboth 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-arcsis 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. ๐
Okay so picture this: the linker could collect the input sections in one continuous memory block and define start and end symbols. ๐ A GNU linker script example that defines a linker output section is literally this:
.gcov_info :
{
PROVIDE (__gcov_info_start = .);
KEEP (*(.gcov_info))
PROVIDE (__gcov_info_end = .);
}
And a program could dump the profiling information registered in this linker set, like, for example, this whole thing:
#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;
}
Then 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. ๐ซถ
Now, the flags. Buckle up, bestie โ this batch is giving profile-and-sanitizer main character energy. โจ
-fprofile-note=pathโ if path is specified, GCC saves.gcnofile into path location. If you combine the option with multiple source files, the.gcnofile will be overwritten. ๐ญ-fprofile-prefix-path=pathโ this one can be used in combination withprofile-generate=profile_dirandprofile-use=profile_dirto inform GCC where the base directory of the built source tree is.- By default,
profile_dirwill contain files with mangled absolute paths of all object files in the built project. - That is not desirable 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=pathwith 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.
- By default,
-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-mapand-fcanon-prefix-map.-fprofile-update=methodโ alter the update method for an application instrumented for profile feedback based optimization. The method argument should be one ofsingle,atomicorprefer-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 a detached thread), a profile file can still be corrupted.
- Using
prefer-atomicwould be transformed either toatomic, when supported by a target, or tosingleotherwise. The GCC driver automatically selectsprefer-atomicwhen-pthreadis present in the command line, otherwise the default method issingle. - If
atomicis 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,libatomicis available, then the profile information is updated through calls tolibatomic. If the target platform neither supports the required atomic operations in hardware norlibatomic, 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.*\.cwill instrument onlymain.cand all C files starting with'module'.
- For example,
-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.
- For example,
-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. The values aremultithreaded,parallel-runs, andserial.- With
-fprofile-reproducible=serialthe profile gathered by-fprofile-generateis 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 beforeforkfunction 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_functionfunction attribute.gcov-dumpwith-lcan be used to dump gathered data and verify that they are indeed reproducible. - With
-fprofile-reproducible=parallel-runscollected 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 withmake -j). This reduces quality of gathered data, in particular of indirect call profiling.
- With
-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. Seehttps://github.com/google/sanitizers/wiki/AddressSanitizerfor more details. The run-time behavior can be influenced using theASAN_OPTIONSenvironment variable. When set tohelp=1, the available options are shown at startup of the instrumented program. Seehttps://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flagsfor a list of supported options. The option cannot be combined with-fsanitize=threador-fsanitize=hwaddress. Note that the only targets-fsanitize=hwaddressis currently supported on are x86-64 (only with-mlam=u48or-mlam=u57options) and AArch64, in both cases only in ABIs with 64-bit pointers. Similarly,-fsanitize=memtag-stackis currently only supported on AArch64 ABIs with 64-bit pointers.- When compiling with
-fsanitize=address, you should also use-gto 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-pointeralso 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 withsetarch `uname -m` -R ./prog.
- When compiling with
-fsanitize=kernel-addressโ enable AddressSanitizer for Linux kernel. Seehttps://github.com/google/kernel-sanitizersfor 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. Seehttps://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.htmlfor more details. The run-time behavior can be influenced using theHWASAN_OPTIONSenvironment variable. When set tohelp=1, the available options are shown at startup of the instrumented program. The option cannot be combined with-fsanitize=threador-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-addressbut with a whole different instrumentation method, and like-fsanitize=hwaddressbut with the tweaks you need for kernel compilation. those tweaks exist so we (a) avoid hwasan library initialization calls and (b) account for the stack pointer having a different value in its top byte ๐ซถ
Note: this option has different defaults than-fsanitize=hwaddress. instrumenting the stack andallocacalls are not on by default, and using a random frame tag is not implemented for kernel instrumentation. no cap.
-fsanitize=memtag-stackโ uses Memory Tagging Extension instructions instead of instrumentation so you can catch memory errors โจ it's similar to HWASAN in that it's also a probabilistic method, bestie. heads up: this one is 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-addressor-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 variableASAN_OPTIONS. using"detect_invalid_pointer_pairs=1"detects the invalid operation only when both pointers are non-null ๐-fsanitize=pointer-subtractโ instruments subtraction with pointer operands ๐ฅ same rules, bestie: it must be combined with either-fsanitize=kernel-addressor-fsanitize=address, and it cannot be combined with-fsanitize=thread. Note: by default the check is disabled at run time โ enable it by adding"detect_invalid_pointer_pairs=2"to the environment variableASAN_OPTIONS. using"detect_invalid_pointer_pairs=1"detects the 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 way 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, and 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 yes, 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 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's 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 ๐ฆ
-fsanitize=threadโ enables ThreadSanitizer, a fast data race detector ๐ฅ memory access instructions are instrumented to detect data race bugs. see <https://github.com/google/sanitizers/wiki#threadsanitizer> for more details. the run-time behavior can be influenced using theTSAN_OPTIONSenvironment variable; see <https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags> for a list of supported options. this option cannot be combined with-fsanitize=address,-fsanitize=leak.
when compiling with -fsanitize=thread, you should also use -g to produce more meaningful output, bestie ๐
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. the run-time behavior can be influenced using theLSAN_OPTIONSenvironment variable. the option cannot be combined with-fsanitize=thread.-fsanitize=undefinedโ enables UndefinedBehaviorSanitizer, a fast undefined behavior detector โจ various computations are instrumented to detect undefined behavior at runtime. see <https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html> for more details. the run-time behavior can be influenced using theUBSAN_OPTIONSenvironment variable. current suboptions are:-fsanitize=shiftโ this enables checking that the result of a shift operation is not undefined ๐ note that what exactly is considered undefined differs slightly between C and C++, as well as between ISO C90 and C99, etc. this option has two suboptions:-fsanitize=shift-baseand-fsanitize=shift-exponent.-fsanitize=shift-exponentโ this enables checking that the second argument of a shift operation is not negative and is smaller than the precision of the promoted first argument ๐-fsanitize=shift-baseโ if the second argument of a shift operation is within range, check that the result of a shift operation is not undefined. note that what exactly is considered undefined differs slightly between C and C++, as well as between ISO C90 and C99, etc. ๐-fsanitize=integer-divide-by-zeroโ detect integer division by zero. iconic behavior honestly ๐-fsanitize=unreachableโ with this option, the compiler turns the"__builtin_unreachable"call into a diagnostics message call instead. when reaching the"__builtin_unreachable"call, the behavior is undefined ๐-fsanitize=vla-boundโ this instructs the compiler to check that the size of a variable length array is positive ๐ธ-fsanitize=nullโ this enables pointer checking. particularly, an application built with this option turned on will issue an error message when it tries to dereference aNULLpointer, or if a reference (possibly an rvalue reference) is bound to aNULLpointer, or if a method is invoked on an object pointed by aNULLpointer ๐ญ-fsanitize=returnโ this enables return statement checking. programs built with this option turned on will issue an error message when the end of a non-void function is reached without actually returning a value. this option works in C++ only ๐ซถ-fsanitize=signed-integer-overflowโ this enables signed integer overflow checking ๐ฅ we check that the result of"+","*", and both unary and binary"-"does not overflow in the signed arithmetics. this also detects"INT_MIN / -1"signed division. note, integer promotion rules must be taken into account. that is, the following is not an overflow:
signed char a = SCHAR_MAX;
a++;
-fsanitize=boundsโ this enables instrumentation of array bounds. various out of bounds accesses are detected โจ flexible array members, flexible array member-like arrays, and initializers of variables with static storage are not instrumented โ with the exception of flexible array member-like arrays for which"-fstrict-flex-arrays"or"-fstrict-flex-arrays="options or"strict_flex_array"attributes say they shouldn't be treated like flexible array member-like arrays ๐-fsanitize=bounds-strictโ this 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โ this 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โ this enables instrumentation of memory references using the"__builtin_dynamic_object_size"function. various out of bounds pointer accesses are detected ๐ฆ-fsanitize=float-divide-by-zeroโ detect floating-point division by zero. unlike other similar options,-fsanitize=float-divide-by-zerois 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โ this enables floating-point type to integer conversion checking. we check that the result of the conversion does not overflow. unlike other similar options,-fsanitize=float-cast-overflowis not enabled by-fsanitize=undefined. this option does not work well with"FE_INVALID"exceptions enabled ๐-fsanitize=nonnull-attributeโ this enables instrumentation of calls, checking whether null values are not passed to arguments marked as requiring a non-null value by the"nonnull"function attribute โญ-fsanitize=returns-nonnull-attributeโ this enables instrumentation of return statements in functions marked with"returns_nonnull"function attribute, to detect returning of null values from such functions ๐-fsanitize=boolโ this enables instrumentation of loads from bool. if a value other than 0/1 is loaded, a run-time error is issued ๐ฅ-fsanitize=enumโ this 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โ bestie this one instruments C++ member function calls, member accesses, and some conversions between pointers to base and derived classes, all so it can verify the referenced object has the correct dynamic type โจ-fsanitize=pointer-overflowโ this instruments pointer arithmetics, and if the pointer arithmetics overflows, a run-time error gets issued ๐ซถ-fsanitize=builtinโ this one instruments the arguments to selected builtin functions, and if an invalid value gets passed to such arguments, a run-time error is issued. Case in point: passing0as the argument to__builtin_ctzor__builtin_clzinvokes undefined behavior and is diagnosed by this option ๐
okay important vibe check: sanitizers tend to increase the rate of false positive warnings, most notably those around-Wmaybe-uninitialized. We recommend against combining-Werrorand [the use of] sanitizers. no cap, just don't ๐
Also, while -ftrapv causes traps for signed overflows to be emitted, -fsanitize=undefined gives a diagnostic message. This currently works only for the C family of languages.
-fno-sanitize=allโ this disables all previously enabled sanitizers. And ngl,-fsanitize=allis not allowed, because some sanitizers cannot be used together ๐-fasan-shadow-offset=numberโ forces GCC to use a custom shadow offset in AddressSanitizer checks. It's useful for experimenting with different shadow memory layouts in Kernel AddressSanitizer ๐ง-fsanitize-sections=s1,s2,...โ sanitize global variables in selected user-defined sections. Heads up:simay contain wildcards โญ-fsanitize-recover[=opts]โ so-fsanitize-recover=controls error recovery mode for the sanitizers mentioned in the comma-separated list of opts. Enabling this option for a sanitizer component causes it to attempt to continue running the program as if no error happened ๐ญ
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 can be used to alter this behavior: 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 and -fsanitize=address. For these sanitizers error recovery is turned on by default, except -fsanitize=address, for which this feature is experimental. -fsanitize-recover=all and -fno-sanitize-recover=all is also accepted โ the former enables recovery for all sanitizers that support it, the latter disables recovery for all sanitizers that support it ๐
Even if a recovery mode is turned on the compiler side, it needs to be also enabled on the runtime library side, otherwise the failures are still fatal. The runtime library defaults to halt_on_error=0 for ThreadSanitizer and UndefinedBehaviorSanitizer, while the default value for AddressSanitizer is halt_on_error=1. This can be overridden through setting the halt_on_error flag in the corresponding environment variable ๐ฅ
real talk: syntax without an explicit opts parameter is deprecated. It's equivalent to specifying an opts list of: undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
-fsanitize-address-use-after-scopeโ enables sanitization of local variables to detect use-after-scope bugs. The option sets-fstack-reusetonone๐ฆ-fsanitize-trap[=opts]โ this option instructs the compiler to report for the sanitizers mentioned in the comma-separated list of opts undefined behavior using__builtin_traprather than alibubsanlibrary routine. If this option is enabled for a certain sanitizer, it takes precedence over the-fsanitizer-recover=for that sanitizer โ__builtin_trapwill be emitted and be fatal regardless of whether recovery is enabled or disabled using-fsanitize-recover=๐
The advantage of this is that the libubsan library is not needed and is not linked in, so this is usable even in freestanding environments โจ
Currently this feature works with -fsanitize=undefined (and its suboptions except for -fsanitize=vptr), -fsanitize=float-cast-overflow, -fsanitize=float-divide-by-zero and -fsanitize=bounds-strict. -fsanitize-trap=all can be also specified, which enables it for undefined suboptions, -fsanitize=float-cast-overflow, -fsanitize=float-divide-by-zero and -fsanitize=bounds-strict. If -fsanitize-trap=undefined or -fsanitize-trap=all is used and -fsanitize=vptr is enabled on the command line, the instrumentation is silently ignored as the instrumentation always needs libubsan support, and -fsanitize-trap=vptr is not allowed ๐
-fsanitize-undefined-trap-on-errorโ this option is the deprecated equivalent of-fsanitize-trap=all๐-fsanitize-coverage=trace-pcโ enables coverage-guided fuzzing code instrumentation. It inserts a call to__sanitizer_cov_trace_pcinto every basic block ๐ฅ-fsanitize-coverage=trace-cmpโ enables dataflow guided fuzzing code instrumentation. It inserts a call to__sanitizer_cov_trace_cmp1,__sanitizer_cov_trace_cmp2,__sanitizer_cov_trace_cmp4or__sanitizer_cov_trace_cmp8for integral comparison with both operands variable, or__sanitizer_cov_trace_const_cmp1,__sanitizer_cov_trace_const_cmp2,__sanitizer_cov_trace_const_cmp4or__sanitizer_cov_trace_const_cmp8for integral comparison with one operand constant, plus__sanitizer_cov_trace_cmpfor__sanitizer_cov_trace_cmpdfor float or double comparisons, and__sanitizer_cov_trace_switchfor switch statements ๐ง-fcf-protection=[full|branch|return|none|check],-fcf-protectionโ this enables code instrumentation to increase program security by checking that target addresses of control-flow transfer instructions (such as indirect function call, function return, indirect jump) are valid. It prevents diverting the flow of control to an unexpected target, and it's intended to protect against such threats as Return-oriented Programming (ROP), and similarly call/jmp-oriented programming (COP/JOP) ๐
The -fcf-protection= keywords are interpreted as follows:
- The value
branchtells 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
returnimplements checking of validity at the point of returning from a function. - The value
fullis an alias for specifying bothbranchandreturn. - The value
checkis used for the final link with link-time optimization (LTO). An error is issued if LTO object files are compiled with different-fcf-protectionvalues. The valuecheckis ignored at the compile time. - The value
noneturns 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 the 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 (for example, conditions tested for conditional moves, or to store in boolean variables), emit extra code to compute and verify the reversed condition, and to call__builtin_trapif the results do not match. Use with-fharden-conditional-branchesto cover all conditionals ๐ฅ-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_trapif the result is unexpected. Use with-fharden-comparesto 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 โ though these possibilities are merely theoretical, as these conditions can only be met when using custom compiler plugins ๐
-fhardcfr-skip-leafโ disable-fharden-control-flow-redundancyin leaf functions ๐-fhardcfr-check-exceptionsโ when-fharden-control-flow-redundancyis 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-exceptionsto disable it โจ-fhardcfr-check-returning-callsโ when-fharden-control-flow-redundancyis 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-redundancyis doing its thing, this decides whether we check the recorded execution path against the control flow graph beforenoreturncalls. Your picks are:always(check, like, all of them ๐ ),no-xthrow(only the ones that aren't expected to hand control back to the caller via an exception โ this is the default, bestie),nothrow(the ones that may not return through an exception either), ornever(check none of them, we're chilling).
And here's the tea ๐ซ: checking before a noreturn function that may return control to the caller through an exception can make checking happen more than once if the exception gets caught in the caller โ whether by a handler or a cleanup. And when -fhardcfr-check-exceptions is also enabled, the compiler will avoid associating a noreturn call with the implicitly-added cleanup handler, since that'd be redundant with the check done before the call. But other handlers or cleanups in the function, if they get activated, will modify the recorded execution path and check it again when another checkpoint is hit. The checkpoint may even be another noreturn call, so yeah, checking may end up performed multiple times ๐ญ.
Also, various optimizers may cause calls to be marked as noreturn and/or nothrow even when the corresponding attributes aren't there, which can affect where checks get placed before calls and the addition of implicit cleanup handlers for them. This unpredictability, plus the fact that raising and reraising exceptions frequently amounts to implicitly calling noreturn functions, is why no-xthrow is the default for this option: it excludes from noreturn treatment only the internal functions used to (re)raise exceptions, which aren't affected by these optimizations. Slay, sensible defaults โจ.
-fhardenedโ turns on a whole little squad of flags for C and C++ that level up the security of the generated code without affecting its ABI ๐ก๏ธ. The exact flags may change between major releases of GCC, but right now they're:
-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 see the whole list of what -fhardened enables with the --help=hardened option ๐.
If your system glibc is older than 2.35, it uses -D_FORTIFY_SOURCE=2 instead.
This one's meant for production builds, not just debug builds โ like, wear your cute outfit to the party, not just to try it on ๐.
Currently -fhardened is only supported on GNU/Linux targets.
And here's the polite part: -fhardened only enables a particular option if it wasn't already specified anywhere on the command line. So like, -fhardened -fstack-protector will only enable -fstack-protector, but not -fstack-protector-strong. It respects your choices, icon behaviour ๐.
-fstack-protectorโ emits extra code to check for buffer overflows, like stack smashing attacks ๐ฅ. It does this by adding a guard variable to functions with vulnerable objects โ that includes functions that callalloca, and functions with buffers larger than or equal to 8 bytes. The guards get initialized when a function is entered and then checked when it exits. If a guard check fails, an error message is printed and the program exits. Only variables actually allocated on the stack count; optimized-away variables or variables allocated in registers don't count, sorry bestie ๐ .-fstack-protector-allโ like-fstack-protectorexcept all functions are protected. Everyone gets a bodyguard, no cap ๐-fstack-protector-strongโ like-fstack-protectorbut it includes extra functions in the protection squad โ those that have local array definitions, or that have references to local frame addresses ๐ซถ. Again, only variables actually allocated on the stack are considered; optimized-away variables or ones in registers don't count.-fstack-protector-explicitโ like-fstack-protectorbut it only protects those functions which have thestack_protectattribute. Exclusive club, invite only โจ-fstack-checkโ generates code to verify you don't go beyond the boundary of the stack ๐ง. You should specify this flag if you're running in an environment with multiple threads, but you only rarely need it in a single-threaded environment, since stack overflow is automatically detected on nearly all systems when there's only one stack.
Important caveat, 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 make sure they see the stack being extended ๐.
You can additionally specify a string parameter: no means no checking, generic means force the use of old-style checking, 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 it comes with these drawbacks ๐ฌ:
- 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.
- Fixed limit on the size of the static frame of functions: when it's topped by a particular function, stack checking isn't reliable and a warning is issued by the compiler.
- Inefficiency: because of both the modified allocation strategy and the generic implementation, code performance is hampered. ๐
Note that old-style stack checking is also the fallback method for specific if no target support has been added in the compiler.
-fstack-check= is designed for Ada's needs to detect infinite recursion and stack overflows. specific is an excellent choice when compiling Ada code. It's not generally sufficient to protect against stack-clash attacks though โ to protect against those you want -fstack-clash-protection ๐.
-fstack-clash-protectionโ generates code to prevent stack clash style attacks ๐ก๏ธ. When this 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 the operating system provides. Periodt.
Most targets don't fully support stack clash protection. But on those targets, -fstack-clash-protection will protect dynamic stack allocations. It 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โ generate code to ensure the stack doesn't grow beyond a certain value, either the value of a register or the address of a symbol ๐ง. If a larger stack is required, a signal is raised at run time. For most targets, the signal is raised before the stack overruns the boundary, so you can catch the signal without taking special precautions.
For instance, if the stack starts at absolute address 0x80000000 and grows downwards, you can use the flags -fstack-limit-symbol=__stack_limit and -Wl,--defsym,__stack_limit=0x7ffe0000 to enforce a stack limit of 128KB. Note that this may only work with the GNU linker, iykyk ๐.
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 super useful when running threaded programs, because it's no longer necessary to calculate a good stack size for each thread. Currently this is only implemented for the x86 targets running GNU/Linux.
Heads up: when code compiled with -fsplit-stack calls code compiled without it, there may not be much stack space available for the latter code to run ๐ฌ. If compiling all code โ including library code โ with -fsplit-stack isn't 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 anystrubattributes. We pretend strub isn't even a thing ๐.-fstrub=strictโ functions default tostrubmodedisabled, and it strictly applies the restriction that only functions associated withstrub-callablemodes (at-calls,callableandalways_inlineinternal) arecallableby functions withstrub-enabled modes (at-callsandinternal). Rules are rules, bestie ๐.-fstrub=relaxedโ restores the default stack scrub (strub) setting, namely,strubis only enabled as required bystrubattributes associated with function and data types.relaxedmeans strub contexts are only prevented from calling functions explicitly associated withstrubmodedisabled. This option is only useful to override other-fstrub=*options that come before it in the command line โ it's the "undo" button of strub ๐ .-fstrub=at-callsโ enablesat-callsstrubmode where viable. The main use of this option is for testing ๐งช. It exercises thestrubmachinery in scenarios strictly local to a translation unit. Thisstrubmode 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 thestrubattribute documentation for the details on viability and eligibility requirements, iykyk ๐.-fstrub=internalโ enablesinternalstrubmode where viable. Again, mostly for testing ๐งช. This option is intended to thoroughly exercise the parts of thestrubmachinery that implement the less efficient but interface-preservingstrubmode. Functions that wouldn't be affected by this option are, like, super uncommon.-fstrub=allโ enables somestrubmode where viable. When both strub modes are viable,at-callsis preferred ๐.-fdump-ipa-strubmadds function attributes that tell you which mode was selected for each function. The primary use of this option is for testing, to exercise thestrubmachinery thoroughly. Obsessed with a flag that just goes "pick the best one" ๐.-fvtable-verify=[std|preinit|none]โ C++ only, bestie! It turns on (or off, if you say-fvtable-verify=none) the security feature that, at run time, for every single virtual call, checks that the vtable pointer the call goes through is actually valid for the type of the object โ and hasn't been corrupted or overwritten. If it catches an invalid vtable pointer at run time, it reports an error and immediately halts execution of the program. ๐
This option makes run-time data structures get built at program startup, and those are the things used to verify the vtable pointers. The std and preinit values control when those data structures get built. In both cases they're built before execution reaches main. With -fvtable-verify=std, the data structures are built after shared libraries have been loaded and initialized. With -fvtable-verify=preinit, they're built before shared libraries have been loaded and initialized. โฑ๏ธ
If this option shows up multiple times on the command line with different values, none takes highest priority over both std and preinit, and preinit takes priority over std.
-fvtv-debugโ when you use this alongside-fvtable-verify=stdor-fvtable-verify=preinit, it makes debug versions of the runtime functions for the vtable verification feature get called. It also makes the compiler log info about which vtable pointers it finds for each class. That info goes into a file namedvtv_set_ptr_data.log, in the directory named by the environment variableVTV_LOGS_DIRif that's defined โ otherwise the current working directory. ๐๏ธ
Note: this feature appends data to the log file. If you want a fresh log file, make sure you delete any existing one first!
-fvtv-countsโ debugging flag, bestie. Used with-fvtable-verify=stdor-fvtable-verify=preinit, it makes the compiler keep track of the total number of virtual calls it encounters and the number of verifications it inserts. It also counts how many calls to certain run-time library functions it inserts, and logs all of that for each compilation unit. The compiler writes this info to a file namedvtv_count_data.log, in the directory named byVTV_LOGS_DIRif that's defined โ otherwise the current working directory. It also counts the size of the vtable pointer sets for each class and writes that tovtv_class_set_sizes.login the same directory. ๐
Note: this one appends to the log files too. To get fresh ones, delete any existing ones first!
-finstrument-functionsโ generates instrumentation calls for entry and exit to functions. Just after a function is entered and just before it exits, these profiling functions get called with the address of the current function and its call site. (On some platforms,__builtin_return_addressdoesn't work beyond the current function, so the call site info might 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 โ and that can be looked up exactly in the symbol table. ๐
This instrumentation also happens for functions that get expanded inline inside other functions. The profiling calls show where, conceptually, the inline function is entered and exited. Which means addressable versions of those functions have to be available. If literally all your uses of a function get expanded inline, this could mean extra code size. And if you use extern inline in your C code, an addressable version of those functions must be provided. (That's normally the case anyway, but if you get lucky and the optimizer always expands the functions inline, you might have gotten away without providing static copies. ๐)
A function can be given the attribute no_instrument_function, and then this instrumentation just doesn't happen for it. You'd use that for, like, the profiling functions listed above, high-priority interrupt routines, and any functions from which the profiling functions can't safely be called (maybe signal handlers, if the profiling routines generate output or allocate memory). ๐
โโ๏ธ
-finstrument-functions-onceโ similar to-finstrument-functions, except the profiling functions get called only once per instrumented function. So the first profiling function is called after the first entry into the instrumented function, and the second profiling function is called before the exit that corresponds to this first entry.
Okay so the definition of "once" here is a little vague, because the implementation is not protected against data races. So the implementation only guarantees the profiling functions are called at least once per process and at most once per thread โ but the calls are always paired. Meaning: if a thread calls the first function, it will call the second function, unless it never reaches the exit of the instrumented function. ๐คทโโ๏ธ
-finstrument-functions-exclude-file-list=file,file,...โ sets the list of functions excluded from instrumentation (peep the description of-finstrument-functions). If the file that contains a function definition matches one of file, then that function just isn't instrumented. The match is done on substrings: if the file parameter is a substring of the file name, it counts as a match. ๐ฏ
For example:
-finstrument-functions-exclude-file-list=/bits/stl,include/sys
excludes any inline function defined in files whose pathnames contain /bits/stl or include/sys.
If, for some reason, you want to include letter , in one of sym, write ,. For example, -finstrument-functions-exclude-file-list=',,tmp' (note the single quote surrounding the option). ๐
-finstrument-functions-exclude-function-list=sym,sym,...โ similar to-finstrument-functions-exclude-file-list, but this option sets the list of function names excluded from instrumentation. The function name that gets matched is its user-visible name, likevector<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's considered a match. For C99 and C++ extended identifiers, the function name must be given in UTF-8, not using universal character names. โจ-fpatchable-function-entry=N[,M]โ generates N NOPs right at the beginning of each function, with the function entry point placed before the Mth NOP. If M is omitted, it defaults to0, so the function entry points to the address just at the first NOP. Those NOP instructions reserve extra space, and that space can be used to patch in any instrumentation you want at run time โ provided 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 interfacegen_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 the command-line option -fpatchable-function-entry=N,M. You can use this 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 gets run on each C source file before the actual compilation happens. ๐ง
If you use the -E option, nothing is done except preprocessing. Some of these options only make sense 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.
-Dname--define-macro=name--define-macroname
Predefines name as a macro, with definition 1. โ
-Dname=definition--define-macro=name=definition--define-macroname=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're 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 want 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're given on the command line. All -imacros file and -include file options are processed after all -D and -U options. ๐ซถ
-Uname--undefine-macro=name--undefine-macroname
Cancels any previous definition of name, whether it was built in or provided with a -D option. ๐ซ
-includefile, **--include=*file***, **--include*file*** โ okay so this one's iconic: it processes *file* as if#include "file"was literally the first line of your primary source file ๐. BUT here's the plot twist โ the first directory searched for *file* is the preprocessor's **working directory**, not the directory containing the main source file. If it's not found there, it gets searched for in the rest of the#include "..."search chain like normal, no cap. And if you stack multiple-include` options? They're included in the order they appear on the command line, periodt. ๐-imacrosfile, **--imacros=*file***, **--imacros*file*** โ exactly like-include, except any output produced by scanning *file* gets **thrown away** ๐๏ธ. Macros it defines stay defined, though. So it's giving "I just want the macros from this header, not its whole declaration situation" โ very main character energy. Heads up: all files specified by-imacrosare 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 basics stay, everything else gets the โ๏ธ.-pthreadโ defines additional macros required for using the POSIX threads library ๐งต. Use it consistently for both compilation and linking, bestie, or you're gonna have a bad time. Supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets. Slay.-M,--dependenciesโ instead of outputting the result of preprocessing, it outputs a rule suitable formakedescribing 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-includeor-imacroscommand-line options.
Unless specified explicitly (with -MT or -MQ), the object file name consists of the name of the source file with any suffix replaced with the object file suffix and with any leading directory parts removed. If there are many included files, the rule gets split into several lines using \-newline. The rule has no commands, fr fr.
This option does not suppress the preprocessor's debug output, such as -dM ๐ญ. To avoid mixing that debug output with the dependency rules, 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. Not me just casually implying -E ๐.
-MM,--user-dependenciesโ like-Mbut it does not mention header files found in system header directories, nor header files included (directly or indirectly) from such a header ๐. Which implies the choice of angle brackets or double quotes in an#includedirective does not in itself determine whether that header appears in-MMdependency output. iykyk.-MFfile โ when used with-Mor-MM, specifies a file to write the dependencies to ๐ธ. If no-MFswitch is given, the preprocessor sends the rules to the same place it would send preprocessed output. When used with the driver options-MDor-MMD,-MFoverrides the default dependency output file. And if file is-, then the dependencies are written to stdout. Cute.-MG,--print-missing-file-dependenciesโ in conjunction with an option such as-Mrequesting dependency generation,-MGassumes 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#includedirective without prepending any path.-MGalso suppresses preprocessed output, since 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, iconic, does exactly what it says on the tin. ๐-MPโ 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 errorsmakegives if you remove header files without updating the Makefile to match. The way this saves you from your own chaosโฆ ๐ญ
This is typical output:
test.o: test.c test.h
test.h:
-MTtarget โ changes 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. That result is the target.
An -MT option sets the target to be exactly the string you specify. Want multiple targets? Pass them as a single argument to -MT, or use multiple -MT options. Easy.
For example, -MT '$(objpfx)foo.o' might give
$(objpfx)foo.o: foo.c
-MQtarget โ same as-MT, but it quotes any characters which are special to Make ๐ . So-MQ '$(objpfx)foo.o'gives
$$(objpfx)foo.o: foo.c
The default target is automatically quoted, as if it were given with -MQ. Iconic behavior honestly.
-MD,--write-dependenciesโ-MDis equivalent to-M -MFfile, except that-Eis not implied ๐ . The driver determines file based on whether an-ooption 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.dsuffix.
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. The vibes shift depending on context, okurrr.
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-MDexcept mention only user header files, not system header files ๐-fpreprocessedโ indicates to the preprocessor that the input file has already been preprocessed ๐ธ. This suppresses things like macro expansion, trigraph conversion, escaped newline splicing, and processing of most directives. The preprocessor still recognizes and removes comments, so you can pass a file preprocessed with-Cto 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. Noted, bestie ๐
-fdirectives-onlyโ when preprocessing, handle directives, but don't expand macros ๐. The option's behavior depends on the-Eand-fpreprocessedoptions:- 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-dDoption 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
-Eand-fpreprocessed, the rules for-fpreprocessedtake precedence. This enables full preprocessing of files previously preprocessed with-E -fdirectives-only. ๐ฆ
- With
-fdollars-in-identifiersโ accept$in identifiers ๐ . That's it. That's the tweet.-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++. So mostly you don't gotta touch it, but now you know ๐-fno-canonical-system-headersโ when preprocessing, do not shorten system header paths with canonicalization ๐-fmax-include-depth=depth โ sets the maximum depth of the nested#include. The default is200. Guardrails, bestie ๐ง-fsearch-include-path[=kind] โ look for input files on the#includepath, 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. Choose your fighter ๐
-ftabstop=width โ sets 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 than1or greater than100, the option is ignored ๐. The default is8.-ftrack-macro-expansion[=level] โ tracks locations of tokens across macro expansions โญ. This lets the compiler emit diagnostics 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, so, tradeoffs ๐ญ.
The level parameter chooses the level of precision of token location tracking, thus decreasing memory consumption if necessary:
- Value
0of level de-activates this option. - Value
1tracks token 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
2tracks token 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. So like, you're already in it, bestie ๐
-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-mapand-fcanon-prefix-map๐-fexec-charset=charset โ sets the execution character set, used for string and character constants ๐. The default isUTF-8. charset can be any encoding supported by the system'siconvlibrary routine. Go off, encoding icon ๐-fwide-exec-charset=charsetโ sets the wide execution character set, bestie, the one used for wide string and character constants ๐ the default is one ofUTF-32BE,UTF-32LE,UTF-16BE, orUTF-16LEโ whichever one matches the width ofwchar_tplus the big-endian or little-endian byte order your code generation is using. Same energy as-fexec-charset: charset can be any encoding your system'siconvlibrary routine supports โ but heads up, you will have problems with encodings that don't fit exactly inwchar_t. like, it's giving mismatched vibes ๐ญ-finput-charset=charsetโ sets the input character set, the one used to translate from the character set of the input file to the source character set GCC uses. The default isUTF-8โจ charset can be any encoding supported by the system'siconvlibrary 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 at all when the input character set matches the execution character set. But if they're different? ill-formed code unit sequences result in an error during transcoding to the execution character set ๐ no cap.
-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, not the files that were used to create it โ because those files aren't consulted when a precompiled header is used. periodt.-fpch-preprocessโ this option lets you use a precompiled header together with-E. It sticks a special#pragma,#pragma GCC pch_preprocess "filename", into the output to mark where the precompiled header was found, plus its filename ๐ when-fpreprocessedis in use, GCC recognizes this#pragmaand 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.
Do 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 ๐ธ with this 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. It's implicitly enabled if debugging information is enabled โ but you can inhibit that with the negated form-fno-working-directory. And if-Pis present in the command line, this option has no effect, since no#linedirectives are emitted whatsoever. iconic behavior ngl.-C,--commentsโ do not discard comments ๐ all comments get passed through to the output file, except for comments in processed directives, which get 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 all the side effects of -C, 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. not me being protected from myself.
The -CC option is generally used to support lint comments.
-P,--no-line-commandsโ inhibits generation of linemarkers in the output from the preprocessor ๐ฆ might be useful when you're running the preprocessor on something that isn't C code, and it'll be sent to a program that might get confused by the linemarkers. fair honestly.-traditional,--traditional,-traditional-cpp,--traditional-cppโ tries to imitate the behavior of pre-standard C preprocessors, as opposed to ISO C preprocessors ๐ see the GNU CPP manual for the 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 ISO C defines to stand for single characters. For example,??/stands for\, so'??/n'is a character constant for a newline. the way that works is so unserious.
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โ enables special code to work around file systems that only permit very short file names, such as MS-DOS ๐ retro.-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#includestack it is. Precompiled header files get printed too, even if they're found to be invalid โ an invalid precompiled header file is printed with...xand a valid one with...!. iykyk.-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. And if you specify letters whose behavior conflicts? the result is undefined ๐ญ-dM,--dump=Mโ instead of the normal output, generate a list of#definedirectives for all the macros defined during the execution of the preprocessor, including predefined macros ๐ธ this gives you a way of finding out what's predefined in your version of the preprocessor. Assuming you have no file foo.h, the command
touch foo.h; cpp -dM foo.h
shows all the predefined macros โจ
If you use -dM without the -E option, -dM is interpreted as a synonym for -fdump-rtl-mach ๐ plot twist.
-dD,--dump=Dโ like-dMexcept that it outputs both the#definedirectives 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 ๐ซถ minimal queen.-dI,--dump=Iโ output#includedirectives in addition to the result of preprocessing.-dU,--dump=Uโ like-dDexcept that only macros that are expanded, or whose definedness is tested in preprocessor directives, get output ๐ the output is delayed until the use or test of the macro; and#undefdirectives are also output for macros tested but undefined at the time. so thorough.
-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. literally nothing. ๐
-Wp,optionโ you can use-Wp,optionto bypass the compiler driver and pass option directly through to the preprocessor โจ if option contains commas, it gets split into multiple options at the commas. However โ and this is the important part, bestie โ many options are modified, translated or interpreted by the compiler driver before being passed to the preprocessor, and-Wpforcibly bypasses this phase ๐ณ the preprocessor's direct interface is undocumented and subject to change, so whenever possible you should avoid using-Wpand let the driver handle the options instead. fr fr, just let the driver cook.-Xpreprocessoroption โ pass option as an option to the preprocessor ๐ธ you can use this to supply system-specific preprocessor options that GCC doesn't 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 you provide this option, the appropriate language front end (cc1,cc1plus, orcc1objfor 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 together with the -B or -wrapper options to specify an alternate preprocessor, or to perform additional processing of the program source between normal preprocessing and compilation ๐ฅ
๐ง Passing Options to the Assembler ๐ง
You can pass options to the assembler. yes bestie, the assembler gets love too ๐
-Wa,optionโ pass option as an option to the assembler. If option contains commas, it's split into multiple options at the commas โจ-Xassembleroption,--for-assembler=option,--for-assembleroption โ pass option as an option to the assembler ๐ธ you can use this to supply system-specific assembler options that GCC doesn't 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 โญ and they're meaningless if the compiler isn't doing a link step. like, don't even bother, they simply won't eat ๐
object-file-nameโ so if a file name does not end in one of the special recognized suffixes, it lowkey gets treated as an object file or a library, periodt. (The linker tells object files apart from libraries by looking at the file contents, iykyk.) If linking actually happens, these object files get fed straight into the linker as input. ๐ซถ-c,-S,-Eโ if you use any of these three, the linker does not run, and ngl you should not be passing object file names as arguments either. ๐-flink-libatomicโ turns on linking of libatomic if it's supported by the target, and bestie it's enabled by default. If you wanna be explicit about not linking it, use the negative form-fno-link-libatomic. โจ-flinker-output=typeโ okay so this one controls code generation of the link-time optimizer. By default, the linker output is automatically determined by the linker plugin. But for debugging the compiler, and if you want incremental linking with a non-LTO object file, it can be useful to control thetypemanually. ๐execโ code generation produces a static binary. In this case-fpicand-fpieare both disabled.dynโ code generation produces a shared library. In this case-fpicor-fPICis 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. ๐pieโ code generation produces an-fpieexecutable. This gives you similar optimizations asexec, except that-fpieis not disabled if you specified it at compilation time.relโ the compiler assumes incremental linking is being done. The sections containing intermediate code for link-time optimization are merged, pre-optimized, and output to the resulting object file. On top of that, if-ffat-lto-objectsis specified, binary code is produced for future non-LTO linking. The object file produced by incremental linking is smaller than a static library produced from the same object files. At link time the result of incremental linking also loads faster than a static library, assuming the majority of objects in the library are used. ๐ธnolto-relโ finally, this configures the compiler for incremental linking where code generation is forced, a final binary is produced, and the intermediate code for later link-time optimization is stripped. When multiple object files are linked together the resulting code is better optimized than with link-time optimizations disabled (for example, cross-module inlining happens), but most of the benefits of whole-program optimizations are lost. ๐ญ
During the incremental link (by -r) the linker plugin defaults to rel. GNU Binutils 2.44 or later is needed to incrementally link LTO objects and non-LTO objects into a single mixed object file. If any of the object files in an incremental link cannot be used for link-time optimization, the linker plugin issues a warning and uses nolto-rel. To maintain whole-program optimization, link such objects into a static library instead. ๐ง
-fuse-ld=bfdโ use thebfdlinker instead of the default linker.-fuse-ld=goldโ use thegoldlinker instead of the default linker.-fuse-ld=lldโ use the LLVMlldlinker 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. ๐ฅ-llibrary,-llibrary โ search the library named library when linking. (The second alternative, with the library as a separate argument, is only for POSIX compliance and is not recommended โ fr fr, don't do it.)
GCC passes the -l option directly to the linker, so definitely check your linker documentation for the exact details. The general description below applies to the GNU linker, bestie. ๐ซถ
The linker searches a standard list of directories for the library. Those directories include several standard system directories plus any that you specify with -L.
Static libraries are archives of object files, and have file names like liblibrary.a. Some targets also support shared libraries, which typically have names like liblibrary.so. If both static and shared libraries are found, the linker gives preference to linking with the shared library unless the -static option is used. โจ
It makes a difference where in the command you write this option โ the linker searches and processes libraries and object files in the order they are specified. Sofoo.o -lz bar.osearches libraryzafter filefoo.obut beforebar.o. Ifbar.orefers to functions inz, those functions may not be loaded. ๐ญ
-lobjcโ you need this special case of the-loption 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 are used normally, unless-nostdlib,-nolibc, or-nodefaultlibsis used.-nodefaultlibsโ do not use the standard system libraries when linking. Only the libraries you specify are passed to the linker, and options specifying linkage of the system libraries, such as-static-libgccor-shared-libgcc, are ignored. The standard startup files are used normally, unless-nostartfilesis 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 aslibgnat,libgfortranorlibstdc++โ unless options preventing their inclusion are used as well. This typically removes-lcfrom the link command line, as well as system libraries that normally go with it and become meaningless when absence of a C library is assumed, for example-lpthreador-lmin some configurations. This is intended for bare-board targets when there is indeed 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 are passed to the linker, and options specifying linkage of the system libraries, such as-static-libgccor-shared-libgcc, are ignored. ๐
Same warning as above, bestie: the compiler may generate calls to memcmp, memset, memcpy and memmove. These entries are usually resolved by entries in libc. These entry points should be supplied through some other mechanism when this option is specified.
One of the standard libraries bypassed by -nostdlib and -nodefaultlibs is libgcc.a, a library of internal subroutines which GCC uses to overcome shortcomings of particular machines, or special needs for some languages. ๐
In most cases, you need libgcc.a even when you want to avoid other standard libraries. In other words, when you specify -nostdlib or -nodefaultlibs you should usually specify -lgcc as well. This ensures that 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. simple as that ๐-eentry,--entry=entry,--entryentry โ specify that the program entry point is entry. The argument is interpreted by the linker; the GNU linker accepts either a symbol name or an address. โญ-pie,--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. that's it, that's the vibe ๐-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 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 option is supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets. On some targets this option also sets flags for the preprocessor, so it should be used consistently for both compilation and linking. ๐งตโจ-rโ produce a relocatable object as output. This is also known as partial linking. ๐-rdynamicโ pass the flag-export-dynamicto the ELF linker, on targets that support it. This instructs the linker to add all symbols, not only used ones, to the dynamic symbol table. This option is needed for some uses ofdlopenor to allow obtaining backtraces from within a program. ๐ฅ-sโ remove all symbol table and relocation information from the executable. bye bye debug info ๐๐-static,--staticโ on systems that support dynamic linking, this overrides-pieand 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 static version, respectively. If no shared version of libgcc was built when the compiler was configured, these options have no effect. ๐ญ
There are several situations in which an application should use the shared libgcc instead of the static version. The most common of these is when the application wishes to throw and catch exceptions across different shared libraries. In that case, each of the libraries as well as the application itself should use the shared libgcc. ๐ซถ
So like, that's literally why the G++ driver just automatically adds -shared-libgcc whenever you build a shared library or a main executable โ because C++ programs typically use exceptions, so it's the right thing to do. ๐
But bestie, here's the plot twist: if you use the GCC driver to create shared libraries instead, you might find they're not always linked with the shared libgcc. ๐ If GCC finds, at its configuration time, that you've got a non-GNU linker or a GNU linker that doesn't 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. And that's actually iconic of it, because it lets exceptions propagate through such shared libraries without incurring relocation costs at library load time. โจ
However โ and this is the important part, no cap โ 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. Don't skip that step, ok? ๐ซถ
-static-libasanโ when-fsanitize=addressis used to link a program, the GCC driver automatically links againstlibasan. Iflibasanis available as a shared library, and-staticis not used, then this links against the shared version oflibasan. The-static-libasanoption directs the GCC driver to linklibasanstatically, without necessarily linking other libraries statically. ๐ง-static-libhwasanโ when-fsanitize=hwaddressis used to link a program, the GCC driver automatically links againstlibhwasan. Iflibhwasanis available as a shared library, and-staticis not used, then this links against the shared version oflibhwasan. The-static-libhwasanoption directs the GCC driver to linklibhwasanstatically, without necessarily linking other libraries statically. ๐ฆ-static-liblsanโ when-fsanitize=leakis used to link a program, the GCC driver automatically links againstliblsan. Ifliblsanis available as a shared library, and-staticis not used, then this links against the shared version ofliblsan. The-static-liblsanoption directs the GCC driver to linkliblsanstatically, without necessarily linking other libraries statically. ๐-static-libtsanโ when-fsanitize=threadis used to link a program, the GCC driver automatically links againstlibtsan. Iflibtsanis available as a shared library, and-staticis not used, then this links against the shared version oflibtsan. The-static-libtsanoption directs the GCC driver to linklibtsanstatically, without necessarily linking other libraries statically. ๐ฅ-static-libubsanโ when-fsanitize=undefinedis used to link a program, the GCC driver automatically links againstlibubsan. Iflibubsanis available as a shared library, and-staticis not used, then this links against the shared version oflibubsan. The-static-libubsanoption directs the GCC driver to linklibubsanstatically, without necessarily linking other libraries statically. ๐-static-libstdc++โ when theg++program is used to link a C++ program, it normally automatically links againstlibstdc++. Iflibstdc++is available as a shared library, and-staticis not used, then this links against the shared version oflibstdc++. That's normally fine, like genuinely. However, it is sometimes useful to freeze the version oflibstdc++used by the program without going all the way to a fully static link. The-static-libstdc++option directs theg++driver to linklibstdc++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. ๐ธ-Tscript โ 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-Toption may be required when linking to avoid references to undefined symbols. ๐ญ-Xlinkeroption โ 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, ngl. ๐
-Wl,option,--for-linker=option,--for-linkeroption โ 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.mappasses-Map output.mapto the linker. When using the GNU linker, you can also get the same effect with-Wl,-Map=output.map. โจ-usymbol,--force-link=symbol,--force-linksymbol โ pretend the symbol symbol is undefined, to force linking of library modules to define it. You can use-umultiple times with different symbols to force loading of additional library modules. ๐ซถ-Tbss=addr,-Tdata=addr,-Ttext=addr,-N,-n,-t,-Z,-zkeyword โ these options are passed through to the linker without interpretation by GCC. Refer to your linker documentation for the meanings of these options. Not GCC's problem, bestie โ it's just the messenger. ๐ง
๐ Options for Directory Search ๐
These options specify directories to search for header files, for libraries and for parts of the compiler. Like, they're the map to your filesystem, and honestly? Iconic. ๐บ๏ธ
-Idir,-iquotedir,-isystemdir,-idirafterdir,--include-directory-after=dir,--include-directory-afterdir,--include-directory=dir,--include-directorydir โ add the directory dir to the list of directories to be searched for header files during preprocessing.--include-directoryis an alias for-I, while--include-directory-afteris an alias for-idirafter. If dir begins with=or$SYSROOT, then the=or$SYSROOTis replaced by the sysroot prefix; see--sysrootand-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:
- For the quote form of the include directive, the directory of the current file is searched first.
- For the quote form of the include directive, the directories specified by
-iquoteoptions are searched in left-to-right order, as they appear on the command line. - Directories specified with
-Ioptions are scanned in left-to-right order. - Directories specified with
-isystemoptions are scanned in left-to-right order. - Standard system directories are scanned.
- Directories specified with
-idirafteroptions 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 โ big however โ you should not use this option to add directories that contain vendor-supplied system header files; use -isystem for that. ๐
โโ๏ธ
The -isystem and -idirafter options also mark the directory as a system directory, so that it gets the same special treatment that is applied to the standard system directories. โจ
If a standard system include directory, or a directory specified with -isystem, is also specified with -I, the -I option is ignored. The directory is still searched but as a system directory at its normal position in the system include chain. This is to ensure that GCC's procedure to fix buggy system headers and the ordering for the #include_next directive are not inadvertently changed. If you really need to change the search order for system directories, use the -nostdinc and/or -isystem options. ๐ฅ
-I-,--include-barrierโ split the include path. This option has been deprecated. โ ๏ธ Please use-iquoteinstead for-Idirectories 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-. ๐ญ Like, zero. None. It's giving "no escape". ๐
-iprefixprefix,--include-prefix=prefix,--include-prefixprefix โ specify prefix as the prefix for subsequent-iwithprefixoptions. If the prefix represents a directory, you should include the final/. ๐-iwithprefixdir,-iwithprefixbeforedir,--include-with-prefix=prefix,--include-with-prefixprefix,--include-with-prefix-after=prefix,--include-with-prefix-afterprefix,--include-with-prefix-before=prefix,--include-with-prefix-beforeprefix โ append dir to the prefix specified previously with-iprefix, and add the resulting directory to the include search path.-iwithprefixbeforeputs it in the same place-Iwould;-iwithprefixputs it where-idirafterwould. ๐ฆ
--include-with-prefix and --include-with-prefix-after are both aliases for -iwithprefix, while --include-with-prefix-before is an alias for -iwithprefixbefore. Slay, aliases. ๐
-isysroot dirโ okay bestie, this is basically--sysrootbut it only applies to header files. Except on Darwin targets, where it applies to both header files and libraries. Peep the--sysrootoption for the full tea โ.-imultilib dirโ usediras a subdirectory of the directory that contains target-specific C++ headers. Slay, very target-specific ๐ .-imultiarch dirโ usediras a subdirectory of the directory that contains architecture-specific C++ headers. Architecture girlies rise ๐ธ.-nostdinc,--no-standard-includesโ do not search the standard system directories for header files. Only the directories explicitly specified with-I,-iquote,-isystem, and/or-idirafteroptions (and the directory of the current file, if appropriate) are searched. No cap, thatโs the whole vibe check ๐ฅ.-nostdinc++โ do not search for header files in the C++-specific standard directories, but do still search the other standard directories. This one is used when building the C++ library, iykyk ๐.--embed-dir=dir,--embed-directory=dir,--embed-directory dirโ appenddirdirectory to the list of searched directories for the"#embed"preprocessing directive or"__has_embed"macro. There are no default directories for"#embed", periodt ๐.
If dir begins with = or $SYSROOT, then the = or $SYSROOT is replaced by the sysroot prefix; see --sysroot and -isysroot. Cute little substitution moment โจ.
-iplugindir=dirโ set the directory to search for plugins that are passed by-fplugin=nameinstead of-fplugin=path/name.so. This option is not meant to be used by the user, but only passed by the driver. So bestie, donโt touch unless youโre the driver ๐ .-Ldir,--library-directory=dir,--library-directory dirโ add directorydirto the list of directories to be searched for-l. Linker girlies, this oneโs for you ๐ซถ.-Bprefix,--prefix=prefix,--prefix prefixโ this option specifies where to find the executables, libraries, include files, and data files of the compiler itself. Main character energy for the whole toolchain ๐.
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. Very โI know where everything livesโ of it.
For each subprogram to be run, the compiler driver first tries the -B prefix, if any. If that name is not found, or if -B is not 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 is found, the unmodified program name is searched for using the directories specified in your PATH environment variable. PATH girlies know ๐ญ.
The compiler checks to see if the path provided by -B refers to a directory, and if necessary it adds a directory separator character at the end of the path. Little detail, but she matters ๐.
-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. Translating options like a multilingual icon ๐
.
The runtime support file libgcc.a can also be searched for using the -B prefix, if needed. If it is not found there, the two standard prefixes above are tried, and that is all. The file is left out of the link if it is not found by those means. So yeah, sometimes sheโs just not invited to the link party ๐.
Another way to specify a prefix much like the -B prefix is to use the environment variable GCC_EXEC_PREFIX. Environment variable cameo ๐ฆ.
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 is replaced by [dir/]include. This is to help with boot-strapping the compiler. Kludge? More like vintage hack couture โจ.
-no-canonical-prefixes,--no-canonical-prefixesโ do not expand any symbolic links, resolve references to/../or/./, or make the path absolute when generating a relative prefix. Leave those paths exactly as they are, bestie ๐.--sysroot=dir,--sysroot dirโ usediras the logical root directory for headers and libraries. For example, if the compiler normally searches for headers in/usr/includeand libraries in/usr/lib, it instead searchesdir/usr/includeanddir/usr/lib. Itโs giving โnew root, same compilerโ ๐.
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. Theyโre splitting duties, your honor ๐
.
The GNU linker (beginning with version 2.16) has the necessary support for this option. If your linker does not support this option, the header file aspect of --sysroot still works, but the library aspect does not. So check your linkerโs vibe first, ngl ๐ญ.
--no-sysroot-suffixโ for some targets, a suffix is added to the root directory specified with--sysroot, depending on the other options used, so that headers may for example be found indir/suffix/usr/includeinstead ofdir/usr/include. This option disables the addition of such a suffix. No extra suffix, no extra drama ๐.
โจ Options for Code Generation Conventions โจ
These machine-independent options control the interface conventions used in code generation. Interface conventions? We love a structured queen ๐.
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. Itโs giving โchoose your own flag adventureโ ๐
.
-fstack-reuse=reuse-levelโ this option controls stack space reuse for user declared local/auto variables and compiler generated temporaries.reuse_levelcan beall,named_vars, ornone.allenables stack reuse for all local variables and temporaries,named_varsenables the reuse only for user defined local variables with names, andnonedisables stack reuse completely. The default value isall. Stack reuse? Sheโs recycling but make it compiler ๐.
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. Bestie, this is the part where old code can get absolutely got ๐ญ.
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. So yeah, itโs a real โrespect the old codeโs boundariesโ situation ๐ซถ.
-ftrapvโ this option generates traps for signed overflow on addition, subtraction, multiplication operations. Traps! We love a dramatic entrance ๐.
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. Override wars, but make it compiler flags โ๏ธ.
-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-ftrapvand-fwrapvoverride each other, so using-ftrapv -fwrapvon the command-line results in-fwrapvbeing effective. Note that only active options override, so using-ftrapv -fwrapv -fno-wrapvon the command-line results in-ftrapvbeing effective. Same override tea, different flag โ.-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. Pointer girlies get their own wrap-around moment ๐ .-fstrict-overflowโ this option implies-fno-wrapv -fno-wrapv-pointerand when negated implies-fwrapv -fwrapv-pointer. Strict overflow said โI contain multitudesโ โจ.-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. Bigger data? Maybe. Slower execution? Not this one, bestie ๐.
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. C and C++ interop? We love a crossover episode ๐.
-fnon-call-exceptionsโ generate code that allows trapping instructions to throw exceptions. Note that this requires platform-specific runtime support that does not exist everywhere. Moreover, it only allows trapping instructions to throw exceptions, i.e. memory references or floating-point instructions. It does not allow exceptions to be thrown from arbitrary signal handlers such as"SIGALRM". This enables-fexceptions. So itโs exceptions with a very specific guest list, no random signal-handler crashers allowed ๐.-fdelete-dead-exceptionsโ okay so this one's like, "instructions that might throw but honestly aren't contributing to the program's actual execution? bestie, they can be optimized away." ๐๏ธโจ It does not affect calls to functions, except the ones with thepureorconstattributes. This is enabled by default for the Ada and C++ compilers โ as permitted by the language specs, no cap. And heads up: the optimization passes that actually cause dead exceptions to be removed are enabled independently at different optimization levels. iykyk ๐-funwind-tablesโ lowkey similar to-fexceptions, except it only generates any needed static data and does not touch the generated code in any other way. You normally don't need to turn this on yourself โ instead, a language processor that needs this handling enables it on your behalf. ๐ซถ-fasynchronous-unwind-tablesโ generates the unwind table in DWARF format, if it's supported by the target machine. The table is exact at each instruction boundary, so it can be used for stack unwinding from asynchronous events (like a debugger or a garbage collector). ๐งโจ-fno-gnu-uniqueโ okay so on systems with a recent GNU assembler and C library, the C++ compiler uses theSTB_GNU_UNIQUEbinding to make sure definitions of template static data members and static local variables in inline functions stay unique even whenRTLD_LOCALis in the mix. This is necessary to avoid problems with a library used by two differentRTLD_LOCALplugins depending on a definition in one of them โ and therefore disagreeing with the other one about the binding of the symbol. BUT ๐ this causesdlcloseto be ignored for affected DSOs. So if your program relies on reinitialization of a DSO viadlcloseanddlopen, you can use-fno-gnu-unique. ๐-fpcc-struct-returnโ returnsshortstructandunionvalues in memory like the longer ones, rather than in registers. This convention is 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. fr fr.
"Short" structures and unions are those whose size and alignment match that of some integer type.
Warning: code compiled with the-fpcc-struct-returnswitch is not binary compatible with code compiled with the-freg-struct-returnswitch. Use it to conform to a non-default application binary interface. โ ๏ธ
-freg-struct-returnโ returnsstructandunionvalues in registers when possible. For small structures this is more efficient than-fpcc-struct-return. ๐
If you specify neither -fpcc-struct-return nor -freg-struct-return, GCC defaults to whichever convention is standard for the target. If there is no standard convention, GCC defaults to -fpcc-struct-return โ except on targets where GCC is the principal compiler. In those cases, we can choose the standard, and we chose the more efficient register-return alternative. ๐
Warning: code compiled with the-freg-struct-returnswitch is not binary compatible with code compiled with the-fpcc-struct-returnswitch. Use it to conform to a non-default application binary interface. โ ๏ธ
-fshort-enumsโ allocates to anenumtype only as many bytes as it needs for the declared range of possible values. Specifically, theenumtype is equivalent to the smallest integer type that has enough room. This option has no effect for an enumeration type with a fixed underlying type. ๐
Warning: the -fshort-enums switch causes GCC to generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface. โ ๏ธ
-fshort-wcharโ overrides the underlying type forwchar_tto beshort unsigned intinstead of the default for the target. This option is useful for building programs to run under WINE. ๐ทโจ
Warning: the -fshort-wchar switch causes GCC to generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface. โ ๏ธ
-fcommonโ in C code, this option controls the placement of global variables defined without an initializer, known as tentative definitions in the C standard. Tentative definitions are distinct from declarations of a variable with theexternkeyword, which do not allocate storage. ๐
The default is -fno-common, which specifies that the compiler places uninitialized global variables in the BSS section of the object file. This inhibits the merging of tentative definitions by the linker, so you get a multiple-definition error if the same variable is accidentally defined in more than one compilation unit. ๐ญ
The -fcommon places uninitialized global variables in a common block. This allows the linker to resolve all tentative definitions of the same variable in different compilation units to the same object, or to a non-tentative definition. This behavior is inconsistent with C++, and on many targets implies a speed and code size penalty on global variable references. It is mainly useful to enable legacy code to link without errors. ๐ซถ
-fno-ident,-Qy,-Qnโ-fno-identsuppresses emission of.identassembler directives and causes the#identpreprocessor directive to be ignored.-Qyand-Qnare obsolete synonyms for-fidentand-fno-ident, respectively. ๐-finhibit-size-directiveโ don't output a.sizeassembler 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 compilingcrtstuff.c; you should not need to use it for anything else. ๐ซ-fverbose-asmโ puts extra commentary info 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). ๐ต๏ธโโ๏ธ
-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. ๐
-frecord-gcc-switchesโ this switch causes the command line used to invoke the compiler to be recorded into the object file that is being created. This switch is only implemented on some targets and the exact format of the recording is target- and binary-file-format-dependent, but it usually takes the form of a section containing ASCII text. This switch is related to the-fverbose-asmswitch, but that switch only records information in the assembler output file as comments, so it never reaches the object file. See also-grecord-gcc-switchesfor another way of storing compiler options into the object file. ๐-fpicโ generates position-independent code (PIC) suitable for use in a shared library, if supported for the target machine. Such code accesses all constant addresses through a global offset table (GOT). The dynamic loader resolves the GOT entries when the program starts (the dynamic loader is not part of GCC; it'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-fpicdoes not work; in that case, recompile with-fPICinstead. (These maximums are 8k on the SPARC, 28k on AArch64 and 32k on the m68k and RS/6000. The x86 has no such limit.) ๐ฅ
Position-independent code requires special support, and therefore works only on certain machines. For the x86, GCC supports PIC for System V but not for the Sun 386i. Code generated for the IBM RS/6000 is always position-independent. ๐
When this flag is set, the macros __pic__ and __PIC__ are defined to 1. โจ
-fPICโ okay bestie, if your target machine supports it, this emits position-independent code thatโs suitable for dynamic linking and avoids any limit on the size of the global offset table. This option makes a difference on AArch64, m68k, PowerPC and SPARC. Position-independent code requires special support, and therefore works only on certain machines. When this flag is set, the macros__pic__and__PIC__are defined to2. ๐ซถ-fpie,-fPIEโ these are similar to-fpicand-fPIC, but the generated position-independent code can be only linked into executables. Usually these options are used to compile code that will be linked using the-pieGCC option. Both-fpieand-fPIEdefine the macros__pie__and__PIE__. The macros have the value1for-fpieand2for-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 leads to more efficient code by eliminating PLT stubs and exposing GOT loads to optimizations. On architectures such as 32-bit x86 where PLT stubs expect the GOT pointer in a specific register, this gives more register allocation freedom to the compiler. Lazy binding requires use of the PLT; with-fno-pltall external symbols are resolved at load time. Alternatively, the function attributenopltcan be used to avoid calls through the PLT for specific external functions. In position-dependent code, a few targets also convert calls to functions that are marked to not use the PLT to use the GOT instead. ๐ฅ-fno-jump-tablesโ do not use jump tables for switch statements even where it would be more efficient than other code generation strategies. This option is of use in conjunction with-fpicor-fPICfor building code that forms part of a dynamic linker and cannot reference the address of a jump table. On some targets, jump tables do not require a GOT and this option is not needed. ๐-fno-bit-testsโ do not use bit tests for switch statements even where it would be more efficient than other code generation strategies. ๐-ffixed-regโ treat the register named reg as a fixed register; generated code should never refer to it (except perhaps as a stack pointer, frame pointer or in some other fixed role). reg must be the name of a register. The register names accepted are machine-specific and are defined in theREGISTER_NAMESmacro in the machine description macro file. This flag does not have a negative form, because it specifies a three-way choice. ๐-fcall-used-regโ treat the register named reg as an allocable register that is clobbered by function calls. It may be allocated for temporaries or variables that do not live across a call. Functions compiled this way do not save and restore the register reg. It is an error to use this flag with the frame pointer or stack pointer. Use of this flag for other registers that have fixed pervasive roles in the machineโs execution model produces disastrous results. This flag does not have a negative form, because it specifies a three-way choice. ๐ญ-fcall-saved-regโ treat the register named reg as an allocable register saved by functions. It may be allocated even for temporaries or variables that live across a call. Functions compiled this way save and restore the register reg if they use it. It is an error to use this flag with the frame pointer or stack pointer. Use of this flag for other registers that have fixed pervasive roles in the machineโs execution model produces disastrous results. A different sort of disaster results from the use of this flag for a register in which function values may be returned. This flag does not have a negative form, because it specifies a three-way choice. ๐-fpack-struct[=n]โ without a value specified, pack all structure members together without holes. When a value is specified (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. ๐ซถ
-fleading-underscoreโ this option and its counterpart,-fno-leading-underscore, forcibly change the way C symbols are represented in the object file. One use is to help link with legacy assembly code.
Warning: the -fleading-underscore switch causes GCC to generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface. Not all targets provide complete support for this switch. ๐ธ
-ftls-model=modelโ alter the thread-local storage model to be used. The model argument should be one ofglobal-dynamic,local-dynamic,initial-execorlocal-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-fpicis not given on the command line. The default without-fpicisinitial-exec; with-fpicthe default isglobal-dynamic. โญ-ftrampolinesโ for targets that normally need trampolines for nested functions, always generate them instead of using descriptors. Otherwise, for targets that do not need them, like for example HP-PA or IA-64, do nothing. A trampoline is a small piece of code that is created at run time on the stack when the address of a nested function is taken, and is used to call the nested function indirectly. Therefore, it requires the stack to be made executable in order for the program to work properly.-fno-trampolinesis 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-trampolinesis enabled by default only for Ada. Moreover, code compiled with-ftrampolinesand code compiled with-fno-trampolinesare 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-ftrampolinesand-fno-trampolinesoptions 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=heapgenerate calls to__gcc_nested_func_ptr_createdand__gcc_nested_func_ptr_deletedin order to allocate and deallocate trampoline space on the executable heap. These functions are implemented inlibgcc, 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 yousetjmp, instantiate nested functions, and thenlongjmpback to a state prior to having allocated those nested functions. ๐-fvisibility=[default|internal|hidden|protected]โ set the default ELF image symbol visibility to the specified option---all symbols are marked with this unless overridden within the code. Using this feature can very substantially improve linking and load times of shared object libraries, produce more optimized code, provide near-perfect API export and prevent symbol clashes. It is strongly recommended that you use this in any shared objects you distribute. Despite the nomenclature,defaultalways means public; i.e., available to be linked against from outside the shared object.protectedandinternalare pretty useless in real-world usage so the only other commonly used option ishidden. The default if-fvisibilityisn't specified isdefault, i.e., make every symbol public. A good explanation of the benefits offered by ensuring ELF symbols have the correct visibility is given by How To Write Shared Libraries by Ulrich Drepper (which can be found athttps://www.akkadia.org/drepper/)---however a superior solution made possible by this option to marking things hidden when the default is public is to make the default hidden and mark things public. This is the norm with DLLs on Windows and with-fvisibility=hiddenand__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 visibilityof use. This works by you enclosing the declarations you wish to set visibility for with (for example)#pragma GCC visibility push(hidden)and#pragma GCC visibility pop. Bear in mind that symbol visibility should be viewed as part of the API interface contract and thus all new code should always specify visibility when it is not the default; i.e., declarations only for use within the local DSO should always be marked explicitly as hidden as so to avoid PLT indirection overheads---making this abundantly clear also aids readability and self-documentation of the code. Note that due to ISO C++ specification requirements,"operator new"and"operator delete"must always be of default visibility. Be aware that headers from outside your project, in particular system headers and headers from any other library you use, may not be expecting to be compiled with visibility other than the default. You may need to explicitly say#pragma GCC visibility push(default)before including any such headers. ๐
Heads up bestie:"extern"declarations do not get touched by-fvisibility, so like, a ton of code can be recompiled with-fvisibility=hiddenand literally nothing needs changing ๐ . But โ and this is the plot twist โ that 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 visibilityto tell the compiler which"extern"declarations should be treated as hidden. iykyk.
Also note ๐: -fvisibility does affect C++ vague linkage entities. Translation: if you've got an exception class getting thrown between DSOs, it must be explicitly marked with default visibility so the type_info nodes get unified between the DSOs. No cap, that one bites people.
There's a whole overview of these techniques, their benefits and how to use them at <https://gcc.gnu.org/wiki/Visibility> โ go read it, it's giving study guide โจ.
๐ง -fstrict-volatile-bitfields
Use this one when 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. Classic example: targets with memory-mapped peripheral registers might need all such accesses to be 16 bits wide. With this flag you can declare all peripheral bit-fields as "unsigned short" (assuming short is 16 bits on these targets) to force GCC to use 16-bit accesses instead of, like, a maybe more efficient 32-bit access. Slay.
If this option is disabled, the compiler just uses the most efficient instruction. In that same 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 that have nothing to do with the one being updated ๐ญ.
Sometimes โ 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'll fault or truncate the result at run time. We love a graceful fallback ๐ซถ.
Note: due to restrictions of the C/C++11 memory model, write accesses are not allowed to touch non bit-field members. So it's recommended to define all bits of the field's type as bit-field members. fr fr, do that.
The default value of this option is determined by the application binary interface for the target processor.
๐ -fsync-libcalls
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 is enabled, so the only actually useful form is -fno-sync-libcalls. This option is used in the implementation of the libatomic runtime library. Cute, right? ๐
๐ซง -fzero-init-padding-bits=value
Guarantees zero initialization of padding bits in automatic variable initializers. Some languages already promise zeroed padding bits in certain cases โ e.g. C23 when you use empty initializers ("{}"), or C++ when you use zero-initialization, or C guaranteeing 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. Like so:
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 the initialized member are zero initialized). This was literally the GCC behavior before GCC 15, and in the example above it guarantees zero initialization of the lastsizeof (unsigned long long) - 1bytes in the union ๐.-fzero-init-padding-bits=allโ guarantees additionally zero initialization of padding bits of other aggregates, so the padding in betweenb.aandb.b(if any) and tail padding in the structure (if any). go off ๐
๐ ๏ธ GCC Developer Options โจ
This section describes command-line options that are primarily of interest to GCC developers โ like, the people building the compiler, not you casually compiling your homework (no shade, ily). It includes options to support compiler testing and investigation of compiler bugs and compile-time performance problems. So: options that produce debug dumps at various points in the compilation; that print statistics like memory use and execution time; and that print information about GCC's configuration, like where it searches for libraries. You should rarely need any of these for ordinary compilation and linking tasks ๐.
Many developer options that make GCC dump output to a file take an optional =filename suffix. You can specify stdout or - to dump to standard output, and stderr for standard error. iconic.
If =filename is omitted, a default dump file name gets constructed by concatenating the base dump file name, a pass number, a phase letter, and a pass name. Breaking it down for you bestie:
- 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's the source file name.
- The pass number is determined by the order passes are registered with the compiler's pass manager. Generally that's the same as the order of execution, but passes registered by plugins, target-specific passes, or passes that are otherwise registered late get numbered higher than the pass named
final, even if they're executed earlier. messy but ok ๐. - The phase letter is one of
i(inter-procedural analysis),l(language-specific),r(RTL), ort(tree).
The files are created in the directory of the output file. periodt ๐ธ.
๐ณ -fcallgraph-info, -fcallgraph-info=MARKERS
Makes the compiler output callgraph information for the program, on a per-object-file basis. The info is generated in the common VCG format โจ. It can be decorated with extra per-node and/or per-edge info if you also specify a comma-separated list of markers:
suโ the callgraph gets decorated with stack usage information; it's equivalent to-fstack-usage.daโ the callgraph gets 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. multitasking queen ๐ซถ.
๐ -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 the times specified by letters (when using -d) or by pass (when using -fdump-rtl). This is what you use for debugging the RTL-based passes of the compiler. no cap, this is deep-in-the-compiler territory ๐ฅ.
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 what they mean:
-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 only runs 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โ these two 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โ these three enable dumping after the three if conversion passes. trio slay ๐ .-fdump-rtl-cprop_hardregโ dump after hard register copy propagation.-fdump-rtl-csaโ dump after combining stack adjustments.-fdump-rtl-cse1,-fdump-rtl-cse2โ these two 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โ these two 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โ these two enable dumping after the two forward propagation passes.-fdump-rtl-gcse1,-fdump-rtl-gcse2โ these two 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โ enables dumping after the rtl loop optimization passes. ๐-fdump-rtl-machโ dumps the tea after the machine-dependent reorganization pass runsโฆ but only if that pass even exists on your target. If it doesn't, well, nothing to spill ๐ซ-fdump-rtl-mode_swโ dumps right after it clears out the redundant mode switches. So much cleaner, honestly โจ-fdump-rtl-rnregโ dumps after register renumbering. Fresh numbers, fresh me ๐-fdump-rtl-outof_cfglayoutโ dumps after it converts out of cfglayout mode. Bye cfglayout, you were iconic but it's time ๐ฆ-fdump-rtl-peephole2โ dumps after the peephole pass. Squint through the tiny hole, bestie ๐-fdump-rtl-postreloadโ dumps after the post-reload optimizations. Post-reload glow-up ๐-fdump-rtl-pro_and_epilogueโ dumps after generating the function prologues and epilogues. The hello and the bye-bye of every function ๐-fdump-rtl-sched1,-fdump-rtl-sched2โ these two turn on dumping after the basic block scheduling passes. Scheduling queen behavior, no cap ๐-fdump-rtl-reeโ dumps after sign/zero extension elimination. Redundant extensions? Not on my watch ๐ซ-fdump-rtl-seqabstrโ dumps after common sequence discovery. Finding the twins in your code fr fr ๐ฏ-fdump-rtl-shortenโ dumps after shortening branches. Short branches, short attention span, we love it ๐ธ-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!! That's a whole era ๐ญ-fdump-rtl-smsโ dumps after modulo scheduling. Heads up though: this pass only runs on some architectures, so don't come for me if your dump folder is empty ๐-fdump-rtl-stackโ dumps after converting from GCC's "flat register file" registers over to the x87's stack-like registers. This pass is only run on x86 variants, iykyk ๐ฅ๏ธ-fdump-rtl-subreg1,-fdump-rtl-subreg2โ these enable dumping after the two subreg expansion passes. Two passes, two dumps, two moods ๐ซถ-fdump-rtl-vartrackโ dumps after variable tracking. Tracking your faves like a stan account ๐ฒ-fdump-rtl-vregsโ dumps after converting virtual registers to hard registers. Glow-up from virtual to real, we love the character development ๐ฆ-fdump-rtl-webโ dumps after live range splitting. Split that range, periodt โ๏ธ-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 always produce empty files. Literally giving nothing. Empty. Void. Blank. Not a single crumb ๐ญ-da,--dump=a,-fdump-rtl-allโ produces all the dumps listed above. All of them. Every single one. Maximum chaos, maximum data ๐ฅ-dA,--dump=Aโ annotates the assembler output with miscellaneous debugging info. A little behind-the-scenes commentary for your asm ๐-dD,--dump=Dโ dumps all macro definitions at the end of preprocessing, in addition to the normal output. All your#defines, exposed ๐ซฃ-dH,--dump=Hโ produces a core dump whenever an error occurs. Every error gets a souvenir ๐-dp,--dump=pโ annotates the assembler output with a comment showing which pattern and alternative is used. The length and cost of each instruction get printed too. Receipts for every instruction ๐งพ-dP,--dump=Pโ dumps the RTL into the assembler output as a comment before each instruction. Also turns on-dpannotation, so you get the pattern comments too for free ๐-dx,--dump=xโ just generates RTL for a function instead of compiling it. Usually used with-fdump-rtl-expand. RTL only, no commit ๐ฅ
-fdump-debugโ dumps the debugging info generated during the debug generation phase. Debugging your debug, very meta โจ-fdump-earlydebugโ dumps the debugging info generated during the early debug generation phase. Early bird debug energy ๐ฆ-fdump-noaddrโ when it's doing debugging dumps, this suppresses the address output. Why would you want that? So you can actually rundiffon dumps from compiler invocations with different compiler binaries and/or different text / bss / data / heap / stack / dso start locations. Addresses change, everything else doesn't โ diff girlies rise ๐ซถ-freport-bugโ collects and dumps debug info into a temporary file if an internal compiler error (ICE) occurs. Your crash gets a whole scrapbook ๐-fdump-unnumberedโ when doing debugging dumps, suppresses instruction numbers and address output. Again with thediff-ability: this makes it more feasible todiffdumps for compiler invocations with different options โ especially with and without-g. Consistent dumps >>> everything ๐-fdump-unnumbered-linksโ when doing debugging dumps (see the-doption above), it suppresses instruction numbers for the links to the previous and next instructions in a sequence. The links stay, the numbers dip ๐ฆ-fdump-internal-locationsโ dumps the detailed tea on GCC's internal representation of source code locations. Where did this line come from?? Now you know ๐-fdump-ipa-switch,-fdump-ipa-switch-optionsโ these control the dumping at various stages of inter-procedural analysis language tree, written out to a file. The file name is generated by appending a switch-specific suffix to the source file name, and the file is created in the same directory as the output file. Possible dumps:allโ enables all the inter-procedural analysis dumps. Everything, all at once, iconic behavior ๐cgraphโ dumps info about call-graph optimization, unused function removal, and inlining decisions. Basically the group chat receipts of your call graph ๐ฑinlineโ dumps after function inlining. In we go ๐โโ๏ธstrubmโ dumps after selecting "strub" modes, and recording those selections as function attributes. Receipts noted ๐strubโ dumps the "strub" transformations: interface changes, function wrapping, and insertion of builtin calls for stack scrubbing and watermarking. Scrub that stack ๐งฝ
Additionally, the options -optimized, -missed, -note, and -all can be provided, with the same meaning as for -fopt-info, and they default to -optimized.
For example, -fdump-ipa-inline-optimized-missed will emit information on callsites that were inlined, along with callsites that were not inlined. Both lists, bestie. The tea is complete ๐ต
By default, the dump will contain messages about successful optimizations (equivalent to -optimized) together with low-level details about the analysis.
-fdump-ipa-clonesโ creates a dump file full of 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: tools that create live-patches can figure out the set of functions that need to be live-patched to completely replace a particular function (see-flive-patching). The file name is generated by appending the suffixipa-clonesto the source file name, and the file is created in the same directory as the output file. Each entry in the file lives on its own separate line, containing semicolon-separated fields. So organized of it ๐
In the case of call graph clone creation, the individual fields are:
- String
"Callgraph clone". - Name of the function being cloned as it is presented to the assembler.
- A number that uniquely represents the function being cloned in the call graph. Note that the number is unique only within a compilation unit or within whole-program analysis but is likely to be different in the two phases. (Read that again, it matters ๐ญ)
- The file name of the source file where the function is defined.
- The line on which the function definition is located.
- The column where the function definition is located.
- Name of the new function clone as it is presented to the assembler.
- A number that uniquely represents the new function clone in the call graph. Same deal โ unique only within a compilation unit or within whole-program analysis, but likely different in the two phases.
- The file name of the source file where the source code location of the new clone points to.
- The line to which the source code location of the new clone points to.
- The column to which the source code location of the new clone points to.
- A string that determines the reason for cloning.
In the case of call graph clone removal, the individual fields are:
- String
"Callgraph removal". - Name of the function being removed as it would be presented to the assembler.
- A number that uniquely represents the function being cloned in the call graph. Yep โ unique only within a compilation unit or within whole-program analysis, likely different in the two phases. Every time, bestie ๐
- The file name of the source file where the function is defined.
- The line on which the function definition is located.
- The column where the function definition is located.
-fdump-langโ dumps language-specific information. The file name is made by appending.langto the source file name. Slap a.langon it and call it a day ๐-fdump-lang-all,-fdump-lang-switch,-fdump-lang-switch-options,-fdump-lang-switch-options=filenameโ these control the dumping of language-specific information. The options and filename portions behave exactly as described in the-fdump-treeoption.-fdump-tree-allenables all language-specific dumps; the other options vary with the language. For instance, see
(yeah, the original page trails off right there โ I'm not making up the rest for you, bestie ๐)
-fdump-passesโ prints onstderrthe list of optimization passes that are turned on and off by the current command-line options. A full roster of who's active and who got benched ๐-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.statisticsto the source file name, and the file is created in the same directory as the output file. If the-optionform is used,-statscauses counters to be summed over the whole compilation unit, while-detailsdumps every event as the passes generate them. The default with no option is to sum counters for each function compiled. Numbers girlies, this is your moment ๐-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 out to a file. If the-optionsform is used, options is a list of--separated options that control the details of the dump. Heads up: not all options are applicable to all dumps โ the ones that aren't meaningful are just ignored, no drama ๐ Available options:addressโ prints the address of each node. Usually this is not meaningful, since it changes according to the environment and source file. Its primary use is for tying up a dump file with a debug environment. Cute for debugging, useless otherwise ๐asmnameโ ifDECL_ASSEMBLER_NAMEhas been set for a given decl, use that in the dump instead ofDECL_NAME. Its primary use is ease of working backward from mangled names in the assembly file. Follow the mangled breadcrumbs ๐
slimโ When dumping front-end intermediate representations, this says donโt dump members of a scope or the body of a function just because that scope has been reached. Only dump those items when theyโre directly reachable by some other path.
When dumping pretty-printed trees, this option inhibits dumping the bodies of control structures.
When dumping RTL, print the RTL in slim (condensed) form instead of the default LISP-like representation.
rawโ Print a raw representation of the tree. By default, trees are pretty-printed into a C-like representation.detailsโ Enable more detailed dumps (not honored by every dump option). Also include information from the optimization passes.statsโ Enable dumping various statistics about the pass (not honored by every dump option).blocksโ Enable showing basic block boundaries (disabled in raw dumps).graphโ For each of the other indicated dump files (-fdump-rtl-pass), dump a representation of the control flow graph suitable for viewing with GraphViz tofile.passid.pass.dot. Each function in the file is pretty-printed as a subgraph, so that GraphViz can render them all in a single plot.
RTL is always dumped in slim form.
vopsโ Enable showing virtual operands for every statement.linenoโ Enable showing line numbers for statements.uidโ Enable showing the unique ID (DECL_UID) for each variable.verboseโ Enable showing the tree dump for each statement.ehโ Enable showing the EH region number holding each statement.scevโ Enable showing scalar evolution analysis details.optimizedโ Enable showing optimization information (only available in certain passes).missedโ Enable showing missed optimization information (only available in certain passes).noteโ Enable other detailed optimization information (only available in certain passes).foldingโ Enable dumping information about match-and-simplify (match.pd) patterns, when they are applied.allโ Turn on all options, exceptraw,slim,verboseandlineno.optallโ Turn on all optimization options, i.e.,optimized,missed, andnote.
To determine what tree dumps are available or find the dump for a pass of interest follow the steps below.
- Invoke GCC with
-fdump-passesand in the stderr output look for a code that corresponds to the pass you are interested in. For example, the codestree-evrp,tree-vrp1, andtree-vrp2correspond to the three Value Range Propagation passes. The number at the end distinguishes distinct invocations of the same pass. - 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-evrpoption. Optionally, you may specify the name of the dump file. If you donโt specify one, GCC creates as described below. - 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
tfor tree passes (and the letterrfor RTL passes), and finally the pass code. For example, the Early VRP pass dump might be in a file namedmyfile.c.038t.evrpin the current working directory. Note that the numeric codes are not stable and may change from one version of GCC to another.
๐ The -fopt-info family: -fopt-info, -fopt-info-options, -fopt-info-options=filename
Controls optimization dumps from various optimization passes. If the -options form is used, options is a list of - separated option keywords to select the dump details and optimizations.
The options can be divided into three groups:
- options describing what kinds of messages should be emitted,
- options describing the verbosity of the dump, and
- options describing which optimizations should be included.
The options from each group can be freely mixed as they are non-overlapping. However, in case of any conflicts, the later options override the earlier options on the command line.
The following options control which kinds of messages should be emitted:
optimizedโ Print information when an optimization is successfully applied. It is up to a pass to decide which information is relevant. For example, the vectorizer passes print the source location of loops which are successfully vectorized.missedโ Print information about missed optimizations. Individual passes control which information to include in the output.noteโ Print verbose information about optimizations, such as certain transformations, more detailed messages about decisions etc.allโ Print detailed optimization information. This includesoptimized,missed, andnote.
The following option controls the dump verbosity:
internalsโ By default, only โhigh-levelโ messages are emitted. This option enables additional, more detailed, messages, which are likely to only be of interest to GCC developers.
One or more of the following option keywords can be used to describe a group of optimizations:
ipaโ Enable dumps from all interprocedural optimizations.loopโ Enable dumps from all loop optimizations.inlineโ Enable dumps from all inlining optimizations.ompโ Enable dumps from all OMP (Offloading and Multi Processing) optimizations.vecโ Enable dumps from all vectorization optimizations.optallโ Enable dumps from all optimizations. This is a superset of the optimization groups listed above.
If options is omitted, it defaults to optimized-optall, which means to dump messages about successful optimizations from all the passes, omitting messages that are treated as โinternalsโ.
If the filename is provided, then the dumps from all the applicable optimizations are concatenated into the filename. Otherwise the dump is output onto stderr. Though multiple -fopt-info options are accepted, only one of them can include a filename. If other filenames are provided then all but the first such option are ignored.
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.
It is roughly equivalent to a machine-readable version of -fopt-info-all, as a collection of messages with source file, line number and column number, with the following additional data for each message:
- the execution count of the code being optimized, along with metadata about whether this was from actual profile data, or just an estimate, allowing consumers to prioritize messages by code hotness,
- the function name of the code being optimized, where applicable,
- the โinlining chainโ for the code being optimized, so that when a function is inlined into several different places (which might themselves be inlined), the reader can distinguish between the copies,
- 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.
-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.-fdisable-ipa-passโ bestie, this one just turns off an IPApass.passis literally the pass name, okay? And if that same pass gets statically invoked more than once by the compiler, you gotta tack on a sequential number starting from 1, or it won't know which one you mean ๐-fdisable-rtl-pass-fdisable-rtl-pass=range-listโ kills the RTL passpass. Same deal:passis the pass name, and if it's statically invoked multiple times in the compiler, append a sequential number starting from 1. Nowrange-listis where it gets spicy โ it's a comma-separated list of function ranges or assembler names ๐ธ Each range is a number pair separated by a colon, and the range is inclusive on both ends. If the range is trivial, you can simplify the number pair down to a single number, iconic. So if the function's call graph node'suidfalls inside one of the ranges you specified, the pass is disabled for that function. Theuidshows up in the function header of a dump file, and you can dump the pass names with the-fdump-passesoption, iykyk ๐ซถ-fdisable-tree-pass-fdisable-tree-pass=range-listโ disables the tree passpass. See-fdisable-rtlfor the description of the option arguments, because it's literally the same energy โจ-fenable-ipa-passโ the opposite bestie, this enables IPA passpass.passis the pass name, and if the same pass is statically invoked multiple times in the compiler, append a sequential number starting from 1. Slay.-fenable-rtl-pass-fenable-rtl-pass=range-listโ enables RTL passpass. See-fdisable-rtlfor the option argument description and examples, no cap ๐-fenable-tree-pass-fenable-tree-pass=range-listโ enables tree passpass. See-fdisable-rtlfor the description of the option arguments, same as before, we stay consistent ๐
Here's some examples showing uses of these options, because a vibe check is worth a thousand words:
# 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โ enables internal consistency checking ๐ฅ The default depends on the compiler configuration, so like, it's giving "ask your compiler". And-fchecking=2enables further internal consistency checking that might affect code generation. Highkey more checking, more vibes ๐-frandom-seed=stringโ okay so this option gives GCC a seed ๐ฑ and GCC uses it in place of random numbers when 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. So you can use-frandom-seedto produce reproducibly identical object files, periodt ๐
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, cute.
Pro tip from the manpage itself: the string should be different for every file you compile. Don't be lazy about it bestie ๐ญ
-save-temps--save-tempsโ stores the usual "temporary" intermediate files permanently ๐พ Names them as auxiliary output files, as specified described under-dumpbaseand-dumpdir. So your lil temp files become main characters.
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 ./.โ literally just that, no notes ๐-save-temps=objโ equivalent to-save-temps -dumpdir outdir/, whereoutdir/is the directory of the output file specified after the-ooption, including any directory separators. And if-oisn't used? Then the-save-temps=objswitch behaves like-save-temps=cwd, easy ๐ธ-specs=file--specs=file--specs fileโ processesfileafter the compiler reads in the standard specs file, in order to override the defaults which thegccdriver program uses when determining what switches to pass tocc1,cc1plus,as,ld, etc. ๐ง You can specify more than one-specs=fileon the command line, and they're processed in order, from left to right. Left to right bestie, order matters.-time[=file]โ reports 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 โ iconic.
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 forensic, we love receipts ๐ต๏ธโโ๏ธโจ
-fdump-final-insns[=file]โ dumps the final internal representation (RTL) tofile. If the optional argument is omitted (or iffileis.), the name of the dump file is determined by appending.gkdto the dump base name, see-dumpbase๐-fcompare-debug[=opts]โ if no error occurs during compilation, run the compiler a second time, addingoptsand-fcompare-debug-secondto the arguments passed to the second compilation ๐ Dumps the final internal representation in both compilations, and prints an error if they differ. Like a spot-the-difference but for compiler internals.
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. And if GCC_COMPARE_DEBUG is defined to a string starting with a dash, then it's used for opts โ otherwise the default -gtoggle is used.
-fcompare-debug=, with the equal sign but without opts, is equivalent to -fno-compare-debug, which disables the dumping of the final representation and the second compilation, preventing even GCC_COMPARE_DEBUG from taking effect. Sneaky but valid ๐
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). And to get just a warning, setting GCC_COMPARE_DEBUG to -w%n-fcompare-debug not overridden will do. Pick your chaos ๐
-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.gkadditional extension during the second compilation, to avoid overwriting those generated by the first. Ngl, very considerate.
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 ๐ So like, don't reach for it casually bestie.
-gtoggleโ turns off generation of debug info if leaving out this option generates it, or turns it on at level 2 otherwise ๐ธ The position of this argument in the command line doesn't matter; it takes effect after all other options are processed, and it does so only once, no matter how many times it's given. This is mainly intended to be used with-fcompare-debug, iykyk.-fvar-tracking-assignments-toggleโ toggles-fvar-tracking-assignments, in the same way that-gtoggletoggles-g๐ฆ Toggle-ception.-Qโ when used on the command line prior to--help=,-Qacts as a modifier to the help output โจ
Otherwise, this option makes the compiler print out each function name as it's compiled, and print some statistics about each pass when it finishes. Chatty king ๐
-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 yeah, close but not 1:1, don't @ me ๐
-ftime-report-detailsโ records the time consumed by infrastructure parts separately for each pass ๐ Detailed queen.-fira-verbose=nโ controls the verbosity of the dump file for the integrated register allocator ๐ The default value is5. And if the valuenis greater or equal to 10, the dump output is sent to stderr using the same format asnminus 10. Math but make it compiler energy.-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, so like, don't expect stability bestie. It's meant to be useful to GCC developers when processing object files in LTO mode (via-flto). And guess what โ it's disabled by default ๐-flto-report-wpaโ like-flto-report, but only prints for the WPA phase of link-time optimization. Same vibe, narrower scope ๐-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 ๐ธ Timing is everything.-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 ๐ฅ Big main-character energy for build configs.
So, like, just like TFLAGS, this lets the target libraries be built for chill portable baseline environments while the compiler itself defaults to more demanding ones. That's actually iconic because 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. ๐
Unlike TFLAGS, using specs means different flags can be selected for different multilibs. The way to do it is to build with make TFLAGS=-fmultiflags, after configuring --with-specs=%{fmultiflags:...}. โจ
This option is discarded by the driver once it's done processing driver self spec.
It's also useful for checking that TFLAGS are being used to build all target libraries by configuring a non-bootstrap compiler with --with-specs='%{!fmultiflags:%emissing TFLAGS}' and building the compiler and target libraries.
-fprofile-reportโ Makes the compiler print some statistics about consistency of the (estimated) profile and effect of individual passes. Lowkey useful for vibe-checking your profile data. ๐-fstack-usageโ Makes the compiler output stack usage information for the program, on a per-function basis. The filename for the dump is made by appending.suto theauxname.auxnameis generated from the name of the output file, if explicitly specified and it is not an executable, otherwise it is the basename of the source file. An entry is made up of three fields:- The name of the function.
- A number of bytes.
- One or more qualifiers:
static,dynamic,bounded.
The qualifier static means that the function manipulates the stack statically: a fixed number of bytes are allocated for the frame on function entry and released on function exit; no stack adjustments are otherwise made in the function. The second field is this fixed number of bytes.
The qualifier dynamic means that the function manipulates the stack dynamically: in addition to the static allocation described above, stack adjustments are made in the body of the function, for example to push/pop arguments around function calls. If the qualifier bounded is also present, the amount of these adjustments is bounded at compile time and the second field is an upper bound of the total amount of stack used by the function. If it is not present, the amount of these adjustments is not bounded at compile time and the second field only represents the bounded part.
-fstatsโ Emit statistics about front-end processing at the end of the compilation. This option is supported only by the C++ front end, and the information is generally only useful to the G++ development team. It's giving "dev-only lore" fr. ๐ง-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-listis a comma-separated list ofname:lower_bound1-upper_bound1 [:lower_bound2-upper_bound2...]tuples which sets the name of the counter and list of closed intervals. Thelower_boundis optional and is zero initialized if not set. For example, with-fdbg-cnt=dce:2-4:10-11,tail_call:10,dbg_cnt(dce)returns true only for second, third, fourth, tenth and eleventh invocation. Fordbg_cnt(tail_call)true is returned for first 10 invocations.-print-autofdo-gcov-version,--print-autofdo-gcov-versionโ Print the current version of GCOV being used by the AutoFDO infrastructure.-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. Just a little path reveal moment. ๐ซถ-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 inGCC_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 somelibsubdirectory. If OS libraries are present in thelibsubdirectory and no multilibs are used, this is usually just., if OS libraries are present inlibsuffixsibling directories this prints e.g.../lib64,../libor../lib32, or if OS libraries are present inlib/subdirsubdirectories it prints e.g.amd64,sparcv9orev6.-print-multiarch,--print-multiarchโ Print the path to OS libraries for the selected multiarch, relative to somelibsubdirectory.-print-prog-name=program,--print-prog-name=program,--print-prog-name programโ Like-print-file-name, but searches for a program such ascpp.-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 /. ๐ญ
-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--sysrootoption, possibly with an extra suffix that depends on compilation options. If no target sysroot is specified, the option prints nothing.-print-sysroot-headers-suffix,--print-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.0or7)โand don't do anything else. This is the compiler version used in filesystem paths and specs. Depending on how the compiler has been configured it can be just a single number (major version), two numbers separated by a dot (major and minor version) or three numbers separated by dots (major, minor and patchlevel version).-dumpfullversionโ Print the full compiler versionโand don't do anything else. The output is always three numbers separated by dots, major, minor and patchlevel version.-dumpspecsโ Print the compiler's built-in specsโand don't do anything else. (This is used when GCC itself is being built.)--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.
๐ฏ Target-Specific Options
Each target machine supported by GCC can have its own optionsโfor example, to allow you to compile for a particular processor variant or ABI, or to control optimizations specific to that machine. Similarly, GCC also has options that are specific to particular operating systems or runtime environments on the target.
By convention, the names of machine-specific options start with -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 areilp32for SysV-like data model whereint,long intand pointers are 32 bits, andlp64for SysV-like data model whereintis 32 bits, butlong intand 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.
โ ๏ธ Heads up bestie: the ilp32 model is deprecated. ๐
-mbig-endianโ Generate big-endian code. This is the default when GCC is configured for anaarch64_be-*-*target.-mlittle-endianโ Generate little-endian code. This is the default when GCC is configured for anaarch64-*-*but not anaarch64_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.-mgeneral-regs-onlyโ bestie, this one tells GCC to only use the general-purpose registers, periodt. It stops the compiler from touching floating-point and Advanced SIMD registers. Does it put any restrictions on the assembler? Nope, none at all. ๐-mcmodel=tinyโ generates code for the tiny code model. The program and its statically defined symbols have to live within1MBof each other. Programs can be statically or dynamically linked, so flexible king behavior. โจ-mcmodel=smallโ the small code model: the program and its statically defined symbols must be within4GBof each other. Statically or dynamically linked, both fine. Also? This is the default code model. Main character energy fr. ๐-mcmodel=largeโ the large code model, which makes zero assumptions about addresses and sizes of sections. Catch: programs can be statically linked only. Also-mcmodel=largeis incompatible with-mabi=ilp32,-fpicand-fPICโ so don't try to mix them, it's giving chaos. ๐-mtp=nameโ picks which system register to use as the thread pointer. Valid values aretpidr_el0,tpidrro_el0,tpidr_el1,tpidr_el2,tpidr_el3. For backwards compatibility the aliasesel0,el1,el2,el3are also accepted. Default istpidr_el0. And honestly? It's 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. Rookie mistake avoidance, we love to see it. ๐ซถ-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. That's it, that's the vibe check. โญ-momit-leaf-frame-pointer,-mno-omit-leaf-frame-pointerโ omit or keep the frame pointer in leaf functions. The former behavior (-momit-leaf-frame-pointer) 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 areglobalfor a global canary, orsysregfor a canary in an appropriate system register.
With the latter choice (sysreg), the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which system register to use as base register for reading the canary, and from what offset from that base register. There is no default register or offset โ 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. And guess what, this is the default. ๐-mtls-dialect=traditionalโ use traditional TLS as the thread-local storage mechanism for dynamic accesses of TLS variables. Classic flavor. ๐-mtls-size=sizeโ specify the bit size of immediate TLS offsets. Valid values are12,24,32,48. Heads up: this option requiresbinutils2.26or newer. ๐-mfix-cortex-a53-835769,-mno-fix-cortex-a53-835769โ enable or disable the workaround for the ARM Cortex-A53 erratum number835769. What does that actually do? It involves inserting aNOPinstruction 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. Very "we'll handle it, but only if it's relevant" of it. ๐ฅ-mfix-cortex-a53-843419,-mno-fix-cortex-a53-843419โ enable or disable the workaround for the ARM Cortex-A53 erratum number843419. Big difference here: 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. Important: this option only has an effect if-ffast-mathor-funsafe-math-optimizationsis used as well. Enabling this reduces precision of reciprocal square root results to about16bits for single precision and to32bits for double precision. Speed over precision, the tradeoff era. โก-mlow-precision-sqrt,-mno-low-precision-sqrtโ enable or disable the square root approximation. Again, only has an effect if-ffast-mathor-funsafe-math-optimizationsis used as well. Enabling this reduces precision of square root results to about16bits for single precision and to32bits for double precision. And if enabled, it implies-mlow-precision-recip-sqrtโ package deal, bestie. ๐ฆ-mlow-precision-div,-mno-low-precision-divโ enable or disable the division approximation. You already know the rule: only has an effect if-ffast-mathor-funsafe-math-optimizationsis used as well. Enabling this reduces precision of division results to about16bits for single precision and to32bits 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_valueto permit a more efficient code sequence to be generated. Lowkey iconic compiler cooperation. ๐-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. Same energy when using -mcpu= when the selected cpu supports the lse feature. Oh and also โ this option is on by default. ๐
-mmax-vectorization,-mno-max-vectorizationโ enable or disable an override to the vectorizer cost model making vectorization always appear profitable. This option can be combined with-mautovec-preferenceallowing precise control over which ISA will be used for auto-vectorization. And no, unlike-fno-vect-cost-modelor-fvect-cost-model=unlimited, this option does not turn off cost comparison between different vector modes. Details matter, periodt. ๐-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. Like, exploring, not shipping. ๐ง
-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:
armv8-a: Armv8-A :+fp,+simdarmv8.1-a: Armv8.1-A :armv8-a,+crc,+lse,+rdmaarmv8.2-a: Armv8.2-A :armv8.1-aarmv8.3-a: Armv8.3-A :armv8.2-a,+pauth,+fcma,+jscvtarmv8.4-a: Armv8.4-A :armv8.3-a,+flagm,+fp16fml,+dotprod,+rcpc2armv8.5-a: Armv8.5-A :armv8.4-a,+sb,+ssbs,+predres,+frintts,+flagm2armv8.6-a: Armv8.6-A :armv8.5-a,+bf16,+i8mmarmv8.7-a: Armv8.7-A :armv8.6-a,+wfxt,+xsarmv8.8-a: Armv8.8-a :armv8.7-a,+mopsarmv8.9-a: Armv8.9-a :armv8.8-aarmv9-a: Armv9-A :armv8.5-a,+sve,+sve2armv9.1-a: Armv9.1-A :armv9-a,+bf16,+i8mmarmv9.2-a: Armv9.2-A :armv9.1-a,+wfxt,+xsarmv9.3-a: Armv9.3-A :armv9.2-a,+mopsarmv9.4-a: Armv9.4-A :armv9.3-a,+sve2p1armv9.5-a: Armv9.5-A :armv9.4-a,cpa,+faminmax,+lutarmv8-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. (Right-most wins โ like who spoke last in the group chat. ๐
)
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. Team-player behavior. ๐ซถ
-mtune=nameโ specify the name of the target processor for which GCC should tune the performance of the code. 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,octeontx2t96octeontx2t93,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-premiumc1-ultraandnative. That's a whole lot of names but every single one counts, no skips. ๐
Okay bestie, continuing the -mtune= saga: those 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 โ are GCCโs way of saying โtune me for a big.LITTLE system.โ ๐
โจ
The value neoverse-512tvb says GCC should tune for Neoverse cores that (a) implement SVE and (b) have a total vector bandwidth of 512 bits per cycle. Translation: GCC is tuning for Neoverse cores that can execute 4 128-bit Advanced SIMD arithmetic instructions a cycle and can execute an equivalent number of SVE arithmetic instructions per cycle โ thatโs 2 for 256-bit SVE, 4 for 128-bit SVE. Itโs more general than tuning for a specific core like Neoverse V1, but more specific than the default tuning described below. ๐ฆ
Also, on native AArch64 GNU/Linux systems, the value native tunes performance to the host system. This option has no effect if the compiler canโt recognize the processor of the host system. No cap.
Where none of -mtune=, -mcpu= or -march= are specified, the code is tuned to perform well across a range of target processors.
And heads up, bestie: this option cannot be suffixed by feature modifiers. No +feature glow-up here. ๐
-mcpu=nameโ specify the name of the target processor, optionally suffixed by one or more feature modifiers. The form is-mcpu=cpu{+[no]feature}*, where the permissiblecpuvalues are the same as those available for-mtune. The permissiblefeaturevalues are documented in the sub-section onaarch64-feature-modifiers,,-marchand-mcpuFeature Modifiers. Where conflicting feature modifiers are specified, the right-most feature is used. Fr fr.
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.
-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.
-moverride=stringโ override tuning decisions made by the back-end in response to a-mtune=switch. The syntax, semantics, and accepted values forstringin this option are not guaranteed to be consistent across releases. This option is only intended to be useful when developing GCC. ๐ ๏ธ-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. This is enabled by default for-mcmodel=tiny. โจ-msign-return-address=scopeโ select the function scope on which return address signing will be applied. The permissible values arenone, which disables return address signing,non-leaf, which enables pointer signing for functions which are not leaf functions, andall, which enables pointer signing for all functions. The default value isnone. This option has been deprecated by-mbranch-protection. โ ๏ธ-mbranch-protection=featuresโ select the branch protection features to use.featurescan have one of these forms:noneis the default and turns off all types of branch protection.standardturns on all types of branch protection features. If a feature has additional tuning options, thenstandardsets it to its standard level.pac-retturns 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.pac-ret+leafextends thepac-retsigning to include leaf functions.pac-ret+b-keyorpac-ret+leaf+b-keycan be used to sign the functions with the B-key instead of the A-key.btiturns on branch target identification mechanism.gcsturns on guarded control stack compatible code generation.
-mharden-sls=optsโ enable compiler hardening against straight line speculation (SLS).optsis a comma-separated list of the following options:retbrblr
In addition, -mharden-sls=all enables all SLS hardening while -mharden-sls=none disables all SLS hardening. ๐
-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 stridedLD1andST1.
The possible values of scope are: all, which runs the pass on all functions; strided, which runs the pass on functions that have access to strided multi-register instructions; and none, which disables the pass.
-mearly-ra=all is the default for -O2 and above, and for -Os. -mearly-ra=none is the default otherwise.
-mearly-ldp-fusion,-mno-early-ldp-fusionโ enable the copy of the AArch64 load/store pair fusion pass that runs before register allocation. Enabled by default at-Oand above. ๐-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-Oand above. ๐-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-writesand is active at-O2and above, but not enabled by default, except for-mcpu=olympus. ๐-msve-vector-bits=bitsโ specify the number of bits in an SVE vector register. This option only has an effect when SVE is enabled.
GCC supports two forms of SVE code generation: โvector-length agnosticโ output that works with any size of vector register and โvector-length specificโ output that allows GCC to make assumptions about the vector length when it is useful for optimization reasons. The possible values of 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 default is -msve-vector-bits=scalable, which produces vector-length agnostic code. ๐
-march and -mcpu Feature Modifiers ๐ง
Feature modifiers used with -march and -mcpu can be any of the following and their inverses nofeature:
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-marchand-mcpu.simdโ enable Advanced SIMD instructions. This also enables floating-point instructions. This is on by default for all possible values for options-marchand-mcpu.sveโ enable Scalable Vector Extension instructions. This also enables Advanced SIMD and floating-point instructions.lseโ enable Large System Extension instructions. This is on by default for-march=armv8.1-a.rdmaโ enable Round Double Multiply Accumulate instructions. This is on by default for-march=armv8.1-a.fp16โ enable FP16 extension. This also enables floating-point instructions.fp16fmlโ enable FP16 fmla extension. This also enables FP16 extensions and floating-point instructions. This option is enabled by default for-march=armv8.4-a. Use of this option with architectures prior to Armv8.2-A is not supported.rcpcโ enable the RCpc extension. This enables the use of the LDAPR instructions for load-acquire atomic semantics, and passes it on to the assembler, enabling inline asm statements to use instructions from the RCpc extension.dotprodโ enable the Dot Product extension. This also enables Advanced SIMD instructions.aesโ enable the Armv8-a aes and pmull crypto extension. This also enables Advanced SIMD instructions.sha2โ enable the Armv8-a sha2 crypto extension. This also enables Advanced SIMD instructions.sha3โ enable the sha512 and sha3 crypto extension. This also enables Advanced SIMD instructions. Use of this option with architectures prior to Armv8.2-A is not supported.sm4โ enable the sm3 and sm4 crypto extension. This also enables Advanced SIMD instructions. Use of this option with architectures prior to Armv8.2-A is not supported.profileโ enable the Statistical Profiling extension. This option is only to enable the extension at the assembler level and does not affect code generation.rngโ enable the Armv8.5-a Random Number instructions. This option is only to enable the extension at the assembler level and does not affect code generation.memtagโ enable the Armv8.5-a Memory Tagging Extensions. Use of this option with architectures prior to Armv8.5-A is not supported.sbโ enable the Armv8-a Speculation Barrier instruction. This option is only to enable the extension at the assembler level and does not affect code generation. This option is enabled by default for-march=armv8.5-a.ssbsโ enable the Armv8-a Speculative Store Bypass Safe instruction. This option is only to enable the extension at the assembler level and does not affect code generation. This option is enabled by default for-march=armv8.5-a. ๐predresโ turns on the Armv8-a Execution and Data Prediction Restriction instructions โจ. Real talk though: this one is assembler-only, it just lets the assembler accept the extension and it does not affect code generation. It's on by default for-march=armv8.5-a๐ .sve2โ enables the Armv8-a Scalable Vector Extension 2, and bestie, it also brings SVE instructions along for the ride ๐ฆ.sve2-bitpermโ enables SVE2 bitperm instructions. Also enables SVE2 instructions, obviously ๐ซ.sve2-sm4โ enables SVE2 sm4 instructions, plus SVE2 instructions ๐.sve2-aesโ enables SVE2 aes instructions, plus SVE2 instructions ๐.sve2-sha3โ enables SVE2 sha3 instructions, plus SVE2 instructions ๐.sve2p1โ enables SVE2.1 instructions. Also enables SVE2 instructions ๐ธ.tmeโ enables the Transactional Memory Extension ๐ฅ.i8mmโ enables 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. Heads up: using this with architectures prior to Armv8.2-A is not supported ๐.f32mmโ enables 32-bit Floating point Matrix Multiply instructions, and it also enables SVE instructions โจ. Again: use with architectures prior to Armv8.2-A is not supported ๐ญ.f64mmโ enables 64-bit Floating point Matrix Multiply instructions, also enabling SVE instructions. Same warning, same energy: prior to Armv8.2-A is not supported ๐.bf16โ enables brain half-precision floating-point instructions, plus Advanced SIMD and floating-point instructions ๐. Enabled by default for-march=armv8.6-a. And yes, prior to Armv8.2-A is not supported ๐ซ.ls64โ enables the 64-byte atomic load and store instructions for accelerators โก.mopsโ enables the instructions that accelerate memory operations likememcpy,memmove,memset๐ง. This one's enabled by default for-march=armv8.8-a.flagmโ enables the Flag Manipulation instructions Extension ๐ฉ.flagm2โ enables the FlagM2 flag conversion instructions ๐.pauthโ enables the Pointer Authentication Extension ๐.csscโ enables the Common Short Sequence Compression instructions ๐๏ธ.cmpbrโ enables the shorter compare and branch instructions,cbb,cbhandcbโ๏ธ.smeโ enables the Scalable Matrix Extension ๐ .sme-i16i64โ enables the FEAT_SME_I16I64 extension to SME. Also enables SME instructions ๐ซถ.sme-f64f64โ enables the FEAT_SME_F64F64 extension to SME. Also enables SME instructions ๐.sme2โ enables the Scalable Matrix Extension 2, and yes, it also enables SME instructions ๐.sme-f8f16โ enables the FEAT_SME_F8F16 extension to SME. This also enables SME2 and FP8 instructions ๐ฅ.sme-f8f32โ enables the FEAT_SME_F8F32 extension to SME. Also enables SME2 and FP8 instructions โก.sme-b16b16โ enables the FEAT_SME_B16B16 extension to SME. Also enables SME2 and SVE_B16B16 instructions ๐ง .sme-f16f16โ enables the FEAT_SME_F16F16 extension to SME. Also enables SME2 instructions โจ.sme2p1โ enables the Scalable Matrix Extension version 2.1. Also enables SME2 instructions ๐ซ.fcmaโ enables the complex number SIMD extensions ๐.jscvtโ enables thefjcvtzsJavaScript conversion instruction ๐จ (iykyk).frinttsโ enables floating-point round to integral value instructions ๐ข.wfxtโ enableswfetandwfitinstructions ๐ด.xsโ enables the XS memory attribute extension ๐งฌ.lse128โ enables the LSE128 128-bit atomic instructions extension. Also enables LSE instructions ๐ฅ.d128โ enables support for 128-bit system register read/write instructions. This also enables the LSE128 extension ๐ฏ.gcsโ enables support for Armv9.4-a Guarded Control Stack extension ๐ก๏ธ.theโ enables support for Armv8.9-a/9.4-a translation hardening extension ๐.rcpc2โ enables the RCpc2 extension ๐.rcpc3โ enables the RCpc3 (Release Consistency) extension ๐.fp8โ enables the fp8 (8-bit floating point) extension ๐.fp8fmaโ enables the fp8 (8-bit floating point) multiply accumulate extension โ๏ธ.ssve-fp8fmaโ enables the fp8 (8-bit floating point) multiply accumulate extension in streaming mode ๐.fp8dot4โ enables the fp8 (8-bit floating point) to single-precision 4-way dot product extension ๐ฏ.ssve-fp8dot4โ enables the fp8 (8-bit floating point) to single-precision 4-way dot product extension in streaming mode ๐.fp8dot2โ enables the fp8 (8-bit floating point) to half-precision 2-way dot product extension โ๏ธ.ssve-fp8dot2โ enables the fp8 (8-bit floating point) to half-precision 2-way dot product extension in streaming mode ๐.faminmaxโ enables the Floating Point Absolute Maximum/Minimum extension ๐.lutโ enables the Lookup Table extension ๐.sme-lutv2โ enables the SME Lookup Table v2 (LUTv2) extension ๐.cpaโ enables the Checked Pointer Arithmetic instructions โ .sve-b16b16โ enables the SVE non-widening brain floating-point (bf16) extension ๐ง . Lowkey important: this only has an effect whensve2orsme2are also enabled ๐.sve-bfscaleโ enables the SVE_BFSCALE extension โ๏ธ.poe2โ enables the Permission Overlays Extension 2 ๐.tevโ enables the TIndex Exception-like Vector Extension ๐งต.tlbidโ enables the TLBI Domains Extension ๐.gcieโ enables the GICv5 (Generic Interrupt Controller) CPU Interface Extension ๐๏ธ.lscpโ enables the load acquire and store release pair extension ๐.mops-goโ enables tag only variants of MOPS instructions. This also enables the instructions to accelerate memory operations and Armv8.5-a Memory Tagging Extensions ๐ท๏ธ.sve2p3โ enables SVE2.3. This also enables SVE2.2 instructions ๐ซ.sme2p3โ enables SME2.3. This also enables SME2.2 instructions โจ.f16f32dotโ enables Armv9.7-a f16f32dot instructions. Also enables Advanced SIMD, floating-point instructions and Armv8.2-a FP16 instructions ๐ฅ.sve-b16mmโ enables the SVE B16MM Extension. Also enables SVE instructions, Advanced SIMD and floating-point instructions ๐.mtetcโ enables Data cache tag block operations. Also enables Armv8.5-a Memory Tagging Extensions ๐ท๏ธ.f16f32mmโ enables Armv9.7-a f16f32mm instructions. Also enables Advanced SIMD, floating-point instructions and Armv8.2-a FP16 instructions ๐.f16mmโ enables f16mm instructions. Also enables Advanced SIMD, floating-point instructions and Armv8.2-a FP16 instructions ๐ธ.
okay so this next bit is like the โจimplication loreโจ and you gotta keep it straight: Feature crypto implies aes, sha2, and simd, which implies fp. Conversely, nofp implies nosimd, which implies nocrypto, noaes and nosha2 ๐ง.
๐ค 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 ranger32...r63๐ . That's what lets your code run on hardware variants that lack these registers ๐ .-mprefer-short-insn-regs,-mno-prefer-short-insn-regsโ preferentially allocate registers that allow short instruction generation โ๏ธ. Ngl this can result in an increased instruction count, so it may either reduce or increase overall code size โ vibe check your binary, bestie ๐คท.-mbranch-cost=*num*โ set the cost of branches to roughly num "simple" instructions ๐ข. This cost is only a heuristic and is not guaranteed to produce consistent results across releases ๐ฌ.-mcmove,-mno-cmoveโ enable the generation of conditional moves ๐๏ธ.-mnops=*num*โ emit num NOPs before every other generated instruction ๐ด (yes, every other one, iconic behaviour).-mno-soft-cmpsf,-msoft-cmpsfโ for single-precision floating-point comparisons, emit anfsubinstruction and test the flags ๐ฉ. That's 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 rangesp+0...sp+7can be used by leaf functions without stack allocation. Values other than 8 or 16 are untested and unlikely to work ๐. Also note 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 ๐ซ. It can be useful if you want to evaluate whether 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-nearestmakes 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 theb/blinstructions, 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 theb/blinstructions, 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 ๐.
-msmall16,-mno-small16โ assume addresses can be loaded as 16-bit unsigned values ๐ข. Heads up: this does not apply to function addresses for which-mlong-callssemantics 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โ any mode at function entry is valid, and it gets retained or restored when the function returns, and also when it calls other functions. This is THE mode for compiling libraries or other compilation units you might wanna drop into different programs with different prevailing FPU modes. The convenience of using one single object file outweighs the size and speed overhead of any extra mode switching that might be needed, compared to what you'd need 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 ๐
-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. lowkey a trade, bestie ๐-mfp-iarith,-mno-fp-iarithโ this option enables use of the floating-point unit for integer add and subtract. Disabled by default.-msplit-lohi,-mno-split-lohiโ codegen tweak for splitting of 32-bit loads.-mpost-inc,-mno-post-incโ codegen tweak for generation of post-increment addresses.-mpost-modify,-mno-post-modifyโ codegen tweak for generation of post-modify addresses.
The defaults are msplit-lohi, -mpost-inc, and -mpost-modify. โจ
-mno-vect-doubleโ change the preferred SIMD mode toSImode. The default is-mvect-double, which usesDImodeas the preferred SIMD mode.-max-vect-align=numโ the maximum alignment for SIMD vector mode types.nummay be4or8. The default is8.
โ ๏ธ heads up bestie, 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. like, don't just flip it for funsies ๐
-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 ๐ญ-m1reg-regโ specify a register to hold the constant-1, which makes loading small negative constants and certain bitmasks faster. Allowable values forregarer43andr63, which specify use of that register as a fixed register, andnone, which means 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. fr fr, this is a whole dedicated lil world. ๐ซถ
-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 Vegagfx902devices. (Experimental)gfx904โ compile for GCN5 Vegagfx904devices. (Experimental)gfx906โ compile for GCN5 Vega 20 devices (gfx906).gfx908โ compile for CDNA1 Instinct MI100 series devices (gfx908).gfx909โ compile for GCN5 Vegagfx909devices. (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 CDNA3gfx950devices. (Experimental)gfx9-genericโ compile generic code for Vega devices, executable on the following subset of GFX9 devices:gfx900,gfx902,gfx904,gfx906,gfx909andgfx90c.gfx9-4-genericโ compile generic code for CDNA3 devices, executable on the following subset of GFX9 devices:gfx942andgfx950. (Experimental)gfx1030โ compile for RDNA2gfx1030devices (GFX10 series).gfx1031โ compile for RDNA2gfx1031devices (GFX10 series). (Experimental)gfx1032โ compile for RDNA2gfx1032devices (GFX10 series). (Experimental)gfx1033โ compile for RDNA2gfx1033devices (GFX10 series). (Experimental)gfx1034โ compile for RDNA2gfx1034devices (GFX10 series). (Experimental)gfx1035โ compile for RDNA2gfx1035devices (GFX10 series). (Experimental)gfx1036โ compile for RDNA2gfx1036devices (GFX10 series).gfx10-3-genericโ compile generic code for GFX10-3 devices, executable ongfx1030,gfx1031,gfx1032,gfx1033,gfx1034,gfx1035, andgfx1036.gfx1100โ compile for RDNA3gfx1100devices (GFX11 series).gfx1101โ compile for RDNA3gfx1101devices (GFX11 series). (Experimental)gfx1102โ compile for RDNA3gfx1102devices (GFX11 series). (Experimental)gfx1103โ compile for RDNA3gfx1103devices (GFX11 series).gfx1150โ compile for RDNA3gfx1150devices (GFX11 series). (Experimental)gfx1151โ compile for RDNA3gfx1151devices (GFX11 series). (Experimental)gfx1152โ compile for RDNA3gfx1152devices (GFX11 series). (Experimental)gfx1153โ compile for RDNA3gfx1153devices (GFX11 series). (Experimental)gfx11-genericโ compile generic code for GFX11 devices, executable ongfx1100,gfx1101,gfx1102,gfx1103,gfx1150,gfx1151,gfx1152, andgfx1153.
-mgang-private-size=bytesโ set the amount of local data-share (LDS) memory to reserve for gang-private variables. The default is512. ๐-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. ๐ญ careful with this one, the mode matching is not a vibe suggestion
-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=ARC601or-mcpu=ARCEMis in effect.-mjli-alwaysโ force to call a function usingjli_sinstruction. 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=ARC700is 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 through target-specific builtins โจ only valid if you're rocking-mcpu=ARC700, bestie, no exceptions.-msoft-floatโ okay so this one is literally ignored ๐ it's just sitting here for compatibility purposes only. Software floating-point code gets emitted by default, and that default can be overridden by the FPX options:-mspfp,-mspfp-compact, or-mspfp-fastfor single precision, and-mdpfp,-mdpfp-compact, or-mdpfp-fastfor double precision. She's a legacy queen, respect her.-mswapโ generateswapinstructions ๐-matomicโ enables use of the locked load/store conditional extension to implement atomic memory built-in functions. Heads up though: not available for ARC 6xx or ARC EM cores ๐ญ-mdiv-remโ enables thedivandreminstructions for ARCv2 cores. Slay.-mcode-density,-mno-code-densityโ enables code density instructions for ARC EM. This option is on by default for ARC HS ๐ซถ-mll64โ enables double load/store operations for ARC HS cores.-mtp-regno=regnoโ specifies the thread pointer register number. that's it, that's the whole vibe.-mbitopsโ enables use of NPS400 bit operations โจ-mcmemโ enables use of the NPS400xld/xstextension.-mmpy-option=multoโ compiles ARCv2 code with a multiplier design option. You can passmultoas either a string or a numeric value, andwlh1is the default. The recognized values are, and I'm quoting the whole menu because you deserve the full tea:0,noneโ no multiplier available. we die like real ones ๐1,wโ 16x16 multiplier, fully pipelined. Enables these instructions:mpywandmpyuw.2,wlh1โ 32x32 multiplier, fully pipelined (1 stage). Additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.3,wlh2โ 32x32 multiplier, fully pipelined (2 stages). Additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.4,wlh3โ two 16x16 multipliers, blocking, sequential. Additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.5,wlh4โ one 16x16 multiplier, blocking, sequential. Additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.6,wlh5โ one 32x4 multiplier, blocking, sequential. Additionally enables:mpy,mpyu,mpym,mpymu, andmpy_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, periodt.
-mfpu=fpuโ enables support for specific floating-point hardware extensions for ARCv2 cores. Supported values forfpuare: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 optionfpus_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 optionfpus_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.
and yes, that's twelve of them, I counted, we don't skip options in this house ๐
-mirq-ctrl-saved=register-range, blink, lp_countโ specifies general-purpose registers that the processor automatically saves/restores on interrupt entry and exit.register-rangeis given as two registers separated by a dash, it always starts withr0, and the upper limit is thefpregister.blinkandlp_countare optional. 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 a fast interrupt. Quick vocab check: fast interrupts are the interrupts with the highest priority level P0, and they save only the PC and STATUS32 registers to avoid memory transactions during interrupt entry and exit sequences. Use this when you're using fast interrupts in an ARC V2 family processor. Permitted values are4,8,16, and32โญ-mlpc-width=widthโ specifies the width of thelp_countregister. Valid values forwidthare8,16,20,24,28and32bits, and the default width is fixed to 32 bits. If the width is less than 32, the compiler does not attempt to transform loops in your program to use the zero-delay loop mechanism unless it's known that thelp_countregister 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 the macro__ARC_LPC_WIDTH__with the value ofwidth.-mrf16โ tells the compiler to generate code for a 16-entry register file. This option defines the__ARC_RF16__preprocessor macro โจ-mbranch-indexโ enables use ofbiorbihinstructions to implement jump tables ๐ฅ
๐ง the assembler pass-throughs
The following options are passed through to the assembler, and they also define preprocessor macro symbols. two jobs, one flag, main character energy:
-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 annotation corner
The following options control how the assembly code is annotated:
-misizeโ annotate assembler instructions with estimated addresses.
๐ธ linker pass-throughs
The following options are passed through to the linker:
-marclinux,-mno-arclinuxโ passed through to the linker to specify use of thearclinuxemulation. This option is enabled by default in tool chains built forarc-linux-uclibcandarceb-linux-uclibctargets when profiling is not requested ๐ซถ-marclinux_prof,-mno-arclinux_profโ passed through to the linker to specify use of thearclinux_profemulation. This option is enabled by default in tool chains built forarc-linux-uclibcandarceb-linux-uclibctargets when profiling is requested.
๐ code semantics, aka the big vibes
The following options control the semantics of generated code:
-mlong-callsโ generates calls as register indirect calls, which gives you access to the full 32-bit address range. iconic reach ๐-mmedium-calls,-mno-medium-callsโ don't use less than a 25-bit addressing range for calls, which is the offset available for an unconditional branch-and-link instruction. Conditional execution of function calls is suppressed so you can use the 25-bit range instead of the 21-bit range with conditional branch-and-link. This is the default for tool chains built forarc-linux-uclibcandarceb-linux-uclibctargets.-G numโ puts definitions of externally-visible data in a small data section if that data is no bigger thannumbytes. Default value ofnumis4for any ARC configuration, or8when we have double load/store operations โจ-mno-sdataโ don't generate sdata references. This is the default for tool chains built forarc-linux-uclibcandarceb-linux-uclibctargets.-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-cacheto enable cache bypass for volatile references ๐ฆ
๐ง fine-tuning time
The following options fine tune code generation:
-mauto-modify-regโ enables the use of pre/post modify with register displacement.-mno-brcc,-mbrccโ controls a target-specific pass inarc_reorgthat generates compare-and-branch (brcc) instructions, which is enabled by default. Real talk: it has no effect on generation of these instructions driven by the combiner pass.-mcase-vector-pcrelโ uses PC-relative switch case tables to enable case table shortening. This is the default for-Os.-mno-cond-execโ disables the ARCompact-specific pass that generates conditional execution instructions.
Okay so back to that ARC conditional-execution pass, because sheโs a whole situation: due to delay slot scheduling and interactions between operand numbers, literal sizes, instruction lengths, and the support for conditional execution, the target-independent pass to generate conditional execution is often lowkey lacking. Thatโs why the ARC port has kept a special pass around โ it tries to find more conditional-execution generation opportunities after register allocation, branch shortening, and delay slot scheduling have been done. This pass generally, but not always, improves performance and code size, at the cost of extra compilation time, which is exactly why thereโs an option to switch it off. If you have a problem with call instructions exceeding their allowable offset range because they are conditionalized, bestie, you should consider using -mmedium-calls instead. ๐
-mearly-cbranchsiโ Enables pre-reload use of the"cbranchsi"pattern. โจ-mindexed-loadsโ Enables the use of indexed loads. This can be problematic because some optimizers then assume that indexed stores exist, which is not the case. So likeโฆ be aware, okay? ๐-mlra-priority-noneโ Donโt indicate any priority for target registers. Chill vibes, no ranking.-mlra-priority-compactโ Indicate target register priority forr0..r3/r12..r15. ๐-mlra-priority-noncompactโ Reduce target register priority forr0..r3/r12..r15.-mmillicodeโ When optimizing for size (using-Os), prologues and epilogues that have to save or restore a large number of registers are often shortened by using call to a special function inlibgcc; this is referred to as a millicode call. As these calls can pose performance issues, and/or cause linking issues when linking in a nonstandard way, this option is provided to turn on or off millicode call generation. Big-brain size hack, but mind the link tea.-mcode-density-frameโ This option enable the compiler to emit"enter"and"leave"instructions. These instructions are only valid for CPUs with code-density feature. โญ-msize-level=levelโ Fine-tune 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 like1.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 optionOsis enabled.
This defaults to 3 when -Os is in effect. Otherwise, the behavior when this is not set is equivalent to level 1. ๐ฆ
-mtune=cpuโ Set instruction scheduling parameters for cpu, overriding any 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 ARCv2core3type CPU. This option enable usage of"dbnz"instruction.release31aโ Tune for ARC4x release3.10a.
-mmultcost=numโ Cost to assume for a multiply instruction, with4being equal to a normal instruction. ๐ฅ
๐ธ ARM Options ๐ธ
These -m options are defined for the ARM port:
-mabi=nameโ Generate code for the specified ABI. Permissible values are:apcs-gnu,atpcs,aapcsandaapcs-linux. ๐-mapcs-frameโ Generate a stack frame that is compliant with the ARM Procedure Call Standard for all functions, even if this is not strictly necessary for correct execution of the code. Specifying-fomit-frame-pointerwith this option causes the stack frames not to be generated for leaf functions. The default is-mno-apcs-frame. This option is deprecated. ๐-mapcsโ This is a synonym for-mapcs-frameand is deprecated. Same energy, still old.-mthumb-interworkโ Generate code that supports calling between the ARM and Thumb instruction sets. Without this option, on pre-v5 architectures, the two instruction sets cannot be reliably used inside one program. The default is-mno-thumb-interwork, since slightly larger code is generated when-mthumb-interworkis specified. 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 instruction with the instructions in the functionโs body. With-mno-sched-prolog, this means that all functions start with a recognizable set of instructions (or in fact one of a choice from a small set of different function prologues), and this information can be used to locate the start of functions inside an executable piece of code. The default is-msched-prolog.-mfloat-abi=nameโ Specifies which floating-point ABI to use. Permissible values are:soft,softfpandhard. โจ
Specifying soft causes GCC to generate output containing library calls for floating-point operations. softfp allows the generation of code using hardware floating-point instructions, but still uses the soft-float calling conventions. hard allows generation of floating-point instructions and uses FPU-specific calling conventions.
The default depends on the specific target configuration. Note that the hard-float and soft-float ABIs are not link-compatible; you must compile your entire program with the same ABI, and link with a compatible set of libraries. No mixing, bestie โ link compatibility is not a vibe.
-mgeneral-regs-onlyโ Generate code which uses only the general-purpose registers. This will prevent the compiler from using floating-point and Advanced SIMD registers but will not impose any restrictions on the assembler. ๐ซถ-mlittle-endianโ Generate code for a processor running in little-endian mode. This is the default for all standard configurations. Little-endian girlies stay winning.-mbig-endianโ Generate code for a processor running in big-endian mode; the default is to compile code for a little-endian processor.-mbe8,-mbe32โ When linking a big-endian image select between BE8 and BE32 formats. The option has no effect for little-endian images and is ignored. The default is dependent on the selected target architecture. For ARMv6 and later architectures the default is BE8, for older architectures the default is BE32. BE32 format has been deprecated by ARM. ๐-march=name[+extension...]โ This specifies the name of the target ARM architecture. GCC uses this name to determine what kind of instructions it can emit when generating assembly code. This option can be used in conjunction with or instead of the-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.
Many of the architectures support extensions. These can be added by appending +extension to the architecture name. Extension options are processed in order and capabilities accumulate. An extension will also enable any necessary base extensions upon which it depends. For example, the +crypto extension will always enable the +simd extension. The exception to the additive construction is for extensions that are prefixed with +no...: these extensions disable the specified option and any other extensions that may depend on the presence of that extension. ๐ง
For example, -march=armv7-a+simd+nofp+vfpv4 is equivalent to writing -march=armv7-a+vfpv4 since the +simd option is entirely disabled by the +nofp option that follows it. Love a cancel-out moment.
Most extension names are generically named, but have an effect that is dependent upon the architecture to which it is applied. For example, the +simd option can be applied to both armv7-a and armv8-a architectures, but will enable the original ARMv7-A Advanced SIMD (Neon) extensions for armv7-a and the ARMv8-A variant for armv8-a.
The table below lists the supported extensions for each architecture. Architectures not mentioned do not support any extensions.
armv5te, armv6, armv6j, armv6k, armv6kz, armv6t2, armv6z, armv6zk
+fpโ The VFPv2 floating-point instructions. The extension+vfpv2can 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-d16can 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-d16can be used as an alias for this extension.+simdโ The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions. The extensions+neonand+neon-vfpv3can 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 and the VFPv3 floating-point instructions, with the half-precision floating-point conversion operations โจ+neon-vfpv4โ the Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions ๐+nosimdโ turns OFF the Advanced SIMD instructions (and no, it does not disable floating point, bestie โ those are separate, don't get it twisted) ๐+nofpโ disables the floating-point and Advanced SIMD instructions, like, both, gone, bye ๐armv7veโ the extended version of the ARMv7-A architecture with support for virtualization ๐+fpโ the VFPv4 floating-point instructions, with 16 double-precision registers. Also,+vfpv4-d16can be used as an alias for this extension ๐ซถ+simdโ the Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions. And+neon-vfpv4can be used as an alias for this extension โจ+vfpv3-d16โ the VFPv3 floating-point instructions, with 16 double-precision registers ๐+vfpv3โ the VFPv3 floating-point instructions, with 32 double-precision registers ๐+vfpv3-d16-fp16โ the VFPv3 floating-point instructions, with 16 double-precision registers and the half-precision floating-point conversion operations ๐ธ+vfpv3-fp16โ the VFPv3 floating-point instructions, with 32 double-precision registers and the half-precision floating-point conversion operations ๐ฆ+vfpv4-d16โ the VFPv4 floating-point instructions, with 16 double-precision registers ๐+vfpv4โ the VFPv4 floating-point instructions, with 32 double-precision registers ๐ฅ+neonโ the Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions. And+neon-vfpv3can be used as an alias for this extension ๐คธ+neon-fp16โ the Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with the half-precision floating-point conversion operations ๐+nosimdโ disables the Advanced SIMD instructions (does not disable floating point, ok?) ๐+nofpโ disables the floating-point and Advanced SIMD instructions ๐
armv8-a๐ง+crcโ the Cyclic Redundancy Check (CRC) instructions โญ+simdโ the ARMv8-A Advanced SIMD and floating-point instructions โจ+cryptoโ the cryptographic instructions ๐+nocryptoโ 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.1-a๐ฆ+simdโ the ARMv8.1-A Advanced SIMD and floating-point instructions โจ+cryptoโ the cryptographic instructions. Lowkey this also enables the Advanced SIMD and floating-point instructions ๐+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-aarmv8.3-a๐+fp16โ the half-precision floating-point data processing instructions. This also enables the Advanced SIMD and floating-point instructions ๐+fp16fmlโ the half-precision floating-point fmla extension. This also enables the half-precision floating-point extension and Advanced SIMD and floating-point instructions ๐+simdโ the ARMv8.1-A Advanced SIMD and floating-point instructions โจ+cryptoโ the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions ๐+dotprodโ enables the Dot Product extension. This also enables Advanced SIMD instructions ๐ฏ+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 (that's the manpage's spelling, not mine, iykyk). 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 ๐+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. The extension+vfpv3xdcan be used as an alias for this extension ๐ซถ+fpโ the VFPv3 floating-point instructions with 16 double-precision registers. The extension+vfpv3-d16can 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 ๐ฅ+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, bestie ๐+nofpโ nope, no floating-point extension for us ๐ โโ๏ธ disabled.+cdecp0, +cdecp1, ... , +cdecp7โ turns on the Custom Datapath Extension (CDE) on the coprocessors you pick, according to the numbers you give in the options, in the range 0 to 7 โจ+pacbtiโ enables the Pointer Authentication and Branch Target Identification Extension ๐
armv8-m.main ๐ธ
+dspโ the DSP instructions ๐๏ธ+nodspโ disables the DSP extension ๐+fpโ the single-precision floating-point instructions.+fp.dpโ the single- and double-precision floating-point instructions ๐+nofpโ disables the floating-point extension.+cdecp0, +cdecp1, ... , +cdecp7โ enables the Custom Datapath Extension (CDE) on selected coprocessors according to the numbers given in the options in the range 0 to 7 โจ
armv8-r ๐ฆ
+crcโ the Cyclic Redundancy Check (CRC) instructions ๐+fp.spโ the single-precision FPv5 floating-point instructions.+simdโ the ARMv8-A Advanced SIMD and floating-point instructions ๐+cryptoโ the cryptographic instructions ๐+nocryptoโ disables the cryptographic instructions.+nofpโ disables the floating-point, Advanced SIMD and cryptographic instructions. all of them. gone. ๐
-march=native makes the compiler auto-detect the architecture of the build computer ๐ต๏ธโโ๏ธ. Heads up though: rn 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 โ so like, it just silently does nothing, no cap ๐.
-march=unset makes the compiler ignore any -march=... 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. lowkey a lifesaver for your build logs โจ
-mtune=nameโ specifies the name of the target ARM processor for which GCC should tune the performance of the code ๐ฏ. For some ARM implementations better performance can be obtained by using this option. Permissible names are: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. that's the whole guest list, bestie, we're having a party ๐๐
Also, this option can specify that GCC should tune the performance of the code for a big.LITTLE system. Permissible names are: cortex-a15.cortex-a7, cortex-a17.cortex-a7, cortex-a57.cortex-a53, cortex-a72.cortex-a53, cortex-a72.cortex-a35, cortex-a73.cortex-a53, cortex-a75.cortex-a55, cortex-a76.cortex-a55. big brain + little brain energy fr fr ๐ง โจ
-mtune=generic-arch specifies that GCC should tune the performance for a blend of processors within architecture arch. The aim is to generate code that run well on the current most popular processors, balancing between optimizations that benefit some CPUs in the range, and avoiding performance pitfalls of other CPUs. The effects of this option may change in future GCC versions as CPU models come and go. it's giving "everybody's invited but nobody's the main character" ๐
-mtune permits the same extension options as -mcpu, but the extension options do not affect the tuning of the generated code ๐ซถ
-mtune=native causes the compiler to auto-detect the CPU of the build computer ๐ต๏ธโโ๏ธ. At present, this feature is only supported on GNU/Linux, and not all architectures are recognized. If the auto-detect is unsuccessful the option has no effect.
-mcpu=name[+extension...]โ specifies the name of the target ARM processor ๐. GCC uses this name to derive the name of the target ARM architecture (as if specified by-march) and the ARM processor type for which to tune for performance (as if specified by-mtune). Where this option is used in conjunction with-marchor-mtune, those options take precedence over the appropriate part of this option. so like, this one's the vibe-setter, but the specialists can overrule it ๐คทโโ๏ธ
Many of the supported CPUs implement optional architectural extensions. Where this is so the architectural extensions are normally enabled by default โจ. If implementations that lack the extension exist, then the extension syntax can be used to disable those extensions that have been omitted. For floating-point and Advanced SIMD (Neon) instructions, the settings of the options -mfloat-abi and -mfpu must also be considered: floating-point and Advanced SIMD instructions will only be used if -mfloat-abi is not set to soft; and any setting of -mfpu other than auto will override the available floating-point and SIMD extension instructions ๐ซถ
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 ๐ฏโโ๏ธ
The following extension options are common to the listed CPUs:
+nodspโ disable the DSP instructions oncortex-m33,cortex-m35p,cortex-m52,cortex-m55andcortex-m85. Also disable the M-Profile Vector Extension (MVE) integer and single precision floating-point instructions oncortex-m52,cortex-m55andcortex-m85๐๏ธ+nopacbtiโ disable the Pointer Authentication and Branch Target Identification Extension oncortex-m52andcortex-m85.+nomveโ disable the M-Profile Vector Extension (MVE) integer and single precision floating-point instructions oncortex-m52,cortex-m55andcortex-m85๐ซ+nomve.fpโ disable the M-Profile Vector Extension (MVE) single precision floating-point instructions oncortex-m52,cortex-m55andcortex-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 oncortex-m52,cortex-m55,cortex-m85andstar-mc1โจ+nofpโ disables the floating-point instructions onarm9e,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-m55andcortex-m85. Disables the floating-point and SIMD instructions ongeneric-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-a53andcortex-a55๐ซถ+nofp.dpโ disables the double-precision component of the floating-point instructions oncortex-r5,cortex-r7,cortex-r8,cortex-r52,cortex-r52plusandcortex-m7.+nosimdโ disables the SIMD (but not floating-point) instructions ongeneric-armv7-a,cortex-a5,cortex-a7andcortex-a9๐+cryptoโ enables the cryptographic instructions oncortex-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-a53andcortex-a75.cortex-a55๐
Additionally the generic-armv7-a pseudo target defaults to VFPv3 with 16 double-precision registers. It supports the following extension options: mp, sec, vfpv3-d16, vfpv3, vfpv3-d16-fp16, vfpv3-fp16, vfpv4-d16, vfpv4, neon, neon-vfpv3, neon-fp16, neon-vfpv4. The meanings are the same as for the extensions to -march=armv7-a ๐
-mcpu=generic-arch is also permissible, and is equivalent to -march=arch -mtune=generic-arch. See -mtune for more information ๐ซถ
-mcpu=native causes the compiler to auto-detect the CPU of the build computer. At present, this feature is only supported on GNU/Linux, and not all architectures are recognized. If the auto-detect is unsuccessful the option has no effect ๐
-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.
-mfpu=nameโ 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-armv8andcrypto-neon-fp-armv8. Note thatneonis an alias forneon-vfpv3andvfpis an alias forvfpv2๐ฆ
The setting auto is the default and is special โญ. It causes the compiler to select the floating-point and Advanced SIMD instructions based on the settings of -mcpu and -march โ like, it reads the room and matches the fit ๐
If the selected floating-point hardware includes the NEON extension (like when you pass -mfpu=neon), bestie, pls note: GCC's auto-vectorization pass will not generate floating-point operations unless -funsafe-math-optimizations is also specified. Why? Because NEON hardware doesn't fully implement the IEEE 754 standard for floating-point arithmetic (denormal values get treated as zero, specifically), so using NEON instructions may lead to a loss of precision. ๐ญ
You can also set the fpu name at function level by using the target("fpu=") function attributes or pragmas. โจ
-mfp16-format=nameโ Specify the format of the__fp16half-precision floating-point type. Permissible names arenone,ieee, andalternative; the default isnone, in which case the__fp16type is not defined. ๐ซถ-mstructure-size-boundary=nโ The sizes of all structures and unions are rounded up to a multiple of the number of bits set by this option. Permissible values are8,32and64. The default value varies for different toolchains. For the COFF targeted toolchain the default value is8. A value of64is only allowed if the underlying ABI supports it. ๐ธ
Specifying a larger number can produce faster, more efficient code, but can also increase the size of the program. Different values are potentially incompatible. Code compiled with one value cannot necessarily expect to work with code or libraries compiled with another value, if they exchange information using structures or unions.
๐จ This option is deprecated.
-mabort-on-noreturnโ Generate a call to the functionabortat the end of anoreturnfunction. 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โ 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. ๐ง-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 isR9if target is EABI based or stack-checking is enabled, otherwise the default isR10. ๐-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-baseby 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=stateconfigure 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 modelsoftgenerates calls to__aeabi_read_tp. Other accepted models aretpidrurw,tpidruroandtpidrprwwhich 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 argumentcp15is also accepted as a convenience alias oftpidruro. The argumentautouses the best available method for the selected processor. The default setting isauto. ๐ฅ-mtls-dialect=dialectโ Specify the dialect to use for accessing thread local storage. Two dialects are supported---gnuandgnu2. Thegnudialect selects the original GNU scheme for supporting local and global dynamic TLS models. Thegnu2dialect 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-fpicor-fPICis specified. This option conflicts with-mslow-flash-data. ๐-mfix-cortex-m3-ldrdโ Some Cortex-M3 cores can cause data corruption whenldrdinstructions with overlapping destination and base registers are used. This option avoids generating these instructions. This option is enabled by default when-mcpu=cortex-m3is 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-a57or-mcpu=cortex-a72is 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 attributeSHF_ARM_PURECODE. This option is only available when generating non-pic code for M-profile targets. โญ-mcmseโ generates secure code as per the "ARMv8-M Security Extensions: Requirements on Development Tools Engineering Specification", which lives at <https://developer.arm.com/documentation/ecm0359818/latest/>. ๐-mfix-cmse-cve-2021-35465โ shields you from a potential security issue with theVLLDMinstruction in some M-profile devices when you're using CMSE (CVE-2021-365465). It's on by default whenever-mcpu=is used withcortex-m33,cortex-m35p,cortex-m52,cortex-m55,cortex-m85orstar-mc1. Wanna turn the mitigation off? That's-mno-fix-cmse-cve-2021-35465, bestie.-mstack-protector-guard=guard</bold> and-mstack-protector-guard-offset=offset โ generate stack protection code using a canary at guard. Supported locations areglobalfor a global canary, ortlsfor a canary you reach via the TLS register. Heads up ๐:-mstack-protector-guard-offset=is for use with-fstack-protector-guard=tlsand 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 forarm-*-uclinuxfdpiceabitargets, this one is on by default and implies-fPIEif none of the PIC/PIE-related options is provided. On other targets it only switches on the FDPIC-specific code generation features, and you gotta explicitly hand over the PIC/PIE-related options yourself as needed.
Note that static linking is not supported, because it would still involve the dynamic linker when the program self-relocates. If that behavior is acceptable to you, use-staticand-Wl,-dynamic-linkeroptions.
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. No cap. ๐ซถ
-mbranch-protection=features</bold> โ enables branch protection features (armv8.1-m.main only, just so you know โจ).
features can have one of these forms:
noneโ generates code without 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 is to sign all functions that save the return address to memory.pac-ret+leafโ extends thepac-retsigning to include leaf functions even if they do not 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 is not enabled (like, via -march=), then all branch protection and return address signing operations are constrained to use only the instructions defined in the architectural-NOP space. The generated code stays backwards-compatible with earlier versions of the architecture, but you can turn the extra security on 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โ control whether vectorization uses NEON quad-word or double-word registers. The default is-mvectorize-with-neon-quadโ slay. ๐
๐ธ AVR Options ๐ธ
These options are defined for AVR implementations, bestie โ yes, the tiny chip energy is real:
-mmcu=mcu</bold> โ specify the AVR instruction set architecture (ISA) or device type. The default for this option isavr2. ๐
Here are all the AVR devices and ISAs that are supported. Note: a complete device support consists of startup code crtmcu.o, a device header avr/io*.h, a device library libmcu.a and a device-specs (<https://gcc.gnu.org/wiki/avr-gcc#spec-files>) file specs-mcu. Only the latter is provided by the compiler according to the supported *mcu*s below โ the rest is supported by AVR-LibC (<https://github.com/avrdudes/avr-libc/>), or by means of atpack (<https://gcc.gnu.org/wiki/avr-gcc#atpack>) files from the hardware manufacturer. ๐ฆ
avr2โ "Classic" devices with up to 8 KiB of program memory.mcu=attiny22,attiny26,at90s2313,at90s2323,at90s2333,at90s2343,at90s4414,at90s4433,at90s4434,at90c8534,at90s8515,at90s8535.
avr25โ "Classic" devices with up to 8 KiB of program memory and with theMOVWinstruction.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 theMOVWinstruction.mcu=attiny167,attiny1634,atmega8u2,atmega16u2,atmega32u2,ata5505,ata6617c,ata664251,at90usb82,at90usb162.
avr4โ "Enhanced" devices with up to 8 KiB of program memory.mcu=atmega48,atmega48a,atmega48p,atmega48pa,atmega48pb,atmega8,atmega8a,atmega8hva,atmega88,atmega88a,atmega88p,atmega88pa,atmega88pb,atmega8515,atmega8535,ata5795,ata6285,ata6286,ata6289,ata6612c,at90pwm1,at90pwm2,at90pwm2b,at90pwm3,at90pwm3b,at90pwm81.
avr5โ "Enhanced" devices with 16 KiB up to 64 KiB of program memory.mcu=atmega16,atmega16a,atmega16hva,atmega16hva2,atmega16hvb,atmega16hvbrevb,atmega16m1,atmega16u4,atmega161,atmega162,atmega163,atmega164a,atmega164p,atmega164pa,atmega165,atmega165a,atmega165p,atmega165pa,atmega168,atmega168a,atmega168p,atmega168pa,atmega168pb,atmega169,atmega169a,atmega169p,atmega169pa,atmega32,atmega32a,atmega32c1,atmega32hvb,atmega32hvbrevb,atmega32m1,atmega32u4,atmega32u6,atmega323,atmega324a,atmega324p,atmega324pa,atmega324pb,atmega325,atmega325a,atmega325p,atmega325pa,atmega328,atmega328p,atmega328pb,atmega329,atmega329a,atmega329p,atmega329pa,atmega3250,atmega3250a,atmega3250p,atmega3250pa,atmega3290,atmega3290a,atmega3290p,atmega3290pa,atmega406,atmega64,atmega64a,atmega64c1,atmega64hve,atmega64hve2,atmega64m1,atmega64rfr2,atmega640,atmega644,atmega644a,atmega644p,atmega644pa,atmega644rfr2,atmega645,atmega645a,atmega645p,atmega649,atmega649a,atmega649p,atmega6450,atmega6450a,atmega6450p,atmega6490,atmega6490a,atmega6490p,ata5790,ata5790n,ata5791,ata6613c,ata6614q,ata5782,ata5831,ata8210,ata8510,ata5787,ata5835,ata5700m322,ata5702m322,at90pwm161,at90pwm216,at90pwm316,at90can32,at90can64,at90scr100,at90usb646,at90usb647,at94k,m3000.
avr51โ "Enhanced" devices with 128 KiB of program memory.mcu=atmega128,atmega128a,atmega128rfa1,atmega128rfr2,atmega1280,atmega1281,atmega1284,atmega1284p,atmega1284rfr2,at90can128,at90usb1286,at90usb1287.
avr6โ "Enhanced" devices with 3-byte PC, i.e. with more than 128 KiB of program memory.mcu=atmega256rfr2,atmega2560,atmega2561,atmega2564rfr2.
avrxmega2โ "XMEGA" devices with more than 8 KiB and up to 64 KiB of program memory.mcu=atxmega8e5,atxmega16a4,atxmega16a4u,atxmega16c4,atxmega16d4,atxmega16e5,atxmega32a4,atxmega32a4u,atxmega32c3,atxmega32c4,atxmega32d3,atxmega32d4,atxmega32e5,avr64da28,avr64da28s,avr64da32,avr64da32s,avr64da48,avr64da48s,avr64da64,avr64da64s,avr64db28,avr64db32,avr64db48,avr64db64,avr64dd14,avr64dd20,avr64dd28,avr64dd32,avr64du28,avr64du32,avr64ea28,avr64ea32,avr64ea48,avr64sd28,avr64sd32,avr64sd48.
avrxmega3 ๐ฆ
"XMEGA" cuties with up to 64 KiB of combined program memory and RAM, and where program memory is visible in the RAM address space. The mcu = roster is 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 plus more than 64 KiB of RAM. She's got range. mcu = atxmega64a1, atxmega64a1u.
avrxmega6 โญ
"XMEGA" besties 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" icons with more than 128 KiB of program memory and more than 64 KiB of RAM. Main character energy fr fr. mcu = atxmega128a1, atxmega128a1u, atxmega128a4u.
avrtiny ๐ง
The "Reduced Tiny" Tiny core girlies โ only 16 general purpose registers and 512 B up to 4 KiB of program memory. Small but mighty ๐
. mcu = attiny4, attiny5, attiny9, attiny10, attiny102, attiny104, attiny20, attiny40.
avr1 ๐
This ISA is implemented by the minimal AVR core and is supported for assembler only. Like, assembler only, no cap. mcu = attiny11, attiny12, attiny15, attiny28, at90s1200.
-mabsdataโ Assume that all data in static storage can be accessed byLDS/STSinstructions. Heads up: this option only does anything on reduced Tiny devices like the ATtiny40. See also theabsdataAVR 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 fromcrtmcu-cvt.oinstead of the usualcrtmcu.o. Besides giving you a compact vector table, the startup code sets bitCPUINT_CTRLA.CPUINT_CVT, which enables the CVT on the device.
If you don't want the startup code setting CPUINT_CTRLA.CPUINT_CVT, you can satisfy the symbol __init_cvt so that the respective code is no longer 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 thedoubleorlong doubletype, respectively. Possible values for bits are32and64. 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 exact same deal applies to the default values of these options.-mgas-isr-prologuesโ Interrupt service routines (ISRs) may use the__gcc_isrpseudo instruction supported by GNU Binutils. If this option is on, the feature can still be disabled for individual ISRs via theno_gccisrAVR function attribute. This feature is activated per default if optimization is on (but not with-Og, see Optimize Options), and if GNU Binutils support PR21683 (https://sourceware.org/PR21683) ๐ฅ.-mint8โ Assumeintto be an 8-bit integer. This affects the sizes of all types: acharis 1 byte, anintis 1 byte, alongis 2 bytes, andlong longis 4 bytes. Please note that this option does not conform to the C standards โ but it does result in smaller code size, so. Your call ๐.-mmain-is-OS_taskโ Do not save registers inmain. The effect is the same as attaching theOS_taskAVR attribute tomain. It is activated per default if optimization is on.-mno-call-mainโ Don't runmainby 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. (Yes, that's the trade. Yes, it's real.)-mrelaxโ Try to replace theCALLresp.JMPinstruction with the shorterRCALLresp.RJMPinstruction if applicable. Setting-mrelaxjust adds the--mlink-relaxoption to the assembler's command line and the--relaxoption to the linker's command line.
Jump relaxing is performed by the linker because jump offsets aren't known before the code is located. So the assembler code generated by the compiler is the same, but the instructions in the executable may differ from the 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.rodatasections for read-only data in RAM resp. in program memory. For most devices there is no choice here 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 using truncation instead of rounding towards zero for fractional fixed-point types.-nodevicelibโ Don't link against AVR-LibC's device specific librarylibmcu.a.
Heads up bestie ๐จ โ 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 the 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 callmainandexit; and__do_flmap_init(https://github.com/avrdudes/avr-libc/issues/931) to set up FLMAP according to the symbol__flmap.
-nodevicespecsโ Don't add-specs=device-specs/specs-mcuto 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 you have to supply your own private device specs file by means of-specs=path-to-specs-file. There is no more need for the option-mmcu=mcu ๐ซถ.
This option can also serve as a replacement for the older way of specifying custom device-specs files, which needed -B some-path to point to a directory containing 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 the__vectorprefix. Enabled by default โญ.
๐ฅ AVR Optimization Options ๐ฅ
The following options are pure optimization options. Quick reality check though: -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 actually matters ๐.
-maccumulate-argsโ Accumulate outgoing function arguments and acquire/release the needed stack space for outgoing function arguments once in the function prologue/epilogue. Without this option, outgoing arguments are pushed before calling a function and popped afterwards. See also the-fdefer-popoptimization option.
Popping the arguments after the function call can be expensive on AVR, so accumulating the stack space might lead to smaller executables, because arguments need not be removed from the stack after such a function call ๐.
-mbranch-cost=costโ sets how expensive a conditional branch is to cost. Reasonable values are small, non-negative integers, and the default is0. Like, literally just0.-mcall-prologuesโ function prologues and epilogues get expanded as calls to the appropriate subroutines instead of being inlined. Code size goes down ๐ (that's the whole point).-mfuse-add,-mno-fuse-add,-mfuse-add=levelโ optimizes indirect memory accesses on reduced Tiny devices โจ. By default it useslevel=1for optimizations-Ogand-O1, andlevel=2for the higher optimizations. Valid values for level are0,1and2. That's it, that's the list ๐-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 useslevel=3for optimization-O1, andlevel=23for higher optimizations. Valid values for level are in the range0 ... 23, which is a3:2:2:2mixed radix value โ each digit controls some aspect of the optimization. iykyk ๐-mfuse-move2โ runs a post-combine optimization pass that tries to fuse move instructions. Lowkey a whole other pass, don't confuse it with the one above ๐ซถ-mstrict-Xโ uses address registerXthe way the hardware actually proposes. MeaningXis only used in indirect, post-increment or pre-decrement addressing. Periodt.
Without this option, the X register may be used in the same way as Y or Z โ which then gets 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
-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-O2and higher, including-Osbut excluding-Oz. Splitting of shifts with a constant offset that is a multiple of 8 is controlled by-mfuse-move. Wild, I know.-msplit-ldstโ splits multi-byte loads and stores into several byte loads and stores. This optimization is turned on per default for-O2and 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-O2and higher ๐
๐ฆ "EIND" and Devices with More Than 128 Ki Bytes of Flash ๐ฆ
Okay bestie, listen up, this part is a whole vibe check on its own.
Pointers in the implementation are 16 bits wide. The address of a function or label is represented as a word address so that indirect jumps and calls can target any code address in the range of 64 Ki words.
In order to facilitate indirect jump on devices with more than 128 Ki bytes of program memory space, there's a special function register called EIND that serves as the 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. Like, not once. Never. - The compiler uses
EINDimplicitly inEICALL/EIJMPinstructions, or might readEINDdirectly in order to emulate an indirect call/jump by means of aRETinstruction. - The compiler assumes that
EINDnever changes during the startup code or during the application. In particular,EINDis not saved/restored in function or interrupt service routine prologue/epilogue. So don't be out here changing it mid-run, okay? ๐ - For indirect calls to functions and computed goto, the linker generates stubs. Stubs are jump pads, sometimes also called trampolines. So the indirect call/jump jumps to such a stub, and 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
-mrelaxand 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 ๐ you've been warned. - The default linker script is arranged for code with
EIND = 0. If code is supposed to work for a setup withEIND != 0, a custom linker script has to be used in order to place the sections whose name start with.trampolinesinto the segment whereEINDpoints 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 onEIND, 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
EINDearly โ 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 setsEINDto the segment where the vector table is located. Iconic behaviour, honestly:
#include <avr/io.h>
static void
__attribute__((section(".init3"),naked,used,no_instrument_function))
init3_set_eind (void)
{
__asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
"out %i0,r24" :: "n" (&EIND) : "r24","memory");
}
The __trampolines_start symbol is defined in the linker script โญ
- Stubs are generated automatically by the linker if the following two conditions are met:
- The address of a label is taken by means of the
gsmodifier (short for generate stubs) like so:
- The address of a label is taken by means of the
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
gsmodifiers 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-prologuescommand-line option. - Switch/case dispatch tables. If you do not want such dispatch tables you can specify the
-fno-jump-tablescommand-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 โจ
๐ 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 the 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
RAMPspecial function registers with zero. - If an AVR Named Address Spaces โ a named address space other than generic or
__flashโ is used, thenRAMPZis set as needed before the operation. - If the device supports RAM larger than 64 KiB and the compiler needs to change
RAMPZto accomplish an operation,RAMPZis reset to zero after the operation ๐ซถ - If the device comes with a specific
RAMPregister, 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
RAMPregisters, you must reset it to zero after the access. No cap, that's mandatory.
โญ AVR Built-in Macros โญ
GCC defines several built-in macros so that the user code can test for the presence or absence of features. Almost any of the following built-in macros are deduced from device capabilities and thus triggered by the -mmcu= command-line option ๐
For even more AVR-specific built-in macros see AVR Named Address Spaces and AVR Built-in Functions.
__AVR_ARCH__
Build-in macro that resolves to a decimal number that identifies the architecture and depends on the -mmcu=mcu option. Possible values are:
2, 25, 3, 31, 35, 4, 5, 51, 6
for mcu=avr2, avr25, avr3, avr31, avr35, avr4, avr5, avr51, avr6, respectively, and
100, 102, 103, 104, 105, 106, 107
for mcu=avrtiny, avrxmega2, avrxmega3, avrxmega4, avrxmega5, avrxmega6, avrxmega7, respectively ๐ง. If mcu specifies a device, this built-in macro is set accordingly. For example, with -mmcu=atmega8 the macro is defined to 4.
__AVR_Device__
Setting -mmcu=device defines this built-in macro, which reflects the device's name. For example, -mmcu=atmega8 defines the built-in macro __AVR_ATmega8__, -mmcu=attiny261a defines __AVR_ATtiny261A__, etc. So cute, honestly ๐ธ
The built-in macros' names follow the scheme __AVR_Device__ where Device is the device name as from the AVR user manual. The difference between Device in the built-in macro and device in -mmcu=device is that the latter is always lowercase ๐
If device is not a device but only a core architecture like avr51, this macro is not defined.
__AVR_DEVICE_NAME__
Setting -mmcu=device defines this built-in macro to the device's name. For example, with -mmcu=atmega8 the macro is defined to atmega8 ๐
If device is not a device but only a core architecture like avr51, this macro is not defined.
__AVR_CVT__
The code is being compiled with option -mcvt to use a compact vector table ๐ฅ
"__AVR_XMEGA__"โ the device / architecture is in the XMEGA family of devices. ๐"__AVR_HAVE_ADIW__"โ the device has the"ADIW"and"SBIW"instructions."__AVR_HAVE_ELPM__"โ the device has the"ELPM"instruction."__AVR_HAVE_ELPMX__"โ the device has the"ELPM Rn,Z"and"ELPM Rn,Z+"instructions."__AVR_HAVE_LPMX__"โ the device has the"LPM Rn,Z"and"LPM Rn,Z+"instructions."__AVR_HAVE_MOVW__"โ the device has the"MOVW"instruction to perform 16-bit register-register moves."__AVR_HAVE_MUL__"โ the device has a hardware multiplier. ๐ฅ"__AVR_HAVE_JMP_CALL__"โ the device has the"JMP"and"CALL"instructions. This is the case for devices with more than8 KiBof 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 than128 KiBof program memory. This also means that the program counter (PC) is3bytes wide."__AVR_2_BYTE_PC__"โ the program counter (PC) is2bytes wide. This is the case for devices with up to128 KiBof 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=avr2and-mmcu=avr25also 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-interruptscommand-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,LASandLAT)."__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-callscommand 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 theAVR64*andAVR128*devices. - It's not known at assembler-time which emulation will be used.
- The device has the
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-avrlibcconfigure option."__HAVE_SIGNAL_N__"โ the compiler supports thesignal(num)andinterrupt(num)AVR Attributes,,function attributes with an argumentnumthat 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 to2or3."__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 internal, bestie: the compiler uses them, and they also communicate between device specs files and the compiler proper. You don't need to set these options by hand, in particular they are not optimization options.
โ ๏ธ Using these options in the wrong way may lead to sub-optimal or wrong code.
They are documented for completeness, and in order to get a better understanding of device specs ("https://gcc.gnu.org/wiki/avr-gcc#spec-files") files.
-mn-flash=numโ assume that the flash memory has a size of num times64 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 forbf561is incomplete. Forbf561, 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-libraryand-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 low64kof 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. ๐
...and honestly the default being -mno-leaf-id-shared-library is kind of a whole thing, because under that default the compiler makes no assumption that the code it's compiling won't get linked against any ID shared libraries ๐ญ โ and the price you pay for that safety is that slower code gets generated for jump and call insns. not glamorous, but there it is ๐
-mshared-library-id=nโ tells the compiler the identification number of the ID-based shared library it's building. setting the value to0gets you more compact code โจ; any other value forces that number to be allocated to the current library, but it's genuinely no more space- or time-efficient than just not passing this option at all. so like...0or nothing, bestie ๐-msep-data,-mno-sep-dataโ generates code that lets the data segment live in a completely different area of memory than the text segment ๐ฆ. why do you care? because it allows 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 generate code that assumes the data segment follows the text segment. periodt ๐-mlong-calls,-mno-long-callsโ makes the compiler do function calls by first loading the address of the function into a register, then doing a subroutine call on that register ๐ฅ. you need this switch if the target function sits outside the 24-bit addressing range of the offset-based version of the subroutine call instruction. it is not enabled by default, and-mno-long-callsrestores the default behavior. โ ๏ธ heads up though: these switches have no effect on how the compiler generates code to handle function calls made via function pointers. iykyk.-mfast-fpโ links against 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. yes, that is the trade, and yes, it is iconic of it.-minline-pltโ enables inlining of PLT entries in function calls to functions that aren't known to bind locally. ๐ซถ important: it has no effect without-mfdpic.-mmulticoreโ builds a standalone application for multicore Blackfin processors ๐. this option makes proper start files and link scripts that support multicore get used, and it defines the macro"__BFIN_MULTICORE". it can only be used with-mcpu=bf561[-sirevision].
it can also be used together 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 โ and in that model, the main function of Core B should be named "coreb_main" ๐.
if you don't use this option at all, the single-core application programming model is what you get.
-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.-mcorebโ builds a standalone application for Core B of BF561 when you're on the one-application-per-core programming model ๐. proper start files and link scripts get used to support Core B, and the macro"__BFIN_COREB"is defined. when you use this one,"coreb_main"should be used instead of"main". and yeah โ this option can only be used in conjunction with-mmulticore.-msdramโ builds a standalone application for SDRAM โญ. proper start files and link scripts get used to put the application into SDRAM, and the macro"__BFIN_SDRAM"is defined. your loader should initialize SDRAM before loading the application. that's on you, not on GCC ๐-micplbโ assumes ICPLBs are enabled at run time ๐ฅ. this has an effect on certain anomaly workarounds. for Linux targets, the default is to assume ICPLBs are enabled; for standalone applications the default is off.
๐ C6X Options ๐
-march=nameโ specifies the name of the target architecture. GCC uses this name to figure out what kind of instructions it's allowed to emit when generating assembly code ๐ฆ. permissible names are:c62x,c64x,c64x+,c67x,c67x+,c674x.-mbig-endianโ generate code for a big-endian target.-mlittle-endianโ generate code for a little-endian target. this is the default โจ.-msimโ choose startup files and linker script suitable for the simulator ๐ง.-msdata=defaultโ put small global and static data in the".neardata"section, which is pointed to by register"B14"๐ซถ. put small uninitialized global and static data in the".bss"section, which sits adjacent to the".neardata"section. put small read-only data into the".rodata"section. the corresponding sections used for large pieces of data are".fardata",".far"and".const".-msdata=allโ put all data, not just small objects, into the sections reserved for small data, and use addressing relative to the"B14"register to access them ๐-msdata=noneโ make no use of the sections reserved for small data, and use absolute addresses to access all data ๐. put all initialized global and static data in the".fardata"section, and all uninitialized data in the".far"section. put all constant data into the".const"section.-mdsbtโ compile for the DSBT shared library ABI ๐. this option is required to compile with-fpicor-fPIC, and it implies-fpic.-mlong-callsโ avoid generating PC-relative calls; use indirection instead ๐ฅ.
๐ CRIS Options ๐
these options are defined specifically for the CRIS ports, bestie ๐
-march=architecture-type,-mcpu=architecture-typeโ generate code for the specified architecture ๐ธ. the choices for architecture-type arev3,v8andv10for respectively ETRAX 4, ETRAX 100, and ETRAX 100 LX. default isv0.-mtune=architecture-typeโ tune to architecture-type everything applicable about the generated code, except for the ABI and the set of available instructions โจ. the choices for architecture-type are the same as for-march=architecture-type.-mmax-stackframe=nโ warn when the stack frame of a function exceeds n bytes ๐ซถ.-metrax4,-metrax100โ these two are just synonyms for-march=v3and-march=v8respectively. cute little nicknames ๐-mmul-bug-workaround,-mno-mul-bug-workaroundโ work around a bug in the"muls"and"mulu"instructions, for the CPU models where it applies ๐ญ. this option is disabled by default.-mpdebugโ enable CRIS-specific verbose debug-related information in the assembly code. this option also has the effect of turning off the#NO_APPformatted-code indicator to the assembler at the beginning of the assembly file ๐.-mcc-initโ do not use condition-code results from a previous instruction; always emit compare and test instructions before condition codes get used ๐ฅ.-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 (theno-versions) 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.-mno-prologue-epilogue,-mprologue-epilogueโ with-mno-prologue-epilogue, the normal function prologue and epilogue that set up the stack frame get omitted, and no return instructions or return sequences are generated in the code ๐. โ ๏ธ use this option only together with visual inspection of the compiled code: no warnings or errors are generated when call-saved registers must be saved, or storage for local variables needs to be allocated. like, it will not tell you. you just have to look. scary but okay.-mbest-lib-options,-moverride-best-lib-optionsโ-mbest-lib-optionsselects the most feature-enabling options allowed by other options ๐. this option has nono-form, but-moverride-best-lib-optionsdisables it regardless of the relative order of the two options on the command line.-mtrap-using-break8โ emit traps as break 8 ๐. this is the default for CRIS v3 and up. if it's disabled, calls to"abort"are used instead.-mtrap-unaligned-atomicโ emit checks that cause break 8 instructions to execute when atomic builtins get applied to misaligned memory ๐ฅ-munaligned-atomic-may-use-libraryโ handle atomic builtins that may be applied to unaligned data by calling library functions ๐ง. this option overrides-mtrap-unaligned-atomic.-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 at0x40000000and zero-initialized data at0x80000000โญ.
๐ 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, andck810. the default isck810โจ.-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, andck810ftv. like yes there are a LOT of them, that's the list, i don't make the rules ๐ญ-mbig-endian,-mlittle-endianโ select big- or little-endian code. the default is little-endian ๐-mfloat-abi=nameโ specifies which floating-point ABI to use. permissible values are:soft,softfpandhard๐
specifying soft causes GCC to generate output containing library calls for floating-point operations. softfp allows the generation of code using hardware floating-point instructions, but still uses the soft-float calling conventions. hard allows generation of floating-point instructions and uses FPU-specific calling conventions ๐ฅ
The default depends on the specific target configuration.
โ ๏ธ bestie, note this: 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.
-mdouble-float,-mno-double-floatโ When-mhard-floatis in effect, this enables generation of double-precision float instructions. It's the default except when compiling for CK803.-mfdivdu,-mno-fdivduโ When-mhard-floatis in effect, this enables generation offrecipd,fsqrtd, andfdivdinstructions. It's the default except when compiling for CK803.-mfpu=fpuโ Select the floating-point processor. This option can only be used with-mhard-float. Values for fpu arefpv2_sf(equivalent to-mno-double-float -mno-fdivdu),fpv2(-mdouble-float -mno-divdu), andfpv2_divd(-mdouble-float -mdivdu).-melrw,-mno-elrwโ Enable the extendedlrwinstruction. This option defaults to on for CK801 and off otherwise.-mistack,-mno-istackโ Enable interrupt stack instructions; the default is off. The-mistackoption is required to handle theinterruptandisrfunction attributes.-mmp,-mno-mpโ Enable multiprocessor instructions; the default is off.-mcp,-mno-cpโ Enable coprocessor instructions; the default is off.-mcache,-mno-cacheโ Enable coprocessor instructions; the default is off.-msecurity,-mno-securityโ Enable C-SKY security instructions; the default is off.-mtrust,-mno-trustโ Enable C-SKY trust instructions; the 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 options default to off.-mdiv,-mno-divโ Generate divide instructions. Default is off.-msmart,-mno-smartโ Generate code for Smart Mode, using only registers numbered0-7to allow use of 16-bit instructions. This option is ignored for CK801 where this is the required behavior, and it defaults to on for CK802. For other targets, the default is off.-mhigh-registers,-mno-high-registersโ Generate code using the high registers numbered16-31. This option is not supported on CK801, CK802, or CK803, and is enabled by default for other processors.-manchor,-mno-anchorโ Generate code using global anchor symbol addresses.-mpushpop,-mno-pushpopโ Generate code usingpushandpopinstructions. This option defaults to on.-mmultiple-stld,-mno-multiple-stldโ Generate code usingstmandldminstructions. This option isn't supported on CK801 but is enabled by default on other processors.-mconstpool,-mno-constpoolโ Create constant pools in the compiler instead of deferring it to the assembler. This option is the default and required for correct code generation on CK801 and CK802, and is optional on other processors.-mstack-size,-mno-stack-sizeโ Emit.stack_sizedirectives for each function in the assembly output. This option defaults to off.-mccrt,-mno-ccrtโ Generate code for the C-SKY compiler runtime instead oflibgcc. This option defaults to off.-mbranch-cost=nโ Set the branch costs to roughlyninstructions. The default is1.-msched-prolog,-mno-sched-prologโ Permit scheduling of function prologue and epilogue sequences. Using this option can result in code that is not compliant with the C-SKY V2 ABI prologue requirements and that cannot be debugged or backtraced. It is disabled by default.-msim,-mno-simโ Links the librarylibsemi.awhich is in compatible with simulator. Applicable toELFcompiler only.
๐ป Cygwin and MinGW Options ๐ป
These additional options are available for Microsoft Windows targets:
-mconsoleโ This option specifies that a console application is to be generated, by instructing the linker to set the PE header subsystem type required for console applications. This option is available for Cygwin and MinGW targets and is enabled by default on those targets.-mcrtdll=libraryโ Preprocess, compile or link with specified C RunTime DLL library. This option adjusts predefined macros__CRTDLL__,__MSVCRT__,_UCRTand__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 proprocessor are:"crtdll*","msvcrt10*","msvcrt20*","msvcrt40*","msvcr40*","msvcrtd*","msvcrt-os*","msvcr70*","msvcr71*","msvcr80*","msvcr90*","msvcr100*","msvcr110*","msvcr120*"and"ucrt*". If this option isn't specified, then the default MinGW import librarymsvcrtis used for linking and no other adjustment for preprocessor is done. MinGW import librarymsvcrtis just a symlink to (or a copy of) another MinGW CRT import library chosen during MinGW compilation. MinGW import librarymsvcrt-osis for Windows system CRT DLL librarymsvcrt.dlland in most cases is the default MinGW import library. Generally speaking, changing the CRT DLL requires recompiling the entire MinGW CRT. This option is for experimental and testing purposes only. This option is available for MinGW targets.-mdllโ This option is available for Cygwin and MinGW targets. It specifies that a DLL---a dynamic link library---is to be generated, enabling the selection of the required runtime startup object and entry point.-mnop-fun-dllimportโ This option is available for Cygwin and MinGW targets. It specifies that thedllimportattribute 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-mthreadsoption. When compiling,-mthreadsdefines-D_MT; when linking, it links in a special thread helper library-lmingwthrdwhich cleans up per-thread exception-handling data.-municodeโ This option is available for MinGW-w64 targets. It causes theUNICODEpreprocessor macro to be predefined, and chooses Unicode-capable runtime startup code.-mwin32โ This option is available for Cygwin and MinGW targets. It specifies that the typical Microsoft Windows predefined macros are to be set in the pre-processor, but does not influence the choice of runtime library/startup code.-mwindowsโ This option is available for Cygwin and MinGW targets. It specifies that a GUI application is to be generated by instructing the linker to set the PE header subsystem type appropriately.-fno-set-stack-executableโ This option is available for MinGW targets. It specifies that the executable flag for the stack used by nested functions isn't set. This is necessary for binaries running in kernel mode of Microsoft Windows, as there the User32 API, which is used to set executable privileges, isn't available.-fwritable-relocated-rdataโ This option is available for MinGW and Cygwin targets. It specifies that relocated-data in read-only section is put into the.datasection. This is necessary for older runtimes not supporting modification of.rdatasections for pseudo-relocation.-mpe-aligned-commonsโ This option is available for Cygwin and MinGW targets. It specifies that the GNU extension to the PE file format that permits the correct alignment of COMMON variables should be used when generating code. It is enabled by default if GCC detects that the target assembler found during configuration supports the feature.-muse-libstdc-wrappersโ Use Cygwin DLL wrappers to support C++ operatorsnewanddelete.
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-Ioptions and are scanned in a left-to-right order.
okay so bestie, a framework directory is literally a directory with frameworks in it. A framework is a directory with a Headers and/or PrivateHeaders directory contained directly in it that ends in .framework. The name of a framework is the name of this directory excluding the .framework. Headers associated with the framework are found in one of those two directories, with Headers being searched first. A subframework is a framework directory that is in a framework's Frameworks directory. Includes of subframework headers can only appear in a header of a framework that contains the subframework, or in a sibling subframework header. Two subframeworks are siblings if they occur in the same framework. A subframework should not have the same name as a framework; a warning is issued if this is violated. Currently a subframework cannot have subframeworks; in the future, the mechanism may be extended to support this. The standard frameworks can be found in /System/Library/Frameworks and /Library/Frameworks. An example include looks like "#include <Framework/header.h>", where Framework denotes the name of the framework and header.h is found in the PrivateHeaders or Headers directory.
-iframeworkdirโ Like-Fexcept the directory is a treated as a system directory. The main difference between this-iframeworkand-Fis that with-iframeworkthe compiler does not warn about constructs contained within header files found via dir. This option is valid only for the C family of languages.-archname โ 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-archoption is accepted for compatibility, but an error is diagnosed if name is inconsistent with GCC's own idea of the target architecture.-dependency-filefilename โ Alias for the preprocessor option-MFfilename.-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-classsetting and cause"@"...""literals to be laid out as constant CoreFoundation strings.-fconstant-cfstringsis 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.-mfix-and-continue,-ffix-and-continue,-findirect-dataโ Generate code suitable for fast turnaround development, such as to allow GDB to dynamically load.ofiles into already-running programs.-findirect-dataand-ffix-and-continueare provided for backwards compatibility.-mkernelโ Enable kernel development mode. The-mkerneloption sets-static,-fno-common,-fno-use-cxa-atexit,-fno-exceptions,-fno-non-call-exceptions,-fapple-kext,-fno-weakand-fno-rttiwhere applicable. This mode also sets-mno-altivec,-msoft-float,-fno-builtinand-mlong-branchfor PowerPC targets.-mmacosx-version-min=version,-asm_macosx_version_min=version โ The-mmacosx-version-minoption specifies the earliest version of MacOS X that this executable will run on is version. Typical values supported for version include12,10.12, and10.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.
-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 thatsizeof(bool)==1. By defaultsizeof(bool)is 4 when compiling for Darwin/PowerPC and 1 when compiling for Darwin/x86, so this option has no effect on x86.
Warning: The -mone-byte-bool switch causes GCC to generate code that is not binary compatible with code generated without that switch. Using this switch may require recompiling all other modules in a program, including system libraries. Use this switch to conform to a non-default data model.
-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-linkerversion โ 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. Seeman 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. Seeman ld(1)for more information.-bundle_loaderexecutable โ This option specifies the executable that will load the build output file being linked. Seeman 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-mcpuor-marchoption.-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-nodefaultrpathsto 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.- These options are passed to the Darwin linker:
-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.
๐ DEC Alpha Options ๐
These -m options are defined for the DEC Alpha implementations:
-mno-soft-float,-msoft-floatโ Use (do not use) the hardware floating-point instructions for floating-point operations. When-msoft-floatis specified, functions inlibgcc.aare 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-regsimplies-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$0instead 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-regsmust 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_FPis defined during compilation. The resulting code is less efficient but is able to correctly support denormalized numbers and exceptional IEEE values such as not-a-number and plus/minus infinity. Other Alpha compilers call this option-ieee_with_no_inexact.-mieee-with-inexactโ This is like-mieee, except the generated code also maintains the IEEE inexact-flag. Turning this on makes the generated code implement fully-compliant IEEE math. On top of_IEEE_FP, it also defines_IEEE_FP_EXACTas a preprocessor macro. On some Alpha implementations, the resulting code may execute significantly slower than the default code. Since very little code actually depends on the inexact-flag, you should normally not specify this option. Other Alpha compilers call this option-ieee_with_inexact.-mfp-trap-mode=trap-modeโ This controls which floating-point related traps are enabled. Other Alpha compilers call this option-fptm trap-mode. The trap mode can be set to one of four values:nโ This is the default (normal) setting. The only traps enabled are the ones that cannot be disabled in software (e.g., division by zero trap).uโ In addition to the traps enabled byn, underflow traps are enabled as well.suโ Likeu, but the instructions are marked to be safe for software completion (see Alpha architecture manual for details).suiโ Likesu, but inexact traps are enabled as well.
-mfp-rounding-mode=rounding-modeโ Selects the IEEE rounding mode. Other Alpha compilers call this option-fprm rounding-mode. The rounding-mode can be one of:nโ Normal IEEE rounding mode. Floating-point numbers are rounded towards the nearest machine number or towards the even machine number in case of a tie.mโ Round towards minus infinity.cโ Chopped rounding mode. Floating-point numbers are rounded towards zero.dโ Dynamic rounding mode. A field in the floating-point control register (fpcr, see Alpha architecture reference manual) controls the rounding mode in effect. The C library initializes this register for rounding towards plus infinity. Thus, unless your program modifies thefpcr,dcorresponds to round towards plus infinity.
-mtrap-precision=trap-precisionโ In the Alpha architecture, floating-point traps are imprecise. That means without software assistance it is impossible to recover from a floating trap, and program execution normally needs to be terminated. GCC can generate code that can assist operating system trap handlers in determining the exact location that caused a floating-point trap. Depending on the requirements of an application, different levels of precisions can be selected:pโ Program precision. This option is the default and 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 provide the equivalent options called -scope_safe and -resumption_safe.
-mieee-conformantโ This option marks the generated code as IEEE conformant.
๐จ Bestie, you must not use this option unless you also specify-mtrap-precision=iand either-mfp-trap-mode=suor-mfp-trap-mode=sui. Its only effect is to emit the line.eflag 48in the function prologue of the generated assembly file.
-mbuild-constantsโ Normally GCC examines a 32- or 64-bit integer constant to see if it can construct it from smaller constants in two or three instructions. If it cannot, it outputs the constant as a literal and generates code to load it from the data segment at run time.
Use this option to require GCC to construct all integer constants using code, even if it takes more instructions (the maximum is six).
You typically use this option to build a shared library dynamic loader. Itself a shared library, it must relocate itself in memory before it can find the variables and constants in its own data segment.
-mbwx,-mno-bwx,-mcix,-mno-cix,-mfix,-mno-fix,-mmax,-mno-maxโ Indicate whether GCC should generate code to use the optional BWX, CIX, FIX and MAX instruction sets. The default is to use the instruction sets supported by the CPU type specified via-mcpu=option or that of the CPU on which GCC was built if none is specified.-msafe-bwa,-mno-safe-bwaโ Indicate whether in the absence of the optional BWX instruction set GCC should generate multi-thread and async-signal safe code for byte and aligned word memory accesses.-msafe-partial,-mno-safe-partialโ Indicate whether GCC should generate multi-thread and async-signal safe code for partial memory accesses, including piecemeal accesses to unaligned data as well as block accesses to leading and trailing parts of aggregate types or other objects in memory that do not respectively start and end on an aligned 64-bit data boundary.-mfloat-vax,-mfloat-ieeeโ Generate code that uses (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 provided no way to generate symbol relocations except via assembler macros. Use of these macros does not allow optimal instruction scheduling. GNU Binutils as of version 2.12 supports a new syntax that allows the compiler to explicitly mark which relocations should apply to which instructions. This option is mostly useful for debugging, as GCC detects the capabilities of the assembler when it is built and sets the default accordingly.-msmall-data,-mlarge-dataโ When-mexplicit-relocsis in effect, static data is accessed via gp-relative relocations. When-msmall-datais used, objects 8 bytes long or smaller are placed in a small data area (the.sdataand.sbsssections) and are accessed via 16-bit relocations off of the$gpregister. This limits the size of the small data area to 64KB, but allows the variables to be directly accessed via a single instruction.
The default is -mlarge-data. With this option the data area is limited to just below 2GB. Programs that require more than 2GB of data must 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.
-msmall-text,-mlarge-textโ When-msmall-textis used, the compiler assumes that the code of the entire program (or shared library) fits in 4MB, and is thus reachable with a branch instruction. When-msmall-datais used, the compiler can assume that all local symbols share the same$gpvalue, and thus reduce the number of instructions required for a function call from 4 to 1.
The default is -mlarge-text.
-mcpu=cpu_typeโ Set the instruction set and instruction scheduling parameters for machine typecpu_type. You can specify either the EV style name or the corresponding chip number. GCC supports scheduling parameters for the EV4, EV5 and EV6 family of processors and chooses the default values for the instruction set from the processor you specify. If you do not specify a processor type, GCC defaults to the processor on which the compiler was built.
Supported values for 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 does not recognize the processor.
-mtune=cpu_typeโ Set only the instruction scheduling parameters for machine typecpu_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 used by the application 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 thatL3is only valid for EV5.
-mtls-kernelโ Emitrdvalinstead ofrduniqfor thread pointer.-mtls-size=bitsizeโ Specify bit size of immediate TLS offsets. Valid values forbitsizeare16,32, and64; it defaults to32.-mlong-double-128,-mlong-double-64โ Specify the size of thelong doubletype. Note that-mlong-double-128is incompatible with VAX floating point.
๐ธ eBPF Options ๐ธ
-mframe-limit=bytesโ This specifies the hard limit for frame sizes, in bytes. Currently, the value that can be specified should be less than or equal to32767. 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.
Okay so the eBPF CPU-feature toggles keep rolling, bestie โ hereโs the next batch, no cap: โจ
-malu32,-mno-alu32โ turns generation of 32-bit ALU instructions on or off. Itโs enabled for CPUv3and above. ๐-mv3-atomics,-mno-v3-atomicsโ toggles instructions for general atomic operations introduced in CPUv3. Enabled for CPUv3and above. ๐ฆ-mbswap,-mno-bswapโ toggles byte swap instructions. Enabled for CPUv4and above. ๐ธ-msdiv,-mno-sdivโ toggles signed division and modulus instructions. Enabled for CPUv4and above. ๐-msmov,-mno-smovโ toggles sign-extending move and memory load instructions. Enabled for CPUv4and above. ๐-mcpu=versionโ picks which version of the eBPF ISA to target. Newer versions may not be supported by all kernels. The default isv4. ๐
Supported values for version are:
v1โ the first stable eBPF ISA, with no special features or extensions.v2โ supports the jump extensions, as in-mjmpext.v3โ all features ofv2, plus:- 32-bit jump operations, as in
-mjmp32 - 32-bit ALU operations, as in
-malu32 - general atomic operations, as in
-mv3-atomics
- 32-bit jump operations, as in
v4โ all features ofv3, 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
- byte swap instructions, as in
-mco-re,-mno-co-reโ toggles BPF Compile Once - Run Everywhere (CO-RE) support. BPF CO-RE support is enabled by default when generating BTF debug information for the BPF target (-gbtf). ๐ซถ-mxbpfโ generates code for an expanded version of BPF, which relaxes some of the restrictions imposed by the BPF architecture:- Save and restore callee-saved registers at function entry and exit, respectively. ๐
-masm=dialectโ outputs assembly instructions using the eBPF selected dialect. The default ispseudoc. ๐
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 whichmemmove,memcpyandmemsetshall always be expanded inline. Operations dealing with sizes larger than this threshold would have to be implemented using a library call instead of being expanded inline, but since BPF doesnโt allow libcalls, exceeding this threshold results in a compile-time error. The default is1024bytes. ๐-Wco-reโ enables warnings for scenarios where-mco-reis enabled, but it may not be possible to generate CO-RE compatible code. ๐ฆ
๐ธ FR30 Options ๐ธ
These options are defined specifically for the FR30 port. Short and sweet, no cap. ๐ง
-msmall-modelโ uses 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โ assumes that runtime support has been provided, so thereโs no need to include the simulator library (libsim.a) on the linker command line. ๐
๐ฅ FRV Options ๐ฅ
FRV options are a whole buffet, lowkey iconic. Every single one is below, periodt. ๐
-mgpr-32โ only use the first 32 general-purpose registers. โจ-mgpr-64โ use all 64 general-purpose registers. โจ-mfpr-32โ use only the first 32 floating-point registers. ๐ฆ-mfpr-64โ use all 64 floating-point registers. ๐ฆ-mhard-floatโ use hardware instructions for floating-point operations. Slay. โก-msoft-floatโ use library routines for floating-point operations. ๐-malloc-ccโ dynamically allocate condition code registers. ๐-mfixed-ccโ do not try to dynamically allocate condition code registers; only use"icc0"and"fcc0". ๐-mdword,-mno-dwordโ control whether the ABI uses double-word instructions. ๐-mdouble,-mno-doubleโ enable or disable use of floating-point double instructions. ๐-mmedia,-mno-mediaโ enable or disable use of media instructions. ๐-mmuladd,-mno-muladdโ enable or disable use of multiply and add/subtract instructions. ๐ฅ-mfdpicโ selects the FDPIC ABI, which uses function descriptors to represent pointers to functions. Without any PIC/PIE-related options, it implies-fPIE. With-fpicor-fpie, it assumes GOT entries and small data are within a 12-bit range from the GOT base address; with-fPICor-fPIE, GOT offsets are computed with 32 bits. With abfin-elftarget, this option implies-msim. ๐-minline-pltโ enables inlining of PLT entries in function calls to functions that are not known to bind locally. It has no effect without-mfdpic. Itโs enabled by default if optimizing for speed and compiling for shared libraries (i.e.,-fPICor-fpic), or when an optimization option such as-O3or above is present in the command line. ๐-mTLSโ assumes a large TLS segment when generating thread-local code. ๐ฆ-mtlsโ does not assume a large TLS segment when generating thread-local code. ๐ฆ-mgprel-roโ enables the use of"GPREL"relocations in the FDPIC ABI for data that is known to be in read-only sections. Itโs enabled by default, except for-fpicor-fpie: even though it may help make the global offset table smaller, it trades 1 instruction for 4. With-fPICor-fPIE, it trades 3 instructions for 4, one of which may be shared by multiple symbols, and it avoids the need for a GOT entry for the referenced symbol, so itโs more likely to be a win. If it is not,-mno-gprel-rocan 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-fPICand-fpicwithout-mfdpic. You should never have to use it explicitly. ๐ญ-mlinked-fpโ follows 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โ uses indirect addressing to call functions outside the current compilation unit. This allows the functions to be placed anywhere within the 32-bit address space. ๐-malign-labelsโ tries to align labels to an 8-byte boundary by inserting NOPs into the previous packet. This option only has an effect when VLIW packing is enabled. It doesnโt create new packets; it merely adds NOPs to existing ones. ๐-mlibrary-picโ generates 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โ enable or disable packing VLIW instructions. ๐-mno-eflagsโ do not mark ABI switches ine_flags. ๐ฆ-mcond-move,-mno-cond-moveโ enable or disable the use of conditional-move instructions; it is enabled by default. This switch is mainly for debugging the compiler and will likely be removed in a future version. โ ๏ธ-mscc,-mno-sccโ enable or disable the use of conditional set instructions; it is enabled by default. This switch is mainly for debugging the compiler and will likely be removed in a future version. โ ๏ธ-mcond-exec,-mno-cond-execโ enable or disable the use of conditional execution; it is enabled by default. This switch is mainly for debugging the compiler and will likely be removed in a future version. โ ๏ธ-mvliw-branch,-mno-vliw-branchโ enable or disable an optimization pass to pack branches into VLIW instructions; it is enabled by default. This switch is mainly for debugging the compiler and will likely be removed in a future version. โ ๏ธ-mmulti-cond-exec,-mno-multi-cond-execโ enable or disable optimization of&&and||in conditional execution; it is enabled by default. This switch is mainly for debugging the compiler and will likely be removed in a future version. โ ๏ธ-mnested-cond-exec,-mno-nested-cond-execโ enable or disable nested conditional execution optimizations; it is enabled by default. This switch is mainly for debugging the compiler and will likely be removed in a future version. โ ๏ธ-moptimize-membar,-mno-optimize-membarโ this switch removes redundant"membar"instructions from the compiler-generated code. It is enabled by default. ๐ฅ-mtomcat-statsโ causes gas to print out tomcat statistics. ๐-mcpu=cpuโ selects the processor type for which to generate code. Possible values arefrv,fr550,tomcat,fr500,fr450,fr405,fr400,fr300andsimple. ๐
๐ฆ FT32 Options ๐ฆ
FT32 time! Tiny but mighty, and yes, thereโs a real warning here. ๐ฆ
-msimโ specifies that the program will be run on the simulator. This causes an alternate runtime startup and library to be linked. You must not use this option when generating programs that will run on real hardware; you must provide your own runtime library for whatever I/O functions are needed. ๐จ-mnodivโ do not usedivandmodinstructions. ๐ฆ-mft32bโ enable use of the extended instructions of the FT32B processor. ๐-mcompressโ compress all code using theFt32Bcode compression scheme. ๐ธ-mnopmโ do not generate code that reads program memory. ๐
๐ง GNU/Linux Options ๐ง
Now weโre in GNU/Linux territory, bestie โ library-picking era, iykyk. ๐ง
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. Finally, this option causes the preprocessor macro __ANDROID__ to be defined. โจ
This option can be disabled completely with -mno-android. ๐
-tno-android-ccโ disable compilation effects of-mandroid, i.e., do not enable-mbionic,-fPIC,-fno-exceptionsand-fno-rttiby default. ๐-tno-android-ldโ disable linking effects of-mandroid, i.e., pass standard Linux linking options to the linker. ๐
โจ H8/300 Options โจ
These -m options are the ones defined for the H8/300 implementations, bestie โ tiny list, big vibes ๐
-mrelaxโ shortens some address references at link time when it can, and it does that 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: this switch must be used with either-mhor-ms, no solo runs ๐-msxโ generates H8SX code.-ms2600โ generates code for the H8S/2600. This switch must be used with-ms.-mquickcallโ uses registers for argument passing. Efficient little icon ๐ซ-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, and 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, and-malign-300causes them to be aligned on 2-byte boundaries instead. This option has no effect on the H8/300.
๐ธ HPPA Options ๐ธ
These -m options are defined for the HPPA family of computers โ buckle up, there's a lot ๐ซถ
-march=architecture-type โ generates code for the specified architecture. The choices for architecture-type are1.0for PA 1.0,1.1for PA 1.1, and2.0for PA 2.0 processors. Peep/usr/lib/sched.modelson 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 โ it's giving one-way street, iykyk.-mpa-risc-1-0,-mpa-risc-1-1,-mpa-risc-2-0โ 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, and 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. So literally all atomic support is implemented using sync and atomic libcalls โ sync libcall support lives in libgcc.a, and atomic libcall support lives in libatomic.
This option generates "__atomic_exchange" calls for atomic stores, and it also provides special handling for atomic DImode accesses on 32-bit targets. Multi-tasking queen ๐ฅ
-mcaller-copiesโ the caller copies function arguments passed by hidden reference. Use this one with care, bestie, because it's not compatible with the default 32-bit runtime ๐ญ That said, only aggregates larger than eight bytes are passed by hidden reference, and the option gives you better compatibility with OpenMP.-mcoherent-ldcwโ use theldcw/ldcdcoherent 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, which lets GCC emit code that performs faster indirect calls โก
Fr fr, this option does not work in the presence of shared libraries or nested functions. Noted.
-mfixed-range=register-range โ generates code treating the given register range as fixed registers. A fixed register is one the register allocator cannot use, which is super useful when compiling kernel code. A register range is specified as two registers separated by a dash, and you can specify multiple register ranges separated by a comma.-mgasโ enables the use of assembler directives only GAS understands.-mgnu-ldโ uses options specific to GNU ld. This passes-sharedto ld when building a shared library, and it's the default when GCC is configured, explicitly or implicitly, with the GNU linker. It does not affect which ld gets called โ it only changes what parameters are passed to that ld. Which ld gets called is decided by the--with-ldconfigure option, GCC's program search path, and finally by the user'sPATH. The linker used by GCC can be printed using whichgcc -print-prog-name=ld. This option is only available on the 64-bit HP-UX GCC, i.e. configured withhppa*64*-*-hpux*.-mhp-ldโ uses options specific to HP ld. This passes-bto ld when building a shared library, and passes+Accept TypeMismatchto ld on all links. It's the default when GCC is configured, explicitly or implicitly, with the HP linker. Same deal as above: it does not affect which ld is called, only what parameters get passed to it. The ld that's called is determined by the--with-ldconfigure option, GCC's program search path, and finally by the user'sPATH. The linker used by GCC can be printed using whichgcc -print-prog-name=ld. Only available on the 64-bit HP-UX GCC, i.e. configured withhppa*64*-*-hpux*.-mlinker-optโ enables the optimization pass in the HP-UX linker. Just know that this makes symbolic debugging impossible ๐-mlong-callsโ generates code that uses long call sequences, which guarantees 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 (whichever applies) exceeds a predefined limit set by the branch type being used. The limits for normal calls are7,600,000and240,000bytes, respectively for the PA 2.0 and PA 1.X architectures. Sibling calls are always limited at240,000bytes ๐ง
Distances are measured from the beginning of functions when using the -ffunction-sections option, or when using the -mgas and -mno-portable-runtime options together under HP-UX with the SOM linker.
It's normally not desirable to use this option since it degrades performance. However, it may be useful in large applications, particularly when partial linking is used to build the application.
The types of long calls used depends on the capabilities of the assembler and linker, and the type of code being generated. On systems that support long absolute calls, and long PIC symbol-difference or PC-relative calls, the impact should be relatively small. But an indirect call is used on 32-bit ELF systems in PIC code, and that one is quite long ๐ญ
-mlong-load-storeโ generates 3-instruction load and store sequences, as sometimes required by the HP-UX 10 linker. Equivalent to the+koption 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โ assumes memory references are ordered and barriers are not needed.-mportable-runtimeโ uses the portable calling conventions proposed by HP for ELF systems.-mschedule=cpu-type โ schedules code according to the constraints for the machine type cpu-type. The choices for cpu-type are7007100,7100LC,7200,7300and8000. Peep/usr/lib/sched.modelson an HP-UX system to determine the proper scheduling option for your machine. The default scheduling is8000.-msio,-mwsioโ-msiogenerates the predefine"_SIO"for server IO. The default is-mwsio, which 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 can't be done directly in cross-compilation โ you have to make your own arrangements to provide suitable library functions for cross-compilation. Also,-msoft-floatchanges the calling convention in the output file, so it's only useful if you compile all of a program with this option. In particular, you need to compilelibgcc.aโ the library that comes with GCC โ with-msoft-floatfor this to work ๐
-msoft-multโ uses 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 are93,95and98.93is supported on all HP-UX versions,95is available on HP-UX 10.10 and later, and98is available on HP-UX 11.11 and later. The default values are93for HP-UX 10.00,95for HP-UX 10.10 though to 11.00, and98for 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", plus the startfile unix95.o. -munix=98 provides additional predefines for "_XOPEN_UNIX", "_XOPEN_SOURCE_EXTENDED", "_INCLUDE__STDC_A1_SOURCE" and "_INCLUDE_XOPEN_SOURCE_500", plus the startfile unix98.o.
Important to note, bestie: this option changes the interfaces for various library routines, and it also affects the operational behavior of the C library. So extreme care is needed when using this option ๐
Library code 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โ suppresses the generation of link options to searchlibdld.slwhen the-staticoption is specified on HP-UX 10 and later.-staticโ the HP-UX C library implementation of"setlocale"has a dependency onlibdld.sl, and there isn't an archive version oflibdld.sl. So when the-staticoption is specified, special link options are needed to resolve this dependency ๐
okay so about that HP-UX situation ๐
โ on HP-UX 10 and later, the GCC driver straight up adds the necessary options to link with libdld.sl whenever you pass -static. and like... plot twist, that makes the resulting binary dynamic ๐ซ yes bestie, -static doing a little chaos. meanwhile on the 64-bit port the linkers are already generating dynamic binaries by default in any case, so it's giving nothing new. and if that's not the vibe for you? the -nolibdld option is right there to stop the GCC driver from adding these link options. slay.
-threadsโ adds support for multithreading with the dce thread library under HP-UX. it sets flags for both the preprocessor and the linker, so both sides are in on it ๐งตโจ
๐ IA-64 Options ๐
these are the -m options defined for the Intel IA-64 architecture. buckle up ๐
-mbig-endianโ generate code for a big-endian target. this is the default for HP-UX ๐ฅ-mlittle-endianโ generate code for a little-endian target. this is the default for AIX5 and GNU/Linux ๐ซ-mgnu-as,-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 ๐ญ like, actually rule-breaking, 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, andoutregister 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. useful when compiling kernel code ๐-mauto-picโ generate code that is self-relocatable. this implies-mconstant-gp. 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 forsqrt๐ซ-mno-dwarf2-asm,-mdwarf2-asmโ don't (or do) generate assembler code for the DWARF line number debugging info. this may be useful when not using the GNU assembler ๐-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 ๐ ngl, no promises-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 are14,22, and64๐ข - *
-mtune=cpu-type* โ tune the instruction scheduling for a particular CPU. valid values areitanium,itanium1,merced,itanium2, andmckinley๐๏ธ (yes the original says "Valid values are itanium..." with that stray comma, we're keeping the energy) -milp32,-mlp64โ generate code for a 32-bit or 64-bit environment. the 32-bit environment setsint,longand pointer to 32 bits. the 64-bit environment setsintto 32 bits andlongand 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 ofld.ainstructions 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 ofld.ainstructions 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 theld.sinstructions and the corresponding check instructionschk.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-specenabled. 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-specenabled. 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-specenabled. 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 is1๐ง -msched-max-memory-insns-hard-limit,-mno-sched-max-memory-insns-hard-limitโ makes the limit specified bymsched-max-memory-insnsa 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 ๐ฌ fr fr, that's the deal
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, whereintis 32 bits, whilelong intand pointers are 64 bits ๐lp64fโ uses 64-bit general purpose registers and 32-bit floating-point registers for parameter passing. data model is LP64, whereintis 32 bits, whilelong intand pointers are 64 bits ๐lp64sโ uses 64-bit general purpose registers and no floating-point registers for parameter passing. data model is LP64, whereintis 32 bits, whilelong intand pointers are 64 bits ๐
- *
-mfpu=fpu-type* โ generate code for the specified FPU type, which can be one of: 64โ lets the hardware floating-point instructions flex for both 32-bit and 64-bit operations ๐32โ hardware floating-point instructions, but only for 32-bit operationsnone/0โ nope, zero, nada: blocks any use of hardware floating-point instructions ๐ โโ๏ธ
-msimd=simd-type ๐ฆ
turns on generating LoongArch SIMD instructions โ both for vectorization and via builtin functions. the value is one of these cuties:
lasxโ enables generating instructions from the 256-bit LoongArch Advanced SIMD Extension (LASX) and the 128-bit LoongArch SIMD Extension (LSX)lsxโ enables generating instructions from the 128-bit LoongArch SIMD Extension (LSX)noneโ literally no LoongArch SIMD instruction may be generated, not even one ๐
the floaty ABI ones ๐
-msoft-floatโ forces-mfpu=noneand straight-up prevents floating-point registers from being used for parameter passing. heads up bestie: this option may change the target ABI-msingle-floatโ forces-mfpu=32and allows 32-bit floating-point registers for parameter passing. again: this option may change the target ABI-mdouble-floatโ forces-mfpu=64and allows 32/64-bit floating-point registers for parameter passing. and yep, this option may change the target ABI
-mlasx / -mno-lasx / -mlsx / -mno-lsx โจ
these four incrementally adjust the scope of the SIMD extensions (none / LSX / LASX) the compiler is allowed to use for code generation. the way they chain is so satisfying: enabling LASX with -mlasx automatically enables LSX, and disabling LSX with -mno-lsx automatically disables LASX ๐ซถ
these are driver-only options โ they act upon 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 passed to the compiler proper. order matters, iykyk ๐
-mbranch-cost=n ๐ฅ
sets the cost of branches to roughly n instructions.
-maddr-reg-reg-cost=n ๐ธ
sets the cost of ADDRESS_REG_REG to the value calculated by n.
-mcheck-zero-division / -mno-check-zero-divison ๐
traps (or does not trap) on integer division by zero. the default is -mcheck-zero-division for -O0 or -Og, and -mno-check-zero-division for other optimization levels.
fr fr note the spelling on that second one โ it's -mno-check-zero-divison in the manual, missing an "i". that's just how it's written, don't come for me ๐
-mbreak-code=code ๐
emits a break code instruction for irrecoverable traps from __builtin_trap or ones inserted by the compiler (for example an erroneous path isolated with -fisolate-erroneous-paths-dereference) โ or an amswap.w $r0, $r1, $r0 instruction, which will cause the hardware to trigger an Instruction Not-defined Exception if code is negative or greater than 32767.
the default is -1, meaning: use the amswap.w instruction.
-mcond-move-int / -mno-cond-move-int ๐
conditional moves for integral data in general-purpose registers are enabled (disabled). default? -mcond-move-int, slay.
-mcond-move-float / -mno-cond-move-float ๐ฆ
conditional moves for floating-point registers are enabled (disabled). default is -mcond-move-float.
-mmemcpy / -mno-memcpy โญ
forces (or doesn't force) the use of memcpy for non-trivial block moves. the default is -mno-memcpy, which lets GCC inline most constant-sized copies.
setting the optimization level to -Os also forces the use of memcpy, but -mno-memcpy may override this behavior if explicitly specified โ regardless of the order these options appear on the command line. chaotic but valid ๐
-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.
-G num ๐
puts global and static data smaller than num bytes into a small data section. the default value is 0.
-mmax-inline-memcpy-size=n โจ
inlines all block moves (like calls to memcpy or structure copies) less than or equal to n bytes. the default value of n is 1024.
-mcmodel=code-model ๐
sets the code model to one of:
tiny-staticโ (Not implemented yet)tinyโ (Not implemented yet)normalโ the text segment must be within 128MB addressing space. the data segment must be within 2GB addressing space.mediumโ the text segment and data segment must be within 2GB addressing space. this is the default code model unless GCC has been configured with--with-cmodel=specifying a different default code model.largeโ (Not implemented yet)extremeโ this mode does not limit the size of the code segment and data segment. the-mcmodel=extremeoption is incompatible with-fpltand/or-mexplicit-relocs=none.
lowkey obsessed with how half these models are just "(Not implemented yet)" ๐ญ iconic honestly
-mexplicit-relocs=style / -mexplicit-relocs / -mno-explicit-relocs ๐ง
sets when to use assembler relocation operators when dealing with symbolic addresses. the alternative is to use assembler macros instead, which may limit instruction scheduling but allow linker relaxation.
- with
-mexplicit-relocs=none, the assembler macros are always used - with
-mexplicit-relocs=always, the assembler relocation operators are always used - with
-mexplicit-relocs=auto, the compiler uses the relocation operators where linker relaxation is impossible (to improve code quality), and macros elsewhere
the default value for the option is determined by the assembler capability detected during GCC build-time plus the setting of -mrelax:
-mexplicit-relocs=noneif the assembler does not support relocation operators at all-mexplicit-relocs=alwaysif the assembler supports relocation operators but-mrelaxis not enabled-mexplicit-relocs=autoif the assembler supports relocation operators and-mrelaxis 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 ๐
controls use of the GOT to access external symbols. the 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 and all external symbols are PC-relatively addressed. it's only suitable for environments where no dynamic link is performed โ like firmwares, OS kernels, executables linked with -static or -static-pie.
-mdirect-extern-accessis not compatible with-fPICor-fpic. bestie, do not mix these, I'm begging ๐ญ
-mrelax / -mno-relax ๐
takes (or doesn't take) advantage of linker relaxations. if -mpass-mrelax-to-as is enabled, this option is also passed to the assembler.
the default is determined during GCC build-time by detecting corresponding assembler support:
-mrelaxif the assembler supports both the-mrelaxoption and the conditional branch relaxation โ and that second part is required, otherwise the.aligndirectives and conditional branch instructions in the assembly code outputted by GCC may be rejected by the assembler because of a relocation overflow ๐-mno-relaxotherwise
-mpass-mrelax-to-as / -mno-pass-mrelax-to-as ๐ธ
passes (or does not pass) the -mrelax or -mno-relax option to the assembler. the default is determined during GCC build-time by detecting corresponding assembler support: -mpass-mrelax-to-as if the assembler supports the -mrelax option, -mno-pass-mrelax-to-as otherwise.
this one is mostly useful for debugging, or for interoperation with assemblers different from the build-time one.
-mrecip ๐ฅ
enables use of the reciprocal estimate and reciprocal square root estimate instructions with additional Newton-Raphson steps to increase precision, instead of doing a divide or square root and divide for floating-point arguments.
these instructions are generated only when -funsafe-math-optimizations is enabled together with -ffinite-math-only and -fno-trapping-math. this option is off by default.
before you can use this option, you must be sure the target CPU supports the frecipe and frsqrte instructions. ๐
and note: 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). so likeโฆ faster but slightly feral ๐ซ
-mrecip=opt ๐
controls which reciprocal estimate instructions may be used. opt is a comma-separated list of options, which may be preceded by a ! to invert the option:
allโ enable all estimate instructionsdefaultโ enable the default instructions, equivalent to-mrecipnoneโ disable all estimate instructions, equivalent to-mno-recipdivโ enable the approximation for scalar divisionvec-divโ enable the approximation for vectorized divisionsqrtโ enable the approximation for scalar square rootvec-sqrtโ enable the approximation for vectorized square rootrsqrtโ enable the approximation for scalar reciprocal square rootvec-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. see how clean that is โจ
-mfrecipe / -mno-frecipe ๐ฆ
use (do not use) frecipe.{s/d} and frsqrte.{s/d} instructions. when compiling with -march=la664, it is enabled by default. otherwise the default is -mno-frecipe.
-mdiv32 / -mno-div32 โญ
use (do not use) div.w[u] and mod.w[u] instructions with input not sign-extended. when compiling with -march=la664, it is enabled by default. otherwise the default is -mno-div32.
-mlam-bh / -mno-lam-bh ๐
use (do not use) am{swap/add}[_db].{b/h} instructions. when compiling with -march=la664, it is enabled by default. otherwise the default is -mno-lam-bh.
-mlamcas / -mno-lamcas ๐
use (do not use) amcas[_db].{b/h/w/d} instructions. when compiling with -march=la664, it is 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 is enabled by default. otherwise the default is -mno-ld-seq-sa, and the load-load barrier is needed.
-mscq / -mno-scq ๐
use (do not use) the 16-byte conditional store instruction sc.q. the default is -mscq if the machine type specified with -march= supports this instruction, -mno-scq otherwise.
-mtls-dialect=optโ bestie, this one controls which TLS dialect may be used for general dynamic and local dynamic TLS models. The opt argument can be one of:tradโ use traditional TLS. This is the default. ๐descโ use TLS descriptors. โจ
-mannotate-tablejump,-mno-annotate-tablejumpโ this creates an annotation section.discard.tablejump_annotateto correlate thejirlinstruction and the jump table when a jump table is used to optimize theswitchstatement. Some external tools, for example objtool of the Linux kernel building system, need the annotation to analyze the control flow. The default is-mno-annotate-tablejump. ๐ฅ
๐ LynxOS Options ๐
These options are available for LynxOS targets.
-msharedโ use shared libraries. The default is to link with static libraries. ๐ซถ-mthreadsโ support multi-threading. ๐-mlegacy-threadsโ support legacy multi-threading. This option is incompatible with-mthreads. ๐
๐ M32C Options ๐
-mcpu=nameโ select the CPU for which code is generated. name may be one ofr8cfor the R8C/Tiny series,m16cfor the M16C (up to /60) series,m32cmfor the M16C/80 series, orm32cfor the M32C/80 series. ๐-msimโ specifies that the program will be run on the simulator. This causes an alternate runtime library to be linked in which supports, for example, file I/O. You must not use this option when generating programs that will run on real hardware; you must provide your own runtime library for whatever I/O functions are needed. ๐จ-memregs=numberโ specifies the number of memory-based pseudo-registers GCC uses during code generation. These pseudo-registers are used like real registers, so there is a tradeoff between GCC's ability to fit 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. 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:
-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 that their addresses can be loaded with theld24instruction), and assume all subroutines are reachable with theblinstruction. 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 generatesseth/add3instructions to load their addresses), and assume all subroutines are reachable with theblinstruction. ๐ฆ-mmodel=largeโ assume objects may be anywhere in the 32-bit address space (the compiler generatesseth/add3instructions to load their addresses), and assume subroutines may not be reachable with theblinstruction (the compiler generates the much slowerseth/add3/jlinstruction sequence). ๐-msdata=noneโ disable use of the small data area. Variables are put into one of.data,.bss, or.rodata(unless thesectionattribute 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 do not 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-msdataoption must be set to one ofsdataorusefor this option to have any effect. ๐
All modules should be compiled with the same -G num value. Compiling with different values of num may or may not work; if it doesn't the linker gives an error message---incorrect code is not generated. ๐จ
-mdebugโ makes the M32R-specific code in the compiler display some statistics that might help 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 is 1 then branches are preferred over conditional code, if it is 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,68060andcpu32. ColdFire architectures are selected according to Freescale's ISA classification and the permissible values are:isaa,isaaplus,isabandisac. ๐ฅ
GCC defines a macro __mcfarch__ whenever it is generating code for a ColdFire target. The arch in this macro is one of the -march arguments given above. โจ
When used together, -march and -mtune select code that runs on a family of similar processors but that is optimized for a particular microarchitecture. ๐
-mcpu=cpuโ generate code for a specific M680x0 or ColdFire processor. The M680x0 cpus are:68000,68010,68020,68030,68040,68060,68302,68332andcpu32. The ColdFire cpus are given by the table below, which also classifies the CPUs into families:
Family : -mcpu arguments
51 : 51 51ac 51ag 51cn 51em 51je 51jf 51jg 51jm 51mm 51qe 51qm
5206 : 5202 5204 5206
5206e : 5206e
5208 : 5207 5208
5211a : 5210a 5211a
5213 : 5211 5212 5213
5216 : 5214 5216
52235 : 52230 52231 52232 52233 52234 52235
5225 : 5224 5225
52259 : 52252 52254 52255 52256 52258 52259
5235 : 5232 5233 5234 5235 523x
5249 : 5249
5250 : 5250
5271 : 5270 5271
5272 : 5272
5275 : 5274 5275
5282 : 5280 5281 5282 528x
53017 : 53011 53012 53013 53014 53015 53016 53017
5307 : 5307
5329 : 5327 5328 5329 532x
5373 : 5372 5373 537x
5407 : 5407
5475 : 5470 5471 5472 5473 5474 5475 547x 5480 5481 5482 5483 5484 5485
-mcpu=cpu overrides -march=arch if arch is compatible with cpu. Other combinations of -mcpu and -march are rejected. ๐จ
GCC defines the macro __mcf_cpu_cpu when ColdFire target cpu is selected. It also defines __mcf_family_family, where the value of family is given by the table above. ๐
-mtune=tuneโ tune the code for a particular microarchitecture within the constraints set by-marchand-mcpu. The M680x0 microarchitectures are:68000,68010,68020,68030,68040,68060andcpu32. The ColdFire microarchitectures are:cfv1,cfv2,cfv3,cfv4andcfv4e. ๐ฆ
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โ bestie, this was an external MMU for the68020processor. GCC accepts this option but does not use it ๐ญ. Itโs giving โwe have your order but the kitchen is closed.โ-mcpu32โ generate output for a CPU32. This is the default when the compiler is configured for CPU32-based systems. Itโs equivalent to-march=cpu32. Use this option for microcontrollers with a CPU32 or CPU32+ core, including the68330,68331,68332,68333,68334,68336,68340,68341,68349and68360. โจ-mfidoaโ generate code for a Fido A. Thatโs the whole vibe. ๐-m5200โ generate output for a 520X ColdFire CPU. This is the default when the compiler is configured for 520X-based systems. Itโs equivalent to-mcpu=5206, and is now deprecated in favor of that option. Use this option for microcontroller with a 5200 core, including theMCF5202,MCF5203,MCF5204andMCF5206. ๐-m5206eโ generate output for a 5206e ColdFire CPU. The option is now deprecated in favor of the equivalent-mcpu=5206e.-m528xโ generate output for a member of the ColdFire 528X family. The option is now deprecated in favor of the equivalent-mcpu=528x.-m5307โ generate output for a ColdFire 5307 CPU. The option is now deprecated in favor of the equivalent-mcpu=5307.-m5407โ generate output for a ColdFire 5407 CPU. The option is now deprecated in favor of the equivalent-mcpu=5407.-mcfv4eโ generate output for a ColdFire V4e family CPU (e.g.547x/548x). This includes use of hardware floating-point instructions. The option is equivalent to-mcpu=547x, and is now deprecated in favor of that option.-m68020-40โ generate output for a68040, without using any of the new instructions. This results in code that can run relatively efficiently on either a68020/68881or a68030or a68040. The generated code does use the68881instructions that are emulated on the68040. The option is equivalent to-march=68020 -mtune=68020-40. ๐-m68020-60โ generate output for a68060, without using any of the new instructions. This results in code that can run relatively efficiently on either a68020/68881or a68030or a68040. The generated code does use the68881instructions that are emulated on the68060. The option is equivalent to-march=68020 -mtune=68020-60.-mhard-float,-m68881โ generate floating-point instructions. This is the default for68020and above, and for ColdFire devices that have an FPU. It defines the macro__HAVE_68881__on M680x0 targets and__mcffpu__on ColdFire targets. ๐-msoft-floatโ do not generate floating-point instructions; use library calls instead. This is the default for68000,68010, and68832targets. It is also the default for ColdFire devices that have no FPU.-mdiv,-mno-divโ generate (do not generate) ColdFire hardware divide and remainder instructions. If-marchis 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 specified by-mcpu). For example, the default is"off"for-mcpu=5206and"on"for-mcpu=5206e. GCC defines the macro__mcfhwdiv__when this option is enabled. โก-mshort,-mno-short,-mnoshortโ consider typeintto be 16 bits wide, likeshort int. Additionally, parameters passed on the stack are also aligned to a 16-bit boundary even on targets whose API mandates promotion to 32-bit. This option is disabled by default.-mbitfield,-mno-bitfield,-mnobitfieldโ control use of the bit-field instructions. The-m68000,-mcpu32and-m5200options imply-mnobitfield; the-m68020option implies-mbitfield.-mrtd,-mno-rtd,-mnortdโ control use of a different function-calling convention, in which functions that take a fixed number of arguments return with thertdinstruction, which pops their arguments while returning. This saves one instruction in the caller since there is no need to pop the arguments there.
โ ๏ธ This calling convention is incompatible with the one normally used on Unix, so you cannot use it if you need to call libraries compiled with the Unix compiler. Also, you must provide function prototypes for all functions that take variable numbers of arguments (including printf); otherwise incorrect code is generated for calls to those functions. In addition, seriously incorrect code results if you call a function with too many arguments. (Normally, extra arguments are harmlessly ignored.) ๐ญ
The rtd instruction is supported by the 68010, 68020, 68030, 68040, 68060 and CPU32 processors, but not by the 68000 or 5200. The default is -mno-rtd.
-malign-int,-mno-align-intโ control whether GCC alignsint,long,long long,float,double, andlong doublevariables 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. ๐
-mpcrelโ use the pc-relative addressing mode of the68000directly, instead of using a global offset table. At present, this option implies-fpic, allowing at most a 16-bit offset for pc-relative addressing.-fPICis not presently supported with-mpcrel, though this could be supported for68020and 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. This option is disabled by default. ๐-mshared-library-id=nโ specifies the identification number of the ID-based shared library being compiled. Specifying a value of0generates more compact code; specifying other values forces the allocation of that number to the current library, but is no more space- or time-efficient than omitting this option.-mxgot,-mno-xgotโ when generating position-independent code for ColdFire, generate code that works if the GOT has more than8192entries. This code is larger and slower than code generated without this option. On M680x0 processors, this option is not needed;-fPICsuffices.
GCC normally uses a single instruction to load values from the GOT. While this is relatively efficient, it only works if the GOT is smaller than about 64k. Anything larger causes the linker to report an error such as:
relocation truncated to fit: R_68K_GOT16O foobar
If this happens, you should recompile your code with -mxgot. It should then work with very large GOTs. However, code generated with -mxgot is less efficient, since it takes 4 instructions to fetch the value of a global symbol. ๐
Note that some linkers, including newer versions of the GNU linker, can create multiple GOTs and sort GOT entries. If you have such a linker, you should only need to use -mxgot when compiling a single object file that accesses more than 8192 GOT entries. Very few do. These options have no effect unless GCC is generating position-independent code.
-mxtlsโ support TLS segment larger than64K. The considerations for using this option are similar to those for-mxgotabove; the default 16-bit offset addressing for TLS is more efficient, but this may be inadequate for some programs.-mlong-jump-table-offsetsโ use 32-bit offsets inswitchtables. The default is to use 16-bit offsets.
๐ธ MCore Options ๐ธ
These are the -m options defined for the Motorola M*Core processors.
-mhardlit,-mno-hardlitโ inline constants into the code stream if it can be done in two instructions or less. ๐-mdiv,-mno-divโ use the divide instruction. (Enabled by default).-mrelax-immediates,-mno-relax-immediatesโ allow arbitrary-sized immediates in bit operations.-mwide-bitfields,-mno-wide-bitfieldsโ always treat bit-fields asint-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 that need a large amount of stack space, but they can also trigger a segmentation fault if the stack is extended too much. The default value is0x1000. ๐
๐ MicroBlaze Options ๐
-msoft-floatโ use software emulation for floating point (default).-mhard-floatโ use hardware floating-point instructions.-mmemcpyโ do not optimize block moves, usememcpy.-mcpu=cpu-typeโ use features of, and schedule code for, the given CPU. Supported values are in the formatvX.YY.Z, whereXis a major version,YYis the minor version, andZis compatibility code. Example values arev3.00.a,v4.00.b,v5.00.a,v5.00.b,v6.00.a. ๐-mxl-soft-mul,-mno-xl-soft-mulโ use software multiply emulation. It's on by default, bestie, so you're already slaying it ๐-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. smol divisions, big brain energy ๐-mxl-gp-optโ use GP-relative.sdata/.sbsssections ๐ฅ-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. Valid models are, and honestly the range:executableโ normal executable (default), uses startup codecrt0.o.xmdstubโ for use with the Xilinx Microprocessor Debugger (XMD) based software intrusive debug agent calledxmdstub. This uses startup filecrt1.oand sets the start address of the program to0x800.bootstrapโ for applications that are loaded using a bootloader. This model uses startup filecrt2.owhich does not contain a processor reset vector handler. This is suitable for transferring control on a processor reset to the bootloader rather than the application.novectorsโ for applications that do not require any of the MicroBlaze vectors. This option may be useful for applications running within a monitoring application. This model usescrt3.oas 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 allows data to be referenced by offset from start of text address instead of GOT, since PC-relative addressing is not supported ๐ซถ
๐ MIPS Options
Ok so this is the MIPS section and it is a lot, but we're getting through it together, no cap ๐
-EB,-mebโ generate big-endian code.-EL,-melโ generate little-endian code. This is the default formips*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
...plus allegrex. And the special value from-abi selects the most compatible architecture for the selected ABI (that is, mips1 for 32-bit ABIs and mips3 for 64-bit ABIs) ๐
The native Linux/GNU toolchain also supports the value native, which selects the best architecture option for the host processor. -march=native has no effect if GCC does not recognize the processor ๐
In processor names, a final 000 can be abbreviated as k (for example, -march=r2k). Prefixes are optional, and vr may be written r โจ
Names of the form nf2_1 refer to processors with FPUs clocked at half the rate of the core, names of the form nf1_1 refer to processors with FPUs clocked at the same rate as the core, and names of the form nf3_2 refer to processors with FPUs clocked a ratio of 3:2 with respect to the core. For compatibility reasons, nf is accepted as a synonym for nf2_1 while nx and bfx are accepted as synonyms for nf1_1 ๐ง
GCC defines two macros based on the value of this option. The first is _MIPS_ARCH, which gives the name of target architecture, as a string. The second has the form _MIPS_ARCH_foo, where foo is the capitalized value of _MIPS_ARCH. For example, -march=r2000 sets _MIPS_ARCH to "r2000" and defines the macro _MIPS_ARCH_R2000 ๐
Note that the _MIPS_ARCH macro uses the processor names given above. In other words, it has the full prefix and does not abbreviate 000 as k. In the case of from-abi, the macro names the resolved architecture (either "mips1" or "mips3"). It names the default architecture when no -march option is given ๐
-mtune=arch โ optimize for arch. Among other things, this option controls the way instructions are scheduled, and the perceived cost of arithmetic operations. The list of arch values is the same as for-march.
When this option is not used, GCC optimizes for the processor specified by -march. By using -march and -mtune together, it is possible to generate code that runs on a family of processors, but optimize the code for one particular member of that family ๐
-mtune defines the macros _MIPS_TUNE and _MIPS_TUNE_foo, which work in the same way as the -march ones described above.
-mips1โ equivalent to-march=mips1.-mips2โ equivalent to-march=mips2.-mips3โ equivalent to-march=mips3.-mips4โ equivalent to-march=mips4.-mips32โ equivalent to-march=mips32.-mips32r3โ equivalent to-march=mips32r3.-mips32r5โ equivalent to-march=mips32r5.-mips32r6โ equivalent to-march=mips32r6.-mips64โ equivalent to-march=mips64.-mips64r2โ equivalent to-march=mips64r2.-mips64r3โ equivalent to-march=mips64r3.-mips64r5โ equivalent to-march=mips64r5.-mips64r6โ equivalent to-march=mips64r6.-mips16,-mno-mips16โ generate (do not generate) MIPS16 code. If GCC is targeting a MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE ๐ธ
MIPS16 code generation can also be controlled on a per-function basis by means of mips16 and nomips16 attributes.
-mmips16e2,-mno-mips16e2โ use (do not use) the MIPS16e2 ASE. This option modifies the behavior of the-mips16option such that it targets the MIPS16e2 ASE โญ-mflip-mips16,-mflip-mips16โ yes, the page really does list it twice, we're just as confused as you are bestie ๐ญ โ 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 โ ๏ธ-minterlink-compressed,-mno-interlink-compressedโ require (do not require) that code using the standard (uncompressed) MIPS ISA be link-compatible with MIPS16 and microMIPS code, and vice versa ๐
For example, code using the standard ISA encoding cannot jump directly to MIPS16 or microMIPS code; it must either use a call or an indirect jump. -minterlink-compressed therefore disables direct jumps unless GCC knows that the target of the jump is not compressed.
-minterlink-mips16,-mno-interlink-mips16โ aliases of-minterlink-compressedand-mno-interlink-compressed. These options predate the microMIPS ASE and are retained for backwards compatibility ๐ซถ-mabi=32,-mabi=o64,-mabi=n32,-mabi=64,-mabi=eabiโ generate code for the given ABI.
Note that the EABI has a 32-bit and a 64-bit variant. GCC normally generates 64-bit code when you select a 64-bit architecture, but you can use -mgp32 to get 32-bit code instead ๐
For information about the O64 ABI, see https://gcc.gnu.org/projects/mipso64-abi.html.
GCC supports a variant of the o32 ABI in which floating-point registers are 64 rather than 32 bits wide. You can select this combination with -mabi=32 -mfp64. This ABI relies on the mthc1 and mfhc1 instructions and is therefore only supported for MIPS32R2, MIPS32R3 and MIPS32R5 processors ๐ฅ
The register assignments for arguments and return values remain the same, but each scalar value is passed in a single 64-bit register rather than a pair of 32-bit registers. For example, scalar floating-point values are returned in $f0 only, not a $f0/$f1 pair. The set of call-saved registers also remains the same in that the even-numbered double-precision registers are saved ๐
Two additional variants of the o32 ABI are supported to enable a transition from 32-bit to 64-bit registers. These are FPXX (-mfpxx) and FP64A (-mfp64 -mno-odd-spreg). The FPXX extension mandates that all code must execute correctly when run using 32-bit or 64-bit registers. The code can be interlinked with either FP32 or FP64, but not both. The FP64A extension is similar to the FP64 extension but forbids the use of odd-numbered single-precision registers. This can be used in conjunction with the FRE mode of FPUs in MIPS32R5 processors and allows both FP32 and FP64A code to interlink and run in the same process without changing FPU modes ๐ฆ
-mabicalls,-mno-abicallsโ generate (do not generate) code that is suitable for SVR4-style dynamic objects.-mabicallsis the default for SVR4-based systems ๐-mshared,-mno-sharedโ generate (do not generate) code that is fully position-independent, and that can therefore be linked into shared libraries. This option only affects-mabicalls.
All -mabicalls code has traditionally been position-independent, regardless of options like -fPIC and -fpic. However, as an extension, the GNU toolchain allows executables to use absolute accesses for locally-binding symbols. It can also use shorter GP initialization sequences and generate direct calls to locally-defined functions. This mode is selected by -mno-shared ๐
-mno-shared depends on binutils 2.16 or higher and generates objects that can only be linked by the GNU linker. However, the option does not affect the ABI of the final executable; it only affects the ABI of relocatable objects. Using -mno-shared generally makes executables both smaller and quicker ๐
-msharedis the default ๐-mplt,-mno-pltโ assume (or don't assume, bestie, pick a lane) that the static and dynamic linkers support PLTs and copy relocations. This one only does anything for-mno-shared+-mabicalls. And for the n64 ABI it's literally a no-op without-msym32. ๐
You can make -mplt the default by configuring GCC with --with-mips-plt. Otherwise the default is -mno-plt. Periodt.
-mxgot,-mno-xgotโ lift (or don't lift) the usual restrictions on how big the global offset table can get.
So normally GCC loads values from the GOT with a single instruction. Cute and efficient, sure, but it only works while the GOT is under about 64k. Anything bigger and the linker comes for you with an error like:
relocation truncated to fit: R_MIPS_GOT16 foobar
If that happens, recompile with -mxgot. It handles very large GOTs, but the code is less efficient too โ fetching a global symbol now takes three instructions instead of one. ๐ญ
Ngl, some linkers can create multiple GOTs. If yours does, you should only need -mxgot when a single object file touches more than 64k's worth of GOT entries. Very few do.
Also these options do nothing unless GCC is generating position independent code. Fr fr.
-mgp32โ assume general-purpose registers are 32 bits wide.-mgp64โ assume general-purpose registers are 64 bits wide.-mfp32โ assume floating-point registers are 32 bits wide.-mfp64โ assume floating-point registers are 64 bits wide.-mfpxxโ don't assume the width of floating-point registers at all. Mysterious. Iconic. ๐-mhard-floatโ use floating-point coprocessor instructions.-msoft-floatโ don't use floating-point coprocessor instructions. Do your floating-point math via library calls instead.-mno-floatโ same energy as-msoft-float, but additionally it asserts that the program you're compiling performs zero floating-point operations. Right now this is only supported by some bare-metal MIPS configurations, where it may pick a special set of libraries with no floating-point support at all (including, for example, the floating-pointprintfformats).
Bestie, if code compiled with -mno-float accidentally contains floating-point operations, it is likely to suffer a link-time or run-time failure. ๐ Don't do that.
-msingle-floatโ assume the floating-point coprocessor only supports single-precision operations.-mdouble-floatโ assume 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. That's the default for processors known to support these registers. When you're on the o32 FPXX ABI, though,-mno-odd-spregis set by default.-mabs=2008,-mabs=legacyโ these control how the special not-a-number (NaN) IEEE 754 floating-point data gets treated by theabs.fmtandneg.fmtmachine instructions.
By default, or when -mabs=legacy is used, you get the legacy treatment. In that case these instructions count as arithmetic and get avoided wherever correct operation is required and the input operand might be a NaN. Instead it uses a longer sequence of instructions that manually manipulates the sign bit of the floating-point datum โ unless you also passed -ffinite-math-only.
The -mabs=2008 option selects the IEEE 754-2008 treatment. Now these instructions count as non-arithmetic, so they operate correctly in all cases, including specifically when the input operand is a NaN. So they're always used for the respective operations. Slay ๐ฅ
-mnan=2008,-mnan=legacyโ these control the encoding of the special not-a-number (NaN) IEEE 754 floating-point data.
-mnan=legacy selects the legacy encoding: quiet NaNs (qNaNs) are denoted by the first bit of their trailing significand field being 0, while signaling NaNs (sNaNs) are denoted by that first bit being 1.
-mnan=2008 selects the IEEE 754-2008 encoding: now qNaNs are denoted by the first bit of their trailing significand field being 1, while sNaNs are denoted by that first bit being 0. Literally flipped, no cap.
The default is -mnan=legacy unless GCC has been configured with --with-nan=2008.
-mllsc,-mno-llscโ use (or don't use)ll,sc, andsyncinstructions 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 one the default by configuring GCC with --with-llsc and --without-llsc respectively. --with-llsc is the default for some configurations โ check the installation documentation for the details ๐
-mdsp,-mno-dspโ use (or don't use) revision 1 of the MIPS DSP ASE. This option defines the preprocessor macro__mips_dsp. It also defines__mips_dsp_revto 1.-mdspr2,-mno-dspr2โ use (or don't use) revision 2 of the MIPS DSP ASE. This one defines the preprocessor macros__mips_dspand__mips_dspr2. It also defines__mips_dsp_revto 2.-msmartmips,-mno-smartmipsโ use (or don't use) the MIPS SmartMIPS ASE.-mpaired-single,-mno-paired-singleโ use (or don't use) paired-single floating-point instructions. This option requires hardware floating-point support to be enabled ๐ซถ-mdmx,-mno-mdmxโ use (or don't use) MIPS Digital Media Extension instructions. You can only use this one when generating 64-bit code, and it requires hardware floating-point support to be enabled.-mips3d,-mno-mips3dโ use (or don't use) the MIPS-3D ASE. The option-mips3dimplies-mpaired-single. Package deal ๐-mmicromips,-mno-micromipsโ generate (or don't generate) microMIPS code.
MicroMIPS code generation can also be controlled on a per-function basis by means of micromips and nomicromips attributes. Fancy.
-mmt,-mno-mtโ use (or don't use) MT Multithreading instructions.-mmcu,-mno-mcuโ use (or don't use) the MIPS MCU ASE instructions.-meva,-mno-evaโ use (or don't use) the MIPS Enhanced Virtual Addressing instructions.-mvirt,-mno-virtโ use (or don't use) the MIPS Virtualization (VZ) instructions.-mxpa,-mno-xpaโ use (or don't use) the MIPS eXtended Physical Address (XPA) instructions.-mcrc,-mno-crcโ use (or don't use) the MIPS Cyclic Redundancy Check (CRC) instructions.-mginv,-mno-ginvโ use (or don't use) the MIPS Global INValidate (GINV) instructions.-mmsa,-mno-msaโ use (or don't use) the MIPS MSA extension instructions.-mloongson-mmi,-mno-loongson-mmiโ use (or don't use) the MIPS Loongson MultiMedia extensions Instructions (MMI).-mloongson-ext,-mno-loongson-extโ use (or don't use) the MIPS Loongson EXTensions (EXT) instructions.-mloongson-ext2,-mno-loongson-ext2โ use (or don't use) the MIPS Loongson EXTensions r2 (EXT2) instructions.-mlong64โ forcelongtypes to be 64 bits wide. See-mlong32for an explanation of the default and how pointer size gets determined ๐-mlong32โ forcelong,int, and pointer types to be 32 bits wide.
The default size of ints, longs and pointers depends on the ABI. All the supported ABIs use 32-bit ints. The n64 ABI uses 64-bit longs, and so does the 64-bit EABI; the others use 32-bit longs. Pointers are the same size as longs, or the same size as integer registers โ whichever is smaller. The way that works is lowkey cursed but okay ๐ฆ
-msym32,-mno-sym32โ assume (or don't assume) that all symbols have 32-bit values, regardless of the selected ABI. This option is useful in combination with-mabi=64and-mno-abicallsbecause it lets GCC generate shorter and faster references to symbolic addresses โจ-Gnum โ put definitions of externally-visible data in a small data section if that data is no bigger than num bytes. Then GCC can generate more efficient accesses to the data; see-mgpoptfor details.
The default -G option depends on the configuration.
-mlocal-sdata,-mno-local-sdataโ extend (or don't extend) the-Gbehavior to local data too, like static variables in C.-mlocal-sdatais 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 also might want to build large libraries with -mno-local-sdata, so the libraries leave more room for the main program. Be considerate ๐ซถ
-mextern-sdata,-mno-extern-sdataโ assume (or don't assume) that externally-defined data is in a small data section if that data's size is within the-Glimit.-mextern-sdatais the default for all configurations.
Okay so this one's got rules, bestie, pay attention: if you compile a module Mod with -mextern-sdata -G num -mgpopt, and Mod references a variable Var that's 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. And if Var is common, you must link the application with a high-enough -G setting. No cap, those are the rules ๐ค
The easiest way of satisfying these restrictions is to compile and link every module with the same -G option. But you may wish to build a library that supports several different small data limits โ you can do that 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. Main character library energy ๐
-mgpopt,-mno-gpoptโ use (or don't use) GP-relative accesses for symbols known to be in a small data section; see-G,-mlocal-sdataand-mextern-sdata.-mgpoptis the default for all configurations โญ-mno-gpoptโ okay bestie, this one is for when the$gpregister might not hold the value of_gp. Like, imagine the code is part of a library that might get used inside a boot monitor โ programs that call boot monitor routines pass an unknown value in$gp. (And in those situations, the boot monitor itself is usually compiled with-G0, iykyk.)
Lowkey important: -mno-gpopt implies -mno-local-sdata and -mno-extern-sdata. Periodt.
-membedded-data,-mno-embedded-dataโ allocates variables to the read-only data section first if possible, then next in the small data section if possible, otherwise in data. It's giving slightly slower code than the default, but it reduces the amount of RAM required when executing โ so it may be preferred for some embedded systems. ๐ธ-muninit-const-in-rodata,-mno-uninit-const-in-rodataโ puts uninitializedconstvariables in the read-only data section. Heads up though: this option is only meaningful in conjunction with-membedded-data. ๐- *
-mcode-readable=setting* โ specifies whether GCC may generate code that reads from executable sections. There are three possible settings, and they're all a whole vibe:-mcode-readable=yesโ instructions may freely access executable sections. This is the default setting. โจ-mcode-readable=pcrelโ MIPS16 PC-relative load instructions can access executable sections, but other instructions must not do so. This one is useful on 4KSc and 4KSd processors when the code TLBs have the Read Inhibit bit set. It's also useful on processors that can be configured to have a dual instruction/data SRAM interface and that, like the M4K, automatically redirect PC-relative loads to the instruction RAM.-mcode-readable=noโ instructions must not access executable sections. Can be useful on targets that are configured to have a dual instruction/data SRAM interface but that (unlike the M4K) do not automatically redirect PC-relative loads to the instruction RAM.
And on SDE targets, -mcode-data-in-code is available as a traditional alias for -mcode-readable=no, and -mcode-xonly for -mcode-readable=pcrel. iykyk ๐ซถ
-msplit-addresses,-mno-split-addressesโ enable (disable) use of the%hi()and%lo()assembler relocation operators. Ngl, this option has been superseded by-mexplicit-relocsbut is retained for backwards compatibility. ๐-mexplicit-relocs=none,-mexplicit-relocs=base,-mexplicit-relocs=pcrel,-mexplicit-relocs,-mno-explicit-relocsโ these options control whether explicit relocs (such as%gp_rel) are used. The default value depends on the version of GAS when GCC itself was built, so it's giving "it depends" energy.
The base explicit-relocs support was introduced into GAS in 2001. The pcrel explicit-relocs support was introduced into GAS in 2014, which supports %pcrel_hi and %pcrel_lo. History lesson slay โจ
-mcheck-zero-division,-mno-check-zero-divisionโ trap (do not trap) on integer division by zero. 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 results in smaller code, but it's only supported on MIPS II and later. Also, some versions of the Linux kernel have a bug that prevents trap from generating the proper signal (SIGFPE) ๐ญ. Use-mdivide-trapsto allow conditional traps on architectures that support them and-mdivide-breaksto force the use of breaks.
The default is usually -mdivide-traps, but this can be overridden at configure time using --with-divide=breaks. And divide-by-zero checks can be completely disabled using -mno-check-zero-division.
-mload-store-pairs,-mno-load-store-pairsโ enable (disable) an optimization that pairs consecutive load or store instructions to enable load/store bonding. Enabled by default, but only takes effect when the selected architecture is known to support bonding. Lowkey conditional, bestie.-mstrict-align,-mno-strict-align,-munaligned-access,-mno-unaligned-accessโ disable (enable) direct unaligned access for MIPS Release 6. MIPSr6 requires load/store unaligned-access support, either by hardware or by trapping and emulation. In the latter case-mstrict-alignmay be needed by the operating system kernel. Also,-munaligned-accessand-mno-unaligned-accessare obsolete and only provided for backward compatibility. Dead flags walking ๐-mmemcpy,-mno-memcpyโ force (do not force) the use ofmemcpyfor non-trivial block moves. The default is-mno-memcpy, which allows GCC to inline most constant-sized copies. Slay.-mlong-calls,-mno-long-callsโ disable (do not disable) use of thejalinstruction. Calling functions usingjalis more efficient but requires the caller and callee to be in the same 256 megabyte segment. So yeah, tradeoffs.
This option has no effect on abicalls code. The default is -mno-long-calls.
-mmad,-mno-madโ enable (disable) use of themad,maduandmulinstructions, as provided by the R4650 ISA. ๐-mimadd,-mno-imaddโ enable (disable) use of themaddandmsubinteger instructions. The default is-mimaddon architectures that supportmaddandmsub, except for the 74k architecture, where it was found to generate slower code. Not the 74k catching strays ๐ญ-mfused-madd,-mno-fused-maddโ enable (disable) use of the floating-point multiply-accumulate instructions, when they're available. The default is-mfused-madd. โจ
Careful though: 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โ tells the MIPS assembler to not run its preprocessor over user assembler files (with a.ssuffix) when assembling them. ๐-mfix-24k,-mno-fix-24kโ works around the 24K E48 errata (that's lost data on stores during refill, bestie, a whole situation). The workarounds are implemented by the assembler rather than by GCC.-mfix-r4000,-mno-fix-r4000โ works 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.
Three whole bugs. Pray for the R4000 ๐
-mfix-r4400,-mno-fix-r4400โ works 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โ works around certain R10000 errata:ll/scsequences 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โ does 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 schedules anopinstruction 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โ works around the RM7000dmult/dmultuerrata. The workarounds are implemented by the assembler rather than by GCC. ๐-mfix-vr4120,-mno-fix-vr4120โ works around certain VR4120 errata:dmultudoes not always produce the correct result.divandddivdo 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โ works around the VR4130mflo/mfhierrata. The workarounds are implemented by the assembler rather than by GCC, although GCC avoids usingmfloandmfhiif the VR4130macc,macchi,dmaccanddmacchiinstructions are available instead. Iconic workaround behaviour โจ-mfix-sb1,-mno-fix-sb1โ works around certain SB-1 CPU core errata. (This flag currently works around the SB-1 revision 2F1andF2floating-point errata.) ๐-mfix4300,-mno-fix4300โ works around a bug in early VR4300 silicon that causes multiplies with certain operands to corrupt immediately following multiplies. Absolutely cursed, but okay ๐ฅ- *
-mr10k-cache-barrier=setting* โ specifies whether GCC should insert cache barriers to avoid the side effects of speculation on R10K processors. Buckle up, this one's a saga:
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. (Like, read the manual bestie, fr fr.)
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:
okay so back in MIPS land, the little safety bubble covers exactly these three things, no cap:
- the memory occupied by the current function's stack frame;
- the memory occupied by an incoming stack argument;
- the memory occupied by an object with a link-time-constant address.
and it is the kernel's responsibility to make sure speculative accesses to those regions are actually safe, bestie. like, that's the whole vibe check.
if the input program contains a function declaration such as:
void foo (void);
then the implementation of foo must allow j foo and jal foo to be executed speculatively. GCC honors this restriction for functions it compiles itself. It expects non-GCC functions (such as hand-written assembly code) to do the same. periodt.
the option has three forms:
-mr10k-cache-barrier=load-storeโ insert a cache barrier before a load or store that might be speculatively executed and that might have side effects even if aborted.-mr10k-cache-barrier=storeโ insert a cache barrier before a store that might be speculatively executed and that might have side effects even if aborted.-mr10k-cache-barrier=noneโ disable the insertion of cache barriers. this is the default setting. ๐-mflush-func=func,-mno-flush-funcโ specifies the function to call to flush the I and D caches, or to not call any such function. if called, the function must take the same arguments as the common_flush_func, that is, the address of the memory range for which the cache is being flushed, the size of the memory range, and the number3(to flush both caches). the default depends on the target GCC was configured for, but commonly is either_flush_funcor__cpu_flush. ๐ง-mbranch-cost=numโ set the cost of branches to roughlynum"simple" instructions. this cost is only a heuristic and is not guaranteed to produce consistent results across releases. a zero cost redundantly selects the default, which is based on the-mtunesetting. lowkey important: it's a heuristic, not a promise.-mbranch-likely,-mno-branch-likelyโ enable or disable use of Branch Likely instructions, regardless of the default for the selected architecture. by default, Branch Likely instructions may be generated if they are supported by the selected architecture. an exception is for the MIPS32 and MIPS64 architectures and processors that implement those architectures; for those, Branch Likely instructions are not be generated by default because the MIPS32 and MIPS64 architectures specifically deprecate their use. ๐ซถ-mcompact-branches=never,-mcompact-branches=optimal,-mcompact-branches=alwaysโ these options control which form of branches are generated. the default is-mcompact-branches=optimal.
the -mcompact-branches=never option ensures that compact branch instructions are never generated. ๐ซ
the -mcompact-branches=always option ensures that a compact branch instruction is generated if available for MIPS Release 6 onwards. if a compact branch instruction is not available (or pre-R6), a delay slot form of the branch is used instead.
if it is used for MIPS16/microMIPS targets, it is just ignored now. the behavior for MIPS16/microMIPS may change in future, since they do have some compact branch instructions. iykyk.
the -mcompact-branches=optimal option causes a delay slot branch to be used if one is available in the current ISA and the delay slot is successfully filled. if the delay slot is not filled, a compact branch is chosen if one is available. โจ
-mfp-exceptions,-mno-fp-exceptionsโ specifies whether FP exceptions are enabled. this affects how FP instructions are scheduled for some processors. the default is that FP exceptions are enabled.
for instance, on the SB-1, if FP exceptions are disabled, and we are emitting 64-bit code, then we can use both FP pipes. otherwise, we can only use one FP pipe. ๐ฅ
-mvr4130-align,-mno-vr4130-alignโ the VR4130 pipeline is two-way superscalar, but can only issue two instructions together if the first one is 8-byte aligned. when this option is enabled, GCC aligns pairs of instructions that it thinks should execute in parallel.
this option only has an effect when optimizing for the VR4130. it normally makes code faster, but at the expense of making it bigger. it is enabled by default at optimization level -O3. bigger but faster, classic tradeoff.
-msynci,-mno-synciโ enable (disable) generation ofsynciinstructions on architectures that support it. thesynciinstructions (if enabled) are generated when__builtin___clear_cacheis compiled.
this option defaults to -mno-synci, but the default can be overridden by configuring GCC with --with-synci.
when compiling code for single processor systems, it is generally safe to use synci. however, on many multi-core (SMP) systems, it does not invalidate the instruction caches on all cores and may lead to undefined behavior. โ ๏ธ like, do not ignore that one.
-mrelax-pic-calls,-mno-relax-pic-callsโ try to turn PIC calls that are normally dispatched via register$25into direct calls. this is only possible if the linker can resolve the destination at link time and if the destination is within range for a direct call.
-mrelax-pic-calls is the default if GCC was configured to use an assembler and a linker that support the .reloc assembly directive and -mexplicit-relocs is in effect. with -mno-explicit-relocs, this optimization can be performed by the assembler and the linker alone without help from the compiler. ๐
-mmcount-ra-address,-mno-mcount-ra-addressโ emit (do not emit) code that allows_mcountto modify the calling function's return address. when enabled, this option extends the usual_mcountinterface with a new ra-address parameter, which has typeintptr_t *and is passed in register$12._mcountcan then modify the return address by doing both of the following:- returning the new address in register
$31. - storing the new address in
*ra-address, if ra-address is nonnull.
- returning the new address in register
the default is -mno-mcount-ra-address. ๐
-mframe-header-opt,-mno-frame-header-optโ enable (disable) frame header optimization in the o32 ABI. when using the o32 ABI, calling functions allocates16bytes on the stack for the called function to write out register arguments. when enabled, this optimization suppresses the allocation of the frame header if it can be determined that it is unused.
this optimization is off by default at all optimization levels. ๐
-mlxc1-sxc1,-mno-lxc1-sxc1โ when applicable, enable (disable) the generation oflwxc1,swxc1,ldxc1,sdxc1instructions. enabled by default. ๐-mmadd4,-mno-madd4โ when applicable, enable (disable) the generation of 4-operandmadd.s,madd.dand related instructions. enabled by default. ๐
๐ฆ MMIX Options ๐ฆ
these options are defined for the MMIX:
-mlibfuncs,-mno-libfuncsโ specify that intrinsic library functions are being compiled, passing all values in registers, no matter the size.-mepsilon,-mno-epsilonโ generate floating-point comparison instructions that compare with respect to therEepsilon register.-mabi=mmixware,-mabi=gnuโ generate code that passes function parameters and return values that (in the called function) are seen as registers$0and up, as opposed to the GNU ABI which uses global registers$231and up. ๐-mzero-extend,-mno-zero-extendโ when reading data from memory in sizes shorter than 64 bits, use (do not use) zero-extending load instructions by default, rather than sign-extending ones.-mknuthdiv,-mno-knuthdivโ make the result of a division yielding a remainder have the same sign as the divisor. with the default,-mno-knuthdiv, the sign of the remainder follows the sign of the dividend. both methods are arithmetically valid, the latter being almost exclusively used. math girlie moment.-mtoplevel-symbols,-mno-toplevel-symbolsโ prepend (do not prepend) a:to all global symbols, so the assembly code can be used with thePREFIXassembly 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 (do not use) the probable-branch instructions, when static branch prediction indicates a probable branch.-mbase-addresses,-mno-base-addressesโ generate (do not generate) code that uses base addresses. using a base address automatically generates a request (handled by the assembler and the linker) for a constant to be set up in a global register. the register is used for one or more base address requests within the range0to255from the value held in the register. this generally leads to short and fast code, but the number of different data items that can be addressed is limited. this means that a program that uses lots of static data may require-mno-base-addresses. ๐-msingle-exit,-mno-single-exitโ force (do not 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 to0x100unless-mno-set-program-startis 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 avoid 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 must be one ofmn10300,am33,am33-2oram34. ๐-mreturn-pointer-on-d0,-mno-return-pointer-on-d0โ okay so when the compiler makes a function that hands back a pointer, this makes it return that pointer in botha0andd0๐ . Without it, the pointer only comes back ina0, and then if you try to call one of those functions without a prototype you get errors, no cap ๐ญ. Heads up: this one is on by default, so reach for-mno-return-pointer-on-d0if you wanna turn it off.-mno-crt0โ don't link in the C run-time initialization object file, bestie. That's it, that's the whole vibe.-mrelaxโ tells the linker "go off, do a relaxation optimization pass" so branches, calls and absolute memory addresses get shortened โจ. Fr fr this only does anything when you use it on the command line for the final link step. Also, big caveat: this option makes symbolic debugging impossible ๐. Choose wisely.-mliw,-mno-liwโ lets the compiler generate Long Instruction Word instructions if your target is the AM33 or later. On by default ๐ซถ.-mliwdefines the preprocessor macro__LIW__, and-mno-liwdefines the preprocessor macro__NO_LIW__.-msetlb,-mno-setlbโ lets the compiler generate theSETLBandLccinstructions if the target is AM33 or later. Also enabled by default โจ.-msetlbdefines__SETLB__,-mno-setlbdefines__NO_SETLB__.
๐ฆ Moxie Options ๐ฆ
-mebโ generate big-endian code. This is the default formoxie-*-*configurations ๐-melโ generate little-endian code ๐ธ-mmul.x,-mno-mul.xโ generatemul.xandumul.xinstructions. This one's enabled by default formoxiebox-*-*configurations ๐-mno-crt0โ do not link in the C run-time initialization object file ๐
๐ MSP430 Options ๐
These options are defined for the MSP430, iykyk:
-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. (Yes, aesthetics. We love a functional-but-pretty moment.)-mmcu=nameโ picks the MCU you're targeting ๐ฏ. This gets used to create a C preprocessor symbol built from the MCU name, converted to upper case and pre- and post-fixed with__. Thenmsp430.huses that to pick an MCU-specific supplementary header file.
The option also sets which ISA to use. If the MCU name is one that's known to only support the 430 ISA, then that's the one selected โ otherwise the 430X ISA gets 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 all 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:
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 ๐
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 ๐ซถ
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've created it and copied devices.csv there, then the MCU data is read. Same 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-mmcuoption and the ISA set by the-mcpuoption and/or the hardware multiply support set by the-mhwmultoption ๐. 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-bitsize_t) โจ-msmallโ use small-model addressing (16-bit pointers, 16-bitsize_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โ no hardware multiply16bitโ the original 16-bit-only multiply supported by early MCUs32bitโ the 16/32-bit multiply supported by later MCUsf5seriesโ 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 isn't recognized, then no hardware multiply support is assumed. "auto" is the default setting ๐
Hardware multiplies are normally performed by calling a library routine. This saves space in the generated code. When compiling at -O3 or higher however, the hardware multiplier is invoked inline โ 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. It's 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 sizeprintfandputslibrary 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 is 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, anmspabihelper function is used instead. The default value is4โจ
This only affects cases where a shift by multiple positions can't be completed with a single instruction (e.g. all shifts >1 on the 430 ISA).
Shifts of a 32-bit value are at least twice as costly, so the value passed for this option is divided by 2 and the resulting value used instead ๐งฎ
-mcode-region=where,-mdata-region=whereโ these tell the compiler where to place functions and data that don't have one of the"lower","upper","either"or"section"attributes. Possible values for where arelower,upper,eitherorany. 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.lowerprefix to section names when compiling with-mcode-region=loweror-mdata-region=lower. Disabled by default ๐-msilicon-errata=name[,name...]โ passes on a request to the assembler to enable the fixes for the named silicon errata. Refer to the assembler documentation for details ๐-msilicon-errata-warn=name[,name...]โ 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 ifdevices.csvis 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 ๐งฎ
Okay bestie, we're still deep in the Andes machine options โ no new heading, just vibes and flags ๐ซถ Let's keep going.
-mext-fpu-sp,-mno-ext-fpu-spโ turn on/off generating single-precision floating-point instructions. Precision, but make it single ๐-mext-fpu-dp,-mno-ext-fpu-dpโ turn on/off generating double-precision floating-point instructions. Double the precision, double the slay โจ-mv3push,-mno-v3pushโ turn on/off generating the v3push25/pop25instructions. Push it, pop it ๐-m16-bit,-mno-16-bitโ turn on/off generating 16-bit instructions. Small but mighty, fr fr.-mvh,-mno-vhโ turn on/off Virtual Hosting support. It's giving main-character hosting energy ๐-misr-vector-size=numโ set the size of each interrupt vector. Heads up: it **must be4or16, no in-between, no negotiation ๐ญ- *
-misr-secure=num* โ set the security level ofc-isrfor the whole file. One level to rule them all ๐ -mcache-block-size=numโ set the size of each cache block. Rules: **must be a power of 2, and it has to sit between4and512inclusive. Math is mathing, no cap โจ- *
-march=arch* โ pick the target architecture. arch can be one ofv2,v3,v3j,v3m,v3f, orv3s. Choose your fighter ๐ - *
-mcpu=cpu* โ pick the CPU to compile for. cpu may be one ofn6,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, orsimple. That's the whole roster, bestie โ it's giving a very long guest list ๐ - *
-mconfig-fpu=num* โ set an FPU configuration value from0to7. Okay so0--3is as the FPU spec says, and4--7correspond to0--3. Same energy, different number ๐ - *
-mconfig-mul=type* โ set the configuration for the multiply instruction. type can be one offast,fast1(equivalent tofast),fast2, orslow. The default isfast1. Fast girlie by default, obviously ๐ - *
-mconfig-register-ports=kind* โ set the numbers of read/write ports for n9/n10 cores. The value should be3r2wor2r1w. Ports, but make it a whole personality ๐ - *
-mcmodel=code-model* โ set the code model to one of these three:smallโ all the data and read-only data segments must be within 512KB addressing space. The text segment must be within 16MB addressing space. Cozy little neighborhood ๐กmediumโ the data segment must be within 512KB, while the read-only data segment can be within 4GB addressing space. The text segment should still be within 16MB addressing space. Mid-size, mid-vibes โจlargeโ all the text and data segments can be within 4GB addressing space. Big energy, no cap ๐ฅ
The default is large on GNU/Linux targets and medium on other ELF targets. Noted, bestie ๐
-mctor-dtor,-mno-ctor-dtorโ turn on/off the constructor/destructor feature. Beginnings and endings, iconic ๐ฆ-mrelax,-mno-relaxโ turn on/off the linker option to relax instructions. Relax, it's just instructions ๐โโ๏ธ-mrelax-hint,-mno-relax-hintโ turn on/off insertion of hints for the linker to do relaxation. Little notes to your linker bestie ๐ซถ-msched-prolog-epilog,-mno-sched-prolog-epilogโ turn on/off scheduling of a function's prologue and epilogue sequence. Bookends matter, periodt ๐-mret-in-naked-func,-mno-ret-in-naked-funcโ turn on/off generating return instructions in naked functions. This option is enabled by default. Naked functions are already out here exposed ๐ญ-malways-save-lp,-mno-always-save-lpโ turn on/off always saving$lpon the stack. Always save your faves ๐-munaligned-access,-mno-unaligned-accessโ turn on/off unaligned word and halfword accesses to packed data. It's giving chaos but make it structured ๐-minline-asm-r15,-mno-inline-asm-r15โ allow/disallow use ofr15for inline asm. Permission slip, signed or denied ๐๏ธ
๐ธ Nvidia PTX Options ๐ธ
These options are defined for Nvidia PTX โ GPU bestie territory ๐
-m64โ ignored, but preserved for backward compatibility. Only 64-bit ABI is supported. It's just here for the memories ๐ซถ- *
-march=architecture-string* โ generate code for the specified PTX ISA target architecture. Valid architecture strings aresm_30,sm_35,sm_37,sm_50,sm_52,sm_53,sm_61,sm_70,sm_75,sm_80, andsm_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. Numbers, but make it iconic โจ
- *
-misa=architecture-string* โ alias of-march=. Same thing, different name, iykyk ๐ -march-map=architecture-stringโ select the closest available-march=value that is **not more capable. For instance, for-march-map=sm_50select-march=sm_37, and for-march-map=sm_53select-march=sm_53. It's giving "bestie, we're matching you to the nearest vibe" ๐ฏ-mptx=version-stringโ generate code for the specified PTX ISA version. Valid version strings are3.1,4.0,4.1,4.2,5.0,6.0,6.3,7.0,7.3, and7.8. The default PTX ISA version is the one that added support for the selected PTX ISA target architecture, see-march=, but **at least6.3, or7.3for-march=sm_52and 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. Major and minor, the duo we deserved ๐ซถ
-mmainkernelโ link in code for a__mainkernel. This is for stand-alone instead of offloading execution. Main-character kernel energy, literally ๐-moptimize,-mno-optimizeโ turn on/off partitioned execution optimizations. This option is enabled by default when any level of optimization is selected. Optimization stays on unless you say otherwise ๐-msoft-stack,-mno-soft-stackโ okay so this one has lore, buckle up:
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. Read that again, bestie ๐ญ
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. Testing-only, don't ship it by accident ๐ซถ
- *
-msoft-stack-reserve-local=size* โ specify the size of.localmemory used for the stack when the exact amount is not known. It defaults to128. When in doubt,128โจ -muniform-simt,-mno-uniform-simtโ turn on/off 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 lane0is the master; inside, each thread sees itself as the master. Shared memory arrayint __nvptx_uni[]stores all-zeros or all-ones bitmasks for each warp, indicating current mode (0outside of SIMD regions). Each thread can bitwise-and the bitmask at positiontid.ywith current lane index to compute the master lane index. Yeah, it's a lot โ but it all matters, don't skip it ๐-mgomp,-mno-gompโ turn on/off generation of code for use in OpenMP offloading.-mgompenables-msoft-stackand-muniform-simtoptions, and selects a corresponding multilib variant. One flag, three jobs, main character energy ๐
๐ง OpenRISC Options ๐ง
These options are defined for OpenRISC โ open source, open heart ๐ซถ
- *
-mboard=name* โ configure a board specific runtime. This is passed to the linker for newlib board library linking. The default isor1ksim. Board meeting, but make it linker ๐ -msoft-div,-mhard-divโ select software or hardware divide (l.div,l.divu) instructions. This default is hardware divide. Dividing, but make it hardware ๐ฅ-msoft-mul,-mhard-mulโ select software or hardware multiply (l.mul,l.muli) instructions. This default is hardware multiply. Multiplication stays fast โจ-msoft-float,-mhard-floatโ select software or hardware for floating point operations. The default is software. Floating point, but the soft way ๐-mdouble-floatโ when-mhard-floatis selected, enables generation of double-precision floating point instructions. By default functions from libgcc are used to perform double-precision floating point operations. Double the float, double the fun ๐-munordered-floatโ when-mhard-floatis 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. Unordered but unbothered ๐-mcmovโ enable generation of conditional move (l.cmov) instructions. By default the equivalents are generated using set and branch. Conditional move said "I'll do it myself" ๐-mrorโ enable generation of rotate right (l.ror) instructions. By default functions from libgcc are used to perform rotate right operations. Rotate right, rotate slay ๐-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. Immediate, like your reaction โก-msextโ enable generation of sign extension (l.ext*) instructions. By default memory loads are used to perform sign extension. Extend the sign, extend the vibe โจ-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. No extra steps if you don't have to ๐-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. Shifting into the immediate, no middleman ๐ฆ-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. Small but mighty, fr fr ๐ก-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. Big model energy, go big or go home ๐
๐ PDP-11 Options ๐
These options are defined for the PDP-11 โ vintage bestie, respect the elders ๐
-mfpuโ use hardware FPP floating point. This is the default. (FIS floating point on the PDP-11/40 is not supported.) Implies-m45. Hardware it is, unless stated otherwise โจ-msoft-floatโ do not use hardware floating point. Soft float era ๐-mac0,-mno-ac0โ with-mac0, return floating-point results in ac0 (fr0in Unix assembler syntax). The default,-mno-ac0, is to return floating-point results in memory. Pick your return address, bestie ๐ซถ-m40โ generate code for a PDP-11/40. Implies-msoft-float-mno-split. The40said soft float, no split, and it meant it ๐-m45โ generate code for a PDP-11/45. This is the default. The45is the moment ๐-m10โ generate code for a PDP-11/10. Implies-msoft-float-mno-split. The10keeps it soft and unsplit, iconic ๐ฅ-mint16,-mno-int32โ use 16-bitint๐ this is the default, bestie, so if you do nothing you already got it.-mint32,-mno-int16โ use 32-bitint. big int energy โจ-msplitโ tells GCC the target has split instruction and data space. it implies-m45. iykyk ๐ซถ-munix-asmโ use Unix assembler syntax.-mdec-asmโ use DEC assembler syntax.-mgnu-asmโ use GNU assembler syntax. this one's the default, she's the main character ๐-mlraโ use the new LRA register allocator. by default the old"reload"allocator is the one getting the job, so this is you upgrading her ๐
โจ Picolibc Options โจ
these bad girls control compilation and linking when you're using Picolibc ๐
--oslib=libraryโ search for the library literally named library after the C library, so symbols the C library left undefined can get defined by this one instead. the C library,libgccand this library all get placed between--start-groupand--end-groupflags so each of them can refer to symbols in the others ๐ซถ. and for many targets, Picolibc hands you a semihost variant (you ask for it with--oslib=semihost) which provides enough basic OS functionality to support console and file I/O when it's run in an emulator or when you're using an in-circuit debugger. iconic.--crt0=[none|minimal|hosted|semihost]โ swaps the defaultcrt0.oname out forcrt0-variant.o. here's the lineup ๐:nonegives you no startup code at all, which means you supply your own โ you're on your own, babe, but in a cool way.minimalperforms basic memory setup but does not invoke any constructors.- when no
-crt0option is provided, the default initialization code adds calls to all constructors. hostedadds a call toexitwhenmainreturns.semihostaccesses a command-line parameter supplied via the semihosting interface and splits that into arguments at whitespace boundaries, passing the resulting array of strings tomaininargcandargv. on some targets โ including AArch64, ARC, ARM, LoongArch, M680x0, RISC-V, SH, and x86 โsemihostalso traps hardware exceptions and prints information to the console ๐จ๏ธ. heads up though:--crt0=semihostdepends upon APIs provided by--oslib=semihost.
--printf=[d|f|l|i|m]โ picks yourprintfvariant. Picolibc gives you five differentprintfvariants, and they offer decreasing levels of functionality along with decreasing code size (trade-off queen ๐):dis the default level, offering full C17 and POSIX.1-2024 conformance.fgives the same feature set, but supportsfloatvalues instead ofdouble, and those get passed using theprintf_floatmacro.lelides all floating-point and POSIX positional parameter support.ilimits integers to those no larger thanlong.mremoves support for most formatting options, including width and precision. the formats and arguments are still parsed correctly, but the output just does not respect those parameters ๐.
--scanf=[d|f|l|i|m]โ same deal but forscanf. five variants, decreasing functionality, decreasing code size:dis the default level, offering full C17 and POSIX.1-2024 conformance.fremoves support fordoublevalues.lelides all floating point support.ilimits integers to those no larger thanlong.mremoves support for%[conversion specifiers.
โจ PowerPC Options โจ
these are listed under โ that's literally what it says, no cap, they're listed under ๐ฆ
โจ PRU Options โจ
these command-line options are defined for the PRU target, okurrr:
-minrtโ link with a minimum runtime environment. this can significantly reduce the size of the final ELF binary, but some standard C runtime features get removed ๐.
this option disables support for static initializers and constructors. beware: the compiler could still generate code with static initializers and constructors. it is up to the programmer to ensure that the source program does not use those features. (yes, that's on you, bestie.)
the minimal startup code does not pass argc and argv arguments to main, so main must be declared as int main (void). this is already the norm for most firmware projects, so like, chill.
-mmcu=mcuโ specify the PRU hardware variant to use. a correspondingly-named spec file gets loaded, which passes the memory region sizes to the linker and defines hardware-specific C macros ๐.
Newlib provides only the sim spec, intended for running regression tests using a simulator. specs for real hardware can be obtained by installing the GnuPruMcu (https://github.com/dinuxbg/gnuprumcu/) package. go get it โจ
-mno-relaxโ makes GCC pass the--no-relaxcommand-line option to the linker instead of the--relaxoption.-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=tiselects the unmodified TI ABI, while-mabi=gnuselects a GNU variant that copes more naturally with certain GCC assumptions. the differences, bestie, are these ๐:
๐ Function Pointer Size ๐
TI ABI specifies that function (code) pointers are 16-bit, whereas GNU supports only 32-bit data and code pointers.
๐ Optional Return Value Pointer ๐
function return values larger than 64 bits are passed by using a hidden pointer as the first argument of the function. TI ABI, though, mandates that the pointer can be NULL in case the caller is not using the returned value. GNU always passes and expects a valid return value pointer.
๐ Size Of Struct Containing Bit-fields ๐
TI ABI mandates that struct size is determined by the bit-field type, if it contains any. on the other hand, GNU allocates the smallest amount of bytes which would fit the bit-field.
for example, TI ABI reserves 4 bytes for this struct, whereas GNU reserves a single byte:
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, periodt ๐ธ:
-mbranch-cost=nโ set the cost of branches to roughly n instructions.-mabi=ABI-stringโ specify the 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=lp64dmeans thatlongand pointers are 64-bit (implicitly definingintto be 32-bit), and that floating-point values up to 64 bits wide are passed in F registers โจ. contrast this with-march=rv64ifd -mabi=lp64f, which still allows the compiler to generate code that uses the F and D extensions but only allows floating-point values up to 32 bits long to be passed in registers; or-march=rv64ifd -mabi=lp64, in which no floating-point arguments are passed in registers.
the default for this argument is system dependent; if you want a specific calling convention you should specify one explicitly, bestie, don't leave it to fate ๐. the valid calling conventions are: ilp32, ilp32f, ilp32d, lp64, lp64f, and lp64d. some calling conventions are impossible to implement on some ISAs: for example, -march=rv32if -mabi=ilp32d is invalid because the ABI requires 64-bit values be passed in F registers, but F registers are only 32 bits wide ๐. there are also the ilp32e ABI that can only be used with the rv32e architecture and the lp64e ABI that can only be used with the rv64e. those ABIs are not well-specified at present, and are subject to change โ so like, don't get too attached.
-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 thefence.tsoinstruction, which is unimplemented on some processors (including those from T-Head). if thefence.tsoinstruction is not available then a stronger fence is used instead. she improvises ๐-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 the 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, no shouting allowed ๐. examples includerv64i,rv32g,rv32e,rv32imaf,rva22u64andrva23u64. 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. cute, right?
-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 โ ๏ธ.
okay so the syntax of the ISA string is defined as follows:
- The string has to start with
rv32orrv64, theni,e, orgโ that bit is the base ISA ๐ - After that comes a list of extension names. These come in two flavours: multi-letter (like
zba) and single-letter (likev). Single-letter extensions can be stacked up back-to-back, but multi-letter ones must be separated by underscores. no cap ๐ซถ - An underscore can show up anywhere after the base ISA. It doesn't actually do anything mechanically โ it's purely a readability thing and can double as a separator ๐
- Extension names can carry an optional version number, written as
<major>p<minor>or<major>, e.g.m2p1orm2โจ
Supported extensions are listed below โ yes, all of them, bestie. Buckle up ๐
gโ version-โ General-purpose computing base extension;gexpands toi,m,a,f,d,zicsrandzifencei.eโ version2.0โ Reduced base integer extensioniโ versions2.0,2.1โ Base integer extensionmโ version2.0โ Integer multiplication and division extensionaโ versions2.0,2.1โ Atomic extensionfโ versions2.0,2.2โ Single-precision floating-point extensiondโ versions2.0,2.2โ Double-precision floating-point extensioncโ version2.0โ Compressed extensionbโ version1.0โ Standard extension for bit manipulation functionsvโ version1.0โ Vector extensionhโ version1.0โ Hypervisor extensionzic64bโ version1.0โ Cache block size is 64 byteszicbomโ version1.0โ Cache-block management extensionzicbopโ version1.0โ Cache-block prefetch extensionzicbozโ version1.0โ Cache-block zero extensionziccamoaโ version1.0โ Main memory supports all atomics in Aziccifโ version1.0โ Main memory supports instruction fetch with atomicity requirementzicclsmโ version1.0โ Main memory supports misaligned loads/storesziccrseโ version1.0โ Main memory supports forward progress on LR/SC sequenceszicfilpโ version1.0โ Control-flow integrity landing pad extensionzicfissโ version1.0โ Control-flow integrity shadow stack extensionzicntrโ version2.0โ Standard extension for base counters and timerszicondโ version1.0โ Integer conditional operations extensionzicsrโ version2.0โ Control and status register access extensionzifenceiโ version2.0โ Instruction-fetch fence extensionzihintntlโ version1.0โ Non-temporal locality hints extensionzihintpauseโ version2.0โ Pause hint extensionzihpmโ version2.0โ Standard extension for hardware performance counterszimopโ version1.0โ May-be-operations extensionzilsdโ version1.0โ Load/store pair instructions extensionzmmulโ version1.0โ Integer multiplication extensionza128rsโ version1.0โ Reservation set size of 128 bytesza64rsโ version1.0โ Reservation set size of 64 byteszaamoโ version1.0โ Atomic memory operations extensionzabhaโ version1.0โ Byte and halfword atomic memory operations extensionzacasโ version1.0โ Atomic compare-and-swap instructions extensionzalrscโ version1.0โ Load-reserved/store-conditional subset of the A extensionzawrsโ version1.0โ Wait-on-reservation-set extensionzama16bโ version1.0โ Misaligned loads, stores, and AMOs that are fully contained within a naturally-aligned 16-byte boundary are atomiczfaโ version1.0โ Additional floating-point extensionzfbfminโ version1.0โ Minimal BF16 support extensionzfhโ version1.0โ Half-precision floating-point extensionzfhminโ version1.0โ Minimal half-precision floating-point extensionzfinxโ version1.0โ Single-precision floating-point in integer registers extensionzdinxโ version1.0โ Double-precision floating-point in integer registers extensionzcaโ version1.0โ Integer compressed instruction extensionzcbโ version1.0โ Simple compressed instruction extensionzcdโ version1.0โ Compressed double-precision floating point loads and stores extensionzceโ version1.0โ Compressed instruction extensions for embedded processorszcfโ version1.0โ Compressed single-precision floating point loads and stores extensionzcmopโ version1.0โ Compressed may-be-operations extensionzcmpโ version1.0โ Compressed push pop extensionzcmtโ version1.0โ Table jump instruction extensionzclsdโ version1.0โ Compressed load/store pair instructions extensionzbaโ version1.0โ Address calculation extensionzbbโ version1.0โ Basic bit manipulation extensionzbcโ version1.0โ Carry-less multiplication extensionzbkbโ version1.0โ Cryptography bit-manipulation extensionzbkcโ version1.0โ Cryptography carry-less multiply extensionzbkxโ version1.0โ Cryptography crossbar permutation extensionzbsโ version1.0โ Single-bit operation extensionzkโ version1.0โ Standard scalar cryptography extensionzknโ version1.0โ NIST algorithm suite extensionzkndโ version1.0โ AES Decryption extensionzkneโ version1.0โ AES Encryption extensionzknhโ version1.0โ Hash function extensionzkrโ version1.0โ Entropy source extensionzksโ version1.0โ ShangMi algorithm suite extensionzksedโ version1.0โ SM4 block cipher extensionzkshโ version1.0โ SM3 hash function extensionzktโ version1.0โ Data independent execution latency extensionztsoโ version1.0โ Total store ordering extensionzvbbโ version1.0โ Vector basic bit-manipulation extensionzvbcโ version1.0โ Vector carry-less multiplication extensionzve32fโ version1.0โ Vector extensions for embedded processorszve32xโ version1.0โ Vector extensions for embedded processorszve64dโ version1.0โ Vector extensions for embedded processorszve64fโ version1.0โ Vector extensions for embedded processorszve64xโ version1.0โ Vector extensions for embedded processorszvfbfminโ version1.0โ Vector BF16 converts extensionzvfbfwmaโ version1.0โ Vector BF16 widening multiply/add extensionzvfhโ version1.0โ Vector half-precision floating-point extensionzvfhminโ version1.0โ Vector minimal half-precision floating-point extensionzvkbโ version1.0โ Vector cryptography bit-manipulation extensionzvkgโ version1.0โ Vector GCM/GMAC extensionzvknโ version1.0โ Vector NIST Algorithm Suite extension,zvknwill expand tozvkncโ version1.0โ Vector NIST Algorithm Suite with carry-less multiply extension,zvknczvknedโ version1.0โ Vector AES block cipher extensionzvkngโ version1.0โ Vector NIST Algorithm Suite with GCM extension,zvkngwill expandzvknhaโ version1.0โ Vector SHA-2 secure hash extensionzvknhbโ version1.0โ Vector SHA-2 secure hash extensionzvksโ version1.0โ Vector ShangMi algorithm suite extension,zvkswill expandzvkscโ version1.0โ Vector ShangMi algorithm suite with carry-less multiplication extension,zvksedโ version1.0โ Vector SM4 block cipher extensionzvksgโ version1.0โ Vector ShangMi algorithm suite with GCM extensionzvkshโ version1.0โ Vector SM3 secure hash extensionzvktโ version1.0โ Vector data independent execution latency extension
okay the vector-length girlies are next, and ngl the wording flip-flops between plural and singular โ I'm keeping it exactly as written because that's the vibe the source committed to ๐:
zvl1024bโ version1.0โ Minimum vector length standard extensionszvl128bโ version1.0โ Minimum vector length standard extensionszvl16384bโ version1.0โ Minimum vector length standard extensionzvl2048bโ version1.0โ Minimum vector length standard extensionszvl256bโ version1.0โ Minimum vector length standard extensionszvl32768bโ version1.0โ Minimum vector length standard extensionzvl32bโ version1.0โ Minimum vector length standard extensionszvl4096bโ version1.0โ Minimum vector length standard extensionszvl512bโ version1.0โ Minimum vector length standard extensionszvl64bโ version1.0โ Minimum vector length standard extensionszvl65536bโ version1.0โ Minimum vector length standard extensionzvl8192bโ version1.0โ Minimum vector length standard extension
and the rest of the alphabet soup โจ:
zhinxโ version1.0โ Half-precision floating-point in integer registers extensionzhinxminโ version1.0โ Minimal half-precision floating-point in integer registers extensionsdtrigโ version1.0โ Debug triggers extensionshaโ version1.0โ The augmented hypervisor extensionshcounterenwโ version1.0โ Support writeable enables for any supported countershgatpaโ version1.0โSvNNx4mode supported for all modes supported bysatpshlcofidelegโ version1.0โ Delegating LCOFI interrupts to VS-modeshtvalaโ version1.0โ Thehtvalregister provides all needed valuesshvstvalaโ version1.0โ Thevstvalregister provides all needed valuesshvstvecdโ version1.0โ Thevstvecregister supports direct modeshvsatpaโ version1.0โ Thevsatpregister supports all modes supported bysatpsmaiaโ version1.0โ Advanced interrupt architecture extensionsmcntrpmfโ version1.0โ Cycle and instret privilege mode filteringsmcsrindโ version1.0โ Machine-level indirect CSR access
that's the whole roster, bestie โ every last one of them, nothing skipped ๐
smepmpโ1.0โ PMP enhancements for memory access and execution prevention on machine modesmmpmโ1.0โ Supervisor-mode pointer masking extensionsmnpmโ1.0โ Supervisor-mode pointer masking extensionsmrnmiโ1.0โ Resumable non-maskable interruptssmstateenโ1.0โ State enable extensionsmdbltrpโ1.0โ Double trap extensionsssaiaโ1.0โ Advanced interrupt architecture extension for supervisor modessccptrโ1.0โ Main memory supports page table readssscofpmfโ1.0โ Count overflow and filtering extensionsscounterenwโ1.0โ Support writeable enables for any supported countersscsrindโ1.0โ Supervisor-mode indirect CSR accessssnpmโ1.0โ Supervisor-mode pointer masking extensionsspmโ1.0โ Supervisor-mode pointer masking extensionssstateenโ1.0โ Supervisor-mode state-enable extensionsstcโ1.0โ Supervisor-mode timer interrupts extensionsstvalaโ1.0โ Stval provides all needed valuessstvecdโ1.0โ Stvec supports direct modessstrictโ1.0โ Unimplemented reserved encodings raise illegal instruction exceptions and no non-conforming extensions are presentssdbltrpโ1.0โ Double trap extensionsssu64xlโ1.0โ UXLEN=64 must be supportedsupmโ1.0โ User-mode pointer masking extensionsvinvalโ1.0โ Fine-grained address-translation cache invalidation extensionsvnapotโ1.0โ NAPOT translation contiguity extensionsvpbmtโ1.0โ Page-based memory types extensionsvvptcโ1.0โ Extension for obviating memory-management instructions after marking PTEs validsvaduโ1.0โ Hardware updating of A/D bits extensionsvadeโ1.0โ Cause exception when hardware updating of A/D bits is disabledsvbareโ1.0โ Satp mode bare is supportedxcvaluโ1.0โ Core-V miscellaneous ALU extensionxcvbiโ1.0โ Core-V immediate branch extensionxcvelwโ1.0โ Core-V event load word extensionxcvmacโ1.0โ Core-V multiply-accumulate extensionxcvsimdโ1.0โ Core-V SIMD extensionxsfceaseโ1.0โ SiFive CEASE instruction extensionxsfvcpโ1.0โ SiFive VCIX vector coprocessor extensionxsfvfnrclipxfqfโ1.0โ SiFive FP32-to-int8 ranged clip instructionsxsfvqmaccdodโ1.0โ SiFive int8 matrix multiplication extensionxsfvqmaccqoqโ1.0โ SiFive int8 matrix multiplication extensionxtheadbaโ1.0โ T-head address calculation extensionxtheadbbโ1.0โ T-head basic bit-manipulation extensionxtheadbsโ1.0โ T-head single-bit instructions extensionxtheadcmoโ1.0โ T-head cache management operations extensionxtheadcondmovโ1.0โ T-head conditional move extensionxtheadfmemidxโ1.0โ T-head indexed memory operations for floating-point registers extensionxtheadfmvโ1.0โ T-head double floating-point high-bit data transmission extensionxtheadintโ1.0โ T-head acceleration interruption extensionxtheadmacโ1.0โ T-head multiply-accumulate extensionxtheadmemidxโ1.0โ T-head indexed memory operation extensionxtheadmempairโ1.0โ T-head two-GPR memory operation extensionxtheadsyncโ1.0โ T-head multi-core synchronization extensionxtheadvectorโ1.0โ T-head vector extensionxventanacondopsโ1.0โ Ventana integer conditional operations extensionxmipscmovโ1.0โ Mips conditional move extensionxmipscbopโ1.0โ Mips prefetch extensionxandesperfโ5.0โ Andes performace extensionxandesbfhcvtโ5.0โ Andes bfloat16 conversion extensionxandesvbfhcvtโ5.0โ Andes vector bfloat16 conversion extensionxandesvsintloadโ5.0โ Andes vector INT4 load extensionxandesvpackfphโ5.0โ Andes vector packed FP16 extensionxandesvdotโ5.0โ Andes vector dot product extensionxsmtvdotโ1.0โ SpacemiT vector dot product extension
Okay bestie, breathe โ that was the whole extension buffet ๐ and honestly it ate.
When -march= is not specified, GCC uses the setting from -mcpu. Slay, it just inherits, no cap.
If both -march and -mcpu= are not specified, the default for this argument is system dependent; so like, if you want a specific architecture extension, you should specify one explicitly. Don't just vibe and hope, okay? ๐ซถ
When the RISC-V specifications define an extension as depending on other extensions, GCC implicitly adds the dependent extensions to the enabled extension set if they weren't added explicitly. Like it literally brings the whole friend group along ๐
๐ Core Name ๐
-mcpu=processor-stringโ Use architecture of and optimize the output for the given processor, specified by particular CPU name. Here's the guest list, all permissible values for this option:
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 โจ Note that-mcpudoes not override-marchor-mtune. It's not that girl, it does not have that power.
๐ธ Tune Name ๐ธ
-mtune=processor-stringโ Optimize the output for the given processor, specified by microarchitecture or particular CPU name. 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=. Yes, every single one, the whole roster ๐
When -mtune= is not specified, GCC uses the setting from -mcpu. The default is generic if neither is specified.
The size choice is not intended for use by end-users ๐ซ โ this is used when -Os is specified. It overrides the instruction cost info provided by -mtune=, but does not override the pipeline info. It helps reduce code size while still giving good performance. So like, don't touch it, it's doing its job ๐
-mpreferred-stack-boundary=numโ Attempt to keep the stack boundary aligned to a 2 raised to num byte boundary. If-mpreferred-stack-boundaryis not specified, the default is4(16 bytes or 128-bits).
โ ๏ธ 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. Not a vibe if you mix them, 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. (Fast > small, that's the default energy ๐ )-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 useslibatomicfunction calls. The default is to use fast inline subword atomics that do not requirelibatomicโ iconic, no library needed ๐-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. (Yes bestie, all three of them get the same treatment, they're a package deal ๐ซถ)-mstringop-strategy=strategyโ Specify a particular strategy for inlining string and memory operations. strategy may be one ofauto,libcall,scalar, orvector.-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 is the "do we do unaligned memory accesses or not" switch.-mno-strict-align= yes we do generate them,-mstrict-align= no we do not. The default just depends on whether the processor we're optimizing for supports fast unaligned access or not. Slay, adaptive defaults ๐-mscalar-strict-align,-mno-scalar-strict-alignโ literally the exact same vibe as above: do not or do generate unaligned memory accesses, with the default set depending on whether the processor we're optimizing for supports fast unaligned access or not. It's an alias for-mstrict-align, so don't stress about picking one ๐ซถ-mvector-strict-align,-mno-vector-strict-alignโ same energy but for vector memory accesses: do not or do generate unaligned vector memory accesses. The default is set to off unless the processor we're optimizing for explicitly supports element-misaligned vector memory access. Iconic conditional behaviour โจ-mmax-vectorization,-mno-max-vectorizationโ enable or disable an override to the vectorizer cost model that makes vectorization always appear profitable. And no, it's not the same as-fno-vect-cost-modelor-fvect-cost-model=unlimitedโ unlike those, this option does not turn off the cost comparison between different vector modes. Important distinction, iykyk ๐-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. Cozy little address box ๐-mcmodel=medanyโ generate code for the medium-any code model. The program and its statically defined symbols must be within any single 2 GiB address range. Programs can be statically or dynamically linked.
The code generated by the medium-any code model is position-independent, but it is not guaranteed to function correctly when linked into position-independent executables or libraries. So likeโฆ read that twice, bestie ๐ญ
-mcmodel=largeโ generate code for a large code model, which has no restrictions on size or placement of symbols. Free-range symbols, no fence ๐-mexplicit-relocs,-mno-explicit-relocsโ use or do not use assembler relocation operators when dealing with symbolic addresses. The alternative is to use assembler macros instead, which may limit optimization. Pick your fighter ๐-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 โ work smarter not harder, periodt โจ-mriscv-attribute,-mno-riscv-attributeโ emit (do not emit) RISC-V attribute to record extra information into ELF objects. Heads up: this feature requires at least binutils 2.32 ๐ซถ-mcsr-check,-mno-csr-checkโ enables or disables the CSR checking. Simple as that, no cap โ-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. Little optimization moment ๐-malign-data=typeโ controls how GCC aligns variables and constants of array, structure, or union types. Supported values for type arexlen, which uses x register width as the alignment value, andnatural, which uses natural alignment.xlenis the default. Alignment lore ๐-mbig-endianโ generate big-endian code. This is the default when GCC is configured for ariscv64be-*-*orriscv32be-*-*target.
Support for RISC-V big-endian is experimental. The ABI is not yet stable and could change in incompatible ways in future releases. Like, don't build your whole empire on it ๐
-mlittle-endianโ generate little-endian code. This is the default when GCC is configured for ariscv64-*-*orriscv32-*-*but not ariscv64be-*-*orriscv32be-*-*target. The chill default vibe ๐ฆ-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offsetโ generate stack protection code using canary at guard. Supported locations areglobalfor a global canary ortlsfor 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 behaviour, bestie, don't touch ๐
-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 for a reason ๐-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 ofscalableorzvl. The default isscalable, which tells GCC to interpret the number as a minimum, whilezvltells GCC to use exactly the number of bits specified. Math but make it fashion โจ-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 ofm1,m2,m4,m8, ordynamic. The default ism1for compatibility with existing hardware that does not support the other options. Backwards compat queen ๐-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. Opt-in only, bestie ๐ซถ-mautovec-segment,-mno-autovec-segmentโ enable or disable generation of vector segment load/store instructions. This option is enabled by default. Free feature, we love to see it ๐
๐ธ RL78 Options ๐ธ
-msimโ links in additional target libraries to support operation within a simulator. Simulator support, cute ๐-mmul=none,-mmul=g10,-mmul=g13,-mmul=g14,-mmul=rl78โ specifies the type of hardware multiplication and division support to be used. Let's break it down:- The simplest is
none, which uses software for both multiplication and division. This is the default. - The
g13value is for the hardware multiply/divide peripheral found on the RL78/G13 (S2 core) targets. - The
g14value selects the use of the multiplication and division instructions supported by the RL78/G14 (S3 core) parts. - The value
rl78is an alias forg14and the valuemg10is an alias fornone.
- The simplest is
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__. Macro lore unlocked ๐
-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=g14or-mcpu=rl78on 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. Bestie, the default is doing less than you think ๐ญ
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. Short and sweet ๐-mallregsโ allow the compiler to use all of the available registers. By default, registersr24..r31are reserved for use in interrupt handlers. With this option enabled these registers can be used in ordinary functions as well. All the registers, no holding back ๐ฅ-mrelax,-mno-relaxโ enable/disable assembler and linker relaxation. This is enabled by default at-Os. Optimize for size, get relaxations free โจ-mes0โ assumeESis zero throughout program execution, and use it to address read-only data. Manifesting ES = 0 for the whole run ๐ง-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. Conditional saving, very demure ๐
๐ 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 are401,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, andnative. That's the whole roster, no skips ๐ซถ
-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. Main character energy, but only if GCC recognizes you ๐
The other options each pick one specific processor, and here's the tea: code generated under those options runs best on that processor โ and honestly might not run at all on any other one. ๐
The -mcpu options automatically enable or disable the following options:
-maltivec -mfprnd -mhard-float -mmfcrf -mmultiple -mpopcntb
-mpopcntd -mpowerpc64 -mpowerpc-gpopt -mpowerpc-gfxopt -mmulhw
-mdlmzb -mmfpgpr -mvsx -mcrypto -mhtm -mpower8-fusion
-mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware
-mprefixed -mpcrel -mmma -mdense-math -mrop-protect
Okay so the exact set of options any given CPU flips on varies between compiler versions โ it all depends on what setting seems to produce the optimal code for that CPU. It does not necessarily reflect what the actual hardware is capable of. Iconic but slightly unhinged, we love her.
If you want to set an individual option to a particular value, just specify it after the -mcpu option, like -mcpu=970 -mno-altivec. ๐
On AIX, the-maltivecand-mpowerpc64options are not enabled or disabled by the-mcpuoption at present, because AIX doesn't have full support for these options. You can still enable or disable them 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. ๐
-mtune=cpu_type โ Sets the instruction scheduling parameters for machine type cpu_type, but doesn't set the architecture type or register usage the way-mcpu=cpu_type does. Same values for cpu_type here 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. Teamwork, bestie.-mpowerpc64,-mno-powerpc64โ-mpowerpc64lets GCC generate those extra 64-bit instructions found in the full PowerPC64 architecture, and treat GPRs as 64-bit, doubleword quantities. GCC defaults to-mno-powerpc64.-mcmodel=smallโ Generate PowerPC64 code for the small model: the TOC is limited to 64k.-mcmodel=mediumโ Generate PowerPC64 code for the medium model: the TOC and other static data may be up to a total of 4G in size. This is the default for 64-bit Linux. โจ-mcmodel=largeโ Generate PowerPC64 code for the large model: the TOC may be up to 4G in size. Other data and code is only limited by the 64-bit address space. big model energy-mprofile-kernelโ Available on PowerPC64 GNU/Linux targets. When used with-pg, it causes calls tomcountto be inserted before the function prologue instead of after it. ๐ฆ-maltivec,-mno-altivecโ Generate code that uses (does not use) AltiVec instructions, and also enable the use of built-in functions that allow more direct access to the AltiVec instruction set. You may also need to set-mabi=altivecto 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. endianness is literally the main character here ngl
-mpowerpc-gpopt,-mno-powerpc-gpoptโ Specifying-mpowerpc-gpoptallows 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-gfxoptallows GCC to use the optional PowerPC architecture instructions in the Graphics group, including floating-point select.-mmfcrf,-mno-mfcrfโ The-mmfcrfoption allows GCC to generate the move from condition register field instruction implemented on the POWER4 processor and other processors that support the PowerPC V2.01 architecture. ๐-mpopcntb,-mno-popcntbโ The-mpopcntboption allows GCC to generate the popcount and double-precision FP reciprocal estimate instruction implemented on the POWER5 processor and other processors that support the PowerPC V2.02 architecture.-mpopcntd,-mno-popcntdโ The-mpopcntdoption allows GCC to generate the popcount instruction implemented on the POWER7 processor and other processors that support the PowerPC V2.06 architecture. ๐ฅ-mfprnd,-mno-fprndโ The-mfprndoption allows GCC to generate the FP round to integer instructions implemented on the POWER5+ processor and other processors that support the PowerPC V2.03 architecture.-mcmpb,-mno-cmpbโ The-mcmpboption allows GCC to 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โ The-mhard-dfpoption allows GCC to 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 allowsldandld.soto build executables and shared libraries with non-executable.pltand.gotsections. This is a PowerPC 32-bit SYSV ABI option. secure queen behavior-mbss-pltโ Generate code that uses a BSS.pltsection thatld.sofills in, and requires.pltand.gotsections that are both writable and executable. This is a PowerPC 32-bit SYSV ABI option.
๐ Heads up: that writable-and-executable combo is exactly what it says on the tin โ-mbss-pltis the one that needs.pltand.gotto be both writable and executable, unlike-msecure-plt. Pick accordingly, bestie.
-msplit-patch-nopsโ When adding NOPs for a patchable area via the-fpatchable-function-entryoption, 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 the 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. ๐ญ (yes, the manpage really says "does not keeps" and honestly? relatable)-mquad-memory,-mno-quad-memoryโ Generate code that uses (does not use) the non-atomic quad word memory instructions. The-mquad-memoryoption 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-atomicoption requires use of 64-bit mode. ๐-mfloat128,-mno-float128โ Enable/disable the__float128keyword 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 don't specify generation of ISA 3.0 instructions or you're targeting a 32-bit big-endian system, IEEE 128-bit floating point is handled with software emulation. emulation era, we make it work
-mfloat128-hardware,-mno-float128-hardwareโ Enable/disable using ISA 3.0 hardware instructions to support the__float128data 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 setsint,longand pointer to 32 bits and generates code that runs on any PowerPC variant. The 64-bit environment setsintto 32 bits andlongand 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-tocoption is selected by default. In that case, GCC allocates at least one TOC entry for each unique non-automatic variable reference in your program. GCC also places floating-point constants in the TOC. However, only 16,384 entries are available in the TOC. ๐ญ
If you receive a linker error message saying you have 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 prevents GCC from putting floating-point constants in the TOC, and -mno-sum-in-toc forces GCC to generate code to calculate the sum of an address and a constant at run time instead of putting that sum into the TOC. You may specify one or both of these options. Each causes GCC to produce very slightly slower and larger code at the expense of conserving TOC space. tradeoffs, tradeoffs, always with the tradeoffs
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 so this is the 64-bit AIX era switch ๐ .-maix64turns on the 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bitlongtype, and all the infrastructure needed to support them. Specifying-maix64implies-mpowerpc64, while-maix32disables the 64-bit ABI and implies-mno-powerpc64. GCC defaults to-maix32, no cap.-mxl-compat,-mno-xl-compatโ this one makes your code cosplay IBM XL compiler semantics more closely when you're using the AIX-compatible ABI. It passes floating-point arguments to prototyped functions beyond the register save area (RSA) on the stack in addition to argument FPRs. It also says: do not assume that the most significantdoublein a 128-bitlong doublevalue is properly rounded when comparing values and converting todouble. And it uses XL symbol names forlong doublesupport routines. The lore: the AIX calling convention was extended but not initially documented to handle an obscure K&R C case of calling a function that takes the address of its arguments with fewer arguments than declared. IBM XL compilers access floating-point arguments that do not fit in the RSA from the stack when a subroutine is compiled without optimization. Because always storing floating-point arguments on the stack is inefficient and rarely needed, this option is not enabled by default and only is necessary when calling subroutines compiled by IBM XL compilers without optimization. iykyk โจ-mpeโ support for 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 specify the appropriate directory location. Also: PE does not support threads, so-mpeand-pthreadare incompatible. not those two together, bestie ๐-malign-natural,-malign-powerโ on AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux,-malign-naturaloverrides the ABI-defined alignment of larger types, such as floating-point doubles, on their natural size-based boundary.-malign-powertells GCC to follow the ABI-specified alignment rules. GCC defaults to the standard alignment defined in the ABI. On 64-bit Darwin, natural alignment is the default, and-malign-poweris not supported. respect the ABI, periodt ๐-msoft-float,-mhard-floatโ code that does not use (uses) the floating-point register set. Software floating-point emulation is provided if you use-msoft-float, and pass the option to GCC when linking. soft float is doing a lot of emotional labor ๐ญ-mmultiple,-mno-multipleโ generate code that uses (does not use) the load multiple word instructions and the store multiple word instructions. These instructions are generated by default on POWER systems, and not generated on PowerPC systems. Do not use-mmultipleon little-endian PowerPC systems, since those instructions do not work when the processor is in little-endian mode. The exceptions are PPC740 and PPC750, which permit these instructions in little-endian mode. serious caveat, no playing around โ ๏ธ-mupdate,-mno-updateโ generate code that uses (does not use) the load or store instructions that update the base register to the address of the calculated memory location. These instructions are generated by default. If you use-mno-update, there is a small window between the time that the stack pointer is updated and the address of the previous frame is stored, which means code that walks the stack frame across interrupts or signals may get corrupted data. corrupted data is not the vibe ๐-mavoid-indexed-addresses,-mno-avoid-indexed-addressesโ generate code that tries to avoid (not avoid) the use of indexed load or store instructions. These instructions can incur a performance penalty on Power6 processors in certain situations, such as when stepping through large arrays that cross a16Mboundary. This option is enabled by default when targeting Power6 and disabled otherwise. Power6 said โnot todayโ ๐ฅ-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. The machine-dependent-mfused-maddoption is now mapped to the machine-independent-ffp-contract=fastoption, and-mno-fused-maddis mapped to-ffp-contract=off. the mapping is giving โold name, new eraโ ๐ฆ-mmulhw,-mno-mulhwโ generate code that uses (does not use) the half-word multiply and multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors. These instructions are generated by default when targeting those processors. specific chip energy ๐-mdlmzb,-mno-dlmzbโ generate code that uses (does not use) the string-searchdlmzbinstruction on the IBM 405, 440, 464 and 476 processors. This instruction is generated by default when targeting those processors. string-search slay โจ-mno-bit-align,-mbit-alignโ on System V.4 and embedded PowerPC systems, do not (do) force structures and unions that contain bit-fields to be aligned to the base type of the bit-field. For example, by default a structure containing nothing but 8unsignedbit-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 size glow-up is real ๐ซถ-mbit-word,-mno-bit-wordโ allow bit-fields to cross word boundaries. boundary crossing, but make it bit-fields ๐ธ-mno-strict-align,-mstrict-alignโ on System V.4 and embedded PowerPC systems, do not (do) assume that unaligned memory references are handled by the system. trust issues with alignment, honestly ๐ฆ-mrelocatable,-mno-relocatableโ generate code that allows (does not allow) a static executable to be relocated to a different address at run time. A simple embedded PowerPC system loader should relocate the entire contents of.got2and 4-byte locations listed in the.fixupsection, a table of 32-bit addresses generated by this option. For this to work, all objects linked together must be compiled with-mrelocatableor-mrelocatable-lib.-mrelocatablecode aligns the stack to an 8-byte boundary. all objects or it does not count, bestie โญ-mrelocatable-lib,-mno-relocatable-libโ like-mrelocatable,-mrelocatable-libgenerates a.fixupsection to allow static executables to be relocated at run time, but-mrelocatable-libdoes not use the smaller stack alignment of-mrelocatable. Objects compiled with-mrelocatable-libmay be linked with objects compiled with any combination of the-mrelocatableoptions. mix-and-match friendly ๐-mlittle,-mlittle-endianโ on System V.4 and embedded PowerPC systems, compile code for the processor in little-endian mode. The-mlittle-endianoption is the same as-mlittle. little-endian girlies rise ๐-mbig,-mbig-endianโ on System V.4 and embedded PowerPC systems, compile code for the processor in big-endian mode. The-mbig-endianoption is the same as-mbig. big-endian main character energy ๐-mdynamic-no-picโ on Darwin / macOS systems, compile code so that it is not relocatable, but that its external references are relocatable. The resulting code is suitable for applications, but not shared libraries. apps yes, shared libraries no ๐-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. runtime said โI got thisโ โจ-mprioritize-restricted-insns=priorityโ this option controls the priority that is assigned to dispatch-slot restricted instructions during the second scheduling pass. The argument priority takes the value0,1, or2to assign no, highest, or second-highest (respectively) priority to dispatch-slot restricted instructions. scheduling drama, but prioritized ๐-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 usingpowerpc-*-eabiaix. March 1995 said โI'm the standard nowโ ๐-mcall-sysv-eabi,-mcall-eabiโ specify both-mcall-sysvand-meabioptions. two options, one bullet, iconic โจ-mcall-sysv-noeabiโ specify both-mcall-sysvand-mno-eabioptions. same energy, no eabi ๐-mcall-aixdescโ on System V.4 and embedded PowerPC systems, compile code for the AIX operating system. AIX mode activated ๐ฆ-mcall-linuxโ on System V.4 and embedded PowerPC systems, compile code for the Linux-based GNU system. Linux-based GNU system, periodt ๐ง-mcall-freebsdโ on System V.4 and embedded PowerPC systems, compile code for the FreeBSD operating system. FreeBSD representation ๐-mcall-netbsdโ on System V.4 and embedded PowerPC systems, compile code for the NetBSD operating system. NetBSD said hi ๐ธ-mcall-openbsdโ on System V.4 and embedded PowerPC systems, compile code for the OpenBSD operating system. OpenBSD in the chat ๐ซถ-mtraceback=traceback_typeโ select the type of traceback table. Valid values for traceback_type arefull,part, andno. traceback table vibe check ๐-maix-struct-returnโ return all structures in memory (as specified by the AIX ABI). memory return, no shortcuts โจ-msvr4-struct-returnโ return structures smaller than 8 bytes in registers (as specified by the SVR4 ABI). small structs get the register treatment ๐-mabi=abi-typeโ okay so this one lets you extend the current ABI with a specific extension, or yeet one right off ๐ซถ. The valid values are:altivec,no-altivec,ibmlongdouble,ieeelongdouble,elfv1,elfv2, and (for AIX girlies specifically)vec-extabiandvec-default.-mabi=ibmlongdoubleโ switches the current ABI over to IBM extended-precisionlong double๐ . Heads up though: this is not likely to work if your system defaults to IEEE extended-precisionlong double. And if you change thelong doubletype away from IEEE extended-precision, the compiler will throw a warning at you unless you pass-Wno-psabi. Also requires-mlong-double-128to be enabled, no exceptions โจ.-mabi=ieeelongdoubleโ same energy but the other direction: switches the current ABI to use IEEE extended-precisionlong double๐ฆ. Same deal โ not likely to work if your system defaults to IBM extended-precisionlong double, and if you change thelong doubletype away from IBM extended-precision the compiler complains unless you use-Wno-psabi. Also needs-mlong-double-128enabled. Symmetry, we love to see it ๐.-mabi=elfv1โ flips the current ABI to 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, and I quote, likely to fail in spectacular ways ๐ no cap, that's the actual warning, please take it seriously.-mabi=elfv2โ flips the current ABI to the ELFv2 ABI, which is the default for little-endian PowerPC 64-bit Linux ๐. Same caveat: overriding the default ABI needs special system support and is likely to fail in spectacular ways ๐ญ iconic warning tbh.-mgnu-attribute,-mno-gnu-attributeโ emit (or don't emit).gnu_attributeassembly directives that set tag/value pairs in a.gnu.attributessection, which specify ABI variations in function parameters or return values ๐.-mprototype,-mno-prototypeโ on System V.4 and embedded PowerPC systems, assume (or don't assume) that all calls to variable argument functions are properly prototyped ๐ธ. When you don't assume it, the compiler has to insert an instruction before every non-prototyped call to set or clear bit 6 of the condition code register (CR), so it can indicate whether floating-point values are passed in the floating-point registers in case the function takes variable arguments. With-mprototype, only calls to prototyped variable argument functions set or clear that bit. Efficient queen behavior ๐ .-msimโ on embedded PowerPC systems, assumes the startup module is calledsim-crt0.oand that the standard C libraries arelibsim.aandlibc.a๐ง. This is the default forpowerpc-*-eabisimconfigurations, iykyk.-mmvmeโ on embedded PowerPC systems, assumes the startup module is calledcrt0.oand the standard C libraries arelibmvme.aandlibc.aโจ.-madsโ on embedded PowerPC systems, assumes the startup module is calledcrt0.oand the standard C libraries arelibads.aandlibc.a๐.-myellowknifeโ on embedded PowerPC systems, assumes the startup module is calledcrt0.oand the standard C libraries arelibyk.aandlibc.a๐ (yes the flag is literally named yellowknife, main character energy).-mvxworksโ on System V.4 and embedded PowerPC systems, says "bestie I'm compiling for a VxWorks system" ๐ฆ.-membโ on embedded PowerPC systems, sets thePPC_EMBbit 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 whole set of modifications to the System V.4 specs ๐. Picking-meabimeans:- the stack is aligned to an 8-byte boundary,
- a function
__eabiis called frommainto set up the EABI environment, - and the
-msdataoption can use bothr2andr13to 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
-msdataonly usesr13to 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, puts small initializedconstglobal and static data in the.sdata2section, which registerr2points to ๐ธ. Puts small initialized non-constglobal and static data in the.sdatasection, pointed to by registerr13. Puts small uninitialized global and static data in the.sbsssection, which sits right next to.sdata. Fair warning bestie:-msdata=eabiis incompatible with the-mrelocatableoption ๐, and it also sets the-memboption.-msdata=sysvโ on System V.4 and embedded PowerPC systems, puts small global and static data in the.sdatasection, pointed to by registerr13โจ. Puts small uninitialized global and static data in.sbss, adjacent to.sdata. Also incompatible with-mrelocatable, so don't try it ๐.-msdata=default,-msdataโ on System V.4 and embedded PowerPC systems: if-meabiis used, compile code the same as-msdata=eabi; otherwise compile it the same as-msdata=sysv๐ซถ. Vibes-based delegation, honestly iconic.-msdata=dataโ on System V.4 and embedded PowerPC systems, puts small global data in the.sdatasection, and small uninitialized global data in the.sbsssection ๐. But โ and this is the plot twist โ do not use registerr13to address small data here. This is the default behavior unless other-msdataoptions are used ๐.-msdata=none,-mno-sdataโ on embedded PowerPC systems, puts all initialized global and static data in the.datasection, and all uninitialized data in the.bsssection ๐ . Simple, clean, no small-data drama.-mreadonly-in-sdataโ also puts read-only objects in the.sdatasection ๐. This is the default, so it's already doing this unless you tell it otherwise.-mblock-move-inline-limit=numโ inlines all block moves (stuff like calls tomemcpyor 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, so check your target's vibe.-mblock-compare-inline-limit=numโ generates non-looping inline code for all block compares (like calls tomemcmpor 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 ๐ซ. Default value is target-specific.-mblock-compare-inline-loop-limit=numโ generates an inline expansion using loop code for all block compares 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 get compared beforememcmpis called to handle the remainder of the block. Default is target-specific.-mstring-compare-inline-limit=numโ compares at most num string bytes using inline code ๐. If the difference or the end of the string isn't found by the end of that inline compare, a call tostrcmporstrncmptakes care of the rest of the comparison. The default is 64 bytes, periodt ๐.-G numโ on embedded PowerPC systems, puts 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 numswitch also gets passed to the linker, and โ important โ all modules should be compiled with the same-G numvalue or things get messy ๐ญ.-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 ๐ฆ. Your asm, your aesthetic.-mlongcall,-mno-longcallโ by default, assumes all calls are far away, so 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 gets generated if the compiler knows the call can't possibly be that far away. This setting can be overridden by theshortcallfunction 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, and so can the GNU linker for PowerPC/64. It's planned to add this feature to the GNU linker for 32-bit PowerPC systems too ๐.
On PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, GCC can generate long calls using an inline PLT call sequence (see -mpltseq) โจ. PowerPC with -mbss-plt and PowerPC64 ELFv1 (big-endian) do not support inline PLT calls ๐
.
On Darwin/PPC systems, #pragma longcall generates jbsr callee, L42, plus a branch island (glue code) ๐๏ธ. 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 gets appended to the body of the calling function, and it computes the full 32-bit address of the callee and jumps to it ๐ (in a cool way).
On Mach-O (Darwin) systems, this option directs the compiler to emit the glue for every direct call, and the Darwin linker decides whether to use it or discard it ๐ซถ.
In the future, GCC may ignore all longcall specifications when the linker is known to generate glue ๐. Just so you're not surprised later.
-mpltseq,-mno-pltseqโ implement (or don't implement)-fno-pltand long calls using an inline PLT call sequence that supports lazy linking and long calls to functions in dlopen'd shared libraries ๐. Inline PLT calls are only supported on PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, and they're enabled by default if the support is detected when configuring GCC โ and, for 32-bit PowerPC, if GCC is configured with--enable-secureplt๐ . Warning bestie:-mpltseqcode and-mbss-plt32-bit PowerPC relocatable objects may not be linked together ๐ญ.-mtls-markers,-mno-tls-markersโ mark (or don't mark) calls to__tls_get_addrwith a relocation specifying the function argument ๐. The 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 โจ. Teamwork, honestly.-mrecip,-mno-recipโ bestie, this one lets GCC use reciprocal estimate and reciprocal square root estimate instructions with extra Newton-Raphson steps to bump precision, instead of doing a divide or square root and divide for floating-point arguments. You should use the-ffast-mathoption when using-mrecip(or at least-funsafe-math-optimizations,-ffinite-math-only,-freciprocal-mathand-fno-trapping-math). Note that while the throughput of the sequence is generally higher than the throughput of the non-reciprocal instruction, the precision of the sequence can be decreased by up to 2 ulp (i.e. the inverse of 1.0 equals0.99999994) for reciprocal square roots. ๐-mrecip=optโ this controls which reciprocal estimate instructions may be used.optis a comma-separated list of options, which may be preceded by a!to invert the option:allโ enable all estimate instructions.defaultโ enable the default instructions, equivalent to-mrecip.noneโ disable all estimate instructions, equivalent to-mno-recip.divโ enable the 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. โจ
-mrecip-precision,-mno-recip-precisionโ assume (or, with-mno-recip-precision, do not assume) that the reciprocal estimate instructions provide higher-precision estimates than is mandated by the PowerPC ABI. Selecting-mcpu=power6,-mcpu=power7or-mcpu=power8automatically 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. ๐ซถ-mveclibabi=typeโ specifies the ABI type to use for vectorizing intrinsics using an external library. The only type supported at present ismass, which specifies to use IBM's Mathematical Acceleration Subsystem (MASS) libraries for vectorizing intrinsics using external libraries. GCC currently emits calls toacosd2,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, andtanhf4when generating code for power7. Both-ftree-vectorizeand-funsafe-math-optimizationsmust also be enabled. The MASS libraries must be specified at link time. ๐-mfriz,-mno-frizโ generate (do not generate) thefrizinstruction when the-funsafe-math-optimizationsoption is used to optimize rounding of floating-point values to 64-bit integer and back to floating point. Thefrizinstruction does not return the same value if the floating-point number is too large to fit in an integer. ๐ญ-mpointers-to-nested-functions,-mno-pointers-to-nested-functionsโ generate (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 registerr2, and static chain value to be loaded in registerr11. The-mpointers-to-nested-functionsis on by default. You cannot call through pointers to nested functions or pointers to functions compiled in other languages that use the static chain if you use-mno-pointers-to-nested-functions. ๐ฅ-msave-toc-indirect,-mno-save-toc-indirectโ generate (do not generate) code to save the TOC value in the reserved stack location in the function prologue if the function calls through a pointer on AIX and 64-bit Linux systems. If the TOC value is not saved in the prologue, it is saved just before the call through the pointer. The-mno-save-toc-indirectoption is the default. ๐-mcompat-align-parm,-mno-compat-align-parmโ generate (do not generate) code to pass structure parameters with a maximum alignment of 64 bits, for compatibility with older versions of GCC.
Older versions of GCC (prior to 4.9.0) incorrectly did not align a structure parameter on a 128-bit boundary when that structure contained a member requiring 128-bit alignment. This is corrected in more recent versions of GCC. This option may be used to generate code that is compatible with functions compiled with older versions of GCC.
The -mno-compat-align-parm option is the default. ๐ธ
-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offsetโ generate stack protection code using canary at guard. Supported locations areglobalfor global canary ortlsfor 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 (do not generate) pc-relative addressing. The-mpcreloption requires that the medium code model (-mcmodel=medium) and prefixed addressing (-mprefixed) options are enabled. โญ-mprefixed,-mno-prefixedโ generate (do not generate) addressing modes using prefixed load and store instructions. The-mprefixedoption requires that the option-mcpu=power10(or later) is enabled. ๐ฆ-mmma,-mno-mmaโ generate (do not generate) the MMA instructions. The-mmaoption requires that the option-mcpu=power10(or later) is enabled. ๐-mdense-math,-mno-dense-mathโ generate (do not generate) Dense Math Facility (DMF) instructions. The-mdense-mathoption requires that the option-mcpu=future(or later) is enabled. ๐-mrop-protect,-mno-rop-protectโ generate (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 (do not generate) code that runs in privileged state. ๐-mblock-ops-unaligned-vsx,-mno-block-ops-unaligned-vsxโ generate (do not generate) unaligned vsx loads and stores for inline expansion ofmemcpyandmemmove. ๐-msplat-word-constant,-mno-splat-word-constantโ generate (do not generate) code that uses theXXSPLTIWinstruction. This option is enabled by default. โจ-msplat-float-constant,-mno-splat-float-constantโ generate (do not generate) code that uses theXXSPLTIDPinstruction. This option is enabled by default. ๐-mieee128-constant,-mno-ieee128-constantโ generate (do not generate) code that uses theLXVKQinstruction. 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. ๐ธ
RX Options ๐
These command-line options are defined for RX targets:
-m64bit-doubles,-m32bit-doublesโ make thedoubledata 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. ๐ฆ-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. ๐ญ
-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 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 (usuallyr13) is reserved for use pointing to this area, so it is no longer available for use by the compiler. This could result in slower and/or larger code if variables are pushed onto the stack instead of being held in this register.
Note, common variables (variables that have not been initialized) and constants are not placed into the small data area as they are assigned to other sections in the output executable. ๐
The default value is zero, which turns this whole feature off. And ngl, it's not on by default even at higher optimization levels (-O2 and friends), because reserving a register can genuinely hurt you. Bestie, this is a "you experiment and find out if it helps your program" situation, no cap. Peep the -mpid description below for how the actual register that holds the small data area pointer gets picked. ๐
-msim,-mno-simโ use the simulator runtime. Default is the libgloss board-specific runtime, iykyk.-mas100-syntax,-mno-as100-syntaxโ when you're generating assembler output, use a syntax that plays nice with Renesas's AS100 assembler. GAS can handle this syntax too, but it comes with some restrictions, which is why it's not what you get by default.-mmax-constant-size=Nโ sets the max size, in bytes, of a constant that can be used as an operand in an RX instruction. So here's the tea: the RX instruction set does let you use constants up to 4 bytes long inside instructions, but a longer value means a longer instruction. So sometimes it's lowkey beneficial to cap how big your in-instruction constants get. Constants that are too big get yeeted into a constant pool and referenced via register indirection instead.
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. That's the process where the linker tries to shrink your program by finding shorter versions of various instructions. Disabled by default.-mint-register=Nโ says how many registers to reserve for fast interrupt handler functions. N can be between 0 and 4. A value of 1 meansr13is reserved exclusively for fast interrupt handlers. A value of 2 reservesr13andr12. A value of 3 reservesr13,r12andr11, and a value of 4 reservesr13throughr10. A value of 0 โ that's the default โ reserves nothing at all. โจ-msave-acc-in-interruptsโ says interrupt handler functions should preserve the accumulator register. You only need this if normal code might actually use the accumulator, like when it does 64-bit multiplications. Default is to ignore the accumulator, because that makes the interrupt handlers faster. ๐โโ๏ธ๐จ-mpid,-mno-pidโ enables generating position-independent data. When it's on, any access to constant data happens via an offset from a base address held in a register. That means the location of constant data can be figured out at run time without the executable needing relocation โ huge win for embedded apps with tight memory constraints. Data that can be modified is not affected by this option, so don't worry about that.
Heads up bestie: this feature reserves a register โ usually r13 โ for the constant data base address. That can make your code slower and/or bigger, especially in complicated functions. ๐ญ
Which register actually gets picked for the constant data base address depends on whether -msmall-data-limit and/or -mint-register are enabled on the command line. Starting at r13 and going downwards, registers get allocated first to satisfy -mint-register, then -mpid, and finally -msmall-data-limit. So yes, it's genuinely possible for the small data area register to be r8 if you pass both -mint-register=4 and -mpid. ๐
By default this is off. You can get the default back with -mno-pid.
-mno-warn-multiple-fast-interrupts,-mwarn-multiple-fast-interruptsโ stops GCC from throwing a warning when it finds more than one fast interrupt handler while compiling a file. The default is to warn for each extra fast interrupt handler it finds, because the RX only supports one such interrupt. fr fr, only one.-mallow-string-insns,-mno-allow-string-insnsโ turns on or off the string manipulation instructionsSMOVF,SCMPU,SMOVB,SMOVU,SUNTIL,SWHILEand also theRMPAinstruction. These instructions may prefetch data, which is not safe 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 GCC literally cannot reliably detect every circumstance where a string instruction might touch an I/O register, so it can't disable them automatically. Instead it's on the programmer โ that's you, bestie โ to use -mno-allow-string-insns if the program accesses I/O space. ๐
When these instructions are enabled, GCC defines the C preprocessor symbol __RX_ALLOW_STRING_INSNS__; otherwise it defines __RX_DISALLOW_STRING_INSNS__.
-mjsr,-mno-jsrโ use only (or not only)JSRinstructions to access functions. This comes in clutch when your code size exceeds the range ofBSRinstructions. Careful though:-mno-jsrdoes not mean "don't useJSR" โ it means any type of branch may be used. ๐-mlraโ use the new LRA register allocator. By default the oldreloadallocator is what you get.
๐ Note: the generic GCC command-line option-ffixed-reghas special significance for the RX port when it's used with theinterruptfunction attribute. That attribute marks a function as one intended to process fast interrupts. GCC makes sure it only uses the registersr10,r11,r12and/orr13โ and only provided that the normal use of the corresponding registers has been restricted via the-ffixed-regor-mint-registercommand-line options.
๐ฆ S/390 and zSeries Options ๐ฆ
These are the -m options defined for the S/390 and zSeries architecture. Big iron energy, we love to see it. ๐๏ธ
-mhard-float,-msoft-floatโ use (or don't use) the hardware floating-point instructions and registers for floating-point operations. With-msoft-float, functions inlibgcc.ahandle the floating-point math. With-mhard-float, the compiler generates IEEE floating-point instructions.-mhard-floatis the default. โจ-mhard-dfp,-mno-hard-dfpโ use (or don't use) the hardware decimal-floating-point instructions for decimal-floating-point operations. With-mno-hard-dfp, functions inlibgcc.ado the decimal-floating-point work. With-mhard-dfp, the compiler generates decimal-floating-point hardware instructions. This is the default for-march=z9-ecor higher. ๐-mlong-double-64,-mlong-double-128โ these switches control the size of thelong doubletype. A size of 64 bits makeslong doubleequivalent todouble. That's 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. You might need a backchain so that debugging tools which don't understand DWARF call frame information can still do their thing. When-mno-packed-stackis in effect, the backchain pointer goes at the bottom of the stack frame; when-mpacked-stackis in effect, the backchain is placed into the topmost word of the 96/160 byte register save area.
Generally speaking, code compiled with -mbackchain is call-compatible with code compiled with -mno-backchain โ but using the backchain for debugging usually requires the whole binary to be built with -mbackchain. Also note that the combination of -mbackchain, -mpacked-stack and -mhard-float is not supported. If you're building a linux kernel, use -msoft-float.
The default is to not maintain the backchain.
-mpacked-stack,-mno-packed-stackโ use (or don't use) the packed stack layout. With-mno-packed-stack, the compiler uses all the fields of the 96/160 byte register save area only for their default purpose โ and unused fields still take up stack space. With-mpacked-stack, register save slots get densely packed at the top of the register save area, and unused space gets reused for other stuff, which means more efficient use of the available stack space. ๐ However, when-mbackchainis also in effect, the topmost word of the save area is always used for the backchain, and the return address register is always saved two words below the backchain.
As long as the stack frame backchain isn't used, code generated with -mpacked-stack is call-compatible with code generated with -mno-packed-stack. But watch out: 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. That kind of 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 โ 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 that uses thebrasinstruction to do subroutine calls. This only works reliably if the total executable size doesn't exceed 64k. The default is to use thebasrinstruction instead, which doesn't have that limitation. ๐-m64,-m31โ with-m31, generate code compliant with the GNU/Linux for S/390 ABI. With-m64, generate code compliant with the GNU/Linux for zSeries ABI. This is what lets GCC in particular generate 64-bit instructions. For s390 targets the default is-m31, while s390x targets default to-m64.
โ ๏ธ Note: -m31 is deprecated and support for it will be removed. Pour one out. ๐ญ
-mzarch,-mesaโ with-mzarch, generate code using the instructions available on z/Architecture. With-mesa, generate code using the instructions available on ESA/390. Note that-mesais not possible with-m64. When generating code compliant with the GNU/Linux for S/390 ABI, the default is-mesa. When generating code compliant with the GNU/Linux for zSeries ABI, the default is-mzarch. ๐-mhtm,-mno-htmโ the-mhtmgirlie turns on a whole set of builtins that use the instructions from the transactional execution facility that came with the IBM zEnterprise EC12 machine generation S/390 System z Built-in Functions. And-mhtmis on by default when you're using-march=zEC12, periodt. ๐-mvx,-mno-vxโ when you say-mvx, you get code using the instructions from the vector extension facility introduced with 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 show up in an ABI-relevant context, a GAS.gnu_attributecommand gets added to mark the resulting binary with the ABI it's using.-mvxis enabled by default when using-march=z13. ๐ฆ-mzvector,-mno-zvectorโ-mzvectorenables vector language extensions and builtins that use instructions from the vector extension facility introduced with the IBM z13 machine generation. It also adds support forvectoras a keyword so you can define vector type variables and arguments. Lowkey important:vectoris only available when GNU extensions are enabled โ it does not expand when you're requesting strict standard compliance, like with-std=c99. On top of the GCC low-level builtins,-mzvectoralso enables a set of builtins added for compatibility with AltiVec-style implementations like Power and Cell. To use those builtins you gotta include the header filevecintrin.h.-mzvectoris disabled by default, no cap. โจ-mmvcle,-mno-mvcleโ generate (or don't generate) code that uses the"mvcle"instruction to do block moves. Say-mno-mvcleand it uses an"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. Simple as that. ๐ซถ-march=cpu-typeโ generate code that runs on cpu-type, which is the name of a system representing a certain processor type. The 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, andnative.
The default is -march=z900.
And if you pass native as the cpu type, it picks the best architecture option for the host processor. But real talk: -march=native has no effect if GCC doesn't 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 whatever value you used for-march. ๐-mtpf-trace,-mno-tpf-traceโ generate code that adds (or does not add) TPF OS specific branches to trace routines in the operating system. This option is off by default, even when you're compiling for the TPF OS. ๐-mtpf-trace-skip,-mno-tpf-trace-skipโ generate code that changes (or does not change) the default branch targets enabled by-mtpf-traceso they point to specialized trace routines that can selectively skip function trace entries for the TPF OS. This one is off by default too, even when you're 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 so you produce a main object. ๐ฅ-mfused-madd,-mno-fused-maddโ generate code that uses (or 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. Since this is a compile-time check, it doesn't have to be an actual problem when the program runs โ it's meant to flag functions that most probably cause a stack overflow. Super useful for environments with a limited stack size, e.g. the Linux kernel.
A value of zero disables this warning, and that's the default. โญ
-mwarn-dynamicstack,-mno-warn-dynamicstackโ emit a warning if the function calls"alloca"or uses dynamically-sized arrays. Generally a bad idea when you've got a limited stack size. ๐ฌ-mstack-guard=stack-guard,-mstack-size=stack-size,-mno-stack-guard,-mno-stack-sizeโ if these 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, bestie). If you omit the stack-guard option, the smallest power of 2 larger than the frame size of the compiled function gets chosen.
These options are meant to help debug stack overflow problems. The additionally emitted code causes only a little overhead, so it can also be used in production-like systems without much performance degradation. ๐
The values you give have to be exact powers of 2, and stack-size has to be greater than stack-guard without exceeding 64k. And to be efficient, the extra code assumes the stack starts at an address aligned to the value given by stack-size.
The-mstack-guard=option can only be used together with-mstack-size=. You can override these options on the command line with-mno-stack-guardand-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 gets prepended with the given number of two-byte NOP instructions (pre-halfwords, maximum1000000). After the label,2 * post-halfwordsbytes get appended, using the largest NOP-like instructions the architecture allows (maximum1000000).
If both arguments are zero, hotpatching is disabled.
You can override this per-function with the "hotpatch" attribute. ๐ง
-mpic-data-is-text-relative,-mno-pic-data-is-text-relativeโ when compiling for S/390 with-fpicor-fPIC, GCC normally emits code using relative addressing between code and data. But for hotpatching you might need to introduce new".text"parts while using the existing".data"and".bss"sections. In that case, use-mno-pic-data-is-text-relativeto 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 areglobalfor a global canary, ortlsfor a per-thread canary in the TLS block (that's the default).
Option -mstack-protector-guard-record results in generating a section "__stack_protector_loc" containing pointers to all the instructions that load the address of the global guard. So it only has an effect together 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 squad of options handles security vulnerabilities related to speculative execution and indirect branch prediction by letting you replace indirect branches and function returns with direct branches to a thunk.
Passing 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 โ and you should prefer it over thunk in user-space applications so you get 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 can also be set per-function using function attributes. โจ
-mindirect-branch-table,-mno-indirect-branch-tableโ useful together with the-mindirect-branchand-mfunction-returnoptions. When enabled, it generates tables pointing to the branch locations that those options patched. The tables are emitted in sections named".s390_indirect_jump",".s390_indirect_call",".s390_return_reg", and".s390_return_mem". Each section is an array of 32-bit elements, and each entry holds the offset from the entry to the patched location. ๐-mfentry,-mno-fentryโ when used together with the-pgoption, 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 isn't 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 of no-op instructions of the same length at the locations where the calls would have gone. This can be used together with the-mrecord-mcountoption 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. Handy 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, bestie:
-m1โ generate code for the SH1. โญ-m2โ generate code for the SH2. โญ-m2eโ generate code for the SH2e. โญ
More SH family realness, bestie โ this whole chunk is literally "okay but which SH chip are we even talking about," and the answer is: so many. Buckle in. ๐ฆ
-m2a-nofpuโ code for the SH2a with no FPU at all, or for a SH2a-FPU where you're making very sure the floating-point unit doesn't get used. โจ-m2a-single-onlyโ code for the SH2a-FPU, set up so that no double-precision floating-point operations happen. Ever. ๐ซ-m2a-singleโ code for the SH2a-FPU, assuming the FPU is chilling in single-precision mode by default.-m2aโ code for the SH2a-FPU, assuming the FPU is in double-precision mode by default. Fancy. ๐-m3โ code for the SH3.-m3eโ code for the SH3e.-m4-nofpuโ code for the SH4 with no floating-point unit.-m4-single-onlyโ code for the SH4 with an FPU that only does single-precision arithmetic. That's its whole range. ๐-m4-singleโ code for the SH4, assuming the FPU is in single-precision mode by default.-m4โ code for the SH4. Simple. Iconic.-m4-100โ code for SH4-100.-m4-100-nofpuโ code for SH4-100 so that the floating-point unit is not used.-m4-100-singleโ code for SH4-100, assuming the FPU is in single-precision mode by default.-m4-100-single-onlyโ code for SH4-100 so that no double-precision floating-point operations are used.-m4-200โ code for SH4-200.-m4-200-nofpuโ code for SH4-200 so that the floating-point unit is not used.-m4-200-singleโ code for SH4-200, assuming the FPU is in single-precision mode by default.-m4-200-single-onlyโ code for SH4-200 so that no double-precision floating-point operations are used.-m4-300โ code for SH4-300.-m4-300-nofpuโ code for SH4-300 so that the floating-point unit is not used.-m4-300-singleโ code for SH4-300 in such a way that no double-precision floating-point operations are used.-m4-300-single-onlyโ code for SH4-300 in such a way that no double-precision floating-point operations are used.-m4-340โ code for SH4-340 (no MMU, no FPU). Bare bones bestie. ๐-m4-400โ code for SH4-400 (no MMU, no FPU).-m4-500โ code for SH4-500 (no FPU). Passes-isa=sh4-nofputo the assembler.-m4a-nofpuโ code for the SH4al-dsp, or for a SH4a so that the floating-point unit is not used.-m4a-single-onlyโ code for the SH4a so that no double-precision floating-point operations are used.-m4a-singleโ code for the SH4a, assuming the FPU is in single-precision mode by default.-m4aโ code for the SH4a.-m4alโ same as-m4a-nofpu, except it implicitly passes-dspto the assembler. Heads up though: GCC doesn't generate any DSP instructions at the moment. ๐ซ-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. Big caveat energy: this changes the calling conventions, and thus some functions from the standard C library do not work unless you recompile it first with-mdalign. ๐ญ So don't just sprinkle this one around.-mrelaxโ shorten some address references at link time, when possible; uses the linker option-relax.-mbigtableโ use 32-bit offsets inswitchtables. The default is to use 16-bit offsets.-mbitopsโ enable the use of bit manipulation instructions on SH2A.-mfmovdโ enable the use of the instructionfmovd. Check-mdalignfor 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 theMACregister as call-clobbered, even if-mrenesasis given.-mieee,-mno-ieeeโ control the IEEE compliance of floating-point comparisons, which affects how cases where the result of a comparison is unordered get handled. By default-mieeeis implicitly enabled. If-ffinite-math-onlyis enabled,-mno-ieeeis implicitly set, which results in faster floating-point greater-equal and less-equal comparisons. The implicit settings can be overridden by specifying either-mieeeor-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-musermodeis in effect and the selected code generation option (e.g.-m4) does not allow the use of theicbiinstruction. If the selected code generation option does not allow the use of theicbiinstruction, and-musermodeis not in effect, the inlined code manipulates the instruction cache address array directly with an associative write. And that's not just spicy, it requires privileged mode at run time, and it also fails if the cache line had been mapped via the TLB and has become unmapped. ๐ฌ-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 notsh*-*-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 issh*-*-linux*and SH3* or SH4*. When the target is SH4A, this option also partially utilizes the hardware atomic instructionsmovli.landmovco.lto create more efficient code, unlessstrictis 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, thegbr-offset=parameter has to be specified as well. โ ๏ธsoft-imaskโ generate software atomic sequences that temporarily disable interrupts by settingSR.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 issh*-*-linux*and SH1* or SH2*.hard-llcsโ generate hardware atomic sequences using themovli.landmovco.linstructions 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 thesoft-tcbmodel 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 thetas.bopcode for__atomic_test_and_set. Real talk though: depending on the particular hardware and software configuration, this can degrade overall performance due to the operand cache line flushes that are implied by thetas.binstruction. And on multi-core SH4A processors thetas.binstruction must be used with caution, since it can result in data corruption for certain cache configurations. ๐ Not the vibe.-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-musermodealso implies-mno-inline-ic_invalidateif the inlined code would not work in user mode.-musermodeis the default when the target issh*-*-linux*. If the target is SH1* or SH2*,-musermodehas no effect, since there is no user mode. ๐คท-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 instructiondiv1to 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 tocall-div1.
call-tableโ okay so this one calls a library function that uses a lookup table for small divisors and thediv1instruction 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 tocall-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-argsis enabled the default.-mdivsi3_libfunc=nameโ set the name of the library function used for 32-bit signed division toname. 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โ assumenumto 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 instructionsbtandbfare fast. If-mzdcbranchis 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 anopif 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 thefscainstruction for sine and cosine approximations. The option-mfscamust be used in combination with-funsafe-math-optimizations. It is enabled by default when generating code for SH4A. Using-mno-fscadisables sine and cosine approximations even if-funsafe-math-optimizationsis in effect.-mfsrra,-mno-fsrraโ allow or disallow the compiler to emit thefsrrainstruction for reciprocal square root approximations. The option-mfsrramust be used in combination with-funsafe-math-optimizationsand-ffinite-math-only. It is enabled by default when generating code for SH4A. Using-mno-fsrradisables reciprocal square root approximations even if-funsafe-math-optimizationsand-ffinite-math-onlyare 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 oldreloadallocator is used.
โ๏ธ Solaris 2 Options โ๏ธ
These options are supported on Solaris 2:
-mclear-hwcap,-mno-clear-hwcapโ-mclear-hwcaptells 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 textto 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. Seectf(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-regsto 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 targetssparc-*-aoutandsparclite-*-*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 thecasainstruction 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 oflddandstdinstructions for copies in structure assignment, in place of twice as manyldandstpairs. 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 typecpu_type. Supported values forcpu_typearev7,cypress,v8,supersparc,hypersparc,leon,leon3,leon3v7,leon5,sparclite,f930,f934,sparclite86x,sparclet,tsc701,v9,ultrasparc,ultrasparc3,niagara,niagara2,niagara3,niagara4,niagara7andm8.
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,leon3v7v8โsupersparc,hypersparc,leon,leon3,leon5sparclitef930,f934,sparclite86x
sparclettsc701
v9โultrasparc,ultrasparc3,niagara,niagara2,niagara3,niagara4,niagara7,m8
By default (unless you went and configured it otherwise), GCC spits out code for the V7 variant of the SPARC architecture. Slap -mcpu=cypress on there and the compiler also optimizes for the Cypress CY7C602 chip โ the one living inside the SPARCStation/SPARCServer 3xx series. It's also a whole vibe for the older SPARCStation 1, 2, IPX, etc. ๐
With -mcpu=v8, GCC generates code for the V8 variant. The only glow-up from V7 code? The compiler now emits the integer multiply and integer divide instructions that exist in SPARC-V8 but literally do not exist in SPARC-V7. And with -mcpu=supersparc, it additionally optimizes for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and 2000 series. โจ
With -mcpu=sparclite, GCC generates code for the SPARClite variant. This adds the integer multiply, integer divide step and scan ("ffs") instructions that 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, bless. With -mcpu=f934, it additionally optimizes for the Fujitsu MB86934 chip, which is the more recent SPARClite with FPU. ๐
With -mcpu=sparclet, GCC generates code for the SPARClet variant. This adds the integer multiply, multiply/accumulate, integer divide step and scan ("ffs") instructions that 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. This adds 64-bit integer and floating-point move instructions, 3 additional floating-point condition code registers and conditional move instructions. Then the optimization era begins, bestie:
-mcpu=ultrasparcโ additionally optimizes for the Sun UltraSPARC I/II/IIi chips-mcpu=ultrasparc3โ additionally optimizes for the Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips-mcpu=niagaraโ additionally optimizes for Sun UltraSPARC T1 chips-mcpu=niagara2โ additionally optimizes for Sun UltraSPARC T2 chips-mcpu=niagara3โ additionally optimizes for Sun UltraSPARC T3 chips-mcpu=niagara4โ additionally optimizes for Sun UltraSPARC T4 chips-mcpu=niagara7โ additionally optimizes for Oracle SPARC M7 chips-mcpu=m8โ additionally optimizes for Oracle M8 chips
-mtune=cpu_typeโ sets the instruction scheduling parameters for machine type cpu_type, but does not set the instruction set or register set that-mcpu=cpu_typedoes. No cap, those are two different things. ๐
The same values you'd use for -mcpu=cpu_type work for -mtune=cpu_type, but the only useful ones are those that select a particular CPU implementation. Those are: cypress, supersparc, hypersparc, leon, leon3, leon3v7, leon5, f930, f934, sparclite86x, tsc701, ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7 and m8. With native Solaris and GNU/Linux toolchains, native can also be used. ๐
-mv8plus,-mno-v8plusโ with-mv8plus, GCC generates code for the SPARC-V8+ ABI. The difference from the V8 ABI is that the global and out registers are considered 64 bits wide. This is enabled by default on Solaris in 32-bit mode for all SPARC-V9 processors. ๐-mvis,-mno-visโ with-mvis, GCC generates code that takes advantage of the UltraSPARC Visual Instruction Set extensions. The default is-mno-vis. โจ-mvis2,-mno-vis2โ with-mvis2, GCC generates code that takes advantage of version 2.0 of the UltraSPARC Visual Instruction Set extensions. The default is-mvis2when targeting a cpu that supports such instructions, such as UltraSPARC-III and later. Setting-mvis2also 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-mvis3when targeting a cpu that supports such instructions, such as niagara-3 and later. Setting-mvis3also sets-mvis2and-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-mvis3bwhen targeting a cpu that supports such instructions, such as niagara-7 and later. Setting-mvis3balso sets-mvis3,-mvis2and-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-mvis4when targeting a cpu that supports such instructions, such as niagara-7 and later. Setting-mvis4also sets-mvis3b,-mvis3,-mvis2and-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-mvis4bwhen targeting a cpu that supports such instructions, such as m8 and later. Setting-mvis4balso sets-mvis4,-mvis3b,-mvis3,-mvis2and-mvis. ๐-mcbcond,-mno-cbcondโ with-mcbcond, GCC generates code that takes advantage of the UltraSPARC Compare-and-Branch-on-Condition instructions. The default is-mcbcondwhen 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-mfmafwhen 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-mfsmuldwhen 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-mpopcwhen 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-msubxcwhen 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, bestie โ yes, there's more, hydrate before continuing: ๐ง
-m32,-m64โ generate code for a 32-bit or 64-bit environment. The 32-bit environment setsint,longand pointer to 32 bits. The 64-bit environment setsintto 32 bits andlongand pointer to 64 bits. ๐-mptr32,-mptr64โ use 32- or 64-bit pointers, respectively. Unlike the-m32and-m64options, this affects only the pointer size and not the ABI. Subtle. Iconic. ๐-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%g4points 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 Orderpsoโ Partial Store Ordertsoโ Total Store Orderscโ 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-2047which 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-symbolicor-sharedbe used instead. (Yes, that's a "please use the other thing" note. Noted. ๐)-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โ so these two are the "do not / do" pair for this one specific optimization ๐: whether to optimize basic blocks that use the same index pointer 4 or more times to copy the pointer into the"ep"register and then use the shorter"sld"and"sst"instructions. And-mepis on by default if you optimize, iykyk โจ-mno-prolog-function,-mprolog-functionโ do not use / do use external functions to save and restore registers at the prologue and epilogue of a function ๐ซถ. Heads up bestie: those external functions are slower, but they use less code space if more than one function saves the same number of registers.-mprolog-functionis on by default if you optimize ๐-mspaceโ try to make the code as small as possible ๐โจ. Right now that just means it turns on-mepand-mprolog-function. Little bit iconic, little bit tiny.-mtda=nโ put static or global variables whose size is n bytes or less into the tiny data area that register"ep"points to ๐. That tiny data area holds up to 256 bytes total (128 bytes for byte references) โ it's giving studio apartment, ngl.-msda=nโ put static or global variables whose size is n bytes or less into the small data area that register"gp"points to ๐ธ. This one can hold up to 64 kilobytes โ so like, the tiny data area's older sibling with a slightly bigger place.-mzda=nโ put static or global variables whose size is n bytes or less into the first 32 kilobytes of memory ๐ฆ.-mv850โ specify that the target processor is the V850 ๐-mv850e3v5โ specify that the target processor is the V850E3V5 โจ. The preprocessor constant"__v850e3v5__"gets defined if you use this option.-mv850e2v4โ specify that the target processor is the V850E3V5. This is an alias for the-mv850e3v5option ๐ (yes, it says V850E3V5 โ we're just reading it, bestie ๐ญ)-mv850e2v3โ specify that the target processor is the V850E2V3 โจ. The preprocessor constant"__v850e2v3__"gets defined if this option is used.-mv850e2โ specify that the target processor is the V850E2 โจ. Preprocessor constant"__v850e2__"gets defined if you use it.-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-mv850e1option ๐ซถ-mv850eโ specify that the target processor is the V850E โจ. The preprocessor constant"__v850e__"gets defined if this option is used.
If neither -mv850 nor -mv850e nor -mv850e1 nor -mv850e2 nor -mv850e2v3 nor -mv850e3v5 are defined, then a default target processor is chosen and the relevant __v850*__ preprocessor constant is defined ๐
And the preprocessor constants "__v850" and "__v851__" are always defined, no matter which processor variant is the target โญ โ those two are the ride-or-dies fr fr.
-mdisable-callt,-mno-disable-calltโ this one 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. If "CALLT" instructions are being generated, then the C preprocessor symbol "__V850_CALLT__" gets defined โจ
-mrelax,-mno-relaxโ pass on (or do not pass on) the-mrelaxcommand-line option to the assembler ๐ฆ-mlong-jumps,-mno-long-jumpsโ disable (or re-enable) the generation of PC-relative jump instructions ๐ซ-msoft-float,-mhard-floatโ disable (or re-enable) generation of hardware floating point instructions ๐. Important: 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 use of the e3v5 LOOP instruction ๐. It is not enabled by default when the e3v5 architecture is selected, because its use is still experimental ๐ โ so like, proceed with 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, these 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-aligncommand-line option is supported โจ - The
-mdisable-calltcommand-line option is enabled by default. The-mno-disable-calltcommand-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, these 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-aligncommand-line option is not supported ๐ - The
-mdisable-calltcommand-line option is supported but not enabled by default
- Integer sized structures and unions are returned in register
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-alignis 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 โ ๏ธ โ it's giving "only for emergencies, bestie".-mapp-regs,-mno-app-regsโ-mapp-regscauses r2 and r5 to be used in the code generated by the compiler. This setting is the default ๐.-mno-app-regscauses 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 forswitchstatements 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, bestie โ retro icon behavior tbh ๐:
-munixโ do not output certain jump instructions ("aobleq"and so on) that the Unix assembler for the VAX cannot handle across long ranges ๐-mgnuโ do output those jump instructions, on the assumption that the GNU assembler is being used โจ-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 ๐. 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 librarieslibc.aandlibdebug.ato 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 librarieslibc.aandlibsim.ato 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 ๐ธ
โ ๏ธ Bestie listen:-msoft-floatchanges the calling convention in the output file. So it's only useful if you compile all of a program with this option. In particular, you need to compilelibgcc.aโ the library that comes with GCC โ with-msoft-floatin order for this to work ๐
-mcpu=cpu_typeโ set the instruction set, register set, and instruction scheduling parameters for machine type cpu_type ๐. Supported values for cpu_type aremcm,gr5andgr6.
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-mcpu=cpu_typewould ๐-msv-modeโ generate code for the supervisor mode, where there are no restrictions on access to general registers ๐. This is the default.-muser-modeโ generate code for the user mode, where 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 are32orshortfor 32 bit pointers,64orlongfor 64 bit pointers, andnofor 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 ๐ โ so go check those if you need the hardware-specific tea, bestie ๐
-mrtpโ ok so GCC can make code for both VxWorks kernels and real time processes (RTPs), and this option flips you from the first vibe to the second ๐ it also defines the preprocessor macro__RTP__, no cap.-msmpโ picks SMP runtimes for linking โจ heads up though: it's not available on architectures other than PowerPC, and it's also not available on VxWorks version 7 or later, because in those the selection is part of the VxWorks build configuration and the library paths are the same either way ๐ซถ-mvthreadsโ links against the VxWorks AE vThread runtime environment ๐-non-staticโ links an RTP executable against shared libraries instead of static ones ๐ธ the options-staticand-sharedcan also be used for RTPs, and-staticis the default (iykyk).-Bstatic,-Bdynamicโ these get passed straight down to the linker, bestie ๐ซ they exist for compatibility with Diab.-Xbind-lazyโ enables lazy binding of function calls ๐ฅ this one is equivalent to-Wl,-z,nowand is defined for compatibility with Diab.-Xbind-nowโ disables lazy binding of function calls ๐ this is the default, and yes, it's also defined for compatibility with Diab.
๐ฆ x86 Options ๐ฆ
This section is literally the whole -m catalogue for the x86 family of computers, so buckle up ๐ข
The following group of options lets you compile for one specific processor ๐
-march=cpu-typeโ generates instructions for the machine type cpu-type. And the difference matters, so listen: unlike-mtune=cpu-type, which merely tunes the generated code for the specified cpu-type,-march=cpu-typelets GCC generate code that may not run at all on processors other than the one indicated ๐ญ also, specifying-march=cpu-typeimplies-mtune=cpu-type, except where noted otherwise.
The choices for cpu-type are:
nativeโ picks the CPU to generate code for at compilation time by determining the processor type of the compiling machine ๐ง using-march=nativeenables all instruction subsets supported by the local machine (hence the result might not run on different machines, oops ๐); using-mtune=nativeproduces 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 cpu-type choices 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 that 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, so don't come for me).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 asgeneric.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; a low-power version of Intel Pentium III CPU with MMX, SSE, SSE2 and FXSR instruction set support ๐ซถ used by Centrino notebooks, iconic era fr.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 with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL and AVX-VNNI instruction set support. โจ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. ๐๐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. ๐ง
okay and now we're entering the AMD portion of the menu, bestie โ the classic lineup ๐
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โ CPUs based on AMD Family 15h cores with x86-64 instruction set support. SupersetsFMA4,AVX,XOP,LWP,AES,PCLMUL,CX16,MMX,SSE,SSE2,SSE3,SSE4A,SSSE3,SSE4.1,SSE4.2,ABMand 64-bit instruction set extensions. ok AMD era ๐bdver2โ AMD Family 15h core based CPUs with x86-64 instruction set support. SupersetsBMI,TBM,F16C,FMA,FMA4,AVX,XOP,LWP,AES,PCLMUL,CX16,MMX,SSE,SSE2,SSE3,SSE4A,SSSE3,SSE4.1,SSE4.2,ABMand 64-bit instruction set extensions.bdver3โ AMD Family 15h core based CPUs with x86-64 instruction set support. SupersetsBMI,TBM,F16C,FMA,FMA4,FSGSBASE,AVX,XOP,LWP,AES,PCLMUL,CX16,MMX,SSE,SSE2,SSE3,SSE4A,SSSE3,SSE4.1,SSE4.2,ABMand 64-bit instruction set extensions.bdver4โ AMD Family 15h core based CPUs with x86-64 instruction set support. SupersetsBMI,BMI2,TBM,F16C,FMA,FMA4,FSGSBASE,AVX,AVX2,XOP,LWP,AES,PCLMUL,CX16,MOVBE,MMX,SSE,SSE2,SSE3,SSE4A,SSSE3,SSE4.1,SSE4.2,ABMand 64-bit instruction set extensions. the "4" is not a vibe, it's a whole upgrade ๐ซถznver1โ AMD Family 17h core based CPUs with x86-64 instruction set support. SupersetsBMI,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. Zen has entered the chat โจznver2โ AMD Family 17h core based CPUs with x86-64 instruction set support. SupersetsBMI,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. SupersetsBMI,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. SupersetsBMI,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,GFNIand 64-bit instruction set extensions. the AVX512 wall of text, iconic ๐ญznver5โ AMD Family 1ah core based CPUs with x86-64 instruction set support. SupersetsBMI,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,PREFETCHIand 64-bit instruction set extensions.znver6โ AMD Family 1ah core based CPUs with x86-64 instruction set support. SupersetsBMI,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,AVX512BMMand 64-bit instruction set extensions. yes the list keeps growing, she ate and left no crumbs ๐ฅbtver1โ CPUs based on AMD Family 14h cores with x86-64 instruction set support. SupersetsMMX,SSE,SSE2,SSE3,SSSE3,SSE4A,CX16,ABMand 64-bit instruction set extensions.btver2โ CPUs based on AMD Family 16h cores with x86-64 instruction set support. This includesMOVBE,F16C,BMI,AVX,PCLMUL,AES,SSE4.2,SSE4.1,CX16,ABM,SSE4A,SSSE3,SSE3,SSE2,SSE,MMXand 64-bit instruction set extensions. (note: this one says "includes" not "supersets", keep that in mind bestie, the wording is doing its own thing ๐)winchip-c6โ IDT WinChip C6 CPU, dealt in same way asi486with additional MMX instruction set support.winchip2โ IDT WinChip 2 CPU, dealt in same way asi486with 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.) yes every single one of these says no scheduling, that's not me being lazy, that's literally what the page says ๐ซถ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,RDSEEDinstruction set support. While the CPUs do supportAVXandF16C, these aren't enabled by-march=lujiazuifor performance reasons.
โ ๏ธ ok that last bit is important bestie: the silicon can doAVXandF16C, but-march=lujiazuidoes not turn them on, and it's for performance reasons. not a bug, on purpose, don't @ me ๐
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,LZCNTinstruction 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,LZCNTinstruction set support. (yes it's the exact same list asyongfeng, no I'm not gaslighting you, that's how the page is written ๐)geodeโ AMD Geode embedded processor with MMX and 3DNow! instruction set support. embedded king ๐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,POPCNTinstruction 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,POPCNTinstruction 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,WBNOINVDinstruction set support. m7 said "let me add the whole AVX512 alphabet" ๐ญ๐ฅ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,WBNOINVDinstruction set support. (same energy asm7, and yeah, same list too โ the page just lists them separately, so I'm listing them separately ๐ธ)-mtune=cpu-typeโ tunes everything applicable about the generated code for cpu-type... except the ABI and the set of available instructions, bestie. Picking a specific cpu-type schedules things appropriately for that particular chip, but the compiler does not generate any code that can't run on the default machine type unless you also use a-march=cpu-typeoption. For example, if GCC is configured fori686-pc-linux-gnuthen-mtune=pentium4generates code that is tuned for Pentium 4 but still runs on i686 machines. ๐
The choices for cpu-type are the same as for -march. In addition, -mtune supports 2 extra choices for cpu-type:
genericโ produces code optimized for the most common IA32/AMD64/EM64T processors. If you know the CPU on which your code will run, then you should use the corresponding-mtuneor-marchoption instead of-mtune=generic. But if you do not know exactly what CPU users of your application will have, then you should use this option. ๐ซถ
As new processors are deployed in the marketplace, the behavior of this option will change. Therefore, if you upgrade to a newer version of GCC, code generation controlled by this option will change to reflect the processors that are most common at the time that version of GCC is released. (it's giving "living document", fr fr)
There is no -march=generic option because -march indicates the instruction set the compiler can use, and there is no generic instruction set applicable to all processors. In contrast, -mtune indicates the processor (or, in this case, collection of processors) for which the code is optimized. ๐ง
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 on which your code will run, then you should use the corresponding-mtuneor-marchoption instead of-mtune=intel. But, if you want your application performs better on both Diamond Rapids and Clearwater Forest, then you should use this option. โจ
As new Intel processors are deployed in the marketplace, the behavior of this option will change. Therefore, if you upgrade to a newer version of GCC, code generation controlled by this option will change to reflect the most current Intel processors at the time that version of GCC is released.
There is no -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 allow more detailed control over which instruction set extensions are targeted by GCC. Each has a corresponding -mno-option to disable use of these instructions. ๐
These extensions are also available as built-in functions: see x86 Built-in Functions, for details of the functions enabled and disabled by these switches.
These options enable GCC to use these extended instructions in generated code. Applications that perform run-time CPU detection must compile separate files for each supported architecture, using the appropriate flags. In particular, the file containing the CPU detection code should be compiled without these options. โ ๏ธ
To control whether 387 or SSE/AVX instructions are generated automatically for floating-point arithmetic, see -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.
Note that -msse4 enables both SSE4.1 and SSE4.2 support, while -mno-sse4 turns off those features; neither form of the option affects SSE4A support, 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. (retro era, honestly iconic)-m3dnowaโ support Athlon 3Dnow! built-in functions.-mpopcntโ support code generation ofpopcntinstruction.-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โ turns on VAES built-in functions and code generation ๐-mwaitpkgโ turns on WAITPKG built-in functions and code generation โจ-mvpclmulqdqโ turns on VPCLMULQDQ built-in functions and code generation-mmovdiriโ turns on MOVDIRI built-in functions and code generation-mmovdir64bโ turns on MOVDIR64B built-in functions and code generation-menqcmdโ turns on ENQCMD built-in functions and code generation-muintrโ turns on UINTR built-in functions and code generation-mtsxldtrkโ turns on TSXLDTRK built-in functions and code generation-mcldemoteโ turns on CLDEMOTE built-in functions and code generation-mserializeโ turns on SERIALIZE built-in functions and code generation ๐ธ-mamx-tileโ turns on AMX-TILE built-in functions and code generation-mamx-int8โ turns on AMX-INT8 built-in functions and code generation-mamx-bf16โ turns on AMX-BF16 built-in functions and code generation-mhresetโ turns on HRESET built-in functions and code generation-mklโ turns on KL built-in functions and code generation-mwideklโ turns on WIDEKL built-in functions and code generation-mcmpccxaddโ turns on MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and CMPCCXADD build-in functions and code generation. (yes, "build-in", the manpage said it like that, we're not touching it ๐ซถ)-mamx-fp16โ turns on AMX-FP16 built-in functions and code generation-mprefetchiโ turns on PREFETCHI built-in functions and code generation-mraointโ turns on RAOINT built-in functions and code generation-mamx-complexโ turns on AMX-COMPLEX built-in functions and code generation-msm3โ turns on MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and SM3 built-in functions and code generation-msm4โ turns on MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and SM4 built-in functions and code generation-msha512โ turns on MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and SHA512 built-in functions and code generation-mapxfโ turns on code generation for APX features, including EGPR, PUSH2POP2, NDD, PPX, NF, CCMP and ZU ๐ฅ-musermsrโ turns on USER_MSR built-in functions and code generation-mamx-avx512โ turns on MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX10.1, AVX10.2 and AMX-AVX512 built-in functions and code generation-mamx-tf32โ turns on AMX-TF32 built-in functions and code generation-mamx-fp8โ turns on AMX-FP8 built-in functions and code generation-mmovrsโ turns on MOVRS built-in functions and code generation-mamx-movrsโ turns on AMX-MOVRS built-in functions and code generation
So like, these additional options are available for the x86 processor family, bestie ๐
-mfpmath=unitโ generates floating-point arithmetic for whichever unit you pick. The choices for unit are, and I quote, the whole menu:387โ use the standard 387 floating-point coprocessor that's on the majority of chips and emulated otherwise. Code compiled with this option runs almost everywhere, iconic. The temporary results get computed in 80-bit precision instead of the precision the type actually specifies, so you get slightly different results compared to most other chips ๐. Peep-ffloat-storefor a more detailed description.
This is the default choice for non-Darwin x86-32 targets.
sseโ use scalar floating-point instructions present in the SSE instruction set. This instruction set is supported by Pentium III and newer chips, and on the AMD side by Athlon-4, Athlon XP and Athlon MP chips. The earlier version of the SSE instruction set supports only single-precision arithmetic, so double and extended-precision arithmetic are still done using 387. A later version, present only in Pentium 4 and AMD x86-64 chips, supports double-precision arithmetic too โจ
For the x86-32 compiler, you must use -march=cpu-type, -msse or -msse2 switches to enable SSE extensions and make this option actually effective. For the x86-64 compiler, these extensions are enabled by default, no cap.
The resulting code should be considerably faster in the majority of cases and avoid the numerical instability problems of 387 code, but may break some existing code that expects temporaries to be 80 bits ๐ญ
This is the default choice for the x86-64 compiler, Darwin x86-32 targets, and the default choice for x86-32 targets with the SSE2 instruction set when -ffast-math is enabled.
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 when needed.
sse,387sse+387bothโ attempt to utilize both instruction sets at once. This effectively doubles the amount of available registers, and on chips with separate execution units for 387 and SSE the execution resources too ๐ฅ Use this option with care though, because it is still experimental โ the GCC register allocator does not model separate functional units well, resulting in unstable performance ๐
-mieee-fp,-mno-ieee-fpโ control whether or not the compiler uses IEEE floating-point comparisons. These correctly handle the case where the result of a comparison is unordered ๐ซถ-m80387,-mhard-floatโ generate output containing 80387 instructions for floating point.-mno-80387,-msoft-floatโ generate output containing library calls for floating point.
Warning: the requisite libraries are not part of GCC. Normally the facilities of the machine's usual C compiler are used, but this cannot be done directly in cross-compilation. You must make your own arrangements to provide suitable library functions for cross-compilation ๐ฌ
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โ do not 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 is no FPU. The idea is that the operating system should emulate an FPU.
The option -mno-fp-ret-in-387 causes such values to be returned in ordinary CPU registers instead.
-mno-fancy-math-387โ some 387 emulators do not support thesin,cosandsqrtinstructions for the 387. Specify this option to avoid generating those instructions. This option is overridden when-marchindicates that the target CPU always has an FPU and so the instruction does not need emulation. These instructions are not generated unless you also use the-funsafe-math-optimizationsswitch ๐ธ-malign-double,-mno-align-doubleโ control whether GCC alignsdouble,long double, andlong longvariables on a two-word boundary or a one-word boundary. Aligningdoublevariables on a two-word boundary produces code that runs somewhat faster on a Pentium at the expense of more memory.
On x86-64, -malign-double is enabled by default.
Warning: if you use the -malign-double switch, structures containing the above types are aligned differently than the published application binary interface specifications for the x86-32 and are not binary compatible with structures in code compiled without that switch ๐
-m96bit-long-double,-m128bit-long-doubleโ these switches control the size oflong doubletype. The x86-32 application binary interface specifies the size to be 96 bits, so-m96bit-long-doubleis 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, this is 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 as its ABI specifies that long double is aligned on 16-byte boundary.
Notice that neither of these options enable any extra precision over the x87 standard of 80 bits for a long double.
Warning: if you override the default value for your target ABI, this changes the size of structures and arrays containinglong doublevariables, as well as modifying the function calling convention for functions takinglong 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 oflong doubletype. A size of 64 bits makes thelong doubletype equivalent to thedoubletype. This is the default for 32-bit Bionic C library. A size of 128 bits makes thelong doubletype equivalent to the__float128type. This is 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 containinglong doublevariables, as well as modifying the function calling convention for functions takinglong double. Hence they are not binary-compatible with code compiled without that switch ๐ซถ
-malign-data=typeโ control how GCC aligns variables. Supported values for type are:compatuses increased alignment value compatible with GCC 4.8 and earlier,abiuses alignment value as specified by the psABI, andcachelineuses increased alignment value to match the cache line size.compatis the default ๐-mlarge-data-threshold=thresholdโ when-mcmodel=mediumor-mcmodel=largeis specified, data objects larger than threshold are placed in large data sections. The default is65535.-mrtdโ use a different function-calling convention, in which functions that take a fixed number of arguments return with theret numinstruction, which pops their arguments while returning. This saves one instruction in the caller since there is no need to pop the arguments there ๐
You can specify that an individual function is called with this calling sequence with the function attribute stdcall. You can also override the -mrtd option by using the function attribute cdecl.
โ ๏ธ Warning: this calling convention is incompatible with the one normally used on Unix, so you literally cannot use it if you need to call libraries compiled with the Unix compiler. ngl that's a whole vibe killer ๐ญ
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. like, the compiler will just Guess Wrong and it's over ๐
In addition, seriously incorrect code results if you call a function with too many arguments. (Normally, extra arguments are harmlessly ignored. not here bestie ๐ซถ)
-mregparm=numโ controls how many registers get used to pass integer arguments. By default, zero 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 attributeregparm. ๐
โ ๏ธ 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. no mixing and matching, that's the rule โจ
-msseregparmโ use SSE register passing conventions forfloatanddoublearguments and return values. You can control this behavior for a specific function by using the function attributesseregparm. ๐ฆ
โ ๏ธ 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. same deal as above, everyone in the group chat has to agree ๐
-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. like it's giving legacy-support-only, don't reach for it casually ๐-mpc32,-mpc64,-mpc80โ set 80387 floating-point precision to 32, 64 or 80 bits. When-mpc32is specified, the significands of results of floating-point operations are rounded to 24 bits (single precision);-mpc64rounds the significands of results of floating-point operations to 53 bits (double precision) and-mpc80rounds 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. ๐ the way "catastrophic cancellation" is a real technical term and not just how my math homework feels
-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-optimizationsoptions normally link in startup code that sets these flags โ except when building a shared library (-shared). You can use the-mdaz-ftzand-mno-daz-ftzoptions to explicitly enable or disable setting these flags, regardless of other options passed to GCC. ๐ฅ explicit is the moment-mstackrealignโ realign the stack at entry. On the x86, the-mstackrealignoption 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 attributeforce_align_arg_pointer, applicable to individual functions. ๐ง-mstack-arg-probeโ emit stack probing code in the function prologue. lil' safety check, slay โจ-mpreferred-stack-boundary=numโ attempt to keep the stack boundary aligned to a 2 raised to num byte boundary. If-mpreferred-stack-boundaryis 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=3can 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 x87long doubleand__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. ๐ญ like please read this one twice fr fr
-mincoming-stack-boundary=numโ assume the incoming stack is aligned to a 2 raised to num byte boundary. If-mincoming-stack-boundaryis not specified, the one specified by-mpreferred-stack-boundaryis 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. small stack energy ๐
-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. it's literally the receipts ๐- *
-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. ๐ฅ okay so this one is devs-only, no cap โ you're off the tested path and that's a whole risk -mno-defaultโ this option instructs GCC to turn off all tunable features. See also-mtune-ctrl=feature-list and-mdump-tune-features. everything off, periodt ๐-mcldโ this option instructs GCC to emit acldinstruction 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-cldconfigure option. Generation ofcldinstructions can be suppressed with the-mno-cldcompiler option in this case. ๐ค some OSes really said "spec? never met her"-mvzeroupperโ this option instructs GCC to emit avzeroupperinstruction before a transfer of control flow out of the function to minimize the AVX to SSE transition penalty as well as remove unnecessaryzeroupperintrinsics. โจ smooth transitions only-mstv,-mno-stvโ enable/disable Scalar to Vectorization pass transforming 64-bit integer computation into vector ones. This optimization is restricted to-O2and higher. ๐ฆ-mprefer-avx128โ this option instructs GCC to use 128-bit AVX instructions instead of 256-bit AVX instructions in the auto-vectorizer. small and mighty ๐- *
-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-mathis 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-mathis in effect. These issues can be mitigated by manually sanitizing the upper part of the partial vector argument register or by using-mdaz-ftzto set denormals-are-zero (DAZ) flag in the MXCSR register. ๐ญ the "leaking into the upper part" imagery is giving contamination horror movie
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. ๐ซถ
And here's the lil' value rundown that shows up in this stretch:
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 optimizes functions that have thenoreturnattribute or the_Noreturnspecifier by not saving callee-saved registers in the function prologue that are used in the function (except theBPregister). It can interfere with debugging the caller of thenoreturnfunction or any function further up in the call stack, so it is not enabled by default. ๐-mcx16โ lets GCC generateCMPXCHG16Binstructions in 64-bit code to implement compare-and-exchange operations on 16-byte aligned 128-bit objects. This is useful for atomic updates of data structures exceeding one machine word in size. The compiler uses this instruction to implement__syncBuiltins. However, for__atomicBuiltins operating on 128-bit integers, a library call is always used. โจ-msahfโ enables generation ofSAHFinstructions in 64-bit code. Early Intel Pentium 4 CPUs with Intel 64 support, prior to the introduction of Pentium 4 G1 step in December 2005, lacked theLAHFandSAHFinstructions which are supported by AMD64. These are load and store instructions, respectively, for certain status flags. In 64-bit mode, theSAHFinstruction is used to optimizefmod,drem, andremainderbuilt-in functions; see Other Builtins for details. ๐ธ-mmovbeโ enables use of themovbeinstruction to optimize byte swapping of four and eight byte entities. ๐ฆ-mshstkโ enables shadow stack built-in functions from x86 Control-flow Enforcement Technology (CET). ๐ฅ-mcrc32โ enables built-in functions__builtin_ia32_crc32qi,__builtin_ia32_crc32hi,__builtin_ia32_crc32siand__builtin_ia32_crc32dito generate thecrc32machine instruction. โญ-mmwaitโ enables built-in functions__builtin_ia32_monitor, and__builtin_ia32_mwaitto generate themonitorandmwaitmachine instructions. ๐-mrecipโ this one enables use ofRCPSSandRSQRTSSinstructions (and their vectorized variantsRCPPSandRSQRTPS) with an additional Newton-Raphson step to increase precision instead ofDIVSSandSQRTSS(and their vectorized variants) for single-precision floating-point arguments.
These instructions are generated only when -funsafe-math-optimizations is enabled together with -ffinite-math-only and -fno-trapping-math. Note that while the throughput of the sequence is higher than the throughput of the non-reciprocal instruction, the precision of the sequence can be decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994). ๐ญ
Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS) already with -ffast-math (or the above option combination), and doesn't need -mrecip.
Also note that GCC emits the above sequence with additional Newton-Raphson step for vectorized single-float division and vectorized sqrtf(x) already with -ffast-math (or the above option combination), and doesn't need -mrecip.
-mrecip=optโ controls which reciprocal estimate instructions may be used.optis a comma-separated list of options, which may be preceded by a!to invert the option:allโ enable all estimate instructions.defaultโ enable the default instructions, equivalent to-mrecip.noneโ disable all estimate instructions, equivalent to-mno-recip.divโ enable the approximation for scalar division.vec-divโ enable the approximation for vectorized division.sqrtโ enable the approximation for scalar square root.vec-sqrtโ enable the approximation for vectorized square root.
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 fortypearesvmlfor the Intel short vector math library,aoclfor the math library (LibM) from AMD Optimizing CPU Libraries (AOCL) andacmlfor the end-of-life AMD core math library (to which AOCL-LibM is the successor). To use this option, both-ftree-vectorizeand-funsafe-math-optimizationshave to be enabled, and an SVML or ACML ABI-compatible library must be specified at link time.
GCC currently emits calls to these for the corresponding function type when -mveclibabi=svml is used:
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
vmlsAcos4
For the corresponding function type when -mveclibabi=aocl is used, it emits calls to:
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
And for the corresponding function type when -mveclibabi=acml is used, it emits calls to:
__vrd2_sin
__vrd2_cos
__vrd2_exp
__vrd2_log
__vrd2_log2
__vrd2_log10
__vrs4_sinf
__vrs4_cosf
__vrs4_expf
__vrs4_logf
__vrs4_log2f
__vrs4_log10f
__vrs4_powf
-mabi=nameโ generate code for the specified calling convention. Permissible values aresysvfor the ABI used on GNU/Linux and other systems, andmsfor 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 attributesms_abiandsysv_abi. ๐ซถ-masm=dialectโ output assembly instructions using selected dialect. Also affects which dialect is used for basicasmand extendedasm. Supported choices (in dialect order) areattorintel. The default isatt. Darwin does not supportintel. ๐-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. ๐ฅ-mmanual-endbrโ insert ENDBR instruction at function entry only via thecf_checkfunction attribute. This is useful when used with the option-fcf-protection=branchto control ENDBR insertion at the function entry. โจ-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. ๐-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-xloguesemits 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. ๐-mtls-dialect=typeโ generate code to access thread-local storage using thegnuorgnu2conventions.gnuis the conservative default;gnu2is more efficient, but it may add compile- and run-time requirements that cannot be satisfied on all systems. ๐ฆ-mpush-args,-mno-push-argsโ use PUSH operations to store outgoing parameters. This method is shorter and usually equally fast as method using SUB/MOV operations and is enabled by default. In some cases disabling it may improve performance because of improved scheduling and reduced dependencies. โญ-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. ๐ญ-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. ๐
okay so this behavior is enabled by default for Microsoft Windows targets, bestie ๐. This behavior can also be controlled locally by use of variable or type attributes. For more information, see the x86 Attributes section. โจ
The Microsoft structure layout algorithm is lowkey fairly simple, except the bit-field packing is giving chaos ๐ญ. The padding and alignment of members of structures and whether a bit-field can straddle a storage-unit boundary are determined by these rules:
- 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.
- 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
- 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, and this is where it gets spicy ๐ถ๏ธ:
- 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.
- 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,baris 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:
- If a zero-length bit-field follows a normal bit-field, the type of the zero-length bit-field may affect the alignment of the structure as a whole. For example,
t2has a size of 4 bytes, since the zero-length bit-field follows a normal bit-field, and is of typeshort. - 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.
- Zero-length bit-fields following non-bit-field members are ignored:
struct
{
char foo;
long : 0;
char bar;
} t5;
Here, t5 takes up 2 bytes.
-mno-align-stringopsโ Do not align the destination of inlined string operations. This switch reduces code size and improves performance in 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 at least a 4-byte boundary. This enables more inlining and increases code size, but may improve performance of code that depends on fastmemcpyandmemsetfor short lengths. The option enables inline expansion ofstrlenfor 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. ๐-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 i386repprefix 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_memcpyshould be inlined and what inline algorithm to use when the expected size of the copy operation is known. strategy is a comma-separated list ofalg:max_size:dest_aligntriplets. 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 is0for the first triplet andmax_size + 1of the preceding range. ๐ฅ-mmemset-strategy=strategyโ This option is similar to-mmemcpy-strategy=except that it controls the__builtin_memsetexpansion. ๐-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-pointerremoves the frame pointer for leaf functions, which might make debugging harder. ๐ญ-mtls-direct-seg-refs,-mno-tls-direct-seg-refsโ Controls whether TLS variables may be accessed with offsets from the TLS segment register (%gsfor 32-bit,%fsfor 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-mavxturns 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-mfentryand-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 themfentry-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 ofnoneto not instrument,callto generate a call to__return__, ornop5to generate a 5-byte nop sequence. This option only instruments true returns ending with aret, not sibling calls via a jump. ๐-mrecord-return,-mno-record-returnโ Generate a__return_locsection pointing to all return instrumentation code. โญ-mfentry-name=nameโ Set name of__fentry__symbol called at function entry for-pg -mfentryfunctions. ๐-mfentry-section=nameโ Set name of section to record-mrecord-mcountcalls. 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-setupcan 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 of0to255, 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 areglobalfor global canary ortlsfor per-thread canary in the TLS block (the default). This option has effect only when-fstack-protectoror-fstack-protector-allis 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โ when GCC is emitting a compare-and-swap loop for__syncBuiltins and__atomicBuiltins that donโt have a native instruction, this optimizes for the highly contended case by issuing an atomic load before theCMPXCHGinstruction, and using thePAUSEinstruction to save CPU power when restarting the loop. ๐-mindirect-branch=choiceโ convert indirect call and jump with choice. The default iskeep, which keeps indirect call and jump unmodified.thunkconverts indirect call and jump to call and return thunk.thunk-inlineconverts indirect call and jump to inlined call and return thunk.thunk-externconverts 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 attributeindirect_branch. ๐ซถ
Note that -mcmodel=large is incompatible with -mindirect-branch=thunk and -mindirect-branch=thunk-extern since the thunk function may not be reachable in the large code model. ๐ญ
Note that -mindirect-branch=thunk-extern is compatible with -fcf-protection=branch since the external thunk can be made to enable control-flow check. โจ
-mfunction-return=choiceโ convert function return with choice. The default iskeep, which keeps function return unmodified.thunkconverts function return to call and return thunk.thunk-inlineconverts function return to inlined call and return thunk.thunk-externconverts 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 attributefunction_return. ๐
Note that -mindirect-return=thunk-extern is compatible with -fcf-protection=branch since the external thunk can be made to enable control-flow check. ๐
Note that -mcmodel=large is incompatible with -mfunction-return=thunk and -mfunction-return=thunk-extern since the thunk function may not be reachable in the large code model. ๐
-mindirect-branch-registerโ force indirect call and jump via register. lowkey direct, ngl.-mharden-sls=choiceโ generate code to mitigate against straight line speculation (SLS) with choice. The default isnonewhich disables all SLS hardening.returnenables SLS hardening for function returns.indirect-jmpenables SLS hardening for indirect jumps.allenables all SLS hardening. ๐ก๏ธ-mindirect-branch-cs-prefixโ addCSprefix tocallandjmpto indirect thunk with branch target inr8-r15registers, so that thecallandjmpinstruction length is 6 bytes. This allows them to potentially be replaced withlfence; call *%r8-r15orlfence; jmp *%r8-r15at run time. โญ-mapx-inline-asm-use-gpr32โ by default, EGPR usage is disabled in inline asm constraints as GCC cannot be aware of whether the asm instructions support GP32 or not. If your inline asm can handle EGPR, use-mapx-inline-asm-use-gpr32. ๐ง-mgatherโ enable vectorization for gather instructions. ๐-mscatterโ enable vectorization for scatter instructions. ๐
These -m switches are supported in addition to the above on x86-64 processors in 64-bit environments. ๐
These next ones generate code for a 16-bit, 32-bit, or 64-bit environment:
-m32โ generate code for a 32-bit environment: setsint,long, and pointer types to 32 bits, and generates code that runs in 32-bit mode. ๐-m64โ generate code for a 64-bit environment: setsintto 32 bits andlongand pointer types to 64 bits, and generates code for the x86-64 architecture. For Darwin only the-m64option also turns off the-fno-picand-mdynamic-no-picoptions. ๐ฆ-mx32โ generate code for an x32 environment: setsint,long, and pointer types to 32 bits, and generates code for the x86-64 architecture. ๐ธ-m16โ the same as-m32, except for that it outputs the.code16gccassembly directive at the beginning of the assembly output so that the binary can run in 16-bit mode. ๐-miamcuโ the-miamcuoption generates code that conforms to Intel MCU psABI. It requires the-m32option to be turned on. ๐ฅ-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-zonedisables this red zone. ๐ซ-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. โจ-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. ๐ง-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-thresholdare put intolarge dataorBSSsections 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. ๐-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โ emitGNU_PROPERTY_X86_ISA_1_NEEDEDGNU property for Linux target to indicate the micro-architecture ISA level required to execute the binary. ๐ท๏ธ-mno-direct-extern-accessโ without-fpicor-fPIC, always use theGOTpointer to access external symbols. With-fpicor-fPIC, treat access to protected symbols as local symbols. The default is-mdirect-extern-access. ๐
โ ๏ธ Warning: shared libraries compiled with-mno-direct-extern-accessand executable compiled with-mdirect-extern-accessmay not be binary compatible if protected symbols are used in shared libraries and executable. ๐
-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-loopsor-funroll-all-loopsare either enabled or explicitly disabled. ๐-mdispatch-schedulerโ enable instruction scheduling. This is only supported onbdver1,bdver2,bdver3,bdver4, andznver1processors and additionally requires-fschedule-insns-fsched-pressure. ๐๏ธ-mlam=choiceโLAM(linear-address masking)allows special bits in the pointer to be used for metadata. The default isnone. Withu48, pointer bits in positions62:48can be used for metadata; Withu57, pointer bits in positions62:57can be used for metadata. ๐ง
๐ช x86 Windows Options
๐ฆ Xstormy16 Options
These options are defined for Xstormy16:
-msimโ choose startup files and linker script suitable for the simulator. ๐ฎ
๐ธ Xtensa Options
These options are supported for Xtensa targets:
-mconst16,-mno-const16โ enable or disable use ofCONST16instructions for loading constant values. When enabled,CONST16instructions are always used in place of the standardL32Rinstructions. The use ofCONST16is enabled by default only if theL32Rinstruction is not available. ๐งฉ-mserialize-volatile,-mno-serialize-volatileโ when this option is enabled, GCC insertsMEMWinstructions beforevolatilememory references to guarantee sequential consistency. The default is-mserialize-volatile. Use-mno-serialize-volatileto omit theMEMWinstructions. โก-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. ๐ง-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. ๐-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. ๐ง-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 likeLOOP, which the assembler always aligns, either by widening density instructions or by insertingNOPinstructions. ๐ฏ-mlongcalls,-mno-longcallsโ okay so when this one's turned on, GCC tells the assembler to turn direct calls into indirect calls unless it can prove the target of a direct call is inside the range the call instruction can actually reach ๐ฏ. This translation typically happens for calls to functions in other source files. Like, specifically: the assembler rewrites a directCALLinstruction into anL32Rfollowed by aCALLXinstruction. The default is-mno-longcalls. Use this in programs where the call target could potentially be out of range. Heads up though โ this option lives in the assembler, not the compiler ๐, so the assembly code GCC spits out still shows direct call instructionsโฆ you gotta look at the disassembled object code to see the actual instructions. And also, the assembler uses an indirect call for every cross-file call, not just the ones that are genuinely out of range. So it's giving "when in doubt, indirect" energy ๐-mabi=nameโ generates code for the specified ABI โจ. Permissible values are:call0,windowed. The default ABI is chosen by the Xtensa core configuration, iykyk.-mabi=call0โ with this one enabled, function parameters get passed in registersa2througha7, registersa12througha15are caller-saved, and registera15may be used as a frame pointer ๐. When this version of the ABI is enabled, the C preprocessor symbol__XTENSA_CALL0_ABI__is defined.-mabi=windowedโ with this one enabled, function parameters are passed in registersa10througha15, and the called function rotates the register window by 8 registers on entry so that its arguments are found in registersa2througha7๐. Registera7may be used as a frame pointer. The register window gets rotated 8 registers back upon return. When this version of the ABI is enabled, the C preprocessor symbol__XTENSA_WINDOWED_ABI__is defined.-mextra-l32r-costs=nโ specifies an extra cost of instruction RAM/ROM access forL32Rinstructions, measured in clock cycles โฑ๏ธ. When you're optimizing for speed, this affects whether a constant gets loaded from the literal pool usingL32R, or synthesized from a small one with a couple of arithmetic instructions. The default value is0.-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-alignfor cores that support both unaligned loads and stores in hardware, and-mstrict-alignfor all other cores. Choose wisely bestie ๐
๐ฆ zSeries Options ๐ฆ
These are listed under
โฆand that's literally it, that's the whole thing ๐ญ the page just drops you there mid-sentence, main character cliffhanger energy, fr fr. More is coming in the next part, don't panic ๐ซถ
๐ธ ENVIRONMENT ๐ธ
Okay bestie, this section is literally the โจvibes layerโจ of GCC โ the environment variables that change how it behaves. Some of them just point at directories or prefixes to search when looking for files. Others tweak whole other aspects of your compilation environment. Slay.
Heads up though ๐ โ you can also tell GCC where to look with options like-B,-Iand-L, and those take precedence over anything you set with environment variables. Env vars in turn beat whatever GCC's configuration says. That's the hierarchy, periodt.
๐ LANG, LC_CTYPE, LC_MESSAGES, LC_ALL
These four control how GCC uses localization info, so it can vibe with different national conventions for diagnostic and informational output. GCC looks at the locale categories LC_CTYPE and LC_MESSAGES if it's been configured to do that. Those categories can be set to literally any value your installation supports โ a very typical one is en_GB.UTF-8 for English in the United Kingdom encoded in UTF-8. ๐ฌ๐งโจ
If LC_ALL is set, it overrides the value of LC_CTYPE and LC_MESSAGES. If it isn't, then LC_CTYPE and LC_MESSAGES default to the value of LANG. And if none of these variables are set at all? GCC falls back to traditional C English behavior. iconic honestly.
Lowkey important ๐: these environment variables do not affect the encodings of input files and strings in output files produced by GCC โ those are controlled by the-finput-charsetand-fexec-charsetoptions respectively. Different thing entirely, okurr.
๐๏ธ TMPDIR
If TMPDIR is set, it says which 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. Passing notes between stages, we love to see it. ๐
๐ฉบ GCC_DIAGNOSTICS_LOG
If GCC_DIAGNOSTICS_LOG is set, extra information about the diagnostics subsystem gets emitted. Set it to an empty value and that info goes to stderr; otherwise GCC will attempt to open that file and write the information there.
The precise content and format of that info is subject to change โ it's intended for GCC developers, not end-users. So like, not your business unless you're built different. ๐
๐ GCC_COMPARE_DEBUG
Setting GCC_COMPARE_DEBUG is nearly equivalent to passing -fcompare-debug to the compiler driver. Peep that option's documentation for the full details, bestie.
๐งฌ GCC_EXEC_PREFIX
If GCC_EXEC_PREFIX is set, it specifies a prefix to use in the names of the subprograms executed by the compiler. No slash is added when this prefix is combined with a subprogram's name, but you can specify a prefix ending with a slash if you wish. Your call, main character.
If GCC_EXEC_PREFIX isn't set, GCC tries to figure out an appropriate prefix based on the pathname it was invoked with.
If GCC can't find the subprogram using the specified prefix, it tries looking in the usual places instead. Fallback queen. ๐
The default value of GCC_EXEC_PREFIX is prefix/lib/gcc/ where prefix is the prefix of the installed compiler. In many cases prefix is the value of "prefix" when you ran the configure script.
Other prefixes specified with -B take precedence over this prefix.
This prefix is also used for finding files like crt0.o that get used for linking.
And in addition โ this is the quirky part โ the prefix is used in an unusual way when finding 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. So with -Bfoo/, GCC searches foo/bar just before it searches the standard directory /usr/local/lib/bar. And 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. Wilder than my group chat ๐ญ
๐งญ COMPILER_PATH
The value of COMPILER_PATH is a colon-separated list of directories, much like PATH. GCC tries those directories when searching for subprograms, if it can't 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 can't 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. No cutting the line, -L. ๐
๐ฌ GCC_EXTRA_DIAGNOSTIC_OUTPUT
If GCC_EXTRA_DIAGNOSTIC_OUTPUT is set to one of the following values, extra text gets emitted to stderr when fix-it hints are emitted. And just so you know: -fdiagnostics-parseable-fixits and -fno-diagnostics-parseable-fixits take precedence over this environment variable. Options always win, that's the rule.
fixits-v1
Emit parseable fix-it hints, equivalent to -fdiagnostics-parseable-fixits. In particular, columns are expressed as a count of bytes, starting at byte 1 for the initial column.
fixits-v2
Same as fixits-v1, but columns are expressed as display columns, as per -fdiagnostics-column-unit=display.
๐ EXPERIMENTAL_SARIF_SOCKET
If EXPERIMENTAL_SARIF_SOCKET is set in the environment, 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. Fancy networking behaviour, we stan. ๐ฆ
The compiler will fail immediately if EXPERIMENTAL_SARIF_SOCKET is set and it cannot connect to it. No chill, no retry.
โ ๏ธ This feature is experimental and subject to change or removal without notice. Do not build your whole personality on it, bestie.
Some additional environment variables affect the behavior of the preprocessor. Yes, there's more. Buckle up. ๐
๐ 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. That special character, "PATH_SEPARATOR", is target-dependent and determined at GCC build time. For Microsoft Windows-based targets it's a semicolon, and for almost all other targets it's a colon.
CPATH specifies a list of directories to be searched as if specified with -I, but after any paths given with -I options on the command line. This environment variable gets used regardless of which language is being preprocessed.
The remaining environment variables apply only when preprocessing the particular language indicated. Each specifies a list of directories to be searched as if specified with -isystem, but after any paths given with -isystem options on the command line.
In all these variables, an empty element tells 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. See how that works? lil empty string doing so much ๐
๐ฆ DEPENDENCIES_OUTPUT
If this variable is set, its value specifies how to output dependencies for Make based on the non-system header files processed by the compiler. System header files are ignored in the dependency output. Not invited to the party, sorry.
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. Combo move! ๐ฅ
โ๏ธ SUNPRO_DEPENDENCIES
This variable is the same as DEPENDENCIES_OUTPUT (see above), except that system header files are not ignored, so it implies -M rather than -MM. However, the dependence on the main input file is omitted.
โฐ SOURCE_DATE_EPOCH
If this variable is set, its value specifies a UNIX timestamp to be used in replacement of the current date and time in the __DATE__ and __TIME__ macros, so that the embedded timestamps become reproducible. Reproducible builds are so iconic, no cap.
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. Like, don't just make one up, bestie. ๐ซถ
๐ BUGS ๐
For instructions on reporting bugs, see <https://gcc.gnu.org/bugs/>. Go off, file that report, the devs literally want to hear it.
๐ FOOTNOTES ๐
- On some systems,
gcc -sharedneeds to build supplementary stub code for constructors to work. On multi-libbed systems,gcc -sharedmust 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. Also โ and this is the spicy part โ-sharedsuppresses the addition of startup code to alter the floating-point environment as done with-ffast-math,-Ofastor-funsafe-math-optimizationson some targets. Okay? Okay. ๐ง
๐ SEE ALSO ๐
gpl(7), gfdl(7), fsf-funding(7), cpp(1), gcov(1), as(1), ld(1), gdb(1) โ and the Info entries for gcc, cpp, as, ld, binutils and gdb. The whole friend group fr fr. ๐
๐ AUTHOR ๐
See the Info entry for gcc, or <https://gcc.gnu.org/onlinedocs/gcc/Contributors.html>, for contributors to GCC. The contributors are the main characters here, honestly.
๐ COPYRIGHT ๐
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.
Okay that's the whole page, bestie โ you made it to the very end, which is genuinely a flex. ๐ซถ This lil masterpiece is gcc-16.2.0, dated 2026-08-07, and it's giving documentation royalty. Now go compile something and slay. ๐
โจ๐
๐ฆ where this page comes from
- arch rolling: loongarch64-linux-gnu-gcc 16.2.0-1 ยท GPL-3.0-or-later WITH GCC-exception-3.1 AND GFDL-1.3-or-later
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms