GCC(1)
โจ gcc(1) โ GNU โ GCC(1) โจ
okay bestie, listen up ๐ you've opened the manual page for gcc, and yes it is long, but we're gonna get through it together. this is gcc(1) from the GNU crew, and it's about to be your whole personality. grab a matcha ๐ต, we're doing this.
๐ธ NAME ๐ธ
gcc โ the GNU project C and C++ compiler ๐ซถ
๐ SYNOPSIS ๐
here's the whole vibe in one glance:
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 literally only the most useful options are listed up there โ the rest of them are further down, and there are so many. alsog++accepts mostly the same options asgcc, so if you're a C++ girlie you're still in the right place ๐
๐ฆ DESCRIPTION ๐ฆ
so when you invoke GCC, it normally does preprocessing, compilation, assembly and linking. that's four whole stages, she's busy. the "overall options" let you stop this process at an intermediate stage. for example, the -c option says not to run the linker. then the output consists of object files output by the assembler. slay ๐
other options get passed on to one or more stages of processing. some options control the preprocessor and others control the compiler itself. and then yet other options control the assembler and linker โ most of these are not documented here, since you rarely need to use any of them. lowkey a relief ngl.
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. so if the description for a particular option does not mention a source language, you can use that option with all supported languages. no cap ๐ซถ
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. yes queen, use the right name ๐
the gcc program accepts options and file names as operands. many options have multi-letter names; therefore multiple single-letter options may not be grouped: -dv is very different from -d -v. like, they are not the same girl, do not conflate them ๐ญ
you can mix options and other arguments. for the most part, the order you use doesn't matter. but โ and this is the plot twist โ 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. remember that bestie ๐
many options have long names starting with -f or with -W---for example, -fmove-loop-invariants, -Wformatand so on. most of these have both positive and negative forms; the negative form of-ffoois-fno-foo`. this manual documents only one of these two forms, whichever one is not the default. so if you're like "where's the other one??" โ that's why ๐
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. yes, she's citing standards, she's that girl ๐โจ
๐ OPTIONS ๐
๐ Option Summary ๐
here is a summary of all the options, grouped by type. the explanations are in the following sections, so don't panic โ this is just the map, not the whole road trip ๐บ๏ธ
โญ Overall Options โญ
-c-S-E-o file-x language-v-###--help[=class[,...]]--target-help--version-pass-exit-codes-pipe-specs=file-wrapper @file-ffile-prefix-map=old=new-fplugin=file-fplugin-arg-name=arg-fdump-ada-spec[-slim]-fada-spec-parent=unit-fdump-go-spec=file
โญ C Language Options โญ
-ansi-std=standard-fgnu89-inline-fpermitted-flt-eval-methods=standard-aux-info filename-fallow-parameterless-variadic-functions-fno-asm-fno-builtin-fno-builtin-function-fgimple-fhosted-ffreestanding-fopenacc-fopenacc-dim=geom-fopenmp-fopenmp-simd-fms-extensions-fplan9-extensions-fsso-struct=endianness-fallow-single-precision-fcond-mismatch-flax-vector-conversions-fsigned-bitfields-fsigned-char-funsigned-bitfields-funsigned-char
โญ C++ Language Options โญ
-fabi-version=n-fno-access-control-faligned-new=n-fargs-in-order=n-fchar8_t-fcheck-new-fconstexpr-depth=n-fconstexpr-loop-limit=n-fconstexpr-ops-limit=n-fno-elide-constructors-fno-enforce-eh-specs-fno-gnu-keywords-fno-implicit-templates-fno-implicit-inline-templates-fno-implement-inlines-fms-extensions-fnew-inheriting-ctors-fnew-ttp-matching-fno-nonansi-builtins-fnothrow-opt-fno-operator-names-fno-optional-diags-fpermissive-fno-pretty-templates-frepo-fno-rtti-fsized-deallocation-ftemplate-backtrace-limit=n-ftemplate-depth=n-fno-threadsafe-statics-fuse-cxa-atexit-fno-weak-nostdinc++-fvisibility-inlines-hidden-fvisibility-ms-compat-fext-numeric-literals-Wabi=n-Wabi-tag-Wconversion-null-Wctor-dtor-privacy-Wdelete-non-virtual-dtor-Wdeprecated-copy-Wdeprecated-copy-dtor-Wliteral-suffix-Wmultiple-inheritance-Wno-init-list-lifetime-Wnamespaces-Wnarrowing-Wpessimizing-move-Wredundant-move-Wnoexcept-Wnoexcept-type-Wclass-memaccess-Wnon-virtual-dtor-Wreorder-Wregister-Weffc++-Wstrict-null-sentinel-Wtemplates-Wno-non-template-friend-Wold-style-cast-Woverloaded-virtual-Wno-pmf-conversions-Wno-class-conversion-Wno-terminate-Wsign-promo-Wvirtual-inheritance
โญ 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-protocol-Wselector-Wstrict-selector-match-Wundeclared-selector
โญ Diagnostic Message Formatting Options โญ
-fmessage-length=n-fdiagnostics-show-location=[once|every-line]-fdiagnostics-color=[auto|never|always]-fdiagnostics-format=[text|json]-fno-diagnostics-show-option-fno-diagnostics-show-caret-fno-diagnostics-show-labels-fno-diagnostics-show-line-numbers-fdiagnostics-minimum-margin-width=width-fdiagnostics-parseable-fixits-fdiagnostics-generate-patch-fdiagnostics-show-template-tree-fno-elide-type-fno-show-column
okay that's the whole cheat sheet ๐ and bestie, this is only part one โ the actual lore for every single one of these bad boys is coming right up, so don't go anywhere ๐โจ
๐ Warning Options ๐
okay bestie, this is the roll call ๐ โ literally every warning flag GCC has in it. this is the guest list, the seating chart, the whole vibe. the actual tea about what each one does lives further down the page, so don't come for me about detail here. the flags are written exactly as they are, no notes. ๐
-fsyntax-onlyโ vibe check on the syntax and only the syntax. nothing else happens, bestie.-fmax-errors=nโ cap it at n errors. after that, we're done here. โ-Wpedanticโ the hall monitor of flags. pedantic to the max.-pedantic-errorsโ pedantic, but make it an error. ๐-wโ lowercase. just lowercase. it is not-Walland it never will be. ๐-Wextraโ extra. like, extra extra. โจ-Wallโ the moment. the icon. the one everyone screams at newbies to use.-Waddressโ addresses, babes.-Waddress-of-packed-memberโ the address of a packed member. very specific, very demure.-Waggregate-returnโ aggregates being returned. okay!-Waligned-newโ aligned new. ๐-Walloc-zeroโ alloc zero, no cap.-Walloc-size-larger-than=byte-sizeโ alloc size larger than byte-size. the number is right there.-Wallocaโ alloca!! it has its own flag and everything.-Walloca-larger-than=byte-sizeโ alloca, but bigger than byte-size.-Wno-aggressive-loop-optimizationsโ the-Wno-version. aggressive loop optimizations said not today.-Warray-boundsโ array bounds. stay in your lane, arrays. ๐ฆ-Warray-bounds=nโ same energy, but at level n.-Wno-attributesโ attributes? not today.-Wattribute-alias=nโ attribute alias at level n.-Wbool-compareโ comparing bools. iconic behaviour, honestly.-Wbool-operationโ bool operations. ๐-Wno-builtin-declaration-mismatchโ builtin declaration mismatch? we're turning that off, bestie.-Wno-builtin-macro-redefinedโ same but for a redefined builtin macro. ๐-Wc90-c99-compatโ c90 โ c99 compatibility tea.-Wc99-c11-compatโ c99 โ c11 compatibility tea.-Wc11-c2x-compatโ c11 โ c2x compatibility tea.-Wc++-compatโ c++ compatibility. the crossover episode.-Wc++11-compatโ c++11 compatibility.-Wc++14-compatโ c++14 compatibility.-Wc++17-compatโ c++17 compatibility.-Wcast-alignโ cast alignment. ๐ธ-Wcast-align=strictโ cast alignment but make it strict.-Wcast-function-typeโ cast function type, as one does.-Wcast-qualโ cast qualifiers. qualifiers are precious, apparently.-Wchar-subscriptsโ char subscripts. ๐-Wcatch-valueโ catch value.-Wcatch-value=nโ catch value, level n.-Wclobberedโ clobbered. that's it, that's the flag.-Wcommentโ comments. yes, comments have a flag.-Wconditionally-supportedโ conditionally supported. the "it depends" of flags. ๐ซ-Wconversionโ conversions. ๐-Wcoverage-mismatchโ coverage mismatch. the coverage is not covering.-Wno-cppโ cpp said no thank you.-Wdangling-elseโ dangling else, living on the edge. ๐ญ-Wdate-timeโ date and time macros. time is a construct, bestie. โฐ-Wdelete-incompleteโ delete incomplete. rude, honestly.-Wno-attribute-warningโ attribute warning, off.-Wno-deprecatedโ deprecated stuff, we're ignoring you. ๐-Wno-deprecated-declarationsโ deprecated declarations, also ignoring you.-Wno-designated-initโ designated init, off.-Wdisabled-optimizationโ disabled optimization. the optimizations are NOT optimizing.-Wno-discarded-qualifiersโ discarded qualifiers, ignored.-Wno-discarded-array-qualifiersโ discarded array qualifiers, also ignored.-Wno-div-by-zeroโ divide by zero. we're not talking about it. ๐-Wdouble-promotionโ double promotion!! get it, girl. ๐-Wduplicated-branchesโ duplicated branches. copy-paste behaviour detected.-Wduplicated-condโ duplicated conditions.-Wempty-bodyโ empty body. no thoughts, head empty.-Wenum-compareโ enum compare.-Wno-endif-labelsโ endif labels, off.-Wexpansion-to-definedโ expansion to defined. ๐ค-Werrorโ every warning becomes an error. no mercy, no chill. ๐ฅ-Werror=*โ the same, but scoped to*.-Wextra-semiโ extra semicolons. one too many, bestie.;;-Wfatal-errorsโ fatal errors. dramatic and correct.-Wfloat-equalโ floats being compared for equality. spicy.-Wformatโ format.-Wformat=2โ format, but at level 2. โจ-Wno-format-contains-nulโ format contains nul, off.-Wno-format-extra-argsโ format extra args, off.-Wformat-nonliteralโ format nonliteral.-Wformat-overflow=nโ format overflow at level n.-Wformat-securityโ format security. lock it down. ๐-Wformat-signednessโ format signedness.-Wformat-truncation=nโ format truncation at level n.-Wformat-y2kโ format y2k. the year 2000 called. ๐-Wframe-addressโ frame address.-Wframe-larger-than=byte-sizeโ frame larger than byte-size. keep it cute and small.-Wno-free-nonheap-objectโ free nonheap object, off.-Wjump-misses-initโ jump misses init. rude jump.-Whsaโ hsa. three letters, whole vibe. ๐-Wif-not-alignedโ if not aligned.-Wignored-qualifiersโ ignored qualifiers. they're being ignored, which is the whole problem.-Wignored-attributesโ ignored attributes.-Wincompatible-pointer-typesโ incompatible pointer types. they're not compatible, bestie. ๐-Wimplicitโ implicit. the sneaky one.-Wimplicit-fallthroughโ implicit fallthrough. falling through, metaphorically.-Wimplicit-fallthrough=nโ same, at level n.-Wimplicit-function-declarationโ implicit function declaration.-Wimplicit-intโ implicit int.-Winit-selfโ init self. ๐ช-Winlineโ inline.-Wno-int-conversionโ int conversion, off.-Wint-in-bool-contextโ an int where a bool belongs. ๐ซ-Wno-int-to-pointer-castโ int to pointer cast, off.-Winvalid-memory-modelโ invalid memory model. the model is not modelling.-Wno-invalid-offsetofโ invalidoffsetof, off.-Winvalid-pchโ invalid pch.-Wlarger-than=byte-sizeโ larger than byte-size.-Wlogical-opโ logical op.-Wlogical-not-parenthesesโ logical not + parentheses. the drama. ๐ญ-Wlong-longโ long long. two longs, one flag. โ๏ธ-Wmainโ main!! the main character gets a flag. ๐-Wmaybe-uninitializedโ maybe uninitialized. it's giving uncertainty.-Wmemset-elt-sizeโ memset element size.-Wmemset-transposed-argsโ memset transposed args. the args got swapped, bestie. ๐-Wmisleading-indentationโ misleading indentation. the indentation is LYING to you. ๐ญ-Wmissing-attributesโ missing attributes.-Wmissing-bracesโ missing braces. where did they go.-Wmissing-field-initializersโ missing field initializers.-Wmissing-format-attributeโ missing format attribute.-Wmissing-include-dirsโ missing include dirs. the folder is GONE.-Wmissing-noreturnโ missing noreturn.-Wmissing-profileโ missing profile.-Wno-multicharโ multichar, off.-Wmultistatement-macrosโ multistatement macros.-Wnonnullโ nonnull.-Wnonnull-compareโ nonnull compare.-Wnormalized=[none|id|nfc|nfkc]โ normalized, and the choices arenone,id,nfc,nfkc. pick your fighter. ๐-Wnull-dereferenceโ null dereference. we do NOT do that here. ๐-Wodrโ odr. three letters, no context, go off.-Wno-overflowโ overflow, off.-Wopenmp-simdโ openmp simd.-Woverride-init-side-effectsโ override init side effects. ๐-Woverlength-stringsโ overlength strings. too long, didn't read.-Wpackedโ packed.-Wpacked-bitfield-compatโ packed bitfield compat.-Wpacked-not-alignedโ packed but not aligned. ๐ซ-Wpaddedโ padded. extra cushion. ๐๏ธ-Wparenthesesโ the parentheses police. show your work. ๐จ-Wno-pedantic-ms-formatโ pedantic ms format, off.-Wplacement-newโ placement new.-Wplacement-new=nโ placement new at level n.-Wpointer-arithโ pointer arithmetic.-Wpointer-compareโ pointer compare.-Wno-pointer-to-int-castโ pointer to int cast, off.-Wno-pragmasโ pragmas, off.-Wno-prio-ctor-dtorโ prio ctor dtor, off.-Wredundant-declsโ redundant declarations. we heard you the first time. ๐-Wrestrictโ restrict.-Wno-return-local-addrโ return local addr, off.-Wreturn-typeโ return type.-Wsequence-pointโ sequence point.-Wshadowโ shadow. spooky. ๐-Wno-shadow-ivarโ shadow ivar, off.-Wshadow=globalโ shadow, global flavour.-Wshadow=localโ shadow, local flavour.-Wshadow=compatible-localโ shadow, compatible-local flavour.-Wshift-overflowโ shift overflow.-Wshift-overflow=nโ shift overflow at level n.-Wshift-count-negativeโ shift count negative. negative counts, negative vibes.-Wshift-count-overflowโ shift count overflow.-Wshift-negative-valueโ shift negative value.-Wsign-compareโ sign compare.-Wsign-conversionโ sign conversion.-Wfloat-conversionโ float conversion.-Wno-scalar-storage-orderโ scalar storage order, off.-Wsizeof-pointer-divโsizeofpointer div. ๐-Wsizeof-pointer-memaccessโsizeofpointer memaccess.-Wsizeof-array-argumentโsizeofarray argument.-Wstack-protectorโ stack protector. protect the stack at all costs. ๐ก๏ธ-Wstack-usage=byte-sizeโ stack usage of byte-size.-Wstrict-aliasingโ strict aliasing.-Wstrict-aliasing=nโ strict aliasing at level n.-Wstrict-overflowโ strict overflow.-Wstrict-overflow=nโ strict overflow at level n.-Wstringop-overflow=nโ stringop overflow at level n.-Wstringop-truncationโ stringop truncation.-Wsubobject-linkageโ subobject linkage.-Wsuggest-attribute=[pure|const|noreturn|format|malloc]โ suggest an attribute, and the menu ispure,const,noreturn,format,malloc. order up. ๐ฝ๏ธ-Wsuggest-final-typesโ suggest final types.-Wsuggest-final-methodsโ suggest final methods.-Wsuggest-overrideโ suggest override.-Wswitchโ switch.-Wswitch-boolโ switch bool.-Wswitch-defaultโ switch default.-Wswitch-enumโ switch enum.-Wswitch-unreachableโ switch unreachable.-Wsync-nandโ sync nand.-Wsystem-headersโ system headers. yes, those ones.-Wtautological-compareโ tautological compare. it's true because it's true. ๐-Wtrampolinesโ trampolines. bouncing. ๐คธ-Wtrigraphsโ trigraphs. the ancient ones.-Wtype-limitsโ type limits.-Wundefโ undef.-Wuninitializedโ uninitialized. it has no value, literally.-Wunknown-pragmasโ unknown pragmas.-Wunsuffixed-float-constantsโ unsuffixed float constants.-Wunusedโ unused. the umbrella of "girl, you're not using that."-Wunused-functionโ unused function.-Wunused-labelโ unused label.-Wunused-local-typedefsโ unused local typedefs.-Wunused-macrosโ unused macros.-Wunused-parameterโ unused parameter. the classic.-Wno-unused-resultโ unused result, off.-Wunused-valueโ unused value.-Wunused-variableโ unused variable.-Wunused-const-variableโ unused const variable.-Wunused-const-variable=nโ unused const variable at level n.-Wunused-but-set-parameterโ unused but set parameter. set and then... nothing. ๐ญ-Wunused-but-set-variableโ unused but set variable.-Wuseless-castโ useless cast. it did nothing. it served no purpose. ๐-Wvariadic-macrosโ variadic macros.-Wvector-operation-performanceโ vector operation performance. performance!! ๐-Wvlaโ vla.-Wvla-larger-than=byte-sizeโ vla larger than byte-size.-Wvolatile-register-varโ volatile register var.-Wwrite-stringsโ write strings.-Wzero-as-null-pointer-constantโ zero as null pointer constant. bestie. no. ๐
๐ธ C and Objective-C-only Warning Options ๐ธ
these ones are exclusive โ C and Objective-C only, no plus-plus girlies allowed. ๐
-Wbad-function-castโ bad function cast.-Wmissing-declarationsโ missing declarations.-Wmissing-parameter-typeโ missing parameter type.-Wmissing-prototypesโ missing prototypes.-Wnested-externsโ nested externs.-Wold-style-declarationโ old style declaration. vintage. ๐ฐ๏ธ-Wold-style-definitionโ old style definition. also vintage.-Wstrict-prototypesโ strict prototypes.-Wtraditionalโ traditional. the ancestors are watching. ๐ฏ๏ธ-Wtraditional-conversionโ traditional conversion.-Wdeclaration-after-statementโ declaration after statement. order matters, bestie.-Wpointer-signโ pointer sign.
๐ฆ Debugging Options ๐ฆ
this is the debug section, aka the "why is my code like this" toolkit. โจ
-gโ the classic. debugging said let there be light.-glevelโ-gwith a level attached.-gdwarfโ dwarf format.-gdwarf-versionโ dwarf, but you pick the version.-ggdbโ g, but gdb-flavoured.-grecord-gcc-switchesโ record those gcc switches. for the archives. ๐-gno-record-gcc-switchesโ don't record them. mind your business.-gstabsโ stabs.-gstabs+โ stabs, plus. โ-gstrict-dwarfโ strict dwarf. be strict about it.-gno-strict-dwarfโ no strict dwarf. loosen up.-gas-loc-supportโ as loc support.-gno-as-loc-supportโ as loc support, but no.-gas-locview-supportโ as locview support.-gno-as-locview-supportโ as locview support, but no.-gcolumn-infoโ column info. columns!! ๐-gno-column-infoโ column info, but no.-gstatement-frontiersโ statement frontiers. the wild west of statements. ๐ค-gno-statement-frontiersโ no frontiers here.-gvariable-location-viewsโ variable location views.-gno-variable-location-viewsโ variable location views, off.-ginternal-reset-location-viewsโ internal reset location views.-gno-internal-reset-location-viewsโ internal reset location views, off.-ginline-pointsโ inline points.-gno-inline-pointsโ inline points, off.-gvmsโ vms.-gxcoffโ xcoff.-gxcoff+โ xcoff, plus. โ-gz[=type]โ z, optionally with a type.-gsplit-dwarfโ split dwarf. dwarf, divided. ๐-gdescribe-diesโ describe dies.-gno-describe-diesโ describe dies, but no.-fdebug-prefix-map=old=newโ debug prefix map, mapping old to new. exactly those two.-fdebug-types-sectionโ debug types section.-fno-eliminate-unused-debug-typesโ don't eliminate unused debug types.-femit-struct-debug-baseonlyโ emit struct debug, base only.-femit-struct-debug-reducedโ emit struct debug, reduced.-femit-struct-debug-detailed[=spec-list]โ emit struct debug, detailed, optionally with a spec-list.-feliminate-unused-debug-symbolsโ eliminate unused debug symbols.-femit-class-debug-alwaysโ emit class debug, always. ALWAYS. ๐ฅ-fno-merge-debug-stringsโ don't merge debug strings.-fno-dwarf2-cfi-asmโ no dwarf2 cfi asm.-fvar-trackingโ var tracking. we're tracking the variables. ๐-fvar-tracking-assignmentsโ var tracking, but the assignments.
๐ฅ Optimization Options ๐ฅ
the optimization section, bestie. this is where GCC goes feral trying to make your code fast. all the -O levels are at the very bottom like the finale they are. ๐
-faggressive-loop-optimizationsโ aggressive. it said what it said.-falign-functions[=n[:m:[n2[:m2]]]]โ align functions, and yes the nesting isn,m,n2,m2. nested like matryoshka dolls. ๐ช-falign-jumps[=n[:m:[n2[:m2]]]]โ align jumps, same nesting situation.-falign-labels[=n[:m:[n2[:m2]]]]โ align labels, same nesting situation.-falign-loops[=n[:m:[n2[:m2]]]]โ align loops, same nesting situation.-fassociative-mathโ associative math.-fauto-profileโ auto profile.-fauto-profile[=path]โ auto profile, optionally at a path.-fauto-inc-decโ auto inc dec.-fbranch-probabilitiesโ branch probabilities.-fbranch-target-load-optimizeโ branch target load optimize.-fbranch-target-load-optimize2โ the sequel. ๐ฌ-fbtr-bb-exclusiveโ btr bb exclusive. very exclusive, apparently. ๐๏ธ-fcaller-savesโ caller saves.-fcombine-stack-adjustmentsโ combine stack adjustments.-fconserve-stackโ conserve stack. save the stack!! ๐ฑ-fcompare-elimโ compare elim.-fcprop-registersโ cprop registers.-fcrossjumpingโ crossjumping.-fcse-follow-jumpsโ cse follow jumps.-fcse-skip-blocksโ cse skip blocks.-fcx-fortran-rulesโ cx fortran rules.-fcx-limited-rangeโ cx limited range.-fdata-sectionsโ data sections.-fdceโ dce.-fdelayed-branchโ delayed branch. fashionably late. โณ-fdelete-null-pointer-checksโ delete null pointer checks.-fdevirtualizeโ devirtualize.-fdevirtualize-speculativelyโ devirtualize, speculatively. ๐ฎ-fdevirtualize-at-ltransโ devirtualize at ltrans.-fdseโ dse.-fearly-inliningโ early inlining. bright and early. ๐-fipa-sraโ ipa sra.-fexpensive-optimizationsโ expensive optimizations. she costs money. ๐ธ-ffat-lto-objectsโ fat lto objects.-ffast-mathโ fast math. FAST. ๐๏ธ-ffinite-math-onlyโ finite math only. no infinities invited.-ffloat-storeโ float store.-fexcess-precision=styleโ excess precision, in your choice of style.-fforward-propagateโ forward propagate.-ffp-contract=styleโ fp contract, style edition.-ffunction-sectionsโ function sections.-fgcseโ gcse.-fgcse-after-reloadโ gcse after reload.-fgcse-lasโ gcse las.-fgcse-lmโ gcse lm.-fgraphite-identityโ graphite identity.-fgcse-smโ gcse sm.-fhoist-adjacent-loadsโ hoist adjacent loads.-fif-conversionโ if conversion.-fif-conversion2โ if conversion, part two. ๐ฌ-findirect-inliningโ indirect inlining.-finline-functionsโ inline functions.-finline-functions-called-onceโ inline functions called once. one shot. ๐ฏ-finline-limit=nโ inline limit of n.-finline-small-functionsโ inline small functions. smol.-fipa-cpโ ipa cp.-fipa-cp-cloneโ ipa cp clone. ๐งฌ-fipa-bit-cpโ ipa bit cp.-fipa-vrpโ ipa vrp.-fipa-ptaโ ipa pta.-fipa-profileโ ipa profile.-fipa-pure-constโ ipa pure const.-fipa-referenceโ ipa reference.-fipa-reference-addressableโ ipa reference, addressable.-fipa-stack-alignmentโ ipa stack alignment.-fipa-icfโ ipa icf.-fira-algorithm=algorithmโ ira algorithm, you supply the algorithm.-flive-patching=levelโ live patching at a level.-fira-region=regionโ ira region, you supply the region.-fira-hoist-pressureโ ira hoist pressure.-fira-loop-pressureโ ira loop pressure. feel the pressure. ๐ฎโ๐จ-fno-ira-share-save-slotsโ no ira share save slots.-fno-ira-share-spill-slotsโ no ira share spill slots.-fisolate-erroneous-paths-dereferenceโ isolate erroneous paths dereference.-fisolate-erroneous-paths-attributeโ isolate erroneous paths attribute.-fivoptsโ ivopts.-fkeep-inline-functionsโ keep inline functions.-fkeep-static-functionsโ keep static functions.-fkeep-static-constsโ keep static consts.-flimit-function-alignmentโ limit function alignment.-flive-range-shrinkageโ live range shrinkage.-floop-blockโ loop block.-floop-interchangeโ loop interchange.-floop-strip-mineโ loop strip mine. โ๏ธ-floop-unroll-and-jamโ loop unroll and jam. unroll it, jam it. ๐ถ-floop-nest-optimizeโ loop nest optimize. optimize that nest. ๐ชบ-floop-parallelize-allโ parallelize ALL the loops. all of them. ๐ฅ-flra-rematโ lra remat.-fltoโ lto.-flto-compression-levelโ lto compression level.-flto-partition=algโ lto partition, you pick the alg.-fmerge-all-constantsโ merge all constants.-fmerge-constantsโ merge constants.-fmodulo-schedโ modulo sched.-fmodulo-sched-allow-regmovesโ modulo sched allow regmoves.-fmove-loop-invariantsโ move loop invariants.-fno-branch-count-regโ no branch count reg.-fno-defer-popโ no defer pop.-fno-fp-int-builtin-inexactโ no fp int builtin inexact.-fno-function-cseโ no function cse.-fno-guess-branch-probabilityโ no guess branch probability. no guessing. ๐ซ-fno-inlineโ no inline.-fno-math-errnoโ no math errno.-fno-peepholeโ no peephole.-fno-peephole2โ no peephole, the sequel.-fno-printf-return-valueโ no printf return value.-fno-sched-interblockโ no sched interblock.-fno-sched-specโ no sched spec.-fno-signed-zerosโ no signed zeros.-fno-toplevel-reorderโ no toplevel reorder.-fno-trapping-mathโ no trapping math.-fno-zero-initialized-in-bssโ no zero initialized in bss.-fomit-frame-pointerโ omit frame pointer. it's gone. ๐จ-foptimize-sibling-callsโ optimize sibling calls. family optimization. ๐ฏ-fpartial-inliningโ partial inlining.-fpeel-loopsโ peel loops. like a fruit. ๐-fpredictive-commoningโ predictive commoning. ๐ฎ-fprefetch-loop-arraysโ prefetch loop arrays.-fprofile-correctionโ profile correction.-fprofile-useโ profile use.-fprofile-use=pathโ profile use, at a path.-fprofile-valuesโ profile values.-fprofile-reorder-functionsโ profile reorder functions.-freciprocal-mathโ reciprocal math.-freeโ free. just free. ๐-frename-registersโ rename registers.-freorder-blocksโ reorder blocks.-freorder-blocks-algorithm=algorithmโ reorder blocks algorithm, you supply the algorithm.-freorder-blocks-and-partitionโ reorder blocks and partition.-freorder-functionsโ reorder functions.-frerun-cse-after-loopโ rerun cse after loop.-freschedule-modulo-scheduled-loopsโ reschedule modulo scheduled loops.-frounding-mathโ rounding math.-fsave-optimization-recordโ save optimization record. for the receipts. ๐งพ-fsched2-use-superblocksโ sched2 use superblocks.-fsched-pressureโ sched pressure.-fsched-spec-loadโ sched spec load.-fsched-spec-load-dangerousโ sched spec load, but DANGEROUS. โ ๏ธ-fsched-stalled-insns-dep[=n]โ sched stalled insns dep, optionally n.-fsched-stalled-insns[=n]โ sched stalled insns, optionally n.-fsched-group-heuristicโ sched group heuristic.-fsched-critical-path-heuristicโ sched critical path heuristic.-fsched-spec-insn-heuristicโ sched spec insn heuristic.-fsched-rank-heuristicโ sched rank heuristic.-fsched-last-insn-heuristicโ sched last insn heuristic.-fsched-dep-count-heuristicโ sched dep count heuristic.-fschedule-fusionโ schedule fusion. ๐งฌ-fschedule-insnsโ schedule insns.-fschedule-insns2โ schedule insns, round two.-fsection-anchorsโ section anchors. โ-fselective-schedulingโ selective scheduling.-fselective-scheduling2โ selective scheduling, round two.-fsel-sched-pipeliningโ sel sched pipelining.-fsel-sched-pipelining-outer-loopsโ sel sched pipelining outer loops.-fsemantic-interpositionโ semantic interposition.-fshrink-wrapโ shrink wrap. ๐-fshrink-wrap-separateโ shrink wrap, separate.-fsignaling-nansโ signaling nans.-fsingle-precision-constantโ single precision constant.-fsplit-ivs-in-unrollerโ split ivs in unroller.-fsplit-loopsโ split loops.-fsplit-pathsโ split paths. ๐-fsplit-wide-typesโ split wide types.-fssa-backpropโ ssa backprop.-fssa-phioptโ ssa phiopt.-fstdarg-optโ stdarg opt.-fstore-mergingโ store merging.-fstrict-aliasingโ strict aliasing.-fthread-jumpsโ thread jumps.-ftracerโ tracer.-ftree-bit-ccpโ tree bit ccp.-ftree-builtin-call-dceโ tree builtin call dce.-ftree-ccpโ tree ccp.-ftree-chโ tree ch.-ftree-coalesce-varsโ tree coalesce vars.-ftree-copy-propโ tree copy prop.-ftree-dceโ tree dce.-ftree-dominator-optsโ tree dominator opts.-ftree-dseโ tree dse.-ftree-forwpropโ tree forwprop.-ftree-freโ tree fre.-fcode-hoistingโ code hoisting.-ftree-loop-if-convertโ tree loop if convert.-ftree-loop-imโ tree loop im.-ftree-phipropโ tree phiprop.-ftree-loop-distributionโ tree loop distribution.-ftree-loop-distribute-patternsโ tree loop distribute patterns.-ftree-loop-ivcanonโ tree loop ivcanon.-ftree-loop-linearโ tree loop linear.-ftree-loop-optimizeโ tree loop optimize.-ftree-loop-vectorizeโ tree loop vectorize.-ftree-parallelize-loops=nโ tree parallelize loops, n of them.-ftree-preโ tree pre.-ftree-partial-preโ tree partial pre.-ftree-ptaโ tree pta.-ftree-reassocโ tree reassoc.-ftree-scev-cpropโ tree scev cprop.-ftree-sinkโ tree sink. ๐ฐ-ftree-slsrโ tree slsr.-ftree-sraโ tree sra.-ftree-switch-conversionโ tree switch conversion.-ftree-tail-mergeโ tree tail merge.-ftree-terโ tree ter.-ftree-vectorizeโ tree vectorize.-ftree-vrpโ tree vrp.-funconstrained-commonsโ unconstrained commons.-funit-at-a-timeโ unit at a time. one at a time, bestie. ๐ข-funroll-all-loopsโ unroll ALL the loops. every single one. ๐ฅ-funroll-loopsโ unroll loops.-funsafe-math-optimizationsโ unsafe math optimizations. the name is right there, girl. โ ๏ธ-funswitch-loopsโ unswitch loops.-fipa-raโ ipa ra.-fvariable-expansion-in-unrollerโ variable expansion in unroller.-fvect-cost-modelโ vect cost model.-fvptโ vpt.-fwebโ web. ๐ธ๏ธ-fwhole-programโ whole program. the entire thing.-fwpaโ wpa.-fuse-linker-pluginโ use linker plugin. ๐--param name=valueโ param, with a name and a value.-Oโ the big O. the original. the icon.-O0โ zero optimization. nothing. vibes only. ๐๏ธ-O1โ level one.-O2โ level two. the people's champion. ๐-O3โ level three. she's doing the MOST.-Osโ s for size. smol and mighty.-Ofastโ fast. ๐๏ธ-Ogโ g. for the debugging girlies. ๐
๐งช Program Instrumentation Options ๐งช
okay so this next batch is the instrumentation era โ these are the flags that make your binary tell on itself. Every single one, in order, no skips ๐
-pโ the vintage one, still cute ๐-pgโ-p's louder sister ๐-fprofile-arcsโ arcs on arcs on arcs ๐--coverageโ the vibe check of coverage โจ-ftest-coverageโ test coverage but make it iconic ๐-fprofile-abs-pathโ absolute path energy ๐ฆ-fprofile-dir=pathโ tell it where to put the receipts ๐ธ-fprofile-generateโ generate, periodt ๐-fprofile-generate=pathโ same but with a path, main character ๐ซ-fprofile-update=methodโ pick your method, bestie ๐ฅ-fprofile-filter-files=regexโ regex filter, very demure ๐ธ-fprofile-exclude-files=regexโ the exclusion era, sorry not sorry ๐-fsanitize=styleโ sanitizer but with a style โจ-fsanitize-recoverโ recovery mode, we bounce back ๐-fsanitize-recover=styleโ recovery with a style ๐-fasan-shadow-offset=numberโ a number goes here ๐ข (well, okay, a number ๐)-fsanitize-sections=s1,s2,...โ sections, plural, we love a list ๐-fsanitize-undefined-trap-on-errorโ trap card activated ๐-fbounds-checkโ check those bounds, bestie ๐ซถ-fcf-protection=[full|branch|return|none|check]โ pick your protection ๐ก (okay that's not in the emoji list โ ๐ )-fstack-protectorโ protect the stack, protect the peace ๐ซถ-fstack-protector-allโ ALL of it, no cap ๐-fstack-protector-strongโ strong era ๐ฅ-fstack-protector-explicitโ being explicit about it โจ-fstack-checkโ check the stack ๐ธ-fstack-limit-register=regโ reg goes here ๐-fstack-limit-symbol=symโ sym goes here ๐ฆ-fno-stack-limitโ no limit, free spirit ๐ง-fsplit-stackโ split it, bestie ๐-fvtable-verify=[std|preinit|none]โ vtable verify, choose your fighter ๐-fvtv-countsโ we counting ๐-fvtv-debugโ debug era ๐-finstrument-functionsโ instrument everything โจ-finstrument-functions-exclude-function-list=sym,sym,...โ a list, very exclusive ๐-finstrument-functions-exclude-file-list=file,file,...โ files excluded, ok ๐
๐ Preprocessor Options ๐
the preprocessor ones!! this is where the macros live and honestly it's giving before the compiler even shows up energy ๐
-Aquestion=answerโ ask a question, give an answer ๐-A-question[=answer]โ same vibe, minus the question ๐-Cโ comments stay, we're sentimental ๐-CCโ comments stay even harder โจ-Dmacro[=defn]โ define a macro, slay ๐-dDโ the-dfamily, entry one ๐ฆ-dIโ entry two ๐ธ-dMโ entry three ๐-dNโ entry four ๐-dUโ entry five ๐ฅ-fdebug-cppโ debug the cpp, bestie ๐-fdirectives-onlyโ directives only, very focused โจ-fdollars-in-identifiersโ dollars in identifiers, iconic ๐ต (fine, ๐ )-fexec-charset=charsetโ exec charset goes here ๐-fextended-identifiersโ extended identifiers, we expanded ๐-finput-charset=charsetโ input charset goes here ๐ฆ-fmacro-prefix-map=old=newโoldbecomesnew, glow up ๐ธ-fno-canonical-system-headersโ no canonical system headers ๐-fpch-depsโ pch deps, tracking them ๐-fpch-preprocessโ pch preprocess, doing the thing โจ-fpreprocessedโ already preprocessed, been there ๐-ftabstop=widthโ width goes here ๐-ftrack-macro-expansionโ tracking the macro expansion, we're watching ๐-fwide-exec-charset=charsetโ wide exec charset, extra wide ๐ซถ-fworking-directoryโ the working directory era ๐-Hโ capital H, one letter, so much power ๐-imacros fileโ file goes here ๐-include fileโ include the file ๐ฆ-Mโ the big M ๐ธ-MDโ M plus D ๐-MFโ M plus F ๐-MGโ M plus G ๐ฅ-MMโ double M, double iconic โจ-MMDโ triple threat ๐-MPโ M plus P ๐-MQโ M plus Q ๐-MTโ M plus T ๐ซถ-no-integrated-cppโ no integrated cpp, we're independent ๐ง-Pโ capital P, short and sweet ๐-pthreadโ pthread, we love her ๐-remapโ remap it ๐ฆ-traditionalโ traditional, old school ๐ธ-traditional-cppโ traditional cpp, even older school ๐-trigraphsโ trigraphs!! the controversial fave ๐-Umacroโ undefine that macro, bye ๐-undefโ undef, no notes ๐ฅ-Wp,optionโ pass option to the preprocessor, here's a note for you ๐ (that's a ๐)-Xpreprocessor optionโ same energy, different syntax โจ
๐ง Assembler Options ๐ง
only two, and honestly? they understood the assignment ๐ซถ
-Wa,optionโ hand option to the assembler, take a note bestie ๐ (๐)-Xassembler optionโ same but the other way ๐
๐ Linker Options ๐
the linker era!! this is where everything gets stitched together and it's so satisfying ๐
object-file-nameโ literally just an object file name, no dash, no notes ๐ฆ-fuse-ld=linkerโ pick your linker ๐ธ-llibraryโ the classic-l, we stan ๐-nostartfilesโ no start files, starting fresh ๐-nodefaultlibsโ no default libs ๐ฅ-nolibcโ no libc, bold move ๐-nostdlibโ no stdlib, living on the edge โจ-e entryโ set the entry ๐--entry=entryโ same thing, long-form girlie ๐-pieโ pie!! ๐ฅง (not in the list โ ๐ธ)-pthreadโ she's back, we love consistency ๐ซถ-rโ just anr๐ฆ-rdynamicโ r plus dynamic ๐ธ-sโ just ans๐-staticโ static era ๐-static-pieโ static and pie, the combo ๐ฅ-static-libgccโ static libgcc ๐-static-libstdc++โ static libstdc++, the plus plus โจ-static-libasanโ static libasan ๐-static-libtsanโ static libtsan ๐-static-liblsanโ static liblsan ๐ฆ-static-libubsanโ static libubsan ๐ธ-sharedโ shared, sharing is caring ๐-shared-libgccโ shared libgcc ๐-symbolicโ symbolic ๐ฅ-T scriptโ a script goes here ๐-Wl,optionโ hand option to the linker ๐ (๐)-Xlinker optionโ same vibe, alternate syntax ๐-u symbolโ a symbol ๐ฆ-z keywordโ a keyword ๐ธ
๐ Directory Options ๐
search paths!! where things get found ๐
-Bprefixโ a prefix goes here ๐-Idirโ the iconic capital I, dir goes here ๐ฅ-I-โ I dash, a classic ๐-idirafter dirโ after the dir โจ-imacros fileโ a file ๐-imultilib dirโ a dir for multilib ๐-iplugindir=dirโ plugin dir, the plugin era ๐ฆ-iprefix fileโ a file prefix ๐ธ-iquote dirโ quote dir ๐-isysroot dirโ sysroot dir ๐-isystem dirโ system dir ๐ฅ-iwithprefix dirโ with prefix dir ๐-iwithprefixbefore dirโ with prefix before dir โจ-Ldirโ capital L, dir goes here ๐-no-canonical-prefixesโ no canonical prefixes ๐--no-sysroot-suffixโ no sysroot suffix ๐ฆ-nostdincโ no stdinc ๐ธ-nostdinc++โ no stdinc, plus plus ๐--sysroot=dirโ sysroot equals dir ๐
โ๏ธ Code Generation Options โ๏ธ
codegen time!! this is the main character section fr fr ๐ฅ
-fcall-saved-regโ reg is call-saved ๐-fcall-used-regโ reg is call-used โจ-ffixed-regโ reg is fixed ๐-fexceptionsโ exceptions ๐-fnon-call-exceptionsโ non-call exceptions ๐ฆ-fdelete-dead-exceptionsโ deleting the dead exceptions, ruthless ๐ธ-funwind-tablesโ unwind tables ๐-fasynchronous-unwind-tablesโ asynchronous unwind tables ๐-fno-gnu-uniqueโ no gnu unique ๐ฅ-finhibit-size-directiveโ inhibit the size directive ๐-fno-commonโ no common โจ-fno-identโ no ident ๐-fpcc-struct-returnโ pcc struct return ๐-fpicโ pic, lowercase ๐ฆ-fPICโ PIC, uppercase, different flag, don't mix them up bestie ๐ธ-fpieโ pie, lowercase ๐-fPIEโ PIE, uppercase ๐-fno-pltโ no plt ๐ฅ-fno-jump-tablesโ no jump tables ๐-frecord-gcc-switchesโ record the gcc switches, receipts kept โจ-freg-struct-returnโ reg struct return ๐-fshort-enumsโ short enums ๐-fshort-wcharโ short wchar ๐ฆ-fverbose-asmโ verbose asm, she talks a lot ๐ธ-fpack-struct[=n]โ pack it up, optionally with n ๐-fleading-underscoreโ leading underscore ๐-ftls-model=modelโ tls model goes here ๐ฅ-fstack-reuse=reuse_levelโ stack reuse at reuse_level ๐-ftrampolinesโ trampolines!! ๐ช (not on the list โ โจ)-ftrapvโ trap on signed overflow vibes ๐-fwrapvโ wrap it up ๐-fvisibility=[default|internal|hidden|protected]โ pick your visibility ๐-fstrict-volatile-bitfieldsโ strict volatile bitfields ๐ฆ-fsync-libcallsโ sync libcalls ๐ธ
๐ ๏ธ Developer Options ๐ ๏ธ
this section is enormous and it's for the girlies who compile with -fdump-everything and read the output for fun. respect ๐
-dlettersโ letters go here ๐-dumpspecsโ dump the specs ๐-dumpmachineโ dump the machine ๐ฅ-dumpversionโ dump the version ๐-dumpfullversionโ dump the full version โจ-fcheckingโ checking ๐-fchecking=nโ checking at level n ๐-fdbg-cnt-listโ list the debug counters ๐ฆ-fdbg-cnt=counter-value-listโ a counter-value-list ๐ธ-fdisable-ipa-pass_nameโ disable an ipa pass by name ๐-fdisable-rtl-pass_nameโ disable an rtl pass by name ๐-fdisable-rtl-pass-name=range-listโ with a range-list ๐ฅ-fdisable-tree-pass_nameโ disable a tree pass by name ๐-fdisable-tree-pass-name=range-listโ with a range-list โจ-fdump-debugโ dump the debug ๐-fdump-earlydebugโ dump the early debug ๐-fdump-noaddrโ dump without addresses ๐ฆ-fdump-unnumberedโ dump unnumbered ๐ธ-fdump-unnumbered-linksโ unnumbered links ๐-fdump-final-insns[=file]โ final insns, optionally to a file ๐-fdump-ipa-allโ all the ipa ๐ฅ-fdump-ipa-cgraphโ the cgraph one ๐-fdump-ipa-inlineโ the inline one โจ-fdump-lang-allโ all the lang ๐-fdump-lang-switchโ the lang switch ๐-fdump-lang-switch-optionsโ switch options ๐ฆ-fdump-lang-switch-options=filenameโ to a filename ๐ธ-fdump-passesโ dump the passes ๐-fdump-rtl-passโ an rtl pass ๐-fdump-rtl-pass=filenameโ to a filename ๐ฅ-fdump-statisticsโ statistics, we love data ๐-fdump-tree-allโ all the trees โจ-fdump-tree-switchโ the tree switch ๐-fdump-tree-switch-optionsโ switch options ๐-fdump-tree-switch-options=filenameโ to a filename ๐ฆ-fcompare-debug[=opts]โ compare debug, optionally with opts ๐ธ-fcompare-debug-secondโ the second one ๐-fenable-kind-passโ enable a kind of pass ๐-fenable-kind-pass=range-listโ with a range-list ๐ฅ-fira-verbose=nโ ira verbose at level n ๐-flto-reportโ lto report โจ-flto-report-wpaโ the wpa variant ๐-fmem-report-wpaโ mem report wpa ๐-fmem-reportโ mem report ๐ฆ-fpre-ipa-mem-reportโ pre-ipa mem report ๐ธ-fpost-ipa-mem-reportโ post-ipa mem report ๐-fopt-infoโ opt info ๐-fopt-info-options[=file]โ opt info options, optionally to a file ๐ฅ-fprofile-reportโ profile report ๐-frandom-seed=stringโ a string seed โจ-fsched-verbose=nโ sched verbose at level n ๐-fsel-sched-verboseโ sel sched verbose ๐-fsel-sched-dump-cfgโ dump the cfg ๐ฆ-fsel-sched-pipelining-verboseโ pipelining verbose ๐ธ-fstatsโ stats ๐-fstack-usageโ stack usage ๐-ftime-reportโ time report โฑ (fine, ๐ฅ)-ftime-report-detailsโ the details version ๐-fvar-tracking-assignments-toggleโ toggle those var tracking assignments โจ-gtoggleโ g toggle ๐-print-file-name=libraryโ print the file name of library ๐-print-libgcc-file-nameโ print the libgcc file name ๐ฆ-print-multi-directoryโ print the multi directory ๐ธ-print-multi-libโ print multi lib ๐-print-multi-os-directoryโ print the multi os directory ๐-print-prog-name=programโ print the prog name of program ๐ฅ-print-search-dirsโ print the search dirs ๐-Qโ capital Q, so mysterious โจ-print-sysrootโ print the sysroot ๐-print-sysroot-headers-suffixโ print the sysroot headers suffix ๐-save-tempsโ save the temps ๐ฆ-save-temps=cwdโ save them to cwd ๐ธ-save-temps=objโ save them to obj ๐-time[=file]โ time it, optionally into a file ๐
๐ค Machine-Dependent Options ๐ค
okay bestie, deep breath โ this is the huge one. Every architecture gets its own little corner ๐
๐ AArch64 Options ๐
-mabi=nameโ abi name ๐-mbig-endianโ big endian ๐ฅ-mlittle-endianโ little endian ๐-mgeneral-regs-onlyโ general regs only โจ-mcmodel=tinyโ tiny code model ๐-mcmodel=smallโ small code model ๐-mcmodel=largeโ large code model ๐ฆ-mstrict-alignโ strict align ๐ธ-mno-strict-alignโ no strict align ๐-momit-leaf-frame-pointerโ omit the leaf frame pointer ๐-mtls-dialect=descโ tls dialect desc ๐ฅ-mtls-dialect=traditionalโ tls dialect traditional ๐-mtls-size=sizeโ tls size โจ-mfix-cortex-a53-835769โ fix that cortex a53 835769 ๐-mfix-cortex-a53-843419โ and that cortex a53 843419 ๐-mlow-precision-recip-sqrtโ low precision recip sqrt ๐ฆ-mlow-precision-sqrtโ low precision sqrt ๐ธ-mlow-precision-divโ low precision div ๐-mpc-relative-literal-loadsโ pc relative literal loads ๐-msign-return-address=scopeโ sign return address at scope ๐ฅ-mbranch-protection=none|standard|pac-ret[+leaf]|btiโ branch protection, pick your fighter ๐-mharden-sls=optsโ harden sls with opts โจ-march=nameโ arch name ๐-mcpu=nameโ cpu name ๐-mtune=nameโ tune for name ๐ฆ-moverride=stringโ override with string ๐ธ-mverbose-cost-dumpโ verbose cost dump ๐-mstack-protector-guard=guardโ stack protector guard ๐-mstack-protector-guard-reg=sysregโ guard reg sysreg ๐ฅ-mstack-protector-guard-offset=offsetโ guard offset ๐-mtrack-speculationโ track speculation โจ-moutline-atomicsโ outline atomics ๐
๐ฆ Adapteva Epiphany Options ๐ฆ
-mhalf-reg-fileโ half reg file ๐-mprefer-short-insn-regsโ prefer short insn regs ๐ธ-mbranch-cost=numโ branch cost num ๐-mcmoveโ cmove ๐-mnops=numโ nops num ๐ฅ-msoft-cmpsfโ soft cmpsf ๐-msplit-lohiโ split lohi โจ-mpost-incโ post inc ๐-mpost-modifyโ post modify ๐-mstack-offset=numโ stack offset num ๐ฆ-mround-nearestโ round nearest ๐ธ-mlong-callsโ long calls ๐-mshort-callsโ short calls ๐-msmall16โ small 16 ๐ฅ-mfp-mode=modeโ fp mode ๐-mvect-doubleโ vect double โจ-max-vect-align=numโ max vect align num ๐-msplit-vecmove-earlyโ split vecmove early ๐-m1reg-regโ 1reg reg ๐ฆ
๐ธ AMD GCN Options ๐ธ
-march=gpuโ arch gpu ๐-mtune=gpuโ tune gpu ๐-mstack-size=bytesโ stack size in bytes ๐ฅ
๐ ARC Options ๐
heads up bestie โ one entry down there genuinely has no leading dash in the page. that's not me being sloppy, that's the page. keeping it exactly as printed ๐ซถ
-mbarrel-shifterโ barrel shifter โจ-mjli-alwaysโ jli always ๐-mcpu=cpuโ cpu cpu ๐-mA6โ A6 ๐ฆ-mARC600โ ARC600 ๐ธ-mA7โ A7 ๐-mARC700โ ARC700 ๐-mdpfpโ dpfp ๐ฅ-mdpfp-compactโ dpfp compact ๐-mdpfp-fastโ dpfp fast โจ-mno-dpfp-lrsrโ no dpfp lrsr ๐-meaโ ea ๐-mno-mpyโ no mpy ๐ฆ-mmul32x16โ mul32x16 ๐ธ-mmul64โ mul64 ๐-matomicโ atomic ๐-mnormโ norm ๐ฅ-mspfpโ spfp ๐-mspfp-compactโ spfp compact โจ-mspfp-fastโ spfp fast ๐-msimdโ simd ๐-msoft-floatโ soft float ๐ฆ-mswapโ swap ๐ธ-mcrcโ crc ๐-mdsp-packaโ dsp packa ๐-mdvbfโ dvbf ๐ฅ-mlockโ lock ๐-mmac-d16โ mac d16 โจ-mmac-24โ mac 24 ๐-mrtscโ rtsc ๐-mswapeโ swape ๐ฆ-mtelephonyโ telephony ๐ธ-mxyโ xy ๐-misizeโ isize ๐-mannotate-alignโ annotate align ๐ฅ-marclinuxโ arclinux ๐-marclinux_profโ arclinux_prof (yes, with the underscore) โจ-mlong-callsโ long calls ๐-mmedium-callsโ medium calls ๐-msdataโ sdata ๐ฆ-mirq-ctrl-savedโ irq ctrl saved ๐ธ-mrgf-banked-regsโ rgf banked regs ๐-mlpc-width=widthโ lpc width ๐-G numโ capital G, num ๐ฅ-mvolatile-cacheโ volatile cache ๐-mtp-regno=regnoโ tp regno โจ-malign-callโ align call ๐-mauto-modify-regโ auto modify reg ๐-mbbit-peepholeโ bbit peephole ๐ฆ-mno-brccโ no brcc ๐ธ-mcase-vector-pcrelโ case vector pcrel ๐-mcompact-casesiโ compact casesi ๐-mno-cond-execโ no cond exec ๐ฅ-mearly-cbranchsiโ early cbranchsi ๐-mexpand-adddiโ expand adddi โจ-mindexed-loadsโ indexed loads ๐-mlraโ lra ๐-mlra-priority-noneโ lra priority none ๐ฆ-mlra-priority-compactโ lra priority compact ๐ธmlra-priority-noncompactโ ๐ no leading dash, exactly as the page prints it ๐-mmillicodeโ millicode ๐-mmixed-codeโ mixed code ๐ฅ-mq-classโ q class ๐-mRcqโ capital R, lowercase cq โจ-mRcwโ capital R, lowercase cw ๐-msize-level=levelโ size level ๐-mtune=cpuโ tune cpu ๐ฆ-mmultcost=numโ multcost num ๐ธ-mcode-density-frameโ code density frame ๐-munalign-prob-threshold=probabilityโ unalign prob probability ๐-mmpy-option=multoโ mpy option multo ๐ฅ-mdiv-remโ div rem ๐-mcode-densityโ code density โจ-mll64โ ll64 ๐-mfpu=fpuโ fpu fpu ๐-mrf16โ rf16 ๐ฆ-mbranch-indexโ branch index ๐ธ
๐ ARM Options ๐
-mapcs-frameโ apcs frame ๐-mno-apcs-frameโ no apcs frame ๐-mabi=nameโ abi name ๐ฅ-mapcs-stack-checkโ apcs stack check ๐-mno-apcs-stack-checkโ no apcs stack check โจ-mapcs-reentrantโ apcs reentrant ๐-mno-apcs-reentrantโ no apcs reentrant ๐-mgeneral-regs-onlyโ general regs only ๐ฆ-msched-prologโ sched prolog ๐ธ-mno-sched-prologโ no sched prolog ๐-mlittle-endianโ little endian ๐-mbig-endianโ big endian ๐ฅ-mbe8โ be8 ๐-mbe32โ be32 โจ-mfloat-abi=nameโ float abi name ๐-mfp16-format=nameโ fp16 format name ๐-mthumb-interworkโ thumb interwork ๐ฆ-mno-thumb-interworkโ no thumb interwork ๐ธ-mcpu=nameโ cpu name ๐-march=nameโ arch name ๐-mfpu=nameโ fpu name ๐ฅ-mtune=nameโ tune name ๐-mprint-tune-infoโ print tune info โจ-mstructure-size-boundary=nโ structure size boundary n ๐-mabort-on-noreturnโ abort on noreturn ๐-mlong-callsโ long calls ๐ฆ-mno-long-callsโ no long calls ๐ธ-msingle-pic-baseโ single pic base ๐-mno-single-pic-baseโ no single pic base ๐-mpic-register=regโ pic reg ๐ฅ-mnop-fun-dllimportโ nop fun dllimport ๐-mpoke-function-nameโ poke function name โจ-mthumbโ thumb ๐-marmโ arm ๐-mflip-thumbโ flip thumb ๐ฆ-mtpcs-frameโ tpcs frame ๐ธ-mtpcs-leaf-frameโ tpcs leaf frame ๐-mcaller-super-interworkingโ caller super interworking ๐-mcallee-super-interworkingโ callee super interworking ๐ฅ-mtp=nameโ tp name ๐-mtls-dialect=dialectโ tls dialect โจ-mword-relocationsโ word relocations ๐-mfix-cortex-m3-ldrdโ fix cortex m3 ldrd ๐-munaligned-accessโ unaligned access ๐ฆ-mneon-for-64bitsโ neon for 64bits ๐ธ-mslow-flash-dataโ slow flash data ๐-masm-syntax-unifiedโ asm syntax unified ๐-mrestrict-itโ restrict it ๐ฅ-mverbose-cost-dumpโ verbose cost dump ๐-mpure-codeโ pure code โจ-mcmseโ cmse ๐
๐ AVR Options ๐
-mmcu=mcuโ mcu mcu ๐-mabsdataโ absdata ๐ฆ-maccumulate-argsโ accumulate args ๐ธ-mbranch-cost=costโ branch cost ๐-mcall-prologuesโ call prologues ๐-mgas-isr-prologuesโ gas isr prologues ๐ฅ-mint8โ int8 ๐-mn_flash=sizeโ n_flash size, underscore and all โจ-mno-interruptsโ no interrupts ๐-mmain-is-OS_taskโ main is OS_task, capitals and underscore preserved ๐-mrelaxโ relax ๐ฆ-mrmwโ rmw ๐ธ-mstrict-Xโ strict capital X ๐-mtiny-stackโ tiny stack ๐-mfract-convert-truncateโ fract convert truncate ๐ฅ-mshort-callsโ short calls ๐-nodevicelibโ no devicelib โจ-nodevicespecsโ no devicespecs ๐-Waddr-space-convertโ a warning, not an-m, we love a curveball ๐-Wmisspelled-isrโ also a warning ๐ฆ
๐ฅ Blackfin Options ๐ฅ
-mcpu=cpu[-sirevision]โ cpu cpu, optional sirevision ๐ธ-msimโ sim ๐-momit-leaf-frame-pointerโ omit leaf frame pointer ๐-mno-omit-leaf-frame-pointerโ no omit leaf frame pointer ๐ฅ-mspecld-anomalyโ specld anomaly ๐-mno-specld-anomalyโ no specld anomaly โจ-mcsync-anomalyโ csync anomaly ๐-mno-csync-anomalyโ no csync anomaly ๐-mlow-64kโ low 64k ๐ฆ-mno-low64kโ no low64k ๐ธ-mstack-check-l1โ stack check l1 ๐-mid-shared-libraryโ id shared library ๐-mno-id-shared-libraryโ no id shared library ๐ฅ-mshared-library-id=nโ shared library id n ๐-mleaf-id-shared-libraryโ leaf id shared library โจ-mno-leaf-id-shared-libraryโ no leaf id shared library ๐-msep-dataโ sep data ๐-mno-sep-dataโ no sep data ๐ฆ-mlong-callsโ long calls ๐ธ-mno-long-callsโ no long calls ๐-mfast-fpโ fast fp ๐-minline-pltโ inline plt ๐ฅ-mmulticoreโ multicore ๐-mcoreaโ corea โจ-mcorebโ coreb ๐-msdramโ sdram ๐-micplbโ icplb ๐ฆ
โจ C6X Options โจ
-mbig-endianโ big endian ๐ธ-mlittle-endianโ little endian ๐-march=cpuโ arch cpu ๐-msimโ sim ๐ฅ-msdata=sdata-typeโ sdata sdata-type ๐
๐ CRIS Options ๐
-mcpu=cpuโ cpu cpu โจ-march=cpuโ arch cpu ๐-mtune=cpuโ tune cpu ๐-mmax-stack-frame=nโ max stack frame n ๐ฆ-melinux-stacksize=nโ elinux stacksize n ๐ธ-metrax4โ etrax4 ๐-metrax100โ etrax100 ๐-mpdebugโ pdebug ๐ฅ-mcc-initโ cc init ๐-mno-side-effectsโ no side effects โจ-mstack-alignโ stack align ๐-mdata-alignโ data align ๐-mconst-alignโ const align ๐ฆ-m32-bitโ 32 bit ๐ธ-m16-bitโ 16 bit ๐-m8-bitโ 8 bit ๐-mno-prologue-epilogueโ no prologue epilogue ๐ฅ-mno-gotpltโ no gotplt ๐-melfโ elf โจ-maoutโ aout ๐-melinuxโ elinux ๐-mlinuxโ linux ๐ฆ-simโ sim, no-m, just vibes ๐ธ-sim2โ sim2 ๐-mmul-bug-workaroundโ mul bug workaround ๐-mno-mul-bug-workaroundโ no mul bug workaround ๐ฅ
๐ง CR16 Options ๐ง
-mmacโ mac ๐-mcr16cplusโ cr16cplus โจ-mcr16cโ cr16c ๐-msimโ sim ๐-mint32โ int32 ๐ฆ-mbit-opsโ bit ops ๐ธ-mdata-model=modelโ data model model ๐
๐ C-SKY Options ๐
-march=archโ arch arch ๐-mcpu=cpuโ cpu cpu ๐ฅ-mbig-endianโ big endian ๐-EBโ EB โจ-mlittle-endianโ little endian ๐-ELโ EL ๐-mhard-floatโ hard float ๐ฆ-msoft-floatโ soft float ๐ธ-mfpu=fpuโ fpu fpu ๐-mdouble-floatโ double float ๐-mfdivduโ fdivdu ๐ฅ-melrwโ elrw ๐-mistackโ istack โจ-mmpโ mp ๐-mcpโ cp ๐-mcacheโ cache ๐ฆ-msecurityโ security ๐ธ-mtrustโ trust ๐-mdspโ dsp ๐-medspโ edsp ๐ฅ-mvdspโ vdsp ๐-mdivโ div โจ-msmartโ smart ๐-mhigh-registersโ high registers ๐-manchorโ anchor ๐ฆ-mpushpopโ pushpop ๐ธ-mmultiple-stldโ multiple stld ๐-mconstpoolโ constpool ๐-mstack-sizeโ stack size ๐ฅ-mccrtโ ccrt ๐-mbranch-cost=nโ branch cost n โจ-mcse-ccโ cse cc ๐-msched-prologโ sched prolog ๐
Darwin Options ๐โจ
bestie, these are the Darwin-specific flags. no descriptions, just the whole squad, periodt:
-all_load-allowable_client-arch-arch_errors_fatal-arch_only-bind_at_load-bundle-bundle_loader-client_name-compatibility_version-current_version-dead_strip-dependency-file-dylib_file-dylinker_install_name-dynamic-dynamiclib-exported_symbols_list-filelist-flat_namespace-force_cpusubtype_ALL-force_flat_namespace-headerpad_max_install_names-iframework-image_base-init-install_name-keep_private_externs-multi_module-multiply_defined-multiply_defined_unused-noall_load-no_dead_strip_inits_and_terms-nofixprebinding-nomultidefs-noprebind-noseglinkedit-pagezero_size-prebind-prebind_all_twolevel_modules-private_bundle-read_only_relocs-sectalign-sectobjectsymbols-whyload-seg1addr-sectcreate-sectobjectsymbols-sectorder-segaddr-segs_read_only_addr-segs_read_write_addr-seg_addr_table-seg_addr_table_filename-seglinkedit-segprot-segs_read_only_addr-segs_read_write_addr-single_module-static-sub_library-sub_umbrella-twolevel_namespace-umbrella-undefined-unexported_symbols_list-weak_reference_mismatches-whatsloaded-F-gused-gfull-mmacosx-version-min=version-mkernel-mone-byte-bool
DEC Alpha Options ๐
-mno-fp-regs-msoft-float-mieee-mieee-with-inexact-mieee-conformant-mfp-trap-mode=mode-mfp-rounding-mode=mode-mtrap-precision=mode-mbuild-constants-mcpu=cpu-type-mtune=cpu-type-mbwx-mmax-mfix-mcix-mfloat-vax-mfloat-ieee-mexplicit-relocs-msmall-data-mlarge-data-msmall-text-mlarge-text-mmemory-latency=time
FR30 Options ๐ธ
-msmall-model-mno-lsim
FT32 Options ๐ฆ
-msim-mlra-mnodiv-mft32b-mcompress-mnopm
FRV Options ๐
-mgpr-32-mgpr-64-mfpr-32-mfpr-64-mhard-float-msoft-float-malloc-cc-mfixed-cc-mdword-mno-dword-mdouble-mno-double-mmedia-mno-media-mmuladd-mno-muladd-mfdpic-minline-plt-mgprel-ro-multilib-library-pic-mlinked-fp-mlong-calls-malign-labels-mlibrary-pic-macc-4-macc-8-mpack-mno-pack-mno-eflags-mcond-move-mno-cond-move-moptimize-membar-mno-optimize-membar-mscc-mno-scc-mcond-exec-mno-cond-exec-mvliw-branch-mno-vliw-branch-mmulti-cond-exec-mno-multi-cond-exec-mnested-cond-exec-mno-nested-cond-exec-mtomcat-stats-mTLS-mtls-mcpu=cpu
GNU/Linux Options ๐ง
-mglibc-muclibc-mmusl-mbionic-mandroid-tno-android-cc-tno-android-ld
H8/300 Options ๐
-mrelax-mh-ms-mn-mexr-mno-exr-mint32-malign-300
HPPA Options ๐
-march=architecture-type-mcaller-copies-mdisable-fpregs-mdisable-indexing-mfast-indirect-calls-mgas-mgnu-ld-mhp-ld-mfixed-range=register-range-mjump-in-delay-mlinker-opt-mlong-calls-mlong-load-store-mno-disable-fpregs-mno-disable-indexing-mno-fast-indirect-calls-mno-gas-mno-jump-in-delay-mno-long-load-store-mno-portable-runtime-mno-soft-float-mno-space-regs-msoft-float-mpa-risc-1-0-mpa-risc-1-1-mpa-risc-2-0-mportable-runtime-mschedule=cpu-type-mspace-regs-msio-mwsio-munix=unix-std-nolibdld-static-threads
IA-64 Options โญ
-mbig-endian-mlittle-endian-mgnu-as-mgnu-ld-mno-pic-mvolatile-asm-stop-mregister-names-msdata-mno-sdata-mconstant-gp-mauto-pic-mfused-madd-minline-float-divide-min-latency-minline-float-divide-max-throughput-mno-inline-float-divide-minline-int-divide-min-latency-minline-int-divide-max-throughput-mno-inline-int-divide-minline-sqrt-min-latency-minline-sqrt-max-throughput-mno-inline-sqrt-mdwarf2-asm-mearly-stop-bits-mfixed-range=register-range-mtls-size=tls-size-mtune=cpu-type-milp32-mlp64-msched-br-data-spec-msched-ar-data-spec-msched-control-spec-msched-br-in-data-spec-msched-ar-in-data-spec-msched-in-control-spec-msched-spec-ldc-msched-spec-control-ldc-msched-prefer-non-data-spec-insns-msched-prefer-non-control-spec-insns-msched-stop-bits-after-every-cycle-msched-count-spec-in-critical-path-msel-sched-dont-check-control-spec-msched-fp-mem-deps-zero-cost-msched-max-memory-insns-hard-limit-msched-max-memory-insns=max-insns
LM32 Options ๐
-mbarrel-shift-enabled-mdivide-enabled-mmultiply-enabled-msign-extend-enabled-muser-enabled
M32R/D Options ๐
-m32r2-m32rx-m32r-mdebug-malign-loops-mno-align-loops-missue-rate=number-mbranch-cost=number-mmodel=code-size-model-type-msdata=sdata-type-mno-flush-func-mflush-func=name-mno-flush-trap-mflush-trap=number-G num
M32C Options ๐ง
-mcpu=cpu-msim-memregs=number
M680x0 Options ๐ฅ
-march=arch-mcpu=cpu-mtune=tune-m68000-m68020-m68020-40-m68020-60-m68030-m68040-m68060-mcpu32-m5200-m5206e-m528x-m5307-m5407-mcfv4e-mbitfield-mno-bitfield-mc68000-mc68020-mnobitfield-mrtd-mno-rtd-mdiv-mno-div-mshort-mno-short-mhard-float-m68881-msoft-float-mpcrel-malign-int-mstrict-align-msep-data-mno-sep-data-mshared-library-id=n-mid-shared-library-mno-id-shared-library-mxgot-mno-xgot-mlong-jump-table-offsets
MCore Options ๐
-mhardlit-mno-hardlit-mdiv-mno-div-mrelax-immediates-mno-relax-immediates-mwide-bitfields-mno-wide-bitfields-m4byte-functions-mno-4byte-functions-mcallgraph-data-mno-callgraph-data-mslow-bytes-mno-slow-bytes-mno-lsim-mlittle-endian-mbig-endian-m210-m340-mstack-increment
MeP Options ๐
-mabsdiff-mall-opts-maverage-mbased=n-mbitops-mc=n-mclip-mconfig=name-mcop-mcop32-mcop64-mivc2-mdc-mdiv-meb-mel-mio-volatile-ml-mleadz-mm-mminmax-mmult-mno-opts-mrepeat-ms-msatur-msdram-msim-msimnovec-mtf-mtiny=n
MicroBlaze Options ๐ธ
-msoft-float-mhard-float-msmall-divides-mcpu=cpu-mmemcpy-mxl-soft-mul-mxl-soft-div-mxl-barrel-shift-mxl-pattern-compare-mxl-stack-check-mxl-gp-opt-mno-clearbss-mxl-multiply-high-mxl-float-convert-mxl-float-sqrt-mbig-endian-mlittle-endian-mxl-reorder-mxl-mode-app-model-mpic-data-is-text-relative
MIPS Options ๐ฆ
bestie, this is the MIPS motherlode, no cap:
-EL-EB-march=arch-mtune=arch-mips1-mips2-mips3-mips4-mips32-mips32r2-mips32r3-mips32r5-mips32r6-mips64-mips64r2-mips64r3-mips64r5-mips64r6-mips16-mno-mips16-mflip-mips16-minterlink-compressed-mno-interlink-compressed-minterlink-mips16-mno-interlink-mips16-mabi=abi-mabicalls-mno-abicalls-mshared-mno-shared-mplt-mno-plt-mxgot-mno-xgot-mgp32-mgp64-mfp32-mfpxx-mfp64-mhard-float-msoft-float-mno-float-msingle-float-mdouble-float-modd-spreg-mno-odd-spreg-mabs=mode-mnan=encoding-mdsp-mno-dsp-mdspr2-mno-dspr2-mmcu-mmno-mcu-meva-mno-eva-mvirt-mno-virt-mxpa-mno-xpa-mcrc-mno-crc-mginv-mno-ginv-mmicromips-mno-micromips-mmsa-mno-msa-mloongson-mmi-mno-loongson-mmi-mloongson-ext-mno-loongson-ext-mloongson-ext2-mno-loongson-ext2-mfpu=fpu-type-msmartmips-mno-smartmips-mpaired-single-mno-paired-single-mdmx-mno-mdmx-mips3d-mno-mips3d-mmt-mno-mt-mllsc-mno-llsc-mlong64-mlong32-msym32-mno-sym32-Gnum-mlocal-sdata-mno-local-sdata-mextern-sdata-mno-extern-sdata-mgpopt-mno-gopt-membedded-data-mno-embedded-data-muninit-const-in-rodata-mno-uninit-const-in-rodata-mcode-readable=setting-msplit-addresses-mno-split-addresses-mexplicit-relocs-mno-explicit-relocs-mcheck-zero-division-mno-check-zero-division-mdivide-traps-mdivide-breaks-mload-store-pairs-mno-load-store-pairs-mmemcpy-mno-memcpy-mlong-calls-mno-long-calls-mmad-mno-mad-mimadd-mno-imadd-mfused-madd-mno-fused-madd-nocpp-mfix-24k-mno-fix-24k-mfix-r4000-mno-fix-r4000-mfix-r4400-mno-fix-r4400-mfix-r5900-mno-fix-r5900-mfix-r10000-mno-fix-r10000-mfix-rm7000-mno-fix-rm7000-mfix-vr4120-mno-fix-vr4120-mfix-vr4130-mno-fix-vr4130-mfix-sb1-mno-fix-sb1-mflush-func=func-mno-flush-func-mbranch-cost=num-mbranch-likely-mno-branch-likely-mcompact-branches=policy-mfp-exceptions-mno-fp-exceptions-mvr4130-align-mno-vr4130-align-msynci-mno-synci-mlxc1-sxc1-mno-lxc1-sxc1-mmadd4-mno-madd4-mrelax-pic-calls-mno-relax-pic-calls-mmcount-ra-address-mframe-header-opt-mno-frame-header-opt
MMIX Options ๐
-mlibfuncs-mno-libfuncs-mepsilon-mno-epsilon-mabi=gnu-mabi=mmixware-mzero-extend-mknuthdiv-mtoplevel-symbols-melf-mbranch-predict-mno-branch-predict-mbase-addresses-mno-base-addresses-msingle-exit-mno-single-exit
MN10300 Options ๐
-mmult-bug-mno-mult-bug-mno-am33-mam33-mam33-2-mam34-mtune=cpu-type-mreturn-pointer-on-d0-mno-crt0-mrelax-mliw-msetlb
Moxie Options ๐ฆ
-meb-mel-mmul.x-mno-crt0
MSP430 Options ๐
-msim-masm-hex-mmcu=-mcpu=-mlarge-msmall-mrelax-mwarn-mcu-mcode-region=-mdata-region=-msilicon-errata=-msilicon-errata-warn=-mhwmult=-minrt
NDS32 Options ๐
-mbig-endian-mlittle-endian-mreduced-regs-mfull-regs-mcmov-mno-cmov-mext-perf-mno-ext-perf-mext-perf2-mno-ext-perf2-mext-string-mno-ext-string-mv3push-mno-v3push-m16bit-mno-16bit-misr-vector-size=num-mcache-block-size=num-march=arch-mcmodel=code-model-mctor-dtor-mrelax
Nios II Options ๐ธ
-G num-mgpopt=option-mgpopt-mno-gpopt-mgprel-sec=regexp-mr0rel-sec=regexp-mel-meb-mno-bypass-cache-mbypass-cache-mno-cache-volatile-mcache-volatile-mno-fast-sw-div-mfast-sw-div-mhw-mul-mno-hw-mul-mhw-mulx-mno-hw-mulx-mno-hw-div-mhw-div-mcustom-insn=N-mno-custom-insn-mcustom-fpu-cfg=name-mhal-msmallc-msys-crt0=name-msys-lib=name-march=arch-mbmx-mno-bmx-mcdx-mno-cdx
Nvidia PTX Options โญ
-m32-m64-mmainkernel-moptimize
OpenRISC Options ๐ง
-mboard=name-mnewlib-mhard-mul-mhard-div-msoft-mul-msoft-div-mcmov-mror-msext-msfimm-mshftimm
PDP-11 Options ๐
-mfpu-msoft-float-mac0-mno-ac0-m40-m45-m10-mint32-mno-int16-mint16-mno-int32-msplit-munix-asm-mdec-asm-mgnu-asm-mlra
picoChip Options ๐ฅ
-mae=ae_type-mvliw-lookahead=N-msymbol-as-address-mno-inefficient-warnings
PowerPC Options ๐ฆ
bestie, for PowerPC just see the RS/6000 and PowerPC Options, periodt.
๐ฆ RISC-V Options ๐ฆ
okay so bestie, here's the whole RISC-V flag squad, no cap ๐
-mbranch-cost=N-instruction-mplt-mno-plt-mabi=ABI-string-mfdiv-mno-fdiv-mdiv-mno-div-march=ISA-string-mtune=processor-string-mpreferred-stack-boundary=num-msmall-data-limit=N-bytes-msave-restore-mno-save-restore-mstrict-align-mno-strict-align-mcmodel=medlow-mcmodel=medany-mexplicit-relocs-mno-explicit-relocs-mrelax-mno-relax-mriscv-attribute-mmo-riscv-attribute
๐ธ RL78 Options ๐ธ
-msim-mmul=none-mmul=g13-mmul=g14-mallregs-mcpu=g10-mcpu=g13-mcpu=g14-mg10-mg13-mg14-m64bit-doubles-m32bit-doubles-msave-mduc-in-interrupts
๐ RS/6000 and PowerPC Options ๐
this list is giving encyclopedia, but we're not skipping a single one, periodt โจ
-mcpu=cpu-type-mtune=cpu-type-mcmodel=code-model-mpowerpc64-maltivec-mno-altivec-mpowerpc-gpopt-mno-powerpc-gpopt-mpowerpc-gfxopt-mno-powerpc-gfxopt-mmfcrf-mno-mfcrf-mpopcntb-mno-popcntb-mpopcntd-mno-popcntd-mfprnd-mno-fprnd-mcmpb-mno-cmpb-mmfpgpr-mno-mfpgpr-mhard-dfp-mno-hard-dfp-mfull-toc-mminimal-toc-mno-fp-in-toc-mno-sum-in-toc-m64-m32-mxl-compat-mno-xl-compat-mpe-malign-power-malign-natural-msoft-float-mhard-float-mmultiple-mno-multiple-mupdate-mno-update-mavoid-indexed-addresses-mno-avoid-indexed-addresses-mfused-madd-mno-fused-madd-mbit-align-mno-bit-align-mstrict-align-mno-strict-align-mrelocatable-mno-relocatable-mrelocatable-lib-mno-relocatable-lib-mtoc-mno-toc-mlittle-mlittle-endian-mbig-mbig-endian-mdynamic-no-pic-mswdiv-msingle-pic-base-mprioritize-restricted-insns=priority-msched-costly-dep=dependence_type-minsert-sched-nops=scheme-mcall-aixdesc-mcall-eabi-mcall-freebsd-mcall-linux-mcall-netbsd-mcall-openbsd-mcall-sysv-mcall-sysv-eabi-mcall-sysv-noeabi-mtraceback=traceback_type-maix-struct-return-msvr4-struct-return-mabi=abi-type-msecure-plt-mbss-plt-mlongcall-mno-longcall-mpltseq-mno-pltseq-mblock-move-inline-limit=num-mblock-compare-inline-limit=num-mblock-compare-inline-loop-limit=num-mstring-compare-inline-limit=num-misel-mno-isel-mvrsave-mno-vrsave-mmulhw-mno-mulhw-mdlmzb-mno-dlmzb-mprototype-mno-prototype-msim-mmvme-mads-myellowknife-memb-msdata-msdata=opt-mreadonly-in-sdata-mvxworks-G num-mrecip-mrecip=opt-mno-recip-mrecip-precision-mno-recip-precision-mveclibabi=type-mfriz-mno-friz-mpointers-to-nested-functions-mno-pointers-to-nested-functions-msave-toc-indirect-mno-save-toc-indirect-mpower8-fusion-mno-mpower8-fusion-mpower8-vector-mno-power8-vector-mcrypto-mno-crypto-mhtm-mno-htm-mquad-memory-mno-quad-memory-mquad-memory-atomic-mno-quad-memory-atomic-mcompat-align-parm-mno-compat-align-parm-mfloat128-mno-float128-mfloat128-hardware-mno-float128-hardware-mgnu-attribute-mno-gnu-attribute-mstack-protector-guard=guard-mstack-protector-guard-reg=reg-mstack-protector-guard-offset=offset
๐ RX Options ๐
-m64bit-doubles-m32bit-doubles-fpu-nofpu-mcpu=-mbig-endian-data-mlittle-endian-data-msmall-data-msim-mno-sim-mas100-syntax-mno-as100-syntax-mrelax-mmax-constant-size=-mint-register=-mpid-mallow-string-insns-mno-allow-string-insns-mjsr-mno-warn-multiple-fast-interrupts-msave-acc-in-interrupts
๐ S/390 and zSeries Options ๐
-mtune=cpu-type-march=cpu-type-mhard-float-msoft-float-mhard-dfp-mno-hard-dfp-mlong-double-64-mlong-double-128-mbackchain-mno-backchain-mpacked-stack-mno-packed-stack-msmall-exec-mno-small-exec-mmvcle-mno-mvcle-m64-m31-mdebug-mno-debug-mesa-mzarch-mhtm-mvx-mzvector-mtpf-trace-mno-tpf-trace-mfused-madd-mno-fused-madd-mwarn-framesize-mwarn-dynamicstack-mstack-size-mstack-guard-mhotpatch=halfwords,halfwords
๐ Score Options ๐
-meb-mel-mnhwloop-muls-mmac-mscore5-mscore5u-mscore7-mscore7d
๐ซถ SH Options ๐ซถ
-m1-m2-m2e-m2a-nofpu-m2a-single-only-m2a-single-m2a-m3-m3e-m4-nofpu-m4-single-only-m4-single-m4-m4a-nofpu-m4a-single-only-m4a-single-m4a-m4al-mb-ml-mdalign-mrelax-mbigtable-mfmovd-mrenesas-mno-renesas-mnomacsave-mieee-mno-ieee-mbitops-misize-minline-ic_invalidate-mpadstruct-mprefergot-musermode-multcost=number-mdiv=strategy-mdivsi3_libfunc=name-mfixed-range=register-range-maccumulate-outgoing-args-matomic-model=atomic-model-mbranch-cost=num-mzdcbranch-mno-zdcbranch-mcbranch-force-delay-slot-mfused-madd-mno-fused-madd-mfsca-mno-fsca-mfsrra-mno-fsrra-mpretend-cmove-mtas
โจ Solaris 2 Options โจ
-mclear-hwcap-mno-clear-hwcap-mimpure-text-mno-impure-text-pthreads
๐ฅ SPARC Options ๐ฅ
-mcpu=cpu-type-mtune=cpu-type-mcmodel=code-model-mmemory-model=mem-model-m32-m64-mapp-regs-mno-app-regs-mfaster-structs-mno-faster-structs-mflat-mno-flat-mfpu-mno-fpu-mhard-float-msoft-float-mhard-quad-float-msoft-quad-float-mstack-bias-mno-stack-bias-mstd-struct-return-mno-std-struct-return-munaligned-doubles-mno-unaligned-doubles-muser-mode-mno-user-mode-mv8plus-mno-v8plus-mvis-mno-vis-mvis2-mno-vis2-mvis3-mno-vis3-mvis4-mno-vis4-mvis4b-mno-vis4b-mcbcond-mno-cbcond-mfmaf-mno-fmaf-mfsmuld-mno-fsmuld-mpopc-mno-popc-msubxc-mno-subxc-mfix-at697f-mfix-ut699-mfix-ut700-mfix-gr712rc-mlra-mno-lra
โญ SPU Options โญ
-mwarn-reloc-merror-reloc-msafe-dma-munsafe-dma-mbranch-hints-msmall-mem-mlarge-mem-mstdmain-mfixed-range=register-range-mea32-mea64-maddress-space-conversion-mno-address-space-conversion-mcache-size=cache-size-matomic-updates-mno-atomic-updates
๐ฆ System V Options ๐ฆ
-Qy-Qn-YP,paths-Ym,dir
๐ TILE-Gx Options ๐
-mcpu=CPU-m32-m64-mbig-endian-mlittle-endian-mcmodel=code-model
๐ธ TILEPro Options ๐ธ
-mcpu=cpu-m32
๐ V850 Options ๐
-mlong-calls-mno-long-calls-mep-mno-ep-mprolog-function-mno-prolog-function-mspace-mtda=n-msda=n-mzda=n-mapp-regs-mno-app-regs-mdisable-callt-mno-disable-callt-mv850e2v3-mv850e2-mv850e1-mv850es-mv850e-mv850-mv850e3v5-mloop-mrelax-mlong-jumps-msoft-float-mhard-float-mgcc-abi-mrh850-abi-mbig-switch
๐ง VAX Options ๐ง
-mg-mgnu-munix
๐ Visium Options ๐
-mdebug-msim-mfpu-mno-fpu-mhard-float-msoft-float-mcpu=cpu-type-mtune=cpu-type-msv-mode-muser-mode
๐ VMS Options ๐
-mvms-return-codes-mdebug-main=prefix-mmalloc64-mpointer-size=size
๐ VxWorks Options ๐
-mrtp-non-static-Bstatic-Bdynamic-Xbind-lazy-Xbind-now
๐ x86 Options ๐
bestie this is the main character flag list, it's literally enormous, stay with me ๐ญ๐
-mtune=cpu-type-march=cpu-type-mtune-ctrl=feature-list-mdump-tune-features-mno-default-mfpmath=unit-masm=dialect-mno-fancy-math-387-mno-fp-ret-in-387-m80387-mhard-float-msoft-float-mno-wide-multiply-mrtd-malign-double-mpreferred-stack-boundary=num-mincoming-stack-boundary=num-mcld-mcx16-msahf-mmovbe-mcrc32-mrecip-mrecip=opt-mvzeroupper-mprefer-avx128-mprefer-vector-width=opt-mmmx-msse-msse2-msse3-mssse3-msse4.1-msse4.2-msse4-mavx-mavx2-mavx512f-mavx512pf-mavx512er-mavx512cd-mavx512vl-mavx512bw-mavx512dq-mavx512ifma-mavx512vbmi-msha-maes-mpclmul-mfsgsbase-mrdrnd-mf16c-mfma-mpconfig-mwbnoinvd-mptwrite-mprefetchwt1-mclflushopt-mclwb-mxsavec-mxsaves-msse4a-m3dnow-m3dnowa-mpopcnt-mabm-mbmi-mtbm-mfma4-mxop-madx-mlzcnt-mbmi2-mfxsr-mxsave-mxsaveopt-mrtm-mhle-mlwp-mmwaitx-mclzero-mpku-mthreads-mgfni-mvaes-mwaitpkg-mshstk-mmanual-endbr-mforce-indirect-call-mavx512vbmi2-mvpclmulqdq-mavx512bitalg-mmovdiri-mmovdir64b-mavx512vpopcntdq-mavx5124fmaps-mavx512vnni-mavx5124vnniw-mprfchw-mrdpid-mrdseed-msgx-mcldemote-mms-bitfields-mno-align-stringops-minline-all-stringops-minline-stringops-dynamically-mstringop-strategy=alg-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-mstackrealign-momit-leaf-frame-pointer-mno-red-zone-mno-tls-direct-seg-refs-mcmodel=code-model-mabi=name-maddress-mode=mode-m32-m64-mx32-m16-miamcu-mlarge-data-threshold=num-msse2avx-mfentry-mrecord-mcount-mnop-mcount-m8bit-idiv-minstrument-return=type-mfentry-name=name-mfentry-section=name-mavx256-split-unaligned-load-mavx256-split-unaligned-store-malign-data=type-mstack-protector-guard=guard-mstack-protector-guard-reg=reg-mstack-protector-guard-offset=offset-mstack-protector-guard-symbol=symbol-mgeneral-regs-only-mcall-ms2sysv-xlogues-mindirect-branch=choice-mfunction-return=choice-mindirect-branch-register
๐ช x86 Windows Options ๐ช
-mconsole-mcygwin-mno-cygwin-mdll-mnop-fun-dllimport-mthread-municode-mwin32-mwindows-fno-set-stack-executable
๐ Xstormy16 Options ๐
-msim
๐ฆ Xtensa Options ๐ฆ
-mconst16-mno-const16-mfused-madd-mno-fused-madd-mforce-no-pic-mserialize-volatile-mno-serialize-volatile-mtext-section-literals-mno-text-section-literals-mauto-litpools-mno-auto-litpools-mtarget-align-mno-target-align-mlongcalls-mno-longcalls
๐ซ zSeries Options ๐ซ
k so this one is just a redirect, bestie โ it literally says see S/390 and zSeries Options. iconic of it, honestly ๐
๐ Options Controlling the Kind of Output ๐
okay so real talk, a compile can go through up to four stages, and they always happen in this exact order, no skipping the line:
- preprocessing
- compilation proper
- assembly
- linking
GCC can preprocess and compile a bunch of files either into several assembler input files, or smoosh them all into one assembler input file ๐ซถ. Then each assembler input file spits out an object file, and linking pulls all the object files together โ both the freshly compiled ones and the ones you handed in as input โ into an executable file. it's giving teamwork, fr fr โจ
For any given input file, the file name suffix decides what kind of compilation happens, like this:
file.cโ C source code that must be preprocessed.file.iโ C source code that should not be preprocessed.file.iiโ C++ source code that should not be preprocessed.file.mโ Objective-C source code. Heads up bestie: you must link with thelibobjclibrary to make an Objective-C program work. don't skip that step ๐file.miโ Objective-C source code that should not be preprocessed.
file.mm,file.Mโ Objective-C++ source code. Heads up bestie, you must link with thelibobjclibrary or your Objective-C++ program is not gonna work, no cap. And.Mmeans a literal capital M, not a vibe, a capital letter. ๐file.miiโ Objective-C++ source code that should not be preprocessed. Leave it alone, it's fine as it is. ๐file.hโ a C, C++, Objective-C or Objective-C++ header file that's getting turned into a precompiled header (that's the default), or a C / C++ header file getting turned into an Ada spec (via the-fdump-ada-specswitch). Two paths, one extension, iconic behavior. โจfile.cc,file.cp,file.cxx,file.cpp,file.CPP,file.c++,file.Cโ C++ source code that must be preprocessed. Little detail that matters: in.cxx, the last two letters have to both be literallyx. Same energy with.Cโ that's a literal capital C, okay? Don't come for me. ๐file.mm,file.Mโ Objective-C++ source code that must be preprocessed. (Yes, she's back โ the manpage really does say it twice, I'm just the messenger. ๐ซถ)file.miiโ Objective-C++ source code that should not be preprocessed. Also back for round two. ๐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. So many spellings, all valid, we love an inclusive queen. ๐file.f,file.for,file.ftnโ 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โ Free form Fortran source code that should not be preprocessed. Free form, free spirit. ๐ฆfile.F90,file.F95,file.F03,file.F08โ Free form Fortran source code that must be preprocessed (with the traditional preprocessor).file.goโ Go source code.file.brigโ BRIG files, aka the binary representation of HSAIL.file.dโ D source code.file.diโ D interface file.file.ddโ D documentation code (Ddoc).file.adsโ Ada source code file containing 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). These ones are also called specs.file.adbโ Ada source code file containing a library unit body (a subprogram or package body). These are also called bodies. ๐ชfile.sโ Assembler code.file.S,file.sxโ Assembler code that must be preprocessed.otherโ an object file to be fed straight into linking. Any file name with no recognized suffix gets treated this way. No suffix, no problem, straight to the linker bestie. ๐
So like, you can also just tell gcc the language yourself with the -x option:
-xlanguage โ Specify explicitly the language for the following input files (instead of letting the compiler pick a default based on the file name suffix). This option applies to all following input files until the next-xoption shows up. Possible values for language are:
c c-header cpp-output
c++ c++-header c++-cpp-output
objective-c objective-c-header objective-c-cpp-output
objective-c++ objective-c++-header objective-c++-cpp-output
assembler assembler-with-cpp
ada
d
f77 f77-cpp-input f95 f95-cpp-input
go
brig
-x noneโ Turns off any specification of a language, so the files after it get handled according to their file name suffixes again (exactly like when-xwas never used at all). It's giving factory reset. ๐
If you only want some of the stages of compilation, you can use -x (or filename suffixes) to tell gcc where to start, and one of -c, -S, or -E to say where gcc is to stop. Lowkey important: some combinations (for example, -x cpp-output -E) instruct gcc to do nothing at all. A whole lot of nothing. ๐
-cโ Compile or assemble the source files, but do not link. The linking stage simply is not done. The ultimate output is an object file for each source file.
By default, the object file name for a source file is made by replacing the suffix .c, .i, .s, etc., with .o.
Unrecognized input files that don't require compilation or assembly are ignored. They're just there for the vibes. ๐
-Sโ Stop after the stage of compilation proper; do not assemble. The output is an assembler code file for each non-assembler input file you specified.
By default, the assembler file name for a source file is made by replacing the suffix .c, .i, etc., with .s.
Input files that don't require compilation are ignored.
-Eโ Stop after the preprocessing stage; do not run the compiler proper. The output is preprocessed source code, and it gets sent to the standard output.
Input files that don't require preprocessing are ignored.
-ofile โ Place output in file. This applies to whatever sort of output is being produced, whether that's an executable file, an object file, an assembler file or preprocessed C code.
If -o isn't specified, the default is 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. Defaults are giving main character energy, honestly. โญ
-vโ Print (on standard error output) the commands executed to run the stages of compilation. Also prints the version number of the compiler driver program and of the preprocessor and the compiler proper. Spill the tea, gcc. โ-###โ 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. Bestie behavior fr fr. ๐ซถ--helpโ Print (on the standard output) a description of the command-line options understood by gcc. If the-voption is also specified then--helpis also passed on to the various processes invoked by gcc, so they can display the command-line options they accept. And 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. We love a thorough queen. ๐--target-helpโ Print (on the standard output) a description of target-specific command-line options for each tool. For some targets extra target-specific information may also be printed. โจ--help={class|[^]qualifier}[,...]โ Print (on the standard output) a description of the command-line options understood by the compiler that fit into all specified classes and qualifiers.
These are the supported classes:
optimizersโ Display all of the optimization options supported by the compiler.warningsโ Display all of the options controlling warning messages produced by the compiler.targetโ Display target-specific options. Unlike the--target-helpoption though, target-specific options of the linker and assembler are not displayed. This is because those tools don't 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.commonโ Display the options that are common to all languages.
These are the supported qualifiers:
undocumentedโ Display only those options that are undocumented.joinedโ Display options taking an argument that appears after an equal sign in the same continuous piece of text, such as:--help=target.separateโ Display options taking an argument that appears as a separate word following the original option, such as:-o output-file.
So like, 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. That's a no from me. ๐ซ
Combining several classes is possible, although this usually restricts the output so much that there is nothing to display. One case where it does work, however, is when one of the classes is target. For example, to display all the target-specific optimization options, use:
--help=target,optimizers
The --help= option can be repeated on the command line. Each successive use displays its requested class of options, skipping those that have already been displayed. If --help is also specified anywhere on the command line then this takes precedence over any --help= option.
If the -Q option appears on the command line before the --help= option, then the descriptive text displayed by --help= is changed. Instead of describing the displayed options, an indication is given as to whether the option is enabled, disabled or set to a specific value (assuming that the compiler knows this at the point where the --help= option is used).
Here'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 possible to find out which optimizations are enabled at -O2 by using:
-Q -O2 --help=optimizers
Alternatively you can discover which binary optimizations are enabled by -O3 by using:
gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
diff /tmp/O2-opts /tmp/O3-opts | grep enabled
Not me showing you the diff pipeline, we're so back. ๐ฅ
--versionโ Display the version number and copyrights of the invoked GCC. Receipts, periodt. ๐งพ-pass-exit-codesโ okay so normallygccjust dips out with exit code1if any phase of the compiler returns a non-success return code. But if you pass this,gccinstead returns the numerically highest error produced by any phase that returned an error indication. And bestie, heads up: the C, C++, and Fortran front ends return4if an internal compiler error pops up. ๐ซ-pipeโ use pipes instead of temporary files for communication between the various stages of compilation. It lowkey fails on some systems where the assembler can't read from a pipe, but the GNU assembler has no trouble at all. โจ-specs=fileโ process file after the compiler reads in the standard specs file, so you can override the defaults that thegccdriver program uses when it's figuring out what switches to pass tocc1,cc1plus,as,ld, etc. You can specify more than one-specs=fileon the command line, and they get processed in order, left to right. ๐-wrapperโ invoke all subcommands under a wrapper program. The name of the wrapper program and its parameters get passed as a comma separated list.
gcc -c t.c -wrapper gdb,--args
This invokes all subprograms of gcc under gdb --args, so the invocation of cc1 is gdb --args cc1 .... ๐ฆ
-ffile-prefix-map=old=newโ when compiling files living in directory old, record any references to them in the result of the compilation as if the files lived in directory new instead. Specifying this option is equivalent to specifying all the individual-f*-prefix-mapoptions. This is how you make reproducible builds that are location independent. See also-fmacro-prefix-mapand-fdebug-prefix-map. ๐-fplugin=name.soโ load the plugin code in filename.so, assumed to be a shared object that getsdlopen'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, iykyk). Every plugin should define the callback functions specified in the Plugins API. ๐-fplugin-arg-name-key=valueโ define an argument called key with a value of value for the plugin called name. That's it, that's the whole thing. ๐-fdump-ada-spec[-slim]โ for C and C++ source and include files, generate corresponding Ada specs. Iconic crossover event fr. ๐-fada-spec-parent=unitโ in conjunction with-fdump-ada-spec[-slim]above, generate Ada specs as child units of parent unit.-fdump-go-spec=fileโ for input files in any language, generate corresponding Go declarations in file. This generates Go"const","type","var", and"func"declarations, which may be a genuinely useful way to start writing a Go interface to code written in some other language. ๐@fileโ read command-line options from file. The options that get read are inserted in place of the original@fileoption. If file doesn't exist, or can't be read, then the option is treated literally, and not removed.
Options inside file are separated by whitespace. A whitespace character can be included in an option by surrounding the entire option in either single or double quotes. Any character (including a backslash) can be included by prefixing the character you want included with a backslash. And plot twist: the file may itself contain additional @file options โ any such options get 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; and preprocessed C++ files use the suffix .ii. GCC recognizes files with these names and compiles them as C++ programs even if you call the compiler the exact same way you would for compiling C programs (usually with the name gcc). ๐
However โ and this is the part everyone gets wrong โ 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. Pick your fighter. ๐ฆ
โจ Options Controlling C Dialect โจ
The following options control the dialect of C (or languages derived from C, such as C++, Objective-C and Objective-C++) that the compiler accepts: ๐
-ansiโ In C mode, this is equivalent to-std=c90. In C++ mode, it is equivalent to-std=c++98.
This turns off certain features of GCC that are incompatible with ISO C90 (when compiling C code), or of standard C++ (when compiling C++ code), such as the "asm" and "typeof" keywords, and predefined macros such as "unix" and "vax" that identify the type of system you are using. It also enables the undesirable and rarely used ISO trigraph feature. For the C compiler, it disables recognition of C++ style // comments as well as the "inline" keyword. ๐
The alternate keywords "__asm__", "__extension__", "__inline__" and "__typeof__" continue to work despite -ansi. You would not want to use them in an ISO C program, of course, but it is useful to put them in header files that might be included in compilations done with -ansi. Alternate predefined macros such as "__unix__" and "__vax__" are also available, with or without -ansi. ๐ธ
The -ansi option does not cause non-ISO programs to be rejected gratuitously. For that, -Wpedantic is required in addition to -ansi. No cap.
The macro "__STRICT_ANSI__" is predefined when the -ansi option is used. Some header files may notice this macro and refrain from declaring certain functions or defining certain macros that the ISO standard doesn't call for; this is to avoid interfering with any programs that might use these names for other things.
Functions that are normally built in but do not have semantics defined by ISO C (such as "alloca" and "ffs") are not built-in functions when -ansi is used. ๐
-std=โ Determine 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 do not contradict it. For example, -std=c90 turns off certain features of GCC that are incompatible with ISO C90, such as the "asm" and "typeof" keywords, but not other GNU extensions that do not have a meaning in ISO C90, such as omitting the middle term of a "?:" expression. On the other hand, when a GNU dialect of a standard is specified, all features supported by the compiler are enabled, even when those features change the meaning of the base standard. As a result, some strict-conforming programs may be rejected. The particular standard is used by -Wpedantic to identify which features are GNU extensions given that version of the standard. For example -std=gnu90 -Wpedantic warns about C++ style // comments, while -std=gnu99 -Wpedantic does not. ๐ซถ
A value for this option must be provided; possible values are
c90c89iso9899:1990- Support all ISO C90 programs (certain GNU extensions that conflict with ISO C90 are disabled). Same as
-ansifor C code. ๐
- Support all ISO C90 programs (certain GNU extensions that conflict with ISO C90 are disabled). Same as
iso9899:199409- ISO C90 as modified in amendment 1.
c99c9xiso9899:1999iso9899: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 <http://gcc.gnu.org/c99status.html> for more information. The names
c9xandiso9899:199xare deprecated. โ ๏ธ
- 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 <http://gcc.gnu.org/c99status.html> for more information. The names
c11c1xiso9899:2011- ISO C11, the 2011 revision of the ISO C standard. This standard is substantially completely supported, modulo bugs, floating-point issues (mainly but not entirely relating to optional C11 features from Annexes F and G) and the optional Annexes K (Bounds-checking interfaces) and L (Analyzability). The name
c1xis deprecated. ๐
- ISO C11, the 2011 revision of the ISO C standard. This standard is substantially completely supported, modulo bugs, floating-point issues (mainly but not entirely relating to optional C11 features from Annexes F and G) and the optional Annexes K (Bounds-checking interfaces) and L (Analyzability). The name
c17c18iso9899:2017iso9899: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. โจ
- 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
c2x- The next version of the ISO C standard, still under development. The support for this version is experimental and incomplete. ๐งช
gnu90gnu89- GNU dialect of ISO C90 (including some C99 features).
gnu99gnu9x- GNU dialect of ISO C99. The name
gnu9xis deprecated. ๐
- GNU dialect of ISO C99. The name
gnu11gnu1x- GNU dialect of ISO C11. The name
gnu1xis deprecated. ๐
- GNU dialect of ISO C11. The name
gnu17gnu18- GNU dialect of ISO C17. This is the default for C code. ๐
gnu2x- The next version of the ISO C standard, still under development, plus GNU extensions. The support for this version is experimental and incomplete. ๐งช
c++98c++03- The 1998 ISO C++ standard plus the 2003 technical corrigendum and some additional defect reports. Same as
-ansifor C++ code. ๐
- The 1998 ISO C++ standard plus the 2003 technical corrigendum and some additional defect reports. Same as
gnu++98gnu++03- GNU dialect of
-std=c++98.
- GNU dialect of
c++11c++0x- The 2011 ISO C++ standard plus amendments. The name
c++0xis deprecated. ๐
- The 2011 ISO C++ standard plus amendments. The name
gnu++11gnu++0x- GNU dialect of
-std=c++11. The namegnu++0xis deprecated. ๐
- GNU dialect of
c++14c++1y- The 2014 ISO C++ standard plus amendments. The name
c++1yis deprecated. ๐
- The 2014 ISO C++ standard plus amendments. The name
gnu++14gnu++1y- GNU dialect of
-std=c++14. This is the default for C++ code. The namegnu++1yis deprecated. ๐
- GNU dialect of
c++17c++1z- The 2017 ISO C++ standard plus amendments. The name
c++1zis deprecated. ๐
- The 2017 ISO C++ standard plus amendments. The name
gnu++17gnu++1zโ GNU dialect of-std=c++17. Heads up bestie, the namegnu++1zis deprecated ๐.c++2aโ the next revision of the ISO C++ standard, tentatively planned for 2020. Support is highly experimental, and will almost certainly change in incompatible ways in future releases. so like, don't build your whole life on it, okay? ๐gnu++2aโ GNU dialect of-std=c++2a. Support is highly experimental, and will almost certainly change in incompatible ways in future releases. same energy as above, fr fr.
-fgnu89-inlineโ tells GCC to use the traditional GNU semantics forinlinefunctions when you're in C99 mode.
Using this option is roughly equivalent to adding the gnu_inline function attribute to all inline functions. slay, one flag doing the work of a hundred attributes ๐
.
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. vibe check your inline semantics, bestie โจ.
-fpermitted-flt-eval-methods=styleโ ISO/IEC TS 18661-3 defines new permissible values forFLT_EVAL_METHODthat say: operations and constants with a semantic type that's an interchange or extended format should be evaluated to the precision and range of that type. These new values are a superset of those permitted under C99/C11, which does not specify the meaning of other positive values ofFLT_EVAL_METHOD. So basically, code that conforms to C11 may not have been written expecting the possibility of these 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. defaults are giving main character energy, honestly ๐.
-aux-infofilename โ output to the given filename prototyped declarations for all functions declared and/or defined in a translation unit, including those in header files. This option is silently ignored in any language other than C. (C only, bestie, it's exclusive ๐.)
Besides declarations, the file indicates, in comments, the origin of each declaration (source file and line), whether the declaration was implicit, prototyped or unprototyped (I, N for new or O for old, respectively, in the first character after the line number and the colon), and whether it came from a declaration or a definition (C or F, respectively, in the following character). In the case of function definitions, a K&R-style list of arguments followed by their declarations is also provided, inside comments, after the declaration. so much lore in one file, I'm obsessed ๐.
-fallow-parameterless-variadic-functionsโ accept variadic functions without named parameters.
Although it's possible to define such a function, this is not very useful as it's not possible to read the arguments. This is only supported for C as this construct is allowed by C++.
-fno-asmโ do not recognizeasm,inlineortypeofas a keyword, so that code can use these words as identifiers. You can use the keywords__asm__,__inline__and__typeof__instead.-ansiimplies-fno-asm.
In C++, this switch only affects the typeof keyword, since asm and inline are standard keywords. You may want to use the -fno-gnu-keywords flag instead, which has the same effect. 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.
-fno-builtin-fno-builtin-functionโ don't recognize built-in functions that do not begin with__builtin_as prefix.
GCC normally generates special code to handle certain built-in functions more efficiently; for instance, calls to alloca may become single instructions which adjust the stack directly, and calls to memcpy may become inline copy loops. The resulting code is often both smaller and faster, but since the function calls no longer appear as such, you cannot set a breakpoint on those calls, nor can you change the behavior of the functions by linking with a different library. In addition, when a function is recognized as a built-in function, GCC may use information about that function to warn about problems with calls to that function, or to generate more efficient code, even if the resulting code still contains calls to that function. For example, warnings are given with -Wformat for bad calls to printf when printf is built in and strlen is known not to modify global memory. so iconic of GCC honestly ๐
.
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))
(yes bestie, -fbuiltin-function genuinely doesn't exist, don't come for me, I'm just the messenger ๐ซถ.)
-fgimpleโ enable parsing of function definitions marked with__GIMPLE. This is an experimental feature that allows unit testing of GIMPLE passes. it's giving "for the compiler girlies only" ๐ง.-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.-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. kernel girlies rise ๐ฆ.-fopenaccโ enable handling of OpenACC directives#pragma accin C/C++ and!$accin Fortran. When-fopenaccis specified, the compiler generates accelerated code according to the OpenACC Application Programming Interface v2.0 <https://www.openacc.org>. This option implies-pthread, and thus is only supported on targets that have support for-pthread. โจ accelerate โจ.-fopenacc-dim=geomโ specify default compute dimensions for parallel offload regions that do not explicitly specify. The geom value is a triple of:-separated sizes, in ordergang,workerand,vector. A size can be omitted, to use a target-specific default value.-fopenmpโ enable handling of OpenMP directives#pragma ompin C/C++ and!$ompin Fortran. When-fopenmpis specified, the compiler generates parallel code according to the OpenMP Application Program Interface v4.5 <https://www.openmp.org>. This option implies-pthread, and thus is only supported on targets that have support for-pthread.-fopenmpimplies-fopenmp-simd. parallel bestie era ๐ฅ.-fopenmp-simdโ enable handling of OpenMP's SIMD directives with#pragma ompin C/C++ and!$ompin Fortran. Other OpenMP directives are ignored.-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).
-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 but x86 targets using ms-abi.
-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++. (C girlies, this one's yours ๐.)
-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++.-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, it's deprecated behavior, don't do it, I'm begging ๐.-funsigned-charโ let the typecharbe unsigned, likeunsigned char.
Each kind of machine has a default for what char should be. It is either like unsigned char by default or like signed char by default.
Ideally, a portable program should always use signed char or unsigned char when it depends on the signedness of an object. But many programs have been written to use plain char and expect it to be signed, or expect it to be unsigned, depending on the machines they were written for. This option, and its inverse, let you make such a program work with the opposite default.
The type char is always a distinct type from each of signed char or unsigned char, even though its behavior is always just like one of those two. no cap, it's its own thing ๐
.
-fsigned-charโ let the typecharbe signed, likesigned char.
Note that this is equivalent to -fno-unsigned-char, which is the negative form of -funsigned-char. Likewise, the option -fno-signed-char is equivalent to -funsigned-char. flip-flop central over here ๐โจ.
-fsigned-bitfields,-funsigned-bitfields,-fno-signed-bitfields,-fno-unsigned-bitfieldsโ bestie, these four decide whether a bit-field is signed or unsigned when the declaration is out here being vague and doesn't saysignedorunsigneditself. And the default? Signed. Why? Because it's consistent โ the basic integer types likeintare signed types, so we keep the vibe matching. ๐-fsso-struct=endiannessโ sets the default scalar storage order of structs and unions to whatever endianness you name. The accepted values arebig-endian,little-endian, andnativefor the native endianness of the target (that one's the default). Heads up though: this option is not supported for C++. ๐
โ ๏ธ Warning, and I mean it: the -fsso-struct switch makes GCC generate code that is not binary compatible with code generated without it, if the endianness you picked isn't the native endianness of the target. So likeโฆ know what you're doing, bestie. ๐ญ
โจ Options Controlling C++ Dialect โจ ๐
Okay so this section is all about the command-line options that are only meaningful for C++ programs. But plot twist: you can still use most of the GNU compiler options no matter what language your program is in. Like, say you compile a file firstClass.C like this:
g++ -g -fstrict-enums -O -c firstClass.C
In that example, only -fstrict-enums is an option meant only for C++ programs; the rest of them you can use with any language GCC supports. ๐
Also, some options for compiling C programs โ like -std โ are relevant for C++ programs too. Slay.
And now, the list of options that are only for compiling C++ programs:
-fabi-version=nโ use version n of the C++ ABI. The default is version 0. Now let me walk you through the whole family tree because it's giving lore:- Version 0 โ the version conforming most closely to the C++ ABI specification. Which means the ABI you get with version 0 will change in different versions of G++ as ABI bugs get fixed. ๐
- Version 1 โ the version of the C++ ABI that first appeared in G++ 3.2.
- Version 2 โ the version of the C++ ABI that first appeared in G++ 3.4, and was the default all the way through G++ 4.9.
- Version 3 โ corrects an error in mangling a constant address as a template argument.
- Version 4, first appearing in G++ 4.5 โ implements a standard mangling for vector types.
- Version 5, first appearing in G++ 4.6 โ corrects the mangling of attribute const/volatile on function pointer types,
decltypeof a plain decl, and use of a function parameter in the declaration of another parameter. - Version 6, first appearing 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, first appearing in G++ 4.8 โ treats
nullptr_tas a builtin type and corrects the mangling of lambdas in default argument scope. - Version 8, first appearing in G++ 4.9 โ corrects the substitution behavior of function types with function-cv-qualifiers.
- Version 9, first appearing in G++ 5.2 โ corrects the alignment of
nullptr_t. - Version 10, first appearing in G++ 6.1 โ adds mangling of attributes that affect type identity, such as ia32 calling convention attributes (e.g.
stdcall). - Version 11, first appearing 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, first appearing in G++ 8 โ corrects the calling conventions for empty classes on the x86_64 target and for classes with only deleted copy/move constructors. It accidentally changes the calling convention for classes with a deleted copy constructor and a trivial move constructor. ๐ซ
- Version 13, first appearing in G++ 8.2 โ fixes that accidental change from version 12.
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 whenever it's defining a symbol with an incorrect mangled name. This switch tells it which ABI version to use for that alias.
With -fabi-version=0 (the default), this defaults to 11 (GCC 7 compatibility). If another ABI version is explicitly selected, this defaults to 0. And if you want compatibility with GCC versions 3.2 through 4.9, use -fabi-compat-version=2.
If this option isn't provided but -Wabi=n is, then that version gets used for the compatibility aliases. If this option is provided along with -Wabi (without the version), the version from this option is what gets used for the warning. iykyk ๐
-fno-access-controlโ turns off all access checking. This switch is mainly useful for working around bugs in the access control code. Like, it's the "just let me in" button. ๐ช-faligned-newโ enables support for C++17newof types that require more alignment thanvoid* ::operator new(std::size_t)provides. You can pass a numeric argument like-faligned-new=32to specify how much alignment (in bytes) that function provides, but honestly few users will ever need to override the default ofalignof(std::max_align_t). This flag is enabled by default for-std=c++17. โจ-fchar8_t,-fno-char8_tโ enables support forchar8_tas adopted for C++2a. This includes adding a brand newchar8_tfundamental type, changes to the types of UTF-8 string and character literals, new signatures for user-defined literals, associated standard library updates, and new__cpp_char8_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 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;
Now here's the messy part โ 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:
char ca[] = u8"xx"; // error: char-array initialized from wide
// string
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
Yeah. It's giving "breaking change." ๐ญ
-fcheck-newโ checks that the pointer returned byoperator newis non-null before attempting to modify the storage that was allocated. This check is normally unnecessary because the C++ standard saysoperator newonly returns 0 if it's declaredthrow(), and in that 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++ Extensions for Concepts Technical Specification, ISO 19217 (2015), which allows code like:
template <class T> concept bool Addable = requires (T t) { t + t; };
template <Addable T> T add (T a, T b) { return a + b; }
-fconstexpr-depth=nโ sets the maximum nested evaluation depth for C++11 constexpr functions to n. A limit is needed so we can detect endless recursion during constant expression evaluation. The minimum specified by the standard is 512. ๐-fconstexpr-loop-limit=nโ sets the maximum number of iterations for a loop in C++14 constexpr functions to n. A limit is needed to detect infinite loops during constant expression evaluation. The default is 262144 (1<<18).-fconstexpr-ops-limit=nโ 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 has many iterations but still smaller than the above limit, or if in the 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). โณ-fdeduce-init-listโ enables deduction of a template type parameter asstd::initializer_listfrom a brace-enclosed initializer list, i.e.
template <class T> auto forward(T t) -> decltype (realfn (t))
{
return realfn (t);
}
void f()
{
forward({1,2}); // call forward<std::initializer_list<int>>
}
This deduction was implemented as a possible extension to the originally proposed semantics for the C++11 standard, but it was not part of the final standard, so it's disabled by default. This option is deprecated, and may be removed in a future version of G++. ๐
-fno-elide-constructorsโ okay so the C++ standard allows an implementation to omit creating a temporary that's only used to initialize another object of the same type. Specifying this option disables that optimization, and forces G++ to call the copy constructor in all cases. This option also makes G++ call trivial member functions which otherwise would've been 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โ bestie, this one says don't bother generating code that checks at runtime whether you violated an exception specification. It straight-up violates the C++ standard, but it can shrink your code in production builds, kinda like definingNDEBUG. ๐ Important though: this does not give your code permission to throw exceptions that break the exception specifications โ the compiler is still out here optimizing based on those specs, so if you throw something unexpected you land in undefined behavior at run time. ๐ญ-fextern-tls-init,-fno-extern-tls-initโ okay so C++11 and OpenMP letthread_localandthreadprivatevariables have dynamic (runtime) initialization, right? To make that work, every use of such a variable goes through a lil wrapper function that does whatever init is needed. โจ When the use and the definition live in the same translation unit, that overhead gets optimized away โ but when the use is in a different TU, there's significant overhead even if the variable doesn't actually need dynamic init. ๐ So if you, the programmer, are sure that no use of the variable in a non-defining TU needs to trigger dynamic initialization (either because it's statically initialized, or because a use in the defining TU will run before any uses in another TU), you can dodge that overhead with-fno-extern-tls-init.
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. ๐
-fno-gnu-keywordsโ don't recognizetypeofas a keyword, so your code can just use that word as an identifier like it's nothing. You can still use the keyword__typeof__instead. ๐ This one is implied by the strict ISO C++ dialects:-ansi,-std=c++98,-std=c++11, etc.-fno-implicit-templatesโ never emit code for non-inline templates that get instantiated implicitly (i.e. by use); only emit code for explicit instantiations. โ ๏ธ Heads up: if you use this, you must be careful to structure your code so it includes all the necessary explicit instantiations, or you'll get undefined symbols at link time. No cap.-fno-implicit-inline-templatesโ and don't emit code for implicit instantiations of inline templates either. The default is to treat inlines differently, so that compiling with and without optimization needs the same set of explicit instantiations. ๐ฆ-fno-implement-inlinesโ to save space, don't emit out-of-line copies of inline functions controlled by#pragma implementation. This causes linker errors if those functions aren't inlined everywhere they're called. ๐-fms-extensionsโ disablesWpedanticwarnings about constructs used in MFC, like implicitintand getting a pointer to member function via non-standard syntax. ๐ธ-fnew-inheriting-ctorsโ turns on the P0136 adjustment to the semantics of C++11 constructor inheritance. It's part of C++17 but also considered 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โ enables the P0522 resolution to Core issue 150, template template parameters and default arguments: it lets a template with default template arguments be an argument for a template template parameter that has fewer template parameters. Enabled by default for-std=c++17. โญ-fno-nonansi-builtinsโ disables built-in declarations of functions that ANSI/ISO C doesn't mandate. That list includesffs,alloca,_exit,index,bzero,conjf, and other related functions. ๐-fnothrow-optโ treats athrow()exception specification as if it were anoexceptspecification, so you reduce or eliminate the text size overhead compared to a function with no exception spec at all. Fun twist: 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? An exception thrown out of a function with such an exception specification results in a call toterminaterather thanunexpected. ๐ซถ-fno-operator-namesโ don't treat the operator name keywordsand,bitand,bitor,compl,not,orandxoras synonyms as keywords. periodt.-fno-optional-diagsโ disable diagnostics that the standard says a compiler doesn't need to issue. Currently the only such diagnostic G++ issues is the one for a name having multiple meanings within a class. ๐-fpermissiveโ downgrades some diagnostics about nonconformant code from errors to warnings. So yeah, using-fpermissivelets some nonconforming code compile. ๐-fno-pretty-templatesโ okay so normally, when an error message refers to a specialization of a function template, the compiler prints the signature of the template followed by the template arguments and any typedefs or typenames in the signature (likevoid f(T) [with T = int]instead ofvoid f(int)) so it's clear which template is involved. And when an error message refers to a specialization of a class template, the compiler omits any template arguments that match the default template arguments for that template. If either of those behaviors makes the error message harder to understand instead of easier, you can use-fno-pretty-templatesto disable them. ๐-frepoโ enable automatic template instantiation at link time. This option also implies-fno-implicit-templates. ๐ฅ-fno-rttiโ disable generation of information about every class with virtual functions for use by the C++ run-time type identification features (dynamic_castandtypeid). If you don't use those parts of the language, you can save some space with this flag. Note that exception handling uses the same information, but G++ generates it as needed. And thedynamic_castoperator can still be used for casts that don't require run-time type information, i.e. casts tovoid *or to unambiguous base classes. โจ
โ ๏ธ Mixing code compiled with -frtti and code compiled with -fno-rtti may not work. For example, programs may fail to link if a class compiled with -fno-rtti is used as a base for a class compiled with -frtti. ๐
-fsized-deallocationโ enables the built-in global declarations
void operator delete (void *, std::size_t) noexcept;
void operator delete[] (void *, std::size_t) noexcept;
as introduced in C++14. This is useful for user-defined replacement deallocation functions that, for example, use the size of the object to make deallocation faster. ๐ Enabled by default under -std=c++14 and above. The flag -Wsized-deallocation warns about places that might want to add a definition.
-fstrict-enumsโ lets the compiler optimize using the assumption that a value of an enumerated type can only be one of the values of the enumeration (as defined in the C++ standard; basically, a value that can be represented in the minimum number of bits needed to represent all the enumerators). ๐ This assumption may not be valid if the program uses a cast to convert an arbitrary integer value to the enumerated type. ๐-fstrong-eval-orderโ evaluate member access, array subscripting, and shift expressions in left-to-right order, and evaluate assignment in right-to-left order, as adopted for C++17. Enabled by default with-std=c++17. And-fstrong-eval-order=someenables just the ordering of member access and shift expressions โ that one is the default without-std=c++17. โญ-ftemplate-backtrace-limit=n โ set the maximum number of template instantiation notes for a single warning or error to n. The default value is10. ๐-ftemplate-depth=n โ set the maximum instantiation depth for template classes to n. A limit on the template instantiation depth is needed to detect endless recursions during template class instantiation. ANSI/ISO C++ conforming programs must not rely on a maximum depth greater than17(changed to1024in C++11). The default value is900, because the compiler can run out of stack space before hitting1024in some situations. ๐ญ-fno-threadsafe-staticsโ don't emit the extra code that uses the routines specified in the C++ ABI for thread-safe initialization of local statics. You can use this option to reduce code size slightly in code that doesn't need to be thread-safe. ๐-fuse-cxa-atexitโ register destructors for objects with static storage duration with the__cxa_atexitfunction rather than theatexitfunction. This option is 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 causesstd::uncaught_exceptionto be incorrect, but it's necessary if the runtime routine isn't available. ๐-fvisibility-inlines-hiddenโ this switch declares that the user does not attempt to compare pointers to inline functions or methods where the addresses of the two functions are taken in different shared objects. ๐
The effect of this is that GCC may, effectively, mark inline methods with __attribute__ ((visibility ("hidden"))) so that they don't appear in the export table of a DSO and don't require a PLT indirection when used within the DSO. โจ Enabling this option can have a dramatic effect on load and link times of a DSO, because it massively reduces the size of the dynamic export table when the library makes heavy use of templates. ๐ฅ
The behavior of this switch is not quite the same as marking the methods as hidden directly, because it does not affect static variables local to the function or cause the compiler to deduce that the function is defined in only one shared object. ๐
You may mark a method as having a visibility explicitly to negate the effect of the switch for that method. For example, if you do want to compare pointers to a particular inline method, you might mark it as having default visibility. Marking the enclosing class with explicit visibility has no effect. ๐
Explicitly instantiated inline methods are unaffected by this option, as their linkage might otherwise cross a shared library boundary. ๐ฆ
-fvisibility-ms-compatโ okay so this flag is literally trying to use visibility settings to make GCC's C++ linkage model compatible with Microsoft Visual Studio's. It's giving "can we be friends with MSVC?" energy, bestie. ๐
The flag makes these changes 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 are permitted when this option is not used.
In new code it is better to use -fvisibility=hidden and export those classes that are intended to be externally visible. Unfortunately it is possible for code to rely, perhaps accidentally, on the Visual Studio behavior. ๐
Among the consequences of these changes are that static data members of the same type with the same name but defined in different shared objects are different, so changing one does not change the other; and that pointers to function members defined in different shared objects may not compare equal. When this flag is given, it is a violation of the ODR to define types with the same name differently. So like, don't do that.
-fno-weakโ bestie, do NOT use weak symbol support, even if it's provided by the linker. By default, G++ uses weak symbols if they are available. This option exists only for testing, and should not be used by end-users; it results in inferior code and has no benefits. This option may be removed in a future release of G++. ๐-nostdinc++โ Do not search for header files in the standard directories specific to C++, but do still search the other standard directories. (This option is used when building the C++ library.) ๐ง
In addition, these optimization, warning, and code generation options have meanings only for C++ programs:
-Wabi(C, Objective-C, C++ and Objective-C++ only) โ Warn when G++ generates code that is probably not compatible with the vendor-neutral C++ ABI. Since G++ now defaults to updating the ABI with each major release, normally-Wabiwill warn only if there is a check added later in a release series for an ABI issue discovered since the initial release.-Wabiwill warn 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 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 ABI warnings.
Although an effort has been made to warn about all such cases, there are probably some cases that are not warned about, even though G++ is generating incompatible code. There may also be cases where warnings are emitted even though the code that is generated is compatible. ๐ญ
You should rewrite your code to avoid these warnings if you are concerned about the fact that code generated by G++ may not be binary compatible with code generated by other compilers.
Known incompatibilities in -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.
It also warns about psABI-related changes. The known psABI changes at this point include:
- For SysV/x86-64, unions with
long doublemembers are passed in memory as specified in psABI. For example:
union U {
long double ld;
int i;
};
union U is always passed in memory.
-Wabi-tag(C++ and Objective-C++ only) โ Warn when a type with an ABI tag is used in a context that does not have that ABI tag. See C++ Attributes for more information about ABI tags. ๐ท๏ธ-Wctor-dtor-privacy(C++ and Objective-C++ only) โ Warn when a class seems unusable because all the constructors or destructors in that class are private, and it has neither friends nor public static member functions. Also warn if there are no non-private methods, and there's at least one private member function that isn't a constructor or destructor. ๐ช-Wdelete-non-virtual-dtor(C++ and Objective-C++ only) โ Warn whendeleteis used to destroy an instance of a class that has virtual functions and non-virtual destructor. It is unsafe to delete an instance of a derived class through a pointer to a base class if the base class does not have a virtual destructor. This warning is enabled by-Wall. ๐๏ธ-Wdeprecated-copy(C++ and Objective-C++ only) โ Warn that the implicit declaration of a copy constructor or copy assignment operator is deprecated if the class has a user-provided copy constructor or copy assignment operator, in C++11 and up. This warning is enabled by-Wextra. With-Wdeprecated-copy-dtor, also deprecate if the class has a user-provided destructor. ๐-Wno-init-list-lifetime(C++ and Objective-C++ only) โ Do not warn about uses ofstd::initializer_listthat are likely to result in dangling pointers. Since the underlying array for aninitializer_listis handled like a normal C++ temporary object, it is easy to inadvertently keep a pointer to the array past the end of the array's lifetime. For example: ๐ซ- If a function returns a temporary
initializer_list, or a 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.
- If a function returns a temporary
// 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.
-Wliteral-suffix(C++ and Objective-C++ only) โ Warn when a string or character literal is followed by a ud-suffix which does not begin with an underscore. As a conforming extension, GCC treats such suffixes as separate preprocessing tokens in order to maintain backwards compatibility with code that uses formatting macros from<inttypes.h>. For example: โจ
#define __STDC_FORMAT_MACROS
#include <inttypes.h>
#include <stdio.h>
int main() {
int64_t i64 = 123;
printf("My int64: %" PRId64"\n", i64);
}
In this case, PRId64 is treated as a separate preprocessing token.
Additionally, warn when a user-defined literal operator is declared with a literal suffix identifier that doesn't begin with an underscore. Literal suffix identifiers that don't begin with an underscore are reserved for future standardization.
This warning is enabled by default.
-Wlto-type-mismatchโ During the link-time optimization warn about type mismatches in global declarations from different compilation units. Requires-fltoto be enabled. Enabled by default. ๐-Wno-narrowing(C++ and Objective-C++ only) โ bestie, for C++11 and later standards, narrowing conversions get diagnosed by default, because the standard literally says so. A narrowing conversion from a constant = full-on error, and a narrowing conversion from a non-constant = just a warning, but-Wno-narrowingshuts the whole diagnostic up. Important caveat tho: this does not change the meaning of well-formed code โ narrowing conversions are still considered ill-formed in SFINAE contexts. The vibes are suppressed, not the rules. ๐
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. iykyk โจ
-Wnoexcept(C++ and Objective-C++ only) โ warns you when anoexcept-expression evaluates to false because of a call to a function that doesn't have a non-throwing exception specification (i.e.throw()or"noexcept") but is known by the compiler to never actually throw an exception. It's giving "you said you'd never do this and yetโฆ" ๐ญ-Wnoexcept-type(C++ and Objective-C++ only) โ warns if the C++17 feature that makes"noexcept"part of a function type changes the mangled name of a symbol compared to C++14. Enabled by-Wabiand-Wc++17-compat. Symbol name glow-ups are not always welcome.
As an example:
template <class T> void f(T t) { t(); };
void g() noexcept;
void h() { f(g); }
In C++14, "f" calls "f<void(*)()>", but in C++17 it calls "f<void(*)()noexcept>". Same code, different mangled name, iconic chaos ๐
-Wclass-memaccess(C++ and Objective-C++ only) โ warns when the destination of a call to a raw memory function like"memset"or"memcpy"is an object of class type, and when writing into such an object might bypass the class's non-trivial or deleted constructor or copy assignment, violate const-correctness or encapsulation, or corrupt virtual table pointers. Modifying the representation of such objects may violate invariants maintained by member functions of the class. For example, the call to"memset"below is undefined because it modifies a non-trivial class object and is, therefore, diagnosed. The safe way to either initialize or clear the storage of objects of such types is by using the appropriate constructor or assignment operator, if one is available. ๐ซถ
std::string str = "abc";
memset (&str, 0, sizeof str);
The -Wclass-memaccess option is enabled by -Wall. Explicitly casting the pointer to the class object to "void *" or to a type that can be safely accessed by the raw memory function suppresses the warning. Problem solved, gatekept, slayed.
-Wnon-virtual-dtor(C++ and Objective-C++ only) โ warns when a class has virtual functions and an accessible non-virtual destructor, either 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. โ ๏ธ-Wregister(C++ and Objective-C++ only) โ warns on uses of the"register"storage class specifier, except when it's part of the GNU Explicit Register Variables extension. Using"register"as a storage class specifier has been deprecated in C++11 and removed in C++17. Enabled by default with-std=c++17. RIP register, you had a good run. ๐ชฆ-Wreorder(C++ and Objective-C++ only) โ warns when the order of member initializers written in the code doesn't match the order in which they must actually be executed. For instance:
struct A {
int i;
int j;
A(): j (0), i (1) { }
};
The compiler rearranges the member initializers for "i" and "j" to match the declaration order of the members, and emits a warning about it. This warning is enabled by -Wall. The compiler is the main character here, not your initializer list. ๐
-Wno-pessimizing-move(C++ and Objective-C++ only) โ warns when a call to"std::move"prevents copy elision. A typical scenario where copy elision can occur is when returning in a function with a class return type, when the expression being returned is the name of a non-volatile automatic object, and is not a function parameter, and has the same type as the function return type.
struct T {
...
};
T fn()
{
T t;
...
return std::move (t);
}
But in this example, the "std::move" call prevents copy elision. You sabotaged your own optimization, bestie. ๐ญ
This warning is enabled by -Wall.
-Wno-redundant-move(C++ and Objective-C++ only) โ warns about redundant calls to"std::move"; that is, when a move operation would have been performed even without the"std::move"call. This happens because the compiler is forced to treat the object as if it were an rvalue in certain situations, such as returning a local variable, where copy elision isn't applicable. Consider:
struct T {
...
};
T fn(T t)
{
...
return std::move (t);
}
Here, the "std::move" call is redundant. Because G++ implements Core Issue 1579, another example is:
struct T { // convertible to U
...
};
struct U {
...
};
U fn()
{
T t;
...
return std::move (t);
}
In this example, copy elision isn't applicable because the type of the expression being returned and the function return type differ, yet G++ treats the return value as if it were designated by an rvalue. Extra effort for zero payoff, we've all been there.
This warning is enabled by -Wextra.
-fext-numeric-literals(C++ and Objective-C++ only) โ accepts 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. This is on by default for all pre-C++11 dialects and all GNU dialects:-std=c++98,-std=gnu++98,-std=gnu++11,-std=gnu++14. This option is off by default for ISO C++11 onwards (-std=c++11, ...). โจ
The following -W... options are not affected by -Wall. They march to the beat of their own drum. ๐ฅ
-Weffc++(C++ and Objective-C++ only) โ warns about violations of the following style guidelines from Scott Meyers' Effective C++ series of books:- Define a copy constructor and an assignment operator for classes with dynamically-allocated memory.
- Prefer initialization to assignment in constructors.
- Have
"operator="return a reference to*this. - Don't try to return a reference when you must return an object.
- Distinguish between prefix and postfix forms of increment and decrement operators.
- Never overload
"&&","||", or",".
This option also enables -Wnon-virtual-dtor, which is also one of the effective C++ recommendations. However, the check is extended to warn about the lack of virtual destructor in accessible non-polymorphic base classes too. Extra thorough, as she should be.
When selecting this option, be aware that the standard library headers do not obey all of these guidelines; use grep -v to filter out those warnings. ๐ซ
-Wstrict-null-sentinel(C++ and Objective-C++ only) โ warns about the use of an uncasted"NULL"as a sentinel. When compiling only with GCC this is a valid sentinel, as"NULL"is defined to"__null". Although it is a null pointer constant rather than a null pointer, it is guaranteed to be of the same size as a pointer. But this use is not portable across different compilers. โ ๏ธ-Wno-non-template-friend(C++ and Objective-C++ only) โ disables warnings when non-template friend functions are declared within a template. In very old versions of GCC that predate implementation of the ISO standard, declarations such 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 compatibility problems, and is enabled by default. ๐ง-Wold-style-cast(C++ and Objective-C++ only) โ warns if an old-style (C-style) cast to a non-void type is used within a C++ program. The new-style casts ("dynamic_cast","static_cast","reinterpret_cast", and"const_cast") are less vulnerable to unintended effects and much easier to search for. Glow-up your casts, bestie. ๐-Woverloaded-virtual(C++ and Objective-C++ only) โ warns when a function declaration hides virtual functions from a base class. For example, in:
struct A {
virtual void f();
};
struct B: public A {
void f(int);
};
the "A" class version of "f" is hidden in "B", and code like:
B* b;
b->f();
fails to compile. Not the vibe check you wanted. ๐
-Wno-pmf-conversions(C++ and Objective-C++ only) โ disables the diagnostic for converting a bound pointer to member function to a plain pointer. ๐-Wsign-promo(C++ and Objective-C++ only) โ warns when overload resolution chooses a promotion from unsigned or enumerated type to a signed type, over a conversion to an unsigned type of the same size. Previous versions of G++ tried to preserve unsignedness, but the standard mandates the current behavior. The standard said "no" and that's that.-Wtemplates(C++ and Objective-C++ only) โ warns when a primary template declaration is encountered. Some coding rules disallow templates, and this may be used to enforce that rule. The warning is inactive inside a system header file, such as the STL, so one can still use the STL. One may also instantiate or specialize templates. โจ-Wmultiple-inheritance(C++ and Objective-C++ only) โ warns when a class is defined with multiple direct base classes. Some coding rules disallow multiple inheritance, and this may be used to enforce that rule. The warning is inactive inside a system header file, such as the STL, so one can still use the STL. One may also define classes that indirectly use multiple inheritance. ๐ธ-Wvirtual-inheritanceโ warns when a class is defined with a virtual direct base class. Some coding rules disallow multiple inheritance, and this may be used to enforce that rule. The warning is inactive inside a system header file, such as the STL, so one can still use the STL. One may also define classes that indirectly use virtual inheritance. ๐ฆ-Wnamespacesโ this one yells at you whenever a namespace definition gets opened, bestie. Some coding rules straight-up ban namespaces and this is how you enforce that rule. Important tho: the warning is inactive inside a system header file, like the STL, so you can still use the STL. You can also still use using directives and qualified names. ๐-Wno-terminate(C++ and Objective-C++ only) โ turns off the warning about athrow-expression that's about to immediately result in a call toterminate. iykyk.-Wno-class-conversion(C++ and Objective-C++ only) โ turns off the warning for when a conversion function converts an object to the same type, to a base class of that type, or tovoid. Likeโฆ such a conversion function will never be called. it's giving useless, fr fr. ๐ญ
๐ฆ Options Controlling Objective-C and Objective-C++ Dialects ๐ฆ
NOTE: This manual does not describe the Objective-C and Objective-C++ languages themselves. We're just doing the compiler flags here, bestie. ๐
So this whole section is about the command-line options that are only meaningful for Objective-C and Objective-C++ programs. But good news: you can also use most of the language-independent GNU compiler options. Like, say you wanted to compile a file some_class.m, you'd do:
gcc -g -fgnu-runtime -O -c some_class.m
In that little example, -fgnu-runtime is an option meant only for Objective-C and Objective-C++ programs โ but the other options? You can use those with any language GCC supports. slay.
Also, 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). And similarly, Objective-C++ compilations may use C++-specific options (e.g., -Wabi). the way that languages stackโฆ ๐
Here's the full list of options that are only for compiling Objective-C and Objective-C++ programs:
- *
-fconstant-string-class=class-name* โ use class-name as the name of the class to instantiate for each literal string specified with the syntax@"...". The default class name isNXConstantStringif the GNU runtime is being used, andNSConstantStringif the NeXT runtime is being used (see below, bestie). And heads up: the-fconstant-cfstringsoption, if it's also present, overrides the-fconstant-string-classsetting and causes@"..."literals to be laid out as constant CoreFoundation strings. -fgnu-runtimeโ generate object code compatible with the standard GNU Objective-C runtime. This is the default for most types of systems. ๐-fnext-runtimeโ generate output compatible with the NeXT runtime. This is the default for NeXT-based systems, including Darwin and Mac OS X. And the macro__NEXT_RUNTIME__gets predefined if (and only if) this option is used. periodt.-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. โก But bestie, this option is only available in conjunction with the NeXT runtime and ABI version 0 or 1. no exceptions.- *
-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 nothing is specified, the default is Version 0 on 32-bit target machines, and Version 2 on 64-bit target machines.
-fobjc-call-cxx-cdtorsโ okay this one is a whole journey, stay with me. For each Objective-C class, it checks if any of its instance variables is a C++ object with a non-trivial default constructor. If so, it synthesizes a special- (id) .cxx_constructinstance method which runs non-trivial default constructors on any such instance variables, in order, and then returnsself. Similarly, it checks if any instance variable is a C++ object with a non-trivial destructor, and if so, synthesizes a special- (void) .cxx_destructmethod which runs all such default destructors, in reverse order. ๐ฅ
The - (id) .cxx_construct and - (void) .cxx_destruct methods thusly generated only operate on instance variables declared in the current Objective-C class โ not those inherited from superclasses. It is the responsibility of the Objective-C runtime to invoke all such methods in an object's inheritance hierarchy. The - (id) .cxx_construct methods are invoked by the runtime immediately after a new object instance is allocated; the - (void) .cxx_destruct methods are invoked immediately before the runtime deallocates an object instance.
As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has support for invoking the - (id) .cxx_construct and - (void) .cxx_destruct methods. ๐
-fobjc-direct-dispatchโ allow fast jumps to the message dispatcher. On Darwin this is accomplished via the comm page. zoom zoom. ๐๏ธ-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. 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. sorry bestie.-fobjc-gcโ enable garbage collection (GC) in Objective-C and Objective-C++ programs. This option is only available with the NeXT runtime; the GNU runtime has a different garbage collection implementation that does not require special compiler flags. ๐๏ธโจ-fobjc-nilcheckโ for the NeXT runtime with version 2 of the ABI, check for anilreceiver in method invocations before doing the actual method call. This is the default, and it can be disabled using-fno-objc-nilcheck. Class methods and super calls are never checked fornilin 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. lowkey a no-op in those cases.-fobjc-std=objc1โ conform to the language syntax of Objective-C 1.0, the language recognized by GCC 4.0. This only affects the Objective-C additions to the C/C++ language; it does not affect conformance to C/C++ standards, which is controlled by the separate C/C++ dialect option flags. When this option is used with the Objective-C or Objective-C++ compiler, any Objective-C syntax that is not recognized by GCC 4.0 is rejected. Super useful if you need to make sure your Objective-C code can be compiled 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, without the need to restart the program itself. Currently, Fix-and-Continue functionality is only available in conjunction with the NeXT runtime on Mac OS X 10.3 and later. ๐ง-fzero-linkโ when compiling for the NeXT runtime, the compiler ordinarily replaces calls 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. And FYI: 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. Whichโฆ 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. we love a clean scope.-fivar-visibility=[public|protected|private|package]โ set the default instance variable visibility to the specified option, so that instance variables declared outside the scope of any access modifier directives default to the specified visibility. ๐ซถ-gen-declsโ dump interface declarations for all classes seen in the source file to a file namedsourcename.decl. dump it, bestie. ๐-Wassign-intercept(Objective-C and Objective-C++ only) โ warn whenever an Objective-C assignment is being intercepted by the garbage collector. caught in 4k. ๐-Wno-protocol(Objective-C and Objective-C++ only) โ if a class is declared to implement a protocol, a warning is issued for every method in the protocol that is not implemented by the class. The default behavior is to issue a warning for every method not explicitly implemented in the class, even if a method implementation is inherited from the superclass. If you use the-Wno-protocoloption, then methods inherited from the superclass are considered to be implemented, and no warning is issued for them. blessed. ๐ธ-Wselector(Objective-C and Objective-C++ only) โ warn if multiple methods of different types for the same selector are found during compilation. The check is performed on the list of methods in the final stage of compilation. Additionally, a check is performed for each selector appearing in a@selector(...)expression, and a corresponding method for that selector has been found during compilation. Because these checks scan the method table only at the end of compilation, these warnings are not produced if the final stage of compilation is not reached โ for example, because an error is found during compilation, or because the-fsyntax-onlyoption is being used. no cap.-Wstrict-selector-match(Objective-C and Objective-C++ only) โ warn if multiple methods with differing argument and/or return types are found for a given selector when attempting to send a message using this selector to a receiver of typeidorClass. When this flag is off (which is the default behavior), the compiler omits such warnings if any differences found are confined to types that share the same size and alignment. iconic behavior honestly. โจ-Wundeclared-selector(Objective-C and Objective-C++ only) โ this one yells at you if it spots a@selector(...)expression pointing at a selector that was never declared. And bestie, "undeclared" here means no method with that name got declared before the@selector(...)expression โ not explicitly in an@interfaceor@protocoldeclaration, and not implicitly in an@implementationsection either. The vibe check on this one is different from-Wselector: this flag always runs its checks the moment a@selector(...)expression shows up, whereas-Wselectorwaits and only checks in the final stage of compilation. It also โจ enforces the coding style convention โจ that methods and selectors have to be declared before anyone uses them. Manners, basically. ๐-print-objc-runtime-infoโ spits out a C header describing the largest structure that gets passed by value, if there even is one. ๐ซถ
โจ Options to Control Diagnostic Messages Formatting โจ
Okay so historically, diagnostic messages were formatted however they came out, completely ignoring the aspect of the output device (its width, that kind of thing). The options down here let you take the wheel on the formatting algorithm instead โ how many characters per line, how often it repeats source location info, all of it. ๐
Heads up bestie: some language front ends may not honor these options. Not everyone got the memo. ๐ญ
-fmessage-length=nโ tries to format error messages so they fit on lines of about n characters. If n is zero, then no line-wrapping happens and every error message lands on a single line. This is the default for all front ends. ๐
Note โ this option also affects how the#errorand#warningpre-processor directives get displayed, plus the deprecated function/type/variable attribute. It does not, however, touch thepragma GCC warningandpragma GCC errorpragmas. No cap.
-fdiagnostics-show-location=onceโ only meaningful in line-wrapping mode. Tells the diagnostic messages reporter to emit source location info once โ so if a message is too long for one physical line and gets wrapped, the source location won't be repeated as a prefix over and over on every continuation line. This is the default behavior. ๐ฆ-fdiagnostics-show-location=every-lineโ only meaningful in line-wrapping mode too. Tells the reporter to emit the same source location info (as a prefix) on every physical line that came out of breaking a message too long for a single line. โจ-fdiagnostics-color[=WHEN],-fno-diagnostics-colorโ use color in diagnostics, bestie. WHEN isnever,always, orauto. The default depends on how the compiler was configured โ it can be any of those WHEN options, or alsoneverif theGCC_COLORSenvironment variable isn't present in the environment, andautootherwise.automeans color is used only when standard error is a terminal. 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:fixit-insert=32:fixit-delete=31:\
diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
type-diff=01;32
where 01;31 is bold red, 01;35 is bold magenta, 01;36 is bold cyan, 32 is green, 34 is blue, 01 is bold, and 31 is red. Setting GCC_COLORS to the empty string disables colors. The supported capabilities are as follows. ๐
error=โ SGR substring forerror:markers.warning=โ SGR substring forwarning:markers.note=โ SGR substring fornote:markers.range1=โ SGR substring for first additional range.range2=โ SGR substring for second additional range.locus=โ SGR substring for location information,file:lineorfile:line:columnetc.quote=โ SGR substring for information printed within quotes.fixit-insert=โ SGR substring for fix-it hints suggesting text to be inserted or replaced.fixit-delete=โ SGR substring for fix-it hints suggesting text to be deleted.diff-filename=โ SGR substring for filename headers within generated patches.diff-hunk=โ SGR substring for the starts of hunks within generated patches.diff-delete=โ SGR substring for deleted lines within generated patches.diff-insert=โ SGR substring for inserted lines within generated patches.type-diff=โ SGR substring for highlighting mismatching types within template arguments in the C++ frontend.
-fno-diagnostics-show-optionโ by default, every diagnostic that comes out includes text pointing at the command-line option that directly controls it (if the diagnostic machinery knows of such an option). Passing-fno-diagnostics-show-optionsuppresses that behavior. ๐-fno-diagnostics-show-caretโ by default, every diagnostic includes the original source line plus a caret^marking the column. This option suppresses that info. The source line gets truncated to n characters if you gave the-fmessage-length=noption. When output goes to the terminal, the width is limited to whatever theCOLUMNSenvironment variable says, or if that's not set, to the terminal width. ๐ฏ-fno-diagnostics-show-labelsโ by default, when source code is printed (via-fdiagnostics-show-caret), diagnostics can label ranges of source code with pertinent info, like the types of expressions:
printf ("foo %s bar", long_i + long_j);
~^ ~~~~~~~~~~~~~~~
| |
char * long int
This option suppresses printing of those labels (in the example above, the vertical bars and the char * and long int text). ๐
-fno-diagnostics-show-line-numbersโ by default, when source code is printed (via-fdiagnostics-show-caret), a left margin is printed showing line numbers. This option suppresses that left margin. ๐ซ-fdiagnostics-minimum-margin-width=widthโ controls the minimum width of the left margin printed by-fdiagnostics-show-line-numbers. It defaults to6. ๐-fdiagnostics-parseable-fixitsโ emits fix-it hints in a machine-parseable format, perfect for IDEs to snack on. For each fix-it, a line gets printed after the relevant diagnostic, starting with the stringfix-it:. For example:
fix-it:"test.c":{45:3-45:21}:"gtk_widget_show_all"
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 example above, 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. โจ
-fdiagnostics-generate-patchโ prints fix-it hints to stderr in unified diff format, after any diagnostics are printed. 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). ๐
-fdiagnostics-show-template-treeโ in the C++ frontend, when diagnostics show mismatching template types, like:
could not convert 'std::map<int, std::vector<double> >()'
from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
the -fdiagnostics-show-template-tree flag enables printing a tree-like structure showing the common and differing parts of the types, like:
map<
[...],
vector<
[double != float]>>
The parts that differ are highlighted with color (double and float in this case). ๐ณ
-fno-elide-typeโ by default, when the C++ frontend prints diagnostics showing mismatching template types, common parts of the types get 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. ๐ซถ
-fno-show-columnโ do not print column numbers in diagnostics. This may be necessary if diagnostics are being scanned by a program that doesn't understand column numbers, likedejagnu. iykyk. ๐-fdiagnostics-format=FORMATโ select a different format for printing diagnostics. FORMAT istextorjson. The default istext. ๐
The json format is literally just one big top-level JSON array, and inside it every diagnostic is a JSON object. That's it, that's the whole vibe. โจ
Heads up bestie: the JSON gets emitted as one single line, no pretty formatting. The examples below have been formatted just so you can actually read them. ๐
Diagnostics can have child diagnostics, like a warning that adopts a note. For example, this error and note:
misleading-indentation.c:15:3: warning: this 'if' clause does not
guard... [-Wmisleading-indentation]
15 | if (flag)
| ^~
misleading-indentation.c:17:5: note: ...this statement, but the latter
is misleadingly indented as if it were guarded by the 'if'
17 | y = 2;
| ^
might be printed in JSON form (after formatting) like this:
[
{
"kind": "warning",
"locations": [
{
"caret": {
"column": 3,
"file": "misleading-indentation.c",
"line": 15
},
"finish": {
"column": 4,
"file": "misleading-indentation.c",
"line": 15
}
}
],
"message": "this \u2018if\u2019 clause does not guard...",
"option": "-Wmisleading-indentation",
"children": [
{
"kind": "note",
"locations": [
{
"caret": {
"column": 5,
"file": "misleading-indentation.c",
"line": 17
}
}
],
"message": "...this statement, but the latter is ..."
}
]
},
...
]
where the "note" is a child of the "warning". Parent-child diagnostics, we love a family tree ๐
So a diagnostic has a "kind". If that kind is "warning", then it's got an "option" key describing the command-line option controlling the warning. Iconic.
A diagnostic can contain zero or more locations. Each location has up to three positions inside it: a "caret" position plus optional "start" and "finish" positions. A location can also have an optional "label" string. For example, this error:
bad-binary-ops.c:64:23: error: invalid operands to binary + (have 'S' {aka
'struct s'} and 'T' {aka 'struct t'})
64 | return callee_4a () + callee_4b ();
| ~~~~~~~~~~~~ ^ ~~~~~~~~~~~~
| | |
| | T {aka struct t}
| S {aka struct s}
has three locations, okay?? Its primary location is at the "+" token at column 23. Then it's got two secondary locations describing the left and right-hand sides of the expression, and those ones have labels. It might be printed in JSON form as:
{
"children": [],
"kind": "error",
"locations": [
{
"caret": {
"column": 23, "file": "bad-binary-ops.c", "line": 64
}
},
{
"caret": {
"column": 10, "file": "bad-binary-ops.c", "line": 64
},
"finish": {
"column": 21, "file": "bad-binary-ops.c", "line": 64
},
"label": "S {aka struct s}"
},
{
"caret": {
"column": 25, "file": "bad-binary-ops.c", "line": 64
},
"finish": {
"column": 36, "file": "bad-binary-ops.c", "line": 64
},
"label": "T {aka struct t}"
}
],
"message": "invalid operands to binary + ..."
}
If a diagnostic contains fix-it hints, it's got a "fixits" array, made of half-open intervals, kinda like the output of -fdiagnostics-parseable-fixits. For example, this diagnostic with a replacement fix-it hint:
demo.c:8:15: error: 'struct s' has no member named 'colour'; did you
mean 'color'?
8 | return ptr->colour;
| ^~~~~~
| color
might be printed in JSON form as:
{
"children": [],
"fixits": [
{
"next": {
"column": 21,
"file": "demo.c",
"line": 8
},
"start": {
"column": 15,
"file": "demo.c",
"line": 8
},
"string": "color"
}
],
"kind": "error",
"locations": [
{
"caret": {
"column": 15,
"file": "demo.c",
"line": 8
},
"finish": {
"column": 20,
"file": "demo.c",
"line": 8
}
}
],
"message": "\u2018struct s\u2019 has no member named ..."
}
where the fix-it hint suggests replacing the text from "start" up to but not including "next" with "string"'s value. And bestie, listen: deletions are expressed via an empty value for "string", and insertions happen by having "start" equal "next". That's the whole trick, periodt. ๐
๐ธ Options to Request or Suppress Warnings ๐ธ
Warnings are diagnostic messages that report constructions that are not inherently erroneous but that are risky, or that suggest there may have been an error. Basically the compiler going "bestieโฆ are you sure about this?" ๐ซถ
The following language-independent options don't enable specific warnings, they just control the kinds of diagnostics produced by GCC.
-fsyntax-onlyโ Check the code for syntax errors, but don't do anything beyond that. That's it, that's the whole job. โจ-fmax-errors=nโ Limits the maximum number of error messages to n, and at that 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. So don't be out here thinking your-fmax-errorswins, because it does NOT. ๐ญ-wโ Inhibit all warning messages. Silencing the haters, literally.-Werrorโ Make all warnings into errors. Every single one. No mercy, no cap. ๐ฅ-Werror=โ Make 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=fooautomatically implies-Wfoo. However,-Wno-error=foodoes not imply anything. The asymmetry is giving unhinged but okay, we move. ๐
-Wfatal-errorsโ This option causes the compiler to abort compilation on the first error occurred rather than trying to keep going and printing further error messages. It's the "we're leaving, right now" option. ๐
You can request many specific warnings with options beginning with -W, for example -Wimplicit to request warnings on implicit declarations. Each of these specific warning options also has a negative form beginning -Wno- to turn off warnings; for example -Wno-implicit. This manual lists only one of the two forms, whichever is not the default. For further language-specific options also refer to C++ Dialect Options and Objective-C and Objective-C++ Dialect Options. iykyk ๐
Some options, such as -Wall and -Wextra, turn on other options, such as -Wunused, which may turn on further options, such as -Wunused-value. The combined effect of positive and negative forms is that more specific options have priority over less specific ones, independently of their position in the command-line. For options of the same specificity, the last one takes effect. Options enabled or disabled via pragmas take effect as if they appeared at the end of the command-line. So it's giving main character energy for the most specific option, always. ๐
When an unrecognized warning option is requested (e.g., -Wunknown-warning), GCC emits a diagnostic stating that the option is not recognized. However, if the -Wno- form is used, the behavior is slightly different: no diagnostic is produced for -Wno-unknown-warning unless other diagnostics are being produced. This allows the use of new -Wno- options with old compilers, but if something goes wrong, the compiler warns that an unrecognized option is present. Sneaky little feature but honestly? Slay. ๐
The effectiveness of some warnings depends on optimizations also being enabled. For example -Wsuggest-final-types is more effective with link-time optimization and -Wmaybe-uninitialized will not warn at all unless optimization is enabled. So if you're out here with no -O and wondering why nothing's warningโฆ that's why bestie. ๐ญ
-Wpedantic-pedanticโ Issue all the warnings demanded by strict ISO C and ISO C++; reject all programs that use forbidden extensions, and some other programs that do not follow ISO C and ISO C++. For ISO C, follows the version of the ISO C standard specified by any-stdoption used. Strict queen behavior, honestly. ๐
Okay bestie, so we're still deep in the -Wpedantic lore, and here's the rest of the tea ๐
Like, valid ISO C and ISO C++ programs should compile properly with or without this option (though a rare few genuinely require -ansi or a -std option that names the required version of ISO C). But โ and this is the plot twist โ without this option, certain GNU extensions and traditional C and C++ features are supported as well. With this option? They get rejected. Periodt. ๐ซ
Also, -Wpedantic does not cause warning messages for use of the alternate keywords whose names begin and end with __. And pedantic warnings are also disabled in the expression that follows "__extension__". However โ and this part is important, no cap โ only system header files should use these escape routes. Application programs should avoid them. ๐
โโ๏ธ
Some users try to use -Wpedantic to check programs for strict ISO C conformance. They soon find that it does not do quite what they want: it finds some non-ISO practices, but not all โ only those for which ISO C requires a diagnostic, and some others for which diagnostics have been added. It's giving "close but not the whole vibe" ๐ญ
A feature to report any failure to conform to ISO C might be useful in some instances, but would require considerable additional work and would be quite different from -Wpedantic. We don't have plans to support such a feature in the near future. Not on our 2024 bingo card, bestie ๐
Where the standard specified with -std represents a GNU extended dialect of C, such as gnu90 or gnu99, there is a corresponding base standard โ the version of ISO C on which the GNU extended dialect is based. Warnings from -Wpedantic are given where they are required by the base standard. (It does not make sense for such warnings to be given only for features not in the specified GNU C dialect, since by definition the GNU dialects of C include all features the compiler supports with the given option, and there would be nothing to warn about.) ๐ง โจ
-pedantic-errors
Give an error whenever the base standard (see -Wpedantic) requires a diagnostic, in some cases where there is undefined behavior at compile-time, and in some other cases that do not prevent compilation of programs that are valid according to the standard.
Bestie, listen: this is not equivalent to -Werror=pedantic, since there are errors enabled by this option and not enabled by the latter โ and vice versa. They are not the same girl. ๐
-Wall
This enables all the warnings about constructions that some users consider questionable, and that are easy to avoid (or modify to prevent the warning), even in conjunction with macros. This also enables some language-specific warnings described in C++ Dialect Options and Objective-C and Objective-C++ Dialect Options.
-Wall turns on the following warning flags:
-Waddress-Warray-bounds=1(only with-O2)-Wbool-compare-Wbool-operation-Wc++11-compat-Wc++14-compat-Wcatch-value(C++ and Objective-C++ only)-Wchar-subscripts-Wcomment-Wduplicate-decl-specifier(C and Objective-C only)-Wenum-compare(in C/ObjC; this is on by default in C++)-Wformat-Wint-in-bool-context-Wimplicit(C and Objective-C only)-Wimplicit-int(C and Objective-C only)-Wimplicit-function-declaration(C and Objective-C only)-Winit-self(only for C++)-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++)-Wmissing-attributes-Wmissing-braces(only for C/ObjC)-Wmultistatement-macros-Wnarrowing(only for C++)-Wnonnull-Wnonnull-compare-Wopenmp-simd-Wparentheses-Wpessimizing-move(only for C++)-Wpointer-sign-Wreorder-Wrestrict-Wreturn-type-Wsequence-point-Wsign-compare(only in C++)-Wsizeof-pointer-div-Wsizeof-pointer-memaccess-Wstrict-aliasing-Wstrict-overflow=1-Wswitch-Wtautological-compare-Wtrigraphs-Wuninitialized-Wunknown-pragmas-Wunused-function-Wunused-label-Wunused-value-Wunused-variable-Wvolatile-register-var
Note that some warning flags are not implied by -Wall. Some of them warn about constructions that users generally do not consider questionable, but which occasionally you might wish to check for; others warn about constructions that are necessary or hard to avoid in some cases, and there is no simple way to modify the code to suppress the warning. Some of them are enabled by -Wextra but many of them must be enabled individually. So like, -Wall is not the final boss, iykyk ๐
-Wextra
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 complete โจ
-Wclobbered-Wcast-function-type-Wdeprecated-copy(C++ only)-Wempty-body-Wignored-qualifiers-Wimplicit-fallthrough=3-Wmissing-field-initializers-Wmissing-parameter-type(C only)-Wold-style-declaration(C only)-Woverride-init-Wsign-compare(C only)-Wredundant-move(only for C++)-Wtype-limits-Wuninitialized-Wshift-negative-value(in C++11 to C++17 and in C99 and newer)-Wunused-parameter(only with-Wunusedor-Wall)-Wunused-but-set-parameter(only with-Wunusedor-Wall)
The option -Wextra also prints warning messages for the following cases:
- A pointer is compared against integer zero with
"<","<=",">", or">=". - (C++ only) An enumerator and a non-enumerator both appear in a conditional expression.
- (C++ only) Ambiguous virtual bases.
- (C++ only) Subscripting an array that has been declared
"register". - (C++ only) Taking the address of a variable that has been declared
"register". - (C++ only) A base class is not initialized in the copy constructor of a derived class.
-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. This warning is enabled by -Wall. Classic oopsie ๐ซ
-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. Like, don't do it unless you truly must, bestie ๐
-Wno-cpp
(C, Objective-C, C++, Objective-C++ and Fortran only)
Suppress warning messages emitted by "#warning" directives. Shhh ๐คซ
-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". Sneaky!! ๐ญ
-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
Check calls to "printf" and "scanf", etc., to make sure that the arguments supplied have types appropriate to the format string specified, and that the conversions specified in the format string make sense. This includes standard functions, and others specified by format attributes, in the "printf", "scanf", "strftime" and "strfmon" (an X/Open extension, not in the C standard) families (or other target-specific families).
Which functions are checked without format attributes having been specified depends on the standard version selected, and such checks of functions without the attribute specified are disabled by -ffreestanding or -fno-builtin.
The formats are checked against the format features supported by GNU libc version 2.2. These include all ISO C90 and C99 features, as well as features from the Single Unix Specification and some BSD and GNU extensions. Other library implementations may not support all these features; GCC does not support warning about features that go beyond a particular library's limitations. However, if -Wpedantic is used with -Wformat, warnings are given about format features not in the selected standard version (but not for "strfmon" formats, since those are not in any version of the C standard). ๐
-Wformat=1
-Wformat
Option -Wformat is equivalent to -Wformat=1, and -Wno-format is equivalent to -Wformat=0.
Since -Wformat also checks for null format arguments for several functions, -Wformat also implies -Wnonnull.
Some aspects of this level of format checking can be disabled by the options: -Wno-format-contains-nul, -Wno-format-extra-args, and -Wno-format-zero-length. -Wformat is enabled by -Wall. ๐
-Wno-format-contains-nul
If -Wformat is specified, do not warn about format strings that contain NUL bytes.
-Wno-format-extra-args
If -Wformat is specified, do not warn about excess arguments to a "printf" or "scanf" format function. The C standard specifies that such arguments are ignored.
Where the unused arguments lie between used arguments that are specified with $ operand number specifications, normally warnings are still given, since the implementation could not know what type to pass to "va_arg" to skip the unused arguments. However, in the case of "scanf" formats, this option suppresses the warning if the unused arguments are all pointers, since the Single Unix Specification says that such unused arguments are allowed. ๐ฆ
-Wformat-overflow,-Wformat-overflow=levelโ okay bestie, this one is about calls to formatted input/output functions likesprintfandvsprintfthat might overflow the destination buffer. ๐ฑ
When the exact number of bytes written by a format directive can't be determined at compile-time, it's estimated based on heuristics that depend on the level argument and on optimization. Turning on optimization will in most cases improve the accuracy of the warning, but it may also result in false positives. ๐
-Wformat-overflow,-Wformat-overflow=1โ Level 1 of-Wformat-overflow(enabled by-Wformat) uses a conservative approach that only warns 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.
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.
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.
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. so chill, bestie ๐-Wformat=2โ Enable-Wformatplus additional format checks. Currently equivalent to-Wformat -Wformat-nonliteral -Wformat-security -Wformat-y2k. โจ-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. iykyk-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 currently a subset of what-Wformat-nonliteralwarns about, but in future warnings may be added to-Wformat-securitythat are not included in-Wformat-nonliteral.) security alert ๐จ-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 drama ๐-Wformat-truncation,-Wformat-truncation=levelโ 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 the level argument and on optimization. While enabling optimization will in most cases improve the accuracy of the warning, it may also result in false positives. Except as noted otherwise, the option uses the same logic-Wformat-overflow. truncation nation โ๏ธ-Wformat-truncation,-Wformat-truncation=1โ Level 1 of-Wformat-truncationenabled by-Wformatemploys 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.-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.
-Wformat-y2kโ If-Wformatis specified, also warn aboutstrftimeformats that may yield only a two-digit year. Y2K vibes ๐-Wnonnullโ Warn about passing a null pointer for arguments marked as requiring a non-null value by thenonnullfunction attribute.
-Wnonnull is included in -Wall and -Wformat. It can be disabled with the -Wno-nonnull option. don't pass null, bestie ๐
โโ๏ธ
-Wnonnull-compareโ Warn when comparing an argument marked with thenonnullfunction attribute against null inside the function.
-Wnonnull-compare is included in -Wall. It can be disabled with the -Wno-nonnull-compare option. why you comparing null tho ๐ญ
-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 ๐-Winit-self(C, C++, Objective-C and Objective-C++ only) โ Warn about uninitialized variables that are initialized with themselves. Note this option can only be used with the-Wuninitializedoption.
For example, GCC warns about i being uninitialized in the following snippet only when -Winit-self has been specified:
int f()
{
int i = i;
return i;
}
This warning is enabled by -Wall in C++. self-init? more like self-own ๐คก
-Wimplicit-int(C and Objective-C only) โ Warn when a declaration does not specify a type. This warning is enabled by-Wall. implicit int? not today ๐ซ-Wimplicit-function-declaration(C and Objective-C only) โ Give a warning whenever a function is used before being declared. In C99 mode (-std=c99or-std=gnu99), this warning is enabled by default and it is made into an error by-pedantic-errors. This warning is also enabled by-Wall. declare before you use, bestie ๐ข-Wimplicit(C and Objective-C only) โ Same as-Wimplicit-intand-Wimplicit-function-declaration. This warning is enabled by-Wall. two-for-one warning โจ-Wimplicit-fallthroughโ-Wimplicit-fallthroughis the same as-Wimplicit-fallthrough=3and-Wno-implicit-fallthroughis the same as-Wimplicit-fallthrough=0. fallthrough, but make it a setting ๐-Wimplicit-fallthrough=nโ Warn when a switch case falls through. For example:
switch (cond)
{
case 1:
a = 1;
break;
case 2:
a = 2;
case 3:
a = 3;
break;
}
This warning does not warn when the last statement of a case cannot fall through, e.g. when there is a return statement or a call to function declared with the noreturn attribute. -Wimplicit-fallthrough= also takes into account control flow statements, such as ifs, and only warns when appropriate. E.g.
switch (cond)
{
case 1:
if (i > 3) {
bar (5);
break;
} else if (i < 1) {
bar (0);
} else
return;
default:
...
}
Since there are occasions where a switch case fall through is desirable, GCC provides an attribute, __attribute__ ((fallthrough)), that is to be used along with a null statement to suppress this warning that would normally occur:
switch (cond)
{
case 1:
bar (0);
__attribute__ ((fallthrough));
default:
...
}
fallthrough: the ultimate plot twist ๐
C++17 literally has a standard way to shut the -Wimplicit-fallthrough warning up: use [[fallthrough]]; instead of that GNU attribute, bestie. And if you're stuck on C++11 or C++14? You can use [[gnu::fallthrough]];, which is a GNU extension ๐
.
But not me forgetting โ you can also just drop a fallthrough comment in there and it silences the warning. The whole body of the C or C++ style comment has to match one of the regular expressions listed below. The option argument n decides what kind of comments get accepted, and it's giving menu of vibes:
-Wimplicit-fallthrough=0โ turns the warning off entirely, periodt ๐-Wimplicit-fallthrough=1โ matches the.*regular expression, so literally any comment counts as a fallthrough comment โจ-Wimplicit-fallthrough=2โ case insensitively matches the.*falls?[ \t-]*thr(ough|u).*regular expression ๐-Wimplicit-fallthrough=3โ case sensitively matches one of these regular expressions, no cap:-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 these regular expressions:-fallthrough@fallthrough@lint -fallthrough[ \t]*[ \t]*FALLTHR(OUGH|U)[ \t]*
-Wimplicit-fallthrough=5โ doesn't recognize any comments as fallthrough comments at all; only attributes can 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. Like so, bestie:
switch (cond)
{
case 1:
bar (0);
/* FALLTHRU */
default:
...
}
The -Wimplicit-fallthrough=3 warning is enabled by -Wextra โจ
-Wif-not-aligned (C, C++, Objective-C and Objective-C++ only) ๐ฆ
Controls whether the warning triggered by the warn_if_not_aligned attribute gets issued. It's enabled by default, iykyk. Want it gone? Use -Wno-if-not-aligned to disable it ๐
-Wignored-qualifiers (C and C++ only) ๐
Warns if the return type of a function has a type qualifier like const. For ISO C, that qualifier does nothing โ because the value a function returns isn't an lvalue. For C++, the warning is only emitted for scalar types or void. And heads up: ISO C prohibits qualified void return types on function definitions, so those return types always get a warning even without this option ๐
This warning is also enabled by -Wextra.
-Wignored-attributes (C and C++ only) ๐ธ
Warns when an attribute is ignored. The way this differs from -Wattributes is: it warns whenever the compiler decides to drop an attribute, not that the attribute is unknown or used in the wrong place or whatever. This warning is enabled by default โจ
-Wmain ๐
Warns if the type of main is suspicious. main should be a function with external linkage, returning int, taking either zero arguments, two, or three arguments of appropriate types. This warning is enabled by default in C++ and is enabled by either -Wall or -Wpedantic ๐
-Wmisleading-indentation (C and C++ only) ๐ญ
Warns when the indentation of the code does not reflect the block structure. Specifically, a warning gets 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. So sneaky fr fr.
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". */
When you've got mixed tabs and spaces, the warning uses the -ftabstop= option to figure out if the statements line up (defaulting to 8).
The warning is not issued for code involving multiline preprocessor logic, like this example here:
if (flagA)
foo (0);
#if SOME_CONDITION_THAT_DOES_NOT_HOLD
if (flagB)
#endif
foo (1);
The warning is also not issued after a #line directive, because that typically means autogenerated code, and you can't make any assumptions about the layout of the file that 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 gets issued for declarations of aliases that use attributes to specify less restrictive requirements than those of their targets. This typically represents a potential optimization opportunity โจ By contrast, the -Wattribute-alias=2 option controls warnings issued when the alias is more restrictive than the target, which could lead to incorrect code generation. The attributes considered include alloc_align, alloc_size, cold, const, hot, leaf, malloc, nonnull, noreturn, nothrow, pure, returns_nonnull, and returns_twice.
In C++, the warning is issued when an explicit specialization of a primary template declared with attribute alloc_align, alloc_size, assume_aligned, format, format_arg, malloc, or nonnull is declared without it. Attributes deprecated, error, and warning suppress the warning..
You can use the copy attribute to apply the same set of attributes to a declaration as that on another declaration, without explicitly enumerating the attributes. This attribute can be applied to declarations of functions, variables, or types ๐
-Wmissing-attributes is enabled by -Wall.
For example, since the declaration of the primary function template below makes use of both attribute malloc and alloc_size, the declaration of the explicit specialization of the template is diagnosed because it's missing one of the attributes:
template <class T>
T* __attribute__ ((malloc, alloc_size (1)))
allocate (size_t);
template <>
void* __attribute__ ((malloc)) // missing alloc_size
allocate<void> (size_t);
-Wmissing-braces ๐
Warns if an aggregate or union initializer isn't fully bracketed. In the following example, the initializer for a isn't fully bracketed, but the one for b is. This warning is enabled by -Wall in C.
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 and Objective-C++ only) ๐ธ
Warns if a user-supplied include directory doesn't exist. That's it, that's the whole thing ๐
-Wmissing-profile ๐
Warns if feedback profiles are missing when you're using the -fprofile-use option. This option diagnoses those cases where a new function or a new file gets added to the user code between compiling with -fprofile-generate and with -fprofile-use, without regenerating the profiles. In these cases, the profile feedback data files don't 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 can't use any profile feedback information. In all these cases, warnings are issued to inform the user that a profile generation step is due ๐ -Wno-missing-profile can be used to disable the warning.
Ignoring the warning can result in poorly optimized code. Completely disabling the warning is not recommended and should be done only when non-existent profile data is justified. Bestie, pls, listen to the compiler ๐ญ
-Wmultistatement-macros ๐
Warns about unsafe multiple statement macros that appear to be guarded by a clause like if, else, for, switch, or while, where only the first statement is actually guarded after the macro is expanded. Not me getting gotcha'd by preprocessor nonsense ๐
For example:
#define DOIT x++; y++
if (c)
DOIT;
...will increment y unconditionally, not just when c holds. You can usually fix this by wrapping the macro in a do-while loop:
#define DOIT do { x++; y++; } while (0)
if (c)
DOIT;
This warning is enabled by -Wall in C and C++.
-Wparentheses ๐ฆ
Warns if parentheses are omitted in certain contexts โ like when there's an assignment in a context where a truth value is expected, or when operators are nested whose precedence people often get confused about. Valid, honestly.
It also warns if a comparison like x<=y<=z appears; that's equivalent to (x<=y ? 1 : 0) <= z, which is a different interpretation from the one in ordinary mathematical notation. Math girlies stay losing ๐ญ
It also warns for dangerous uses of the GNU extension to ?: with an omitted middle operand. When the condition in the ?: operator is a boolean expression, the omitted value is always 1. But programmers often 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.
-Wsequence-point โจ
Warns about code that may have undefined semantics because of violations of sequence point rules in the C and C++ standards. Yeah. That's the scary one, bestie ๐ซถ
okay so bestie, quick story time about sequence points โ the C and C++ standards define the order in which expressions in a C/C++ program get evaluated using these little things called sequence points, and honestly it's giving "partial ordering" energy: they mark a split between the parts of the program that run before the sequence point and the parts that run after it. ๐ธ
Where do these iconic little checkpoints show up? After the evaluation of a full expression (aka one that's not part of some bigger expression), after the evaluation of the first operand of a "&&", "||", "? :" or "," (comma) operator, before a function is called (but like, after the arguments get evaluated and after the expression naming the called function gets evaluated), and in certain other places. ๐
And the tea is: other than what the sequence point rules actually say, the order of evaluation of subexpressions of an expression is not specified. All these rules describe only a partial order, not a total order โ because, say, if two functions get called inside one expression with no sequence point between them, the order they get called in? Not specified, bestie. However, the standards committee has ruled that function calls do not overlap. No cap.
Also 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 โ and the C and C++ standards literally say:
"Between the previous and next sequence point an object shall have its stored value modified at most once by the evaluation of an expression. Furthermore, the prior value shall be read only to determine the value to be stored."
If a program breaks these rules, the results on any particular implementation are entirely unpredictable. ๐
Examples of code with undefined behavior are a = a++;, a[n] = b[n++] and a[i++] = i;. Some more complicated cases are not diagnosed by this option, and it may give an occasional false positive result, but in general it has been found fairly effective at detecting this sort of problem in programs. ๐
Now for the glow-up: 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 warning 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 <http://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-typeโ warn whenever a function is defined with a return type that defaults to"int". Also warn about any"return"statement with no return value in a function whose return type is not"void"(falling off the end of the function body counts as returning without a value, bestie). ๐ For C only, warn about a"return"statement with an expression in a function whose return type is"void", unless the expression type is also"void". As a GNU extension, the latter case is accepted without a warning unless-Wpedanticis used. Attempting to use the return value of a non-"void"function other than"main"that flows off the end by reaching the closing curly brace that terminates the function is undefined. ๐ Unlike in C, in C++, flowing off the end of a non-"void"function other than"main"results in undefined behavior even when the value of the function is not used. ๐จ This warning is enabled by default in C++ and by-Wallotherwise.-Wshift-count-negativeโ warn if shift count is negative. This warning is enabled by default. ๐ธ-Wshift-count-overflowโ warn if shift count>=width of type. This warning is enabled by default. โจ-Wshift-negative-valueโ warn if left shifting a negative value. This warning is enabled by-Wextrain C99 (and newer) and C++11 to C++17 modes. ๐ฆ-Wshift-overflow-Wshift-overflow=nโ warn about left shift overflows. This warning is enabled by default in C99 and C++11 modes (and newer). ๐ฅ-Wshift-overflow=1โ this is the warning level of-Wshift-overflowand is enabled by default in C99 and C++11 modes (and newer). This warning level does not warn about left-shifting 1 into the sign bit. (However, in C, such an overflow is still rejected in contexts where an integer constant expression is required.) No warning is emitted in C++2A mode (and newer), as signed left shifts always wrap. ๐-Wshift-overflow=2โ this warning level also warns about left-shifting 1 into the sign bit, unless C++14 mode (or newer) is active. ๐
-Wswitchโ warn whenever a"switch"statement has an index of enumerated type and lacks a"case"for one or more of the named codes of that enumeration. (The presence of a"default"label prevents this warning, bestie.)"case"labels outside the enumeration range also provoke warnings when this option is used (even if there is a"default"label). This warning is enabled by-Wall. ๐-Wswitch-defaultโ warn whenever a"switch"statement does not have a"default"case. ๐ญ-Wswitch-enumโ warn whenever a"switch"statement has an index of enumerated type and lacks a"case"for one or more of the named codes of that enumeration."case"labels outside the enumeration range also provoke warnings when this option is used. The only difference between-Wswitchand this option is that this option gives a warning about an omitted enumeration code even if there is a"default"label. ๐-Wswitch-boolโ warn whenever a"switch"statement has an index of boolean type and the case values are outside the range of a boolean type. It is possible to suppress this warning by casting the controlling expression to a type other than"bool". For example:
switch ((int) (a == 4))
{
...
}
This warning is enabled by default for C and C++ programs. โจ
-Wswitch-unreachableโ warn whenever a"switch"statement contains statements between the controlling expression and the first case label, which will never be executed. For example:
switch (cond)
{
i = 15;
...
case 5:
...
}
-Wswitch-unreachable does not warn if the statement between the controlling expression and the first case label is just a declaration:
switch (cond)
{
int i;
...
case 5:
i = 5;
...
}
This warning is enabled by default for C and C++ programs. ๐ธ
-Wsync-nand(C and C++ only) โ warn when"__sync_fetch_and_nand"and"__sync_nand_and_fetch"built-in functions are used. These functions changed semantics in GCC 4.4. ๐จ-Wunused-but-set-parameterโ warn whenever a function parameter is assigned to, but otherwise unused (aside from its declaration). ๐ซถ To suppress this warning use the"unused"attribute. This warning is also enabled by-Wunusedtogether with-Wextra.-Wunused-but-set-variableโ warn whenever a local variable is assigned to, but otherwise unused (aside from its declaration). This warning is enabled by-Wall. ๐ To suppress this warning use the"unused"attribute. This warning is also enabled by-Wunused, which is enabled by-Wall.-Wunused-functionโ warn whenever a static function is declared but not defined or a non-inline static function is unused. This warning is enabled by-Wall. ๐-Wunused-labelโ warn whenever a label is declared but not used. This warning is enabled by-Wall. ๐ To suppress this warning use the"unused"attribute.-Wunused-local-typedefs(C, Objective-C, C++ and Objective-C++ only) โ warn when a typedef locally defined in a function is not used. This warning is enabled by-Wall. ๐-Wunused-parameterโ warn whenever a function parameter is unused aside from its declaration. ๐ฆ To suppress this warning use the"unused"attribute.-Wno-unused-resultโ do not warn if a caller of a function marked with attribute"warn_unused_result"does not use its return value. The default is-Wunused-result. โจ-Wunused-variableโ warn whenever a local or static variable is unused aside from its declaration. This option implies-Wunused-const-variable=1for C, but not for C++. This warning is enabled by-Wall. ๐ฅ To suppress this warning use the"unused"attribute.-Wunused-const-variable-Wunused-const-variable=nโ warn whenever a constant static variable is unused aside from its declaration.-Wunused-const-variable=1is enabled by-Wunused-variablefor C, but not for C++. In C this declares variable storage, but in C++ this is not an error since const variables take the place of"#define"s. ๐ To suppress this warning use the"unused"attribute.-Wunused-const-variable=1โ this is the warning level that is enabled by-Wunused-variablefor C. It warns only 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=2โ this warning level also warns for unused constant static variables in headers (excluding system headers). This is the warning level of-Wunused-const-variableand must be explicitly requested since in C++ this isn't an error and in C it might be harder to clean up all headers included. ๐ญ
-Wunused-valueโ warn whenever a statement computes a result that is explicitly not used. To suppress this warning cast the unused expression to"void". This includes an expression-statement or the left-hand side of a comma expression that contains no side effects. 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. ๐ซถ๐
Okay so if you actually want a warning about an unused function parameter, bestie, you've got two moves: either say -Wextra -Wunused together (quick reminder: -Wall already implies -Wunused, so don't be out here double-dipping thinking you're clever), or specify -Wunused-parameter all by itself. That's the whole vibe check. ๐
-Wuninitializedโ warns you when an automatic variable gets used without being initialized first, or when a variable might get clobbered by asetjmpcall. And in C++? It'll also warn if a non-static reference or a non-staticconstmember shows up in a class that has no constructors. ๐
And if you want the warning for code that uses the uninitialized value of the variable in its own initializer, that's a whole separate thing โ go grab -Winit-self.
These warnings fire for individual uninitialized or clobbered elements of structure, union or array variables, and also for variables that are uninitialized or clobbered as a whole. But they do NOT occur for variables or elements declared volatile. And because these warnings depend on optimization, the exact variables or elements that get warnings depends on the precise optimization options and version of GCC you're running. So like, your mileage literally varies, no cap.
Also note: there may be no warning at all about a variable that's used only to compute a value that itself is never used, because those computations may get deleted by data flow analysis before the warnings even get printed. Sneaky. ๐
-Winvalid-memory-modelโ warns for invocations of__atomicBuiltins,__syncBuiltins, and the C11 atomic generic functions when the memory consistency argument is either invalid for the operation or outside the range of values of thememory_orderenumeration. For example, since the__atomic_storeand__atomic_store_nbuilt-ins are only defined for the relaxed, release, and sequentially consistent memory orders, this little guy right here gets diagnosed:
void store (int *i)
{
__atomic_store_n (i, 0, memory_order_consume);
}
-Winvalid-memory-model is enabled by default. She's always on, icon behaviour. โจ
-Wmaybe-uninitializedโ for an automatic (i.e. local) variable, if there exists a path from the function entry to a use of the variable that is initialized, but there exist some other paths for which the variable is not initialized, the compiler emits a warning if it cannot prove the uninitialized paths are not executed at run time. Basically it's doing its best detective work. ๐ต๏ธ
These warnings are only possible in optimizing compilation, because otherwise GCC does not keep track of the state of variables.
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's 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. GCC is not a mind reader, 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. False alarm central.
Some spurious warnings can be avoided if you declare all the functions you use that never return as noreturn.
This warning is enabled by -Wall or -Wextra.
-Wunknown-pragmasโ warns when a#pragmadirective is encountered that is not understood by GCC. And plot twist: if this command-line option is used, warnings are even issued for unknown pragmas in system header files. That is not the case if the warnings are only enabled by the-Wallcommand-line option. So like, she's got range. ๐-Wno-pragmasโ do not warn about misuses of pragmas, such as incorrect parameters, invalid syntax, or conflicts between pragmas. See also-Wunknown-pragmas. Just let her live. ๐-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 beforemainis 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 like, that range is taken, hands off. ๐-Wstrict-aliasingโ this option is only active when-fstrict-aliasingis active. It warns about code that might break the strict aliasing rules that the compiler is using for optimization. The warning does not catch all cases, but does attempt to catch the more common pitfalls. It is included in-Wall. It is equivalent to-Wstrict-aliasing=3. Fancy.-Wstrict-aliasing=nโ also only active when-fstrict-aliasingis active. It warns about code that might break the strict aliasing rules that the compiler is using for optimization. Higher levels correspond to higher accuracy (fewer false positives). Higher levels also correspond to more effort, similar to the way-Oworks. And-Wstrict-aliasingis equivalent to-Wstrict-aliasing=3. The levels, bestie, let me break them down:- Level 1: Most aggressive, quick, least accurate. Possibly useful when higher levels do not warn but
-fstrict-aliasingstill breaks the code, as it has very few false negatives. However, it has many false positives. Warns for all pointer conversions between possibly incompatible types, even if never dereferenced. Runs in the front end only. - Level 2: Aggressive, quick, not too precise. May still have many false positives (not as many as level 1 though), and few false negatives (but possibly more than level 1). Unlike level 1, it only warns when an address is taken. Warns about incomplete types. Runs in the front end only.
- Level 3 (default for
-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.
- Level 1: Most aggressive, quick, least accurate. Possibly useful when higher levels do not warn but
-Wstrict-overflow-Wstrict-overflow=n
This option is only active when signed overflow is undefined. It warns about cases where the compiler optimizes based on the assumption that signed overflow does not occur. 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. Thus this warning depends on the optimization level. ๐
An optimization that assumes that signed overflow does not occur is perfectly safe if the values of the variables involved are such that overflow never does, in fact, occur. Therefore this warning can easily give a false positive: a warning about code that is not actually a problem. To help focus on important issues, several warning levels are defined. No warnings are issued for the use of undefined signed overflow when estimating how many iterations a loop requires, in particular when determining whether a loop will be executed at all.
-Wstrict-overflow=1โ warn about cases that are both questionable and easy to avoid. For example the compiler simplifiesx + 1 > xto 1. 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. You've been warned, babe. ๐ญ
-Wstringop-overflow-Wstringop-overflow=type
Warn for calls to string manipulation functions such as memcpy and strcpy that are determined to overflow the destination buffer. The optional argument is one greater than the type of Object Size Checking to perform to determine the size of the destination. The argument is meaningful only for functions that operate on character arrays but not for raw memory functions like memcpy which always make use of Object Size type-0. The option also warns for calls that specify a size in excess of the largest possible object or at most SIZE_MAX / 2 bytes. The option produces the best results with optimization enabled but can detect a small subset of simple buffer overflows even without optimization in calls to the GCC built-in functions like __builtin_memcpy that correspond to the standard functions. In any case, the option warns about just a subset of buffer overflows detected by the corresponding overflow checking built-ins. For example, the option will issue 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
}
okay so lowkey, that's the little culprit that gets flagged. And heads up bestie: option -Wstringop-overflow=2 is enabled by default. yes, by default, no cap. ๐
-Wstringop-overflow-Wstringop-overflow=1โ this setting uses type-zero Object Size Checking to figure out how big the destination objects are. It's the default setting of the option, periodt. At this level, it will not warn about writes past the end of subobjects of larger objects accessed by pointers โ unless the size of the largest surrounding object is known. And when the destination could be one of several objects? It just assumes it's the largest one of them, iykyk. On Linux systems, when optimization is enabled, this setting warns for the exact same code as when the_FORTIFY_SOURCEmacro is defined to a non-zero value. cute little twin behavior ๐-Wstringop-overflow=2โ now we're on type-one Object Size Checking for the destination sizes. Here it will warn about overflows when you're writing to members of the largest complete objects whose exact size is known. But โ plot twist โ it will not warn for excessive writes to the same members of unknown objects referenced by pointers, because those could totally point to arrays with an unknown number of elements. so valid of it ๐ธ-Wstringop-overflow=3โ type-two Object Size Checking, bestie. This one warns about overflowing the smallest object or data member. it's the most restrictive setting of the option that may result in warnings for safe code. yes, safe code getting flagged, that's the tradeoff ๐ญ-Wstringop-overflow=4โ type-three Object Size Checking. At this level it 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 warn. And just like-Wstringop-overflow=3, this setting may also result in warnings for benign code. so dramatic ๐
-Wstringop-truncation ๐
This one warns for calls to bounded string manipulation functions like strncat, strncpy, and stpncpy that might either truncate the copied string or leave the destination unchanged. messy behavior, we don't love it.
In this next example, the call to strncat specifies a bound that's less than the length of the source string. So the copy of the source gets truncated and the call gets diagnosed. To dodge the warning, use bufsize - strlen (buf) - 1) as the bound. ๐
void append (char *buf, size_t bufsize)
{
strncat (buf, ".txt", 3);
}
As another example, the following call to strncpy copies to d just the characters preceding the terminating NUL, without appending the NUL to the end. Assuming the result of strncpy is necessarily a NUL-terminated string is a super common mistake, so the call gets diagnosed too. To avoid the warning when the result isn't expected to be NUL-terminated, call memcpy instead. glow up ๐ฆ
void copy (char *d, const char *s)
{
strncpy (d, s, strlen (s));
}
In the following example, the call to strncpy specifies the size of the destination buffer as the bound. If the length of the source string is equal to or greater than this size, the result of the copy will not be NUL-terminated. So the 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);
...
}
When a character array is meant to store a sequence of bytes with no terminating NUL, you can annotate that array with the attribute nonstring to avoid this warning. But heads up โ such arrays are not suitable arguments to functions that expect NUL-terminated strings. To help catch accidental misuses of these arrays, GCC issues warnings unless it can prove the use is safe. protective king ๐
-Wsuggest-attribute=[pure|const|noreturn|format|cold|malloc] ๐
Warns you for cases where adding an attribute might be beneficial. The attributes currently supported are listed below, bestie.
-Wsuggest-attribute=pure / -Wsuggest-attribute=const / -Wsuggest-attribute=noreturn / -Wmissing-noreturn / -Wsuggest-attribute=malloc
-Wsuggest-attribute=pure-Wsuggest-attribute=const-Wsuggest-attribute=noreturn-Wmissing-noreturn-Wsuggest-attribute=mallocโ warns about functions that might be candidates for attributespure,const,noreturn, ormalloc. The compiler only warns for functions visible in other compilation units, or (forpureandconst) 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, callingabort, or trapping. This analysis needs option-fipa-pure-const, which is enabled by default at-Oand higher. Higher optimization levels improve the accuracy of the analysis. the more you optimize, the better it vibes โจ
-Wsuggest-attribute=format / -Wmissing-format-attribute
-Wsuggest-attribute=format-Wmissing-format-attributeโ warns about function pointers that might be candidates forformatattributes. Note these are only possible candidates, not absolute ones, okay? 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 this might not always be the case, and some functions for which format attributes are appropriate may not be detected. it's guessing, bestie, not reading minds ๐ญ
-Wsuggest-attribute=cold
-Wsuggest-attribute=coldโ warns about functions that might be candidates for thecoldattribute. This is based on static detection and generally will only warn about functions which always lead to a call to anothercoldfunction โ like wrappers of C++throwor fatal error reporting functions leading toabort. brrr, cold ๐ฅถ
-Wsuggest-final-types ๐ง
Warns about types with virtual methods where code quality would improve if the type were declared with the C++11 final specifier, or, if possible, declared in an anonymous namespace. This lets GCC more aggressively devirtualize the polymorphic calls. This warning is more effective with link time optimization, where the info about the class hierarchy graph is more complete. team up for better results ๐ซถ
-Wsuggest-final-methods ๐ง
Warns about virtual methods where code quality would improve if the method were declared with the C++11 final specifier, or, if possible, if its type were declared in an anonymous namespace or with the final specifier. This warning is more effective with link-time optimization, where the info about the class hierarchy graph is more complete. And it's recommended to first consider suggestions of -Wsuggest-final-types and then rebuild with new annotations. order matters, bestie ๐
-Wsuggest-override ๐
Warns about overriding virtual functions that are not marked with the override keyword. just label it, it's not that hard ๐
-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. 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. fr fr, don't do it ๐
-Walloc-size-larger-than=byte-size ๐ธ
Warns about calls to functions decorated with attribute alloc_size that try 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. And -Walloc-size-larger-than=PTRDIFF_MAX is enabled by default. Warnings controlled by this option can be disabled either by specifying a byte-size of SIZE_MAX or more, or by -Wno-alloc-size-larger-than. two ways to shut it up ๐
-Wno-alloc-size-larger-than ๐
Disables -Walloc-size-larger-than= warnings. This option is equivalent to -Walloc-size-larger-than=SIZE_MAX or larger. bye bye warning ๐
-Walloca ๐ฅ
This option warns on all uses of alloca in the source. all of them, no exceptions, periodt.
-Walloca-larger-than=byte-size ๐
This option warns on calls to alloca with an integer argument whose value is either zero, or that isn't bounded by a controlling predicate that limits its value to at most byte-size. It also warns for calls to alloca where the bound value is unknown. And arguments of non-integer types are considered unbounded even if they look like they're constrained to the expected range. the audacity ๐ญ
For example, a bounded case of alloca could be:
void func (size_t n)
{
void *p;
if (n <= 1000)
p = alloca (n);
else
p = malloc (n);
f (p);
}
In the example above, passing -Walloca-larger-than=1000 would not issue a warning, because the call to alloca is known to be at most 1000 bytes. But if -Walloca-larger-than=500 were passed, the compiler would emit a warning. so close, bestie ๐ซถ
Unbounded uses, on the other hand, are uses of alloca with no controlling predicate constraining its integer argument. Like, zero vibe check on that number. For example:
void func ()
{
void *p = alloca (n);
f (p);
}
If -Walloca-larger-than=500 were passed, the above would trigger a warning, but this time because of the lack of bounds checking. Bestie simply did not check. ๐ญ
Note, that even seemingly correct code involving signed integers could cause a warning:
void func (signed int n)
{
if (n < 500)
{
p = alloca (n);
f (p);
}
}
In the above example, n could be negative, causing a larger than expected argument to be implicitly cast into the alloca call. Sneaky!! ๐
This option also warns when alloca is used in a loop. (not the loop ๐)
-Walloca-larger-than=PTRDIFF_MAX is enabled by default but is usually only effective when -ftree-vrp is active (default for -O2 and above).
See also -Wvla-larger-than=byte-size.
-Wno-alloca-larger-thanโ Disable-Walloca-larger-than=warnings. This option is equivalent to-Walloca-larger-than=SIZE_MAXor larger. Turning it all the way off, periodt.
-Warray-bounds,-Warray-bounds=nโ This option is only active when-ftree-vrpis active (default for-O2and above). It warns about subscripts to arrays that are always out of bounds. This warning is enabled by-Wall. ๐จ-Warray-bounds=1โ This is the warning level of-Warray-boundsand is enabled by-Wall; higher levels are not, and must be explicitly requested.-Warray-bounds=2โ This warning level also warns about out of bounds access for arrays at the end of a struct and for arrays accessed through pointers. Heads up: this warning level may give a larger number of false positives and is deactivated by default. โ ๏ธ
-Wattribute-alias=n,-Wno-attribute-aliasโ Warn about declarations using thealiasand similar attributes whose target is incompatible with the type of the alias.-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. ๐-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. (a whole squad of attributes fr fr)
-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.
-Wbool-compareโ Warn about boolean expression compared with an integer value different fromtrue/false. For instance, the following comparison is always false:
int n = 5;
...
if ((n > 1) == 2) { ... }
This warning is enabled by -Wall.
-Wbool-operationโ Warn about suspicious operations on expressions of a boolean type. For instance, bitwise negation of a boolean is very likely a bug in the program. For C, this warning also warns about incrementing or decrementing a boolean, which rarely makes sense. (In C++, decrementing a boolean is always invalid. Incrementing a boolean is invalid in C++17, and deprecated otherwise.) pls don't ++ your bools ๐
This warning is enabled by -Wall.
-Wduplicated-branchesโ Warn when an if-else has identical branches. This warning detects cases like
if (p != NULL)
return 0;
else
return 0;
It doesn't warn when both branches contain just a null statement. This warning also warn for conditional operators:
int i = x ? *p : *p;
(both branches the same?? bestie why ๐ญ)
-Wduplicated-condโ Warn 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) { ... }
-Wframe-addressโ Warn when the__builtin_frame_addressor__builtin_return_addressis called with an argument greater than 0. Such calls may return indeterminate values or crash the program. The warning is included in-Wall.
-Wno-discarded-qualifiers(C and Objective-C only) โ Do not warn if type qualifiers on pointers are being discarded. Typically, the compiler warns if aconst char *variable is passed to a function that takes achar *parameter. This option can be used to suppress such a warning. โจ
-Wno-discarded-array-qualifiers(C and Objective-C only) โ Do not warn if type qualifiers on arrays which are pointer targets are being discarded. Typically, the compiler warns if aconst int (*)[]variable is passed to a function that takes aint (*)[]parameter. This option can be used to suppress such a warning.
-Wno-incompatible-pointer-types(C and Objective-C only) โ Do not warn when there is a conversion between pointers that have incompatible types. This warning is for cases not covered by-Wno-pointer-sign, which warns for pointer argument passing or assignment with different signedness.
-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.
-Wno-div-by-zeroโ Do not warn about compile-time integer division by zero. Floating-point division by zero is not warned about, as it can be a legitimate way of obtaining infinities and NaNs. ๐ (that one's a feature, not a bug)
-Wsystem-headersโ Print warning messages for constructs found in system header files. Warnings from system headers are normally suppressed, on the assumption that they usually do not indicate real problems and would only make the compiler output harder to read. Using this command-line option tells GCC to emit warnings from system headers as if they occurred in user code. However, note that using-Wallin conjunction with this option does not warn about unknown pragmas in system headers---for that,-Wunknown-pragmasmust also be used. ๐
-Wtautological-compareโ Warn if a self-comparison always evaluates to true or false. This warning detects various mistakes such as:
int i = 1;
...
if (i > i) { ... }
This warning also warns about bitwise comparisons that always evaluate to true or false, for instance:
if ((a & 16) == 10) { ... }
will always be false.
This warning is enabled by -Wall.
-Wtrampolinesโ Warn about trampolines generated for pointers to nested functions. A trampoline is a small piece of data or code that is created at run time on the stack when the address of a nested function is taken, and is used to call the nested function indirectly. For some targets, it is made up of data only and thus requires no special treatment. But, for most targets, it is made up of code and thus requires the stack to be made executable in order for the program to work properly. ๐ (executable stack? iconic but risky)
-Wfloat-equalโ Warn if floating-point values are used in equality comparisons.
The idea behind this is that sometimes it is convenient (for the programmer) to consider floating-point values as approximations to infinitely precise real numbers. If you are doing this, then you need to compute (by analyzing the code, or in some other way) the maximum or likely maximum error that the computation introduces, and allow for it when performing comparisons (and when producing output, but that's a different problem). In particular, instead of testing for equality, you should check to see whether the two values have ranges that overlap; and this is done with the relational operators, so equality comparisons are probably mistaken. ๐ซถ (floats are never exactly equal, bestie, it's giving chaos)
-Wtraditional(C and Objective-C only) โ Warn about certain constructs that behave differently in traditional and ISO C. Also warn about ISO C constructs that have no traditional C equivalent, and/or problematic constructs that should be avoided.- 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 rolls up right after astaticone โ bestie, some old-school traditional C compilers literally will not accept this. ๐- the ISO type of an integer constant has a different width or signedness than its traditional type โ but like, this warning only pops off if the base of the constant is ten. So hex or octal values (which are usually just bit patterns anyway) get zero warning. ๐
- ISO string concatenation usage gets detected. slay.
- initialization of automatic aggregates. noted.
- identifier conflicts with labels โ because traditional C just does not have a separate namespace for labels. it's giving "we don't have that here." ๐ญ
- initialization of unions โ but if the initializer is zero, the warning is skipped entirely. The logic? It assumes a zero initializer in your code shows up conditioned on like
"__STDC__"to dodge missing-initializer warnings, and it 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 you're compiling with traditional C causes serious problems, no cap. Heads up: this is only a subset of the possible conversion warnings. For the full set, use
-Wtraditional-conversion. - use of ISO C style function definitions โ and this warning is intentionally not issued for prototype declarations or variadic functions, because those ISO C features show up in your code when you're using libiberty's traditional C compatibility macros,
"PARAMS"and"VPARAMS". It's also bypassed for nested functions, because that feature is already a GCC extension and thus not relevant to traditional C compatibility. ๐
-Wtraditional-conversion(C and Objective-C only) โ Warn if a prototype causes a type conversion that's different from what would happen to the same argument without a prototype. This includes conversions of fixed point to floating and vice versa, plus conversions that change 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) โ Warn when a declaration shows up after a statement in a block. This construct, known from C++, was introduced with ISO C99 and is by default allowed in GCC. ISO C90 does not support it. periodt.-Wshadowโ Warn whenever a local variable or type declaration shadows another variable, parameter, type, class member (in C++), or instance variable (in Objective-C), or whenever a built-in function is shadowed. Note that in C++, the compiler warns if a local variable shadows an explicit typedef, but not if it shadows a struct/class/enum. Same as-Wshadow=global.-Wno-shadow-ivar(Objective-C only) โ Do not warn whenever a local variable shadows an instance variable in an Objective-C method. ๐ซถ-Wshadow=globalโ The default for-Wshadow. Warns for any (global) shadowing.-Wshadow=localโ Warn when a local variable shadows another local variable or parameter. This warning is enabled by-Wshadow=global.-Wshadow=compatible-localโ Warn when a local variable shadows another local variable or parameter whose type is compatible with that of the shadowing variable. In C++, type compatibility here means the type of the shadowing variable can be converted to that of the shadowed variable. The creation of this flag (in addition to-Wshadow=local) is based on the idea that when a local variable shadows another one of incompatible type, it's most likely intentional โ not a bug or a typo โ as shown in the following example:
for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
{
for (int i = 0; i < N; ++i)
{
...
}
...
}
Since the two variable i in the example above have incompatible types, enabling only -Wshadow=compatible-local will not emit a warning. Because their types are incompatible, if a programmer accidentally uses one in place of the other, type checking will catch that and emit an error or warning. So not warning (about shadowing) in this case will not lead to undetected bugs. Use of this flag instead of -Wshadow=local can possibly reduce the number of warnings triggered by intentional shadowing.
This warning is enabled by -Wshadow=local.
- *
-Wlarger-than=byte-size* โ Warn whenever an object is defined whose size exceedsbyte-size.-Wlarger-than=PTRDIFF_MAXis enabled by default. Warnings controlled by the option can be disabled either by specifyingbyte-sizeofSIZE_MAXor more, or 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 exceedsbyte-size. The computation done to determine the stack frame size is *approximate and not conservative. The actual requirements may be somewhat greater than *byte-sizeeven if you don't get a warning. In addition, any space allocated via"alloca", variable-length arrays, or related constructs is not included by the compiler when determining whether or not to issue a warning.-Wframe-larger-than=PTRDIFF_MAXis enabled by default. Warnings controlled by the option can be disabled either by specifyingbyte-sizeofSIZE_MAXor 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.-Wno-free-nonheap-objectโ Do not warn when attempting to free an object that was not allocated on the heap.-Wstack-usage=byte-sizeโ Warn if the stack usage of a function might exceedbyte-size. The computation done to determine the stack usage is conservative. Any space allocated via"alloca", variable-length arrays, or related constructs **is included by the compiler when determining whether or not to issue a warning.
The message 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-optimizations, warn if the compiler makes such assumptions. ๐-Wno-pedantic-ms-format(MinGW targets only) โ When used in combination with-Wformatand-pedanticwithout GNU extensions, this option disables the warnings about non-ISO"printf"/"scanf"format width specifiers"I32","I64", and"I"used on Windows targets, which depend on the MS runtime.-Waligned-newโ Warn 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=allalso warns about class member allocation functions. โจ-Wplacement-new- *
-Wplacement-new=n* โ Warn about placement new expressions with undefined behavior, such as constructing an object in a buffer that's smaller than the type of the object. For example, the placement new expression below is diagnosed because it attempts to construct an array of 64 integers in a buffer only 64 bytes large. ๐
char buf [64];
new (buf) int[64];
This warning is enabled by default.
-Wplacement-new=1โ This is the default warning level of-Wplacement-new. At this level the warning is not issued for some strictly undefined constructs that GCC allows as extensions for compatibility with legacy code. For example, the following"new"expression is not diagnosed at this level even though it has undefined behavior according to the C++ standard, because it writes past the end of the one-element array.
struct S { int n, a[1]; };
S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
new (s->a)int [32]();
-Wplacement-new=2โ At this level, in addition to diagnosing all the same constructs as at level 1, a diagnostic is also issued for placement new expressions that construct an object in the last member of 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]();
-Wpointer-arithโ Warn about anything that depends on the "size of" a function type or of"void". GNU C assigns these types a size of 1, for convenience in calculations with"void *"pointers and pointers to functions. In C++, warn also when an arithmetic operation involves"NULL". This warning is also enabled by-Wpedantic. ๐-Wpointer-compareโ Warn if a pointer is compared with a zero character constant. This usually means that the pointer was meant to be dereferenced. For example:
const char *p = foo ();
if (p == '\0')
return 42;
Note that the code above is invalid in C++11. ๐
This warning is enabled by default.
-Wtype-limitsโ bestie, this one clocks when a comparison is always true or always false purely because of the limited range of the data type โ but it does not warn for constant expressions, okay? So like, if an unsigned variable gets compared against zero with<or>=, she's gonna say something. Also, this warning is enabled by-Wextratoo ๐-Wabsolute-value(C and Objective-C only) โ warn when you call a standard function that computes the absolute value of an argument but a more appropriate standard function exists. Example bestie: callingabs(3.14)triggers the warning because the correct function for adoubleargument isfabs. She also warns when the argument in a call to such a function has an unsigned type. You can hush her with an explicit type cast, and it's also enabled by-Wextraโจ-Wcomment-Wcommentsโ warn whenever a comment-start sequence/*appears inside a/*comment, or whenever a backslash-newline shows up in a//comment. Enabled by-Wall๐ซถ-Wtrigraphsโ warn if any trigraphs are encountered that might change the meaning of the program. Trigraphs inside comments are not warned about, except the ones 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 still 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, iykyk.-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 counts as 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 bestie: 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 ๐-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-c2x-compat(C and Objective-C only) โ warn about features not present in ISO C11, but present in ISO C2X. For instance, warn about omitting the string in_Static_assert. This option is independent of the standards mode. Warnings are disabled in the expression that follows__extension__โญ-Wc++-compat(C and Objective-C only) โ warn about ISO C constructs that are outside of the common subset of ISO C and ISO C++, e.g. request for implicit conversion fromvoid *to a pointer to non-voidtype ๐ฆ-Wc++11-compat(C++ and Objective-C++ only) โ warn about C++ constructs whose meaning differs between ISO C++ 1998 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords in ISO C++ 2011. This warning turns on-Wnarrowingand is enabled by-Wall๐-Wc++14-compat(C++ and Objective-C++ only) โ warn about C++ constructs whose meaning differs between ISO C++ 2011 and ISO C++ 2014. This warning is enabled by-Wallโจ-Wc++17-compat(C++ and Objective-C++ only) โ warn about C++ constructs whose meaning differs between ISO C++ 2014 and ISO C++ 2017. This warning is enabled by-Wall๐-Wcast-qualโ warn whenever a pointer is cast so as to remove a type qualifier from the target type. For example, warn if aconst char *is cast to an ordinarychar *.
Also warn when making a cast that introduces a type qualifier in an unsafe way. For example, casting char ** to const char ** is unsafe, as in this example:
/* p is char ** value. */
const char **q = (const char **) p;
/* Assignment of readonly string to const char * is OK. */
*q = "string";
/* Now char** pointer points to read-only memory. */
**p = 'b';
-Wcast-alignโ warn whenever a pointer is cast such that the required alignment of the target is increased. For example, warn if achar *is cast to anint *on machines where integers can only be accessed at two- or four-byte boundaries ๐-Wcast-align=strictโ warn whenever a pointer is cast such that the required alignment of the target is increased. For example, warn if achar *is cast to anint *regardless of the target machine.-Wcast-function-typeโ warn when a function pointer is cast to an incompatible function pointer. In a cast involving function types with a variable argument list only the types of initial arguments that are provided are considered. Any parameter of pointer-type matches any other pointer-type. Any benign differences in integral types are ignored, likeintvs.longon ILP32 targets. Likewise type qualifiers are ignored. The function typevoid (*) (void)is special and matches everything, which can be used to suppress this warning. In a cast involving pointer to member types this warning warns whenever the type cast is changing the pointer to member type. This warning is enabled by-Wextra๐ฅ-Wwrite-stringsโ when compiling C, give 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 find at compile time code that can try to write into a string constant, but only if you have been very careful about usingconstin declarations and prototypes. Otherwise, it is just a nuisance. This is why we did not make-Wallrequest these warnings.
When compiling C++, warn about the deprecated conversion from string literals to char *. This warning is enabled by default for C++ programs ๐
-Wcatch-value-Wcatch-value=n(C++ and Objective-C++ only) โ warn 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๐-Wclobberedโ warn for variables that might be changed bylongjmporvfork. This warning is also enabled by-Wextra๐ญ-Wconditionally-supported(C++ and Objective-C++ only) โ warn for conditionally-supported (C++11 [intro.defs]) constructs ๐ง-Wconversionโ warn for implicit conversions that may alter a value. This 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). Do not warn for explicit casts likeabs ((int) x)andui = (unsigned) -1, or if the value is not changed by the conversion like inabs (2.0). Warnings about conversions between signed and unsigned integers can be disabled by using-Wno-sign-conversion.
For C++, also warn for confusing overload resolution for user-defined conversions; and conversions that never use a type conversion operator: conversions to void, the same type, a base class or a reference to them. Warnings about conversions between signed and unsigned integers are disabled by default in C++ unless -Wsign-conversion is explicitly enabled ๐
-Wno-conversion-null(C++ and Objective-C++ only) โ do not warn for conversions betweenNULLand non-pointer types.-Wconversion-nullis enabled by default ๐ธ-Wzero-as-null-pointer-constant(C++ and Objective-C++ only) โ warn when a literal0is used as null pointer constant. This can be useful to facilitate the conversion tonullptrin C++11 โญ-Wsubobject-linkage(C++ and Objective-C++ only) โ warn if a class type has a base or a field whose type uses the anonymous namespace or depends on a type with no linkage. If a type A depends on a type B with no or internal linkage, defining it in multiple translation units would be an ODR violation because the meaning of B is different in each translation unit. If A only appears in a single translation unit, the best way to silence the warning is to give it internal linkage by putting it in an anonymous namespace as well. The compiler doesn't give this warning for types defined in the main .C file, as those are unlikely to have multiple definitions.-Wsubobject-linkageis enabled by default ๐ฆ-Wdangling-elseโ bestie, this one warns about constructions where there could be confusion about whichifstatement anelsebranch actually belongs to. Classic case:
{
if (a)
if (b)
foo ();
else
bar ();
}
In C/C++, every else branch belongs to the innermost possible if statement, which in this example is if (b). That's often not what the programmer expected, and the indentation above is basically the crime scene photo. When there's potential for this confusion, GCC issues a warning when this flag is specified. To eliminate the warning, add explicit braces around the innermost if statement so there's no way the else can belong to the enclosing if. The glow-up looks like this:
{
if (a)
{
if (b)
foo ();
else
bar ();
}
}
This warning is enabled by -Wparentheses.
-Wdate-timeโ warns when the macros__TIME__,__DATE__or__TIMESTAMP__show up, because they might prevent bit-wise-identical reproducible compilations. no cap, they're little chaos gremlins in your build ๐-Wdelete-incomplete(C++ and Objective-C++ only) โ warns when you delete a pointer to an incomplete type, which may cause undefined behavior at runtime. This warning is enabled by default. ๐-Wuseless-cast(C++ and Objective-C++ only) โ warns when an expression is casted to its own type. like bestie that's just you talking to yourself ๐-Wempty-bodyโ warns if an empty body occurs in anif,elseordo whilestatement. This warning is also enabled by-Wextra.-Wenum-compareโ warns about a comparison between values of different enumerated types. In C++ enumerated type mismatches in conditional expressions are also diagnosed and the warning is enabled by default. In C this warning is enabled by-Wall.-Wextra-semi(C++, Objective-C++ only) โ warns about redundant semicolon after in-class function definition.-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. Heads up: this only warns about variables that are initialized when they are declared. This warning is only supported for C and Objective-C; in C++ this sort of branch is an error in any case.
-Wjump-misses-init is included in -Wc++-compat. It can be disabled with the -Wno-jump-misses-init option.
-Wsign-compareโ 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 is also enabled by-Wextra. the sign-flip betrayal arc ๐ญ-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. In C, this option is enabled also by-Wconversion.-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.-Wsized-deallocation(C++ and Objective-C++ only) โ warns about a definition of an unsized deallocation function
void operator delete (void *) noexcept;
void operator delete[] (void *) noexcept;
without a definition of the corresponding sized deallocation function
void operator delete (void *, std::size_t) noexcept;
void operator delete[] (void *, std::size_t) noexcept;
or vice versa. Enabled by -Wextra along with -fsized-deallocation.
-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. the classic "wait, that's a pointer" plot twist ๐ซถ-Wsizeof-pointer-memaccessโ warns for suspicious length parameters to certain string and memory built-in functions if the argument usessizeof. This warning 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.
-Wsizeof-array-argumentโ warns 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. bestie forgot the โจmultiplicationโจ-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 is an expression that is folded to zero, or a cast of zero to some type, it is far less likely that the arguments have been mistakenly transposed and no warning is emitted. This warning is enabled by-Wall.-Waddressโ warns about suspicious uses of memory addresses. These include using the address of a function in a conditional expression, such asvoid func(void); if (func), and comparisons against the memory address of a string literal, such asif (x == "abc"). Such uses typically indicate a programmer error: the address of a function always evaluates to true, so their use in a conditional usually indicate that the programmer forgot the parentheses in a function call; and comparisons against string literals result in unspecified behavior and are not portable in C, so they usually indicate that the programmer intended to usestrcmp. This warning is enabled by-Wall.-Waddress-of-packed-memberโ warns when the address of packed member of struct or union is taken, which usually results in an unaligned pointer value. This is enabled by default.-Wlogical-opโ warns about suspicious uses of logical operators in expressions. This includes using logical operators in contexts where a bit-wise operator is likely to be expected. Also warns when the operands of a logical operator are the same:
extern int a;
if (a < 0 && a < 0) { ... }
-Wlogical-not-parenthesesโ 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 is possible to suppress the warning by wrapping the LHS into parentheses:
if ((!a) > 1) { ... }
This warning is enabled by -Wall.
-Waggregate-returnโ warns if any functions that return structures or unions are defined or called. (In languages where you can return an array, this also elicits a warning.)-Wno-aggressive-loop-optimizationsโ warns if in a loop with constant number of iterations the compiler detects undefined behavior in some statement during one or more of the iterations.-Wno-attributesโ do not warn if an unexpected__attribute__is used, such as unrecognized attributes, function attributes applied to variables, etc. This does not stop errors for incorrect use of supported attributes.-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 does not include a prototype is called with arguments whose promoted types do not match those expected by the function. When-Wextrais specified, also warn when a built-in function that takes arguments is declared without a prototype. The-Wno-builtin-declaration-mismatchwarning is enabled by default. To avoid the warning include the appropriate header to bring the prototypes of built-in functions into scope.
For example, the call to memset below is 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 is diagnosed as well.
extern void* memset ();
void f (void *d)
{
memset (d, '\0', 32);
}
-Wno-builtin-macro-redefinedโ do not warn if certain built-in macros are redefined. This suppresses warnings for redefinition of__TIMESTAMP__,__TIME__,__DATE__,__FILE__, and__BASE_FILE__.-Wstrict-prototypes(C and Objective-C only) โ warns if a function is declared or defined without specifying the argument types. (An old-style function definition is permitted without a warning if preceded by a declaration that specifies the argument types.) vintage C behaviour, we respect the elders ๐-Wold-style-declaration<span style="color:pink">(C and Objective-C only)</span> โ bestie, this one's for the obsolescent vibes. It warns about usages that the C Standard has basically side-eyed as old, inside a declaration. Example: if storage-class specifiers likestaticaren't the first things in a declaration, you get a lil nudge. This warning is also enabled by-Wextra. โจ-Wold-style-definition<span style="color:pink">(C and Objective-C only)</span> โ warns you if an old-style function definition is being used. And like, even if there's a previous prototype, it's still gonna say something. No free passes here. ๐-Wmissing-parameter-type<span style="color:pink">(C and Objective-C only)</span> โ this is when a function parameter gets declared with no type specifier at all in K&R-style functions, like:
void foo(bar) { }
This warning is also enabled by -Wextra. ๐ซถ
-Wmissing-prototypes<span style="color:pink">(C and Objective-C only)</span> โ warns if a global function is defined with no previous prototype declaration. And yeah, it fires even if the definition itself provides a prototype. Use this to sniff out global functions that don't have a matching prototype declaration in a header file. โ ๏ธ Heads up: this option is not valid for C++, because in C++ all function declarations provide prototypes, and a non-matching declaration declares an overload rather than conflicting with an earlier declaration. If you're in C++, use-Wmissing-declarationsinstead to catch missing declarations. ๐-Wmissing-declarationsโ warns if a global function is defined without a previous declaration, and it does this even if the definition itself provides a prototype. This is your tool for finding global functions that aren't declared in header files. In C, no warnings are issued for functions with previous non-prototype declarations โ use-Wmissing-prototypesfor those. In C++, no warnings are issued for function templates, or for inline functions, or for functions in anonymous namespaces. ๐ฆ-Wmissing-field-initializersโ warns when a structure's initializer is missing some fields. Like, this code here triggers it, becausex.his implicitly zero:
struct s { int f, g, h; };
struct s x = { 3, 4 };
It does not warn about designated initializers though, so this version stays quiet:
struct s { int f, g, h; };
struct s x = { .f = 3, .g = 4 };
In C, it also doesn't warn about the universal zero initializer { 0 }:
struct s { int f, g, h; };
struct s x = { 0 };
Same energy in C++ โ it doesn't warn about the empty { } initializer:
struct s { int f, g, h; };
s x = { };
This warning is included in -Wextra. And if you want the other -Wextra warnings without this one, hit it with -Wextra -Wno-missing-field-initializers. ๐
-Wno-multicharโ do not warn if a multicharacter constant ('FOOF') is used. Usually these are just a typo in the user's code, since they have implementation-defined values and really shouldn't be in portable code. So yeah, silencing it is a choice you're allowed to make. ๐-Wnormalized=[none|id|nfc|nfkc]โ okay so in ISO C and ISO C++, two identifiers are different if they're different sequences of characters. But sometimes, when you're using characters outside the basic ASCII character set, you can have two different character sequences that look exactly the same. ๐ญ To avoid the confusion, the ISO 10646 standard lays out 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 isn't in the ISO 10646 "C" normalized form, NFC. NFC is the recommended form for most uses. It's equivalent to -Wnormalized.
Unfortunately โ and this is the annoying part โ there are some characters allowed in identifiers by ISO C and ISO C++ that, when turned into NFC, are not allowed in identifiers. So there's literally no way to use these symbols in portable ISO C or C++ and have all your identifiers in NFC. -Wnormalized=id suppresses the warning for these characters. The hope is that future versions of the standards involved will fix this, which is exactly why this option is not the default.
You can switch the warning off for all characters by writing -Wnormalized=none or -Wno-normalized. Only do this if you're using some other normalization scheme (like "D"), because otherwise you can easily create bugs that are literally impossible to see. ๐จ
Some characters in ISO 10646 have distinct meanings but look identical in some fonts or display methodologies, especially 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 isn't in NFKC when you use -Wnormalized=nfkc. This warning is comparable to warning about every identifier that contains the letter O because it might be confused with the digit 0, so it's not the default โ but it may be useful as a local coding convention if the programming environment can't be fixed to display these characters distinctly. ๐
-Wno-attribute-warningโ do not warn about usage of functions declared with thewarningattribute. By default, this warning is enabled.-Wno-attribute-warningcan be used to disable the warning, or-Wno-error=attribute-warningcan be used to disable the error when compiled with the-Werrorflag. ๐-Wno-deprecatedโ do not warn about usage of deprecated features. Simple as that. ๐-Wno-deprecated-declarationsโ do not warn about uses of functions, variables, and types marked as deprecated by using thedeprecatedattribute. ๐ง-Wno-overflowโ do not warn about compile-time overflow in constant expressions. ๐-Wno-odrโ warn about One Definition Rule violations during link-time optimization. Requires-flto-odr-type-mergingto be enabled. Enabled by default. โจ-Wopenmp-simdโ warns if the vectorizer cost model overrides the OpenMP simd directive set by the user. The-fsimd-cost-model=unlimitedoption can be used to relax the cost model. ๐ฅ-Woverride-init<span style="color:pink">(C and Objective-C only)</span> โ warns if an initialized field without side effects is overridden when using designated initializers.
This warning is included in -Wextra. To get the other -Wextra warnings without this one, use -Wextra -Wno-override-init. ๐
-Woverride-init-side-effects<span style="color:pink">(C and Objective-C only)</span> โ warns if an initialized field with side effects is overridden when using designated initializers. This warning is enabled by default. ๐-Wpackedโ warns if a structure is given the packed attribute, but that packed attribute has no effect on the layout or size of the structure. Such structures may end up mis-aligned for basically no 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;
};
-Wpacked-bitfield-compatโ the 4.1, 4.2 and 4.3 series of GCC ignore thepackedattribute on bit-fields of typechar. This got fixed in GCC 4.4, but the change can lead to differences in the structure layout. GCC lets you know when the offset of such a field has changed in GCC 4.4. For example, there's no longer a 4-bit padding between 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<span style="color:pink">(C, C++, Objective-C and Objective-C++ only)</span> โ warns 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โ warns if padding is included in a structure, whether it's there to align an element of the structure or to align the whole structure. Sometimes when this happens, you can rearrange the fields of the structure to reduce the padding and make the structure smaller. ๐-Wredundant-declsโ warns if anything is declared more than once in the same scope, even in cases where the multiple declaration is valid and changes nothing. Like, we see you, but okay. ๐-Wno-restrictโ warns when an object referenced by arestrict-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 thestrcpyfunction below attempts to truncate the string by replacing its initial characters with the last four. But 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 it works best at -O2 and above. It's included in -Wall. ๐ฅ
-Wnested-externs<span style="color:pink">(C and Objective-C only)</span> โ warns if anexterndeclaration is encountered within a function. Nested externs? We're clocking it. ๐-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. ๐-Winlineโ warns if a function that is declared as inline cannot actually be inlined. And even with this option on, 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.
-Wno-invalid-offsetof(C++ and Objective-C++ only) โ bestie, this one shuts off the warnings you get from applying theoffsetofmacro to a non-POD type. Per the 2014 ISO C++ standard, applyingoffsetofto a non-standard-layout type is undefined. But likeโฆ in existing C++ implementations,offsetoftypically gives meaningful results anyway. This flag is for users who know they're writing nonportable code and who have deliberately chosen to ignore the warning about it. ๐
The restrictions on offsetof may be relaxed in a future version of the C++ standard.
-Wint-in-bool-contextโ warns you about suspicious use of integer values where boolean values are expected ๐ซฃ like conditional expressions (?:) using non-boolean integer constants in boolean context, e.g.if (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.-Wno-int-to-pointer-castโ suppresses warnings from casts to pointer type of an integer of a different size. In C++, casting to a pointer type of smaller size is an error.Wint-to-pointer-castis enabled by default.-Wno-pointer-to-int-cast(C and Objective-C only) โ suppresses warnings from casts from a pointer to an integer type of a different size.-Winvalid-pchโ warns if a precompiled header is found in the search path but cannot be used. ๐ญ-Wlong-longโ warns iflong longtype is used. This is enabled by either-Wpedanticor-Wtraditionalin ISO C90 and C++98 modes. To inhibit the warning messages, use-Wno-long-long.-Wvariadic-macrosโ warns if variadic macros are used in ISO C90 mode, or if the GNU alternate syntax is used in ISO C99 mode. This is enabled by either-Wpedanticor-Wtraditional. To inhibit the warning messages, use-Wno-variadic-macros.-Wvarargsโ warns upon questionable usage of the macros used to handle variable arguments likeva_start. This is default. To inhibit the warning messages, use-Wno-varargs.-Wvector-operation-performanceโ warns if a vector operation is not implemented via SIMD capabilities of the architecture. Mainly useful for the performance tuning ๐ A vector operation can be implementedpiecewise, which means that the scalar operation is performed on every vector element;in parallel, which means that the vector operation is implemented using scalars of wider type, which normally is more performance efficient; andas a single scalar, which means that vector fits into a scalar type.-Wno-virtual-move-assignโ suppresses warnings about inheriting from a virtual base with a non-trivial C++11 move assignment operator. This is dangerous โ ๏ธ because if the virtual base is reachable along more than one path, it is moved multiple times, which can mean both objects end up in the moved-from state. If the move assignment operator is written to avoid moving from a moved-from object, this warning can be disabled.-Wvlaโ warns if a variable-length array is used in the code.-Wno-vlaprevents the-Wpedanticwarning of the variable-length array.-Wvla-larger-than=byte-sizeโ if this option is used, the compiler will warn for declarations of variable-length arrays whose size is either unbounded, or bounded by an argument that allows the array size to exceed byte-size bytes. This is similar to how-Walloca-larger-than=byte-sizeworks, but with variable-length arrays.
Note that GCC may optimize small variable-length arrays of a known value into plain arrays, so this warning may not get triggered for such arrays. ๐
-Wvla-larger-than=PTRDIFF_MAX is enabled by default but is typically only effective when -ftree-vrp is active (default for -O2 and above).
See also -Walloca-larger-than=byte-size.
-Wno-vla-larger-thanโ disables-Wvla-larger-than=warnings. The option is equivalent to-Wvla-larger-than=SIZE_MAXor larger.-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.-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 is implied by-Walland by-Wpedantic, which can be disabled with-Wno-pointer-sign.-Wstack-protectorโ this option is only active when-fstack-protectoris active. It warns about functions that are not protected against stack smashing. ๐ก๏ธ-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-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.-Whsaโ issues a warning when HSAIL cannot be emitted for the compiled function or OpenMP construct.
๐โจ Options for Debugging Your Program โจ๐
To tell GCC to emit extra information for use by a debugger, in almost all cases you need only to add -g to your other options. ๐ซถ
GCC allows you to use -g with -O. The shortcuts taken by optimized code may occasionally be surprising: some variables you declared may not exist at all; flow of control may briefly move where you did not expect it; some statements may not be executed because they compute constant results or their values are already at hand; some statements may execute in different places because they have been moved out of loops. Nevertheless it is possible to debug optimized output. This makes it reasonable to use the optimizer for programs that might have bugs. ๐
If you are not using some other optimization option, consider using -Og with -g. With no -O option at all, some compiler passes that collect information useful for debugging do not run at all, so that -Og may result in a better debugging experience. ๐
-gโ produce debugging information in the operating system's native format (stabs, COFF, XCOFF, or DWARF). GDB can work with this debugging information.
On most systems that use stabs format, -g enables use of extra debugging information that only GDB can use; this extra information makes debugging work better in GDB but probably makes other debuggers crash or refuse to read the program ๐ญ If you want to control for certain whether to generate the extra information, use -gstabs+, -gstabs, -gxcoff+, -gxcoff, or -gvms (see below).
-ggdbโ produce debugging information for use by GDB. This means to use the most expressive format available (DWARF, stabs, or the native format if neither of those are supported), including GDB extensions if at all possible.-gdwarf-gdwarf-versionโ produce debugging information in DWARF format (if that is supported). The value of version may be either 2, 3, 4 or 5; the default version for most targets is 4. DWARF Version 5 is only experimental. ๐งช
Note that with DWARF Version 2, some ports require and always use some non-conflicting DWARF 3 extensions in the unwind tables.
Version 4 may require GDB 7.0 and -fvar-tracking-assignments for maximum benefit.
GCC no longer supports DWARF Version 1, which is substantially different than Version 2 and later. For historical reasons, some other DWARF-related options such as -fno-dwarf2-cfi-asm) retain a reference to DWARF Version 2 in their names, but apply to all currently-supported versions of DWARF.
-gstabsโ produce debugging information in stabs format (if that is supported), without GDB extensions. This is the format used by DBX on most BSD systems. On MIPS, Alpha and System V Release 4 systems this option produces stabs debugging output that is not understood by DBX. On System V Release 4 systems this option requires the GNU assembler.-gstabs+โ produce debugging information in stabs format (if that is supported), using GNU extensions understood only by the GNU debugger (GDB). The use of these extensions is likely to make other debuggers crash or refuse to read the program. ๐-gxcoffโ produce debugging information in XCOFF format (if that is supported). This is the format used by the DBX debugger on IBM RS/6000 systems.-gxcoff+โ okay so this one makes debugging info in XCOFF format (if your setup even supports it ๐ ), and it uses GNU extensions that literally only GDB understands. Heads up bestie: using those extensions will probably make other debuggers crash or flat-out refuse to read your program, and it can make assemblers that aren't GAS (the GNU assembler) throw an error at you. ๐ญ So like, know what you're doing.-gvmsโ produces debugging info in Alpha/VMS debug format (if that's supported). This is the format that DEBUG uses on Alpha/VMS systems. โจ
๐ -g LEVELS, THE WHOLE SITUATION ๐
-glevel,-ggdblevel,-gstabslevel,-gxcofflevel,-gvmslevelโ ask for debugging info and tell it how much you want with level. Default level is2. Periodt.- Level
0= literally no debug info at all. So-g0cancels out-g. Bye. ๐ - Level
1= the bare minimum, enough to make backtraces for the parts of the program you don't plan to debug. That means descriptions of functions and external variables, plus line number tables โ but no info about local variables. - Level
3= extra info, like all the macro definitions present in the program. Some debuggers support macro expansion when you use-g3. ๐
- Level
- If you use multiple
-goptions, with or without level numbers, the last one is the one that counts. The last one wins, no cap. -gdwarfdoes not accept a concatenated debug level, specifically so it doesn't get confused with-gdwarf-level. Instead, use an extra-gleveloption to change the debug level for DWARF. ๐ซถ
-feliminate-unused-debug-symbolsโ produces debugging info in stabs format (if that's supported), but only for symbols that are actually used. Less clutter, cute.-femit-class-debug-alwaysโ normally GCC emits debugging info for a C++ class in just one object file; with this it emits it in all object files that use the class. Only use this with debuggers that can't handle how GCC normally emits class debug info, because it can inflate the size of your debugging info by as much as a factor of two. It's giving bloated. ๐ญ-fno-merge-debug-stringsโ tells the linker to not merge together identical strings in the debugging information across different object files. Merging isn't supported by all assemblers or linkers. Merging shrinks the debug info in the output file but costs you more link processing time. Merging is enabled by default. โจ-fdebug-prefix-map=old=newโ when you compile files that live in directory old, record the debugging info as if those files lived in directory new instead. Use case: swapping a build-time path for an install-time path in the debug info. You can also turn an absolute path into a relative one by using.for new. This can give you more reproducible builds that are location independent โ but it may need an extra command to tell GDB where to find the source files. See also-ffile-prefix-map. ๐ฆ-fvar-trackingโ runs the variable tracking pass, which figures out where variables are stored at each position in the code. Then better debugging info gets generated (if the debug info format even supports that kind of info).
It's enabled by default when you compile with optimization (-Os, -O, -O2, ...), debugging information (-g), and the debug info format supports it. ๐
-fvar-tracking-assignmentsโ annotates assignments to user variables early in compilation and tries to carry those annotations all the way through to the end, all to improve debug info while optimizing. Using-gdwarf-4alongside it is recommended. ๐
It can be enabled even if var-tracking is disabled โ in that case the annotations get created and maintained, but discarded at the end. By default this flag is enabled together with -fvar-tracking, except when selective scheduling is enabled.
-gsplit-dwarfโ splits as much DWARF debugging info as possible into a separate output file with the extension.dwo. This lets the build system avoid linking files that have debug info. To actually be useful, this option needs a debugger that can read.dwofiles. No.dwo-reading debugger, no vibes. ๐ฅฒ-gdescribe-diesโ adds description attributes to some DWARF DIEs that have no name attribute, like artificial variables, external references and call site parameter DIEs. โจ-gpubnamesโ generates DWARF".debug_pubnames"and".debug_pubtypes"sections.-ggnu-pubnamesโ generates".debug_pubnames"and".debug_pubtypes"sections in a format suitable for conversion into a GDB index. Only useful with a linker that can produce GDB index version 7. ๐-fdebug-types-sectionโ when using DWARF Version 4 or higher, type DIEs can go into their own".debug_types"section instead of being part of the".debug_info"section. Putting them in a separate comdat section is more efficient because the linker can then remove duplicates. But: not all DWARF consumers support".debug_types"sections yet, and on some objects".debug_types"produces larger instead of smaller debugging info. ๐-grecord-gcc-switches,-gno-record-gcc-switchesโ this switch appends the command-line options used to invoke the compiler that may affect code generation onto theDW_AT_producerattribute in DWARF debugging information. The options get concatenated with spaces separating them from each other and from the compiler version. Enabled by default. See also-frecord-gcc-switchesfor another way to store compiler options in the object file. ๐ซถ-gstrict-dwarfโ disallows using extensions from a later DWARF standard version than the one selected with-gdwarf-version. On most targets, using non-conflicting DWARF extensions from later standard versions is allowed โ this is the option that says nope, don't. ๐-gno-strict-dwarfโ allows using extensions of a later DWARF standard version than the one selected with-gdwarf-version. The chill one. ๐ธ-gas-loc-supportโ informs the compiler that the assembler supports".loc"directives. 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 the ones the compiler can generate itself. ๐
This option is enabled by default if, at GCC configure time, the assembler was found to support such directives.
-gno-as-loc-supportโ forces GCC to generate DWARF2+ line number tables internally, if DWARF2+ line number tables are going to be generated anyway.gas-locview-supportโ informs the compiler that the assembler supports "view" assignment and reset assertion checking in".loc"directives.
This option is enabled by default if, at GCC configure time, the assembler was found to support them. โจ
gno-as-locview-supportโ forces GCC to assign view numbers internally, if-gvariable-location-viewsis explicitly requested.-gcolumn-info,-gno-column-infoโ emits location column information into DWARF debugging information, rather than just file and line. Enabled by default. ๐-gstatement-frontiers,-gno-statement-frontiersโ makes GCC create markers in the internal representation at the beginning of statements and keep them roughly in place throughout compilation, using them to guide the output of"is_stmt"markers in the line number table. Enabled by default when compiling with optimization (-Os,-O,-O2, ...) and outputting DWARF 2 debug information at the normal level. ๐-gvariable-location-views,-gvariable-location-views=incompat5,-gno-variable-location-viewsโ augments variable location lists with progressive view numbers implied from the line number table. This lets debug info consumers inspect state at certain points of the program, even when no instructions associated with the corresponding source locations exist at that point. If the assembler doesn't support view numbers in line number tables, this will make the compiler emit the line number table itself, which generally makes those tables somewhat less compact. The augmented line number tables and location lists are fully backward-compatible, so consumers that aren't aware of these augmentations can still read them โ they just won't get any benefit from them either. ๐คท
Enabled by default when outputting DWARF 2 debug information at the normal level, as long as there's assembler support, -fvar-tracking-assignments is enabled and -gstrict-dwarf is not. When assembler support isn't available, this may still be enabled, but it'll force GCC to output internal line number tables โ and if -ginternal-reset-location-views isn't enabled, that will most certainly lead 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 turn it on with -gvariable-location-views=incompat5. This option may be removed in the future, and it's only provided as a reference implementation of the proposed representation. Debug info consumers are not expected to support this extended format, and they'd be rendered unable to decode location lists that use it. ๐
-ginternal-reset-location-views,-gno-internal-reset-location-viewsโ tries to determine location views that can be omitted from location view lists. This requires the compiler to have very accurate insn length estimates, which isn't always the case, and it may cause incorrect view lists to be generated silently when using an assembler that doesn't support location view lists. The GNU assembler will flag any such error as a"view number mismatch". This is only enabled on ports that define a reliable estimation function. ๐-ginline-points,-gno-inline-pointsโ generates extended debug information for inlined functions. Location view tracking markers get inserted at inlined entry points, so that address and view numbers can be computed and output in the debug info. 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's only enabled by default if location views are enabled. ๐ฆ-gz[=type]โ okay so this one makes your debug sections compressed in DWARF format, if that's even supported, bestie. If you don't hand over atype, the default type just depends on what the assembler and linker you're using can actually do. Andtypecan be one of:none(literally don't compress, we're chill),zlib(zlib compression, ELF gABI format style), orzlib-gnu(zlib compression, traditional GNU format). ๐ซถ If your linker can't write compressed debug sections, the option gets rejected โ no debate. But if the assembler doesn't support them,-gzis silently ignored when you're producing object files. Rude but okay.-femit-struct-debug-baseonlyโ this emits debug info for struct-like types only when the base name of the compilation source file matches the base name of the file where that struct is defined. ๐
It substantially shrinks your debugging information, but at a significant potential loss of type info for the debugger. If that sounds like too much, go peep -femit-struct-debug-reduced for a less aggressive option, or -femit-struct-debug-detailed if you want detailed control, iykyk.
Heads up: this one only works with DWARF debug output. No DWARF, no vibes.
-femit-struct-debug-reducedโ emits debug info for struct-like types only when the base name of the compilation source file matches the base name of the file where the type is defined โ unless the struct is a template or it's defined in a system header. โจ
This significantly reduces the size of debugging information, with some potential loss in type information to the debugger. Want something more aggressive? -femit-struct-debug-baseonly. Want the full control panel? -femit-struct-debug-detailed.
Again: DWARF debug output only, bestie.
-femit-struct-debug-detailed[=spec-list]โ this lets you specify exactly which struct-like types the compiler generates debug information for. The whole intent? Reduce duplicate struct debug info between different object files in the same program. ๐ง
It's basically the detailed version of -femit-struct-debug-reduced and -femit-struct-debug-baseonly, and honestly it serves most needs.
A specification has the syntax:
[dir:|ind:][ord:|gen:](any|sys|base|none)
The optional first word limits the spec to structs used directly (dir:) or used indirectly (ind:). A struct type is used directly when it's the type of a variable, member. Indirect uses come through pointers to structs. So like, when use of an incomplete struct is valid, that use is indirect. Example:
struct one direct; struct two * indirect;
The optional second word limits the spec to ordinary structs (ord:) or generic structs (gen:). Generic structs are a bit complicated to explain, ngl. 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 doesn't implement them yet. ๐ญ
The third word specifies the source files for those structs the compiler should emit debug info for. The values none and any have the normal meaning. The value base means the base of the name of the file where the type declaration appears must match the base of the name of the main compilation file. In practice, that means when compiling foo.c, debug information is generated for types declared in that file and foo.h, but not other header files. The value sys means those types satisfying base or declared in system or compiler headers. ๐
You may need to experiment to determine the best settings for your application. Fr fr.
The default is -femit-struct-debug-detailed=all.
And yes โ this option works only with DWARF debug output. ๐
-fno-dwarf2-cfi-asmโ emits DWARF unwind info as a compiler generated".eh_frame"section instead of using GAS".cfi_*"directives. ๐ธ-fno-eliminate-unused-debug-typesโ normally, when producing DWARF output, GCC avoids producing debug symbol output for types that are nowhere used in the source file being compiled. Sometimes it's useful to have GCC emit debugging information for all types declared in a compilation unit, regardless of whether they're actually used in that compilation unit โ like if, in the debugger, you want to cast a value to a type that isn't actually used in your program (but is declared). More often, though, this results in a significant amount of wasted space. ๐
๐ Options That Control Optimization ๐
These options control various sorts of optimizations. The main character energy of compiler flags, honestly.
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. Predictable queen. ๐
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, bestie, we all have them.
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. Group project but it actually works. โจ
Not all optimizations are controlled directly by a flag. Only optimizations that have a flag are listed in this section.
Most optimizations are completely disabled at -O0 or if an -O level is not set on the command line, even if individual optimization flags are specified. Similarly, -Og suppresses many optimization passes.
Depending on the target and how GCC was configured, a slightly different set of optimizations may be enabled at each -O level than those listed here. You can invoke GCC with -Q --help=optimizers to find out the exact set of optimizations that are enabled at each level. Go check, it's giving detective work. ๐
-O-O1โ Optimize. Optimizing compilation takes somewhat more time, and a lot more memory for a large function.
With -O, the compiler tries to reduce code size and execution time, without performing any optimizations that take a great deal of compilation time.
-O turns on the following optimization flags:
-fauto-inc-dec -fbranch-count-reg -fcombine-stack-adjustments
-fcompare-elim -fcprop-registers -fdce -fdefer-pop -fdelayed-branch
-fdse -fforward-propagate -fguess-branch-probability -fif-conversion
-fif-conversion2 -finline-functions-called-once -fipa-profile
-fipa-pure-const -fipa-reference -fipa-reference-addressable
-fmerge-constants -fmove-loop-invariants -fomit-frame-pointer
-freorder-blocks -fshrink-wrap -fshrink-wrap-separate
-fsplit-wide-types -fssa-backprop -fssa-phiopt -ftree-bit-ccp
-ftree-ccp -ftree-ch -ftree-coalesce-vars -ftree-copy-prop
-ftree-dce -ftree-dominator-opts -ftree-dse -ftree-forwprop
-ftree-fre -ftree-phiprop -ftree-pta -ftree-scev-cprop -ftree-sink
-ftree-slsr -ftree-sra -ftree-ter -funit-at-a-time
-O2โ Optimize even more. GCC performs nearly all supported optimizations that don't involve a space-speed tradeoff. Compared to-O, this option increases both compilation time and the performance of the generated code. Glow up. ๐ฅ
-O2 turns on all optimization flags specified by -O. It also turns on the following optimization flags:
-falign-functions -falign-jumps -falign-labels -falign-loops
-fcaller-saves -fcode-hoisting -fcrossjumping -fcse-follow-jumps
-fcse-skip-blocks -fdelete-null-pointer-checks -fdevirtualize
-fdevirtualize-speculatively -fexpensive-optimizations -fgcse
-fgcse-lm -fhoist-adjacent-loads -finline-small-functions
-findirect-inlining -fipa-bit-cp -fipa-cp -fipa-icf -fipa-ra
-fipa-sra -fipa-vrp -fisolate-erroneous-paths-dereference
-flra-remat -foptimize-sibling-calls -foptimize-strlen
-fpartial-inlining -fpeephole2 -freorder-blocks-algorithm=stc
-freorder-blocks-and-partition -freorder-functions
-frerun-cse-after-loop -fschedule-insns -fschedule-insns2
-fsched-interblock -fsched-spec -fstore-merging -fstrict-aliasing
-fthread-jumps -ftree-builtin-call-dce -ftree-pre
-ftree-switch-conversion -ftree-tail-merge -ftree-vrp
Please note the warning under-fgcseabout invoking-O2on programs that use computed gotos. ๐
NOTE: In Ubuntu 8.10 and later versions,-D_FORTIFY_SOURCE=2is set by default, and is activated when-Ois set to 2 or higher. This enables additional compile-time and run-time checks for several libc functions. To disable, specify either-U_FORTIFY_SOURCEor-D_FORTIFY_SOURCE=0.
-O3โ Optimize yet more.-O3turns on all optimizations specified by-O2and also turns on the following optimization flags:
-fgcse-after-reload -finline-functions -fipa-cp-clone
-floop-interchange -floop-unroll-and-jam -fpeel-loops
-fpredictive-commoning -fsplit-paths -ftree-loop-distribute-patterns
-ftree-loop-distribution -ftree-loop-vectorize -ftree-partial-pre
-ftree-slp-vectorize -funswitch-loops -fvect-cost-model
-fversion-loops-for-strides
-O0โ Reduce compilation time and make debugging produce the expected results. This is the default. The cozy no-makeup look. ๐ธ-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. Tiny but mighty. ๐
-Ofastโ Disregard strict standards compliance.-Ofastenables all-O3optimizations. It also enables optimizations that are not valid for all standard-compliant programs. It turns on-ffast-mathand the Fortran-specific-fstack-arrays, unless-fmax-stack-var-sizeis specified, and-fno-protect-parens. Chaos mode, but make it performance. ๐-Ogโ Optimize debugging experience.-Ogshould be the optimization level of choice for the standard edit-compile-debug cycle, offering a reasonable level of optimization while maintaining fast compilation and a good debugging experience. It's a better choice than-O0for producing debuggable code because some compiler passes that collect debug information are disabled at-O0. The balanced icon. ๐ฆ
Like -O0, -Og is a whole mood of no โ it straight-up kills a bunch of optimization passes so that the individual options controlling them have literally zero effect. Otherwise, -Og turns on all the -O1 optimization flags except for the ones that would get in the way of debugging:
-fbranch-count-reg -fdelayed-branch -fif-conversion
-fif-conversion2 -finline-functions-called-once
-fmove-loop-invariants -fssa-phiopt -ftree-bit-ccp -ftree-pta
-ftree-sra
If you pass multiple -O options, with or without level numbers, bestie, the last one is the one that actually counts. Last one wins, periodt.
Options shaped like -fflag are the machine-independent flags, the โจ universal โจ ones. Most flags have both a positive and a negative form, and the negative form of -ffoo is -fno-foo. In the table below only one of the two forms is listed โ the one you'd typically reach for. You can figure out the other form by either dropping the no- or adding it. iykyk ๐
The options below control specific optimizations. They're either activated by -O options or they're related to ones that are. Use these flags in those rare cases when you're craving some "fine-tuning" of the optimizations being performed. ๐
-fno-defer-popโ for machines that have to pop arguments after a function call, this makes them pop the arguments the moment each function returns. At levels-O1and higher,-fdefer-popis the default, which lets the compiler justโฆ let arguments pile up on the stack across several function calls and pop them all at once. Efficient queen. ๐-fforward-propagateโ runs a forward propagation pass on RTL. The pass tries to combine two instructions and checks whether the result can be simplified. If loop unrolling is active, two passes happen and the second one is scheduled after loop unrolling. Enabled by default at optimization levels-O,-O2,-O3,-Os.-ffp-contract=styleโ-ffp-contract=offdisables floating-point expression contraction.-ffp-contract=fastenables floating-point expression contraction, like forming fused multiply-add operations if the target has native support for them.-ffp-contract=onenables floating-point expression contraction if the language standard allows it โ but this is currently not implemented and gets treated the same as-ffp-contract=off. The default is-ffp-contract=fast.-fomit-frame-pointerโ omits the frame pointer in functions that don't need one. This skips the instructions that save, set up and restore the frame pointer; on many targets it also frees up an extra register. ๐ฆ On some targets this flag does nothing, because the standard calling sequence always uses a frame pointer, so it simply cannot be omitted. Also note:-fno-omit-frame-pointerdoes not guarantee the frame pointer is used in all functions โ several targets always omit the frame pointer in leaf functions. Enabled by default at-Oand higher.-foptimize-sibling-callsโ optimizes sibling and tail recursive calls. Enabled at levels-O2,-O3,-Os.-foptimize-strlenโ optimizes various standard C string functions (likestrlen,strchrorstrcpy) and their_FORTIFY_SOURCEcounterparts into faster alternatives. Enabled at levels-O2,-O3.-fno-inlineโ do not expand any functions inline, apart from the ones marked with thealways_inlineattribute. This is the default when not optimizing. Individual functions can be exempted from inlining by marking them with thenoinlineattribute.-finline-small-functionsโ integrates functions into their callers when their body is smaller than the expected function call code (so the overall size of the program gets smaller). The compiler heuristically decides which functions are simple enough to be worth integrating this way. This inlining applies to all functions, even the ones not declared inline. Enabled at levels-O2,-O3,-Os.-findirect-inliningโ also inlines indirect calls that turn out to be known at compile time thanks to previous inlining. This option only has any effect when inlining itself is turned on by the-finline-functionsor-finline-small-functionsoptions. Enabled at levels-O2,-O3,-Os.-finline-functionsโ considers all functions for inlining, even if they aren't declared inline. The compiler heuristically decides which functions are worth integrating this way. If all calls to a given function get integrated, and the function is declaredstatic, then that function normally isn't output as assembler code in its own right. Enabled at levels-O3,-Os. Also enabled by-fprofile-useand-fauto-profile.-finline-functions-called-onceโ considers allstaticfunctions called once for inlining into their caller, even if they aren't markedinline. If a call to a given function gets integrated, then the function isn't output as assembler code in its own right. Enabled at levels-O1,-O2,-O3and-Os, but not-Og.-fearly-inliningโ inlines functions marked byalways_inlineand functions whose body seems smaller than the function call overhead, early โ before doing-fprofile-generateinstrumentation and the real inlining pass. Doing it this way makes profiling significantly cheaper and usually makes inlining faster on programs with big chains of nested wrapper functions. Enabled by default.-fipa-sraโ performs interprocedural scalar replacement of aggregates, removal of unused parameters, and replacement of parameters passed by reference with parameters passed by value. Enabled at levels-O2,-O3and-Os.-finline-limit=nโ by default, GCC limits the size of functions that can be inlined. This flag gives you coarse control over that limit.nis the size of functions that can be inlined, measured in number of pseudo instructions. Inlining is actually controlled by a number of parameters, which can be specified individually using--param name=value. The-finline-limit=noption sets some of these parameters like so:max-inline-insns-singleโ is set ton/2.max-inline-insns-autoโ is set ton/2.
See below for documentation of the individual parameters controlling inlining, and for the defaults of those parameters.
Note: there may be no value of -finline-limit that results in default behavior.
Note: "pseudo instruction" represents, in this particular context, an abstract measurement of a function's size. It does not in any way represent a count of assembly instructions, and as such its exact meaning might change from one release to another. ๐
-fno-keep-inline-dllexportโ this is a more fine-grained version of-fkeep-inline-functions, which applies only to functions declared using thedllexportattribute or declspec.-fkeep-inline-functionsโ in C, emitsstaticfunctions that are declaredinlineinto the object file, even if the function has been inlined into all of its callers. This switch does not affect 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 the function is never used.-fkeep-static-constsโ emits variables declaredstatic constwhen optimization isn't turned on, even if the variables aren't referenced. GCC enables this option by default. If you want to force the compiler to check whether a variable is referenced, regardless of whether or not optimization is turned on, use the-fno-keep-static-constsoption.-fmerge-constantsโ attempts to merge identical constants (string constants and floating-point constants) across compilation units. This option is the default for optimized compilation if the assembler and linker support it. Use-fno-merge-constantsto inhibit this behavior. Enabled at levels-O,-O2,-O3,-Os.-fmerge-all-constantsโ attempts to merge identical constants and identical variables. This option implies-fmerge-constants. On top of-fmerge-constants, it also considers e.g. even constant initialized arrays or initialized constant variables with integral or floating-point types. Languages like C or C++ require each variable โ including multiple instances of the same variable in recursive calls โ to have distinct locations, so using this option results in non-conforming behavior. โ ๏ธ-fmodulo-schedโ performs swing modulo scheduling immediately before the first scheduling pass. This pass looks at innermost loops and reorders their instructions by overlapping different iterations.-fmodulo-sched-allow-regmovesโ performs more aggressive SMS-based modulo scheduling with register moves allowed. Setting this flag deletes certain anti-dependences edges, which triggers the generation of reg-moves based on the life-range analysis. This option is effective only with-fmodulo-schedenabled.-fno-branch-count-regโ disables the optimization pass that scans for opportunities to use "decrement and branch" instructions on a count register, instead of instruction sequences that decrement a register, compare it against zero, and then branch based on the result. This option is only meaningful on architectures that support such instructions, which include x86, PowerPC, IA-64 and S/390. Note that the-fno-branch-count-regoption doesn't remove the decrement and branch instructions from the generated instruction stream introduced by other optimization passes. The default is-fbranch-count-regat-O1and higher, except for-Og.-fno-function-cseโ do not put function addresses in registers; make each instruction that calls a constant function contain the function's address explicitly. This option results in less efficient code, but some strange hacks that alter the assembler output may get confused by the optimizations performed when this option isn't used. The default is-ffunction-cse.-fno-zero-initialized-in-bssโ if the target supports a BSS section, GCC by default puts variables that are initialized to zero into BSS. This can save space in the resulting code. This option turns that behavior off, because some programs explicitly rely on variables going to the data section โ e.g., so the resulting executable can find the beginning of that section and/or make assumptions based on that. The default is-fzero-initialized-in-bss. ๐ธ-fthread-jumpsโ okay so bestie, this optimization checks to see if a jump branches to a location where another comparison subsumed by the first is found. If so, the first branch is redirected to either the destination of the second branch or a point immediately following it, depending on whether the condition is known to be true or false. Enabled at levels-O2,-O3,-Os. periodt.-fsplit-wide-typesโ bestie, when you're using a type that occupies multiple registers, likelong longon a 32-bit system, this splits the registers apart and allocates them independently. It normally generates better code for those types, but it may make debugging more difficult. Enabled at levels-O,-O2,-O3,-Os.-fcse-follow-jumpsโ In common subexpression elimination (CSE), this scans through jump instructions when the target of the jump is not reached by any other path. For example, whenCSEencounters anifstatement with anelseclause,CSEfollows the jump when the condition tested is false. Enabled at levels-O2,-O3,-Os.-fcse-skip-blocksโ This is similar to-fcse-follow-jumps, but it causesCSEto follow jumps that conditionally skip over blocks. WhenCSEencounters a simpleifstatement with no else clause,-fcse-skip-blockscausesCSEto follow the jump around the body of theif. Enabled at levels-O2,-O3,-Os.-frerun-cse-after-loopโ Re-run common subexpression elimination after loop optimizations are performed. Enabled at levels-O2,-O3,-Os.-fgcseโ Perform a global common subexpression elimination pass. This pass also performs global constant and copy propagation. Note: When compiling a program using computed gotos, a GCC extension, you may get better run-time performance if you disable the global common subexpression elimination pass by adding-fno-gcseto the command line. Enabled at levels-O2,-O3,-Os.-fgcse-lmโ When-fgcse-lmis enabled, global common subexpression elimination attempts to move loads that are only killed by stores into themselves. This allows a loop containing a load/store sequence to be changed to a load outside the loop, and a copy/store within the loop. Enabled by default when-fgcseis enabled.-fgcse-smโ When-fgcse-smis enabled, a store motion pass is run after global common subexpression elimination. This pass attempts to move stores out of loops. When used in conjunction with-fgcse-lm, loops containing a load/store sequence can be changed to a load before the loop and a store after the loop. Not enabled at any optimization level.-fgcse-lasโ When-fgcse-lasis enabled, the global common subexpression elimination pass eliminates redundant loads that come after stores to the same memory location (both partial and full redundancies). Not enabled at any optimization level.-fgcse-after-reloadโ When-fgcse-after-reloadis enabled, a redundant load elimination pass is performed after reload. The purpose of this pass is to clean up redundant spilling. Enabled by-fprofile-useand-fauto-profile.-faggressive-loop-optimizationsโ This option tells the loop optimizer to use language constraints to derive bounds for the number of iterations of a loop. This assumes that loop code does not invoke undefined behavior by for example causing signed integer overflows or out-of-bound array accesses. The bounds for the number of iterations of a loop are used to guide loop unrolling and peeling and loop exit test optimizations. This option is enabled by default.-funconstrained-commonsโ This option tells the compiler that variables declared in common blocks (e.g. Fortran) may later be overridden with longer trailing arrays. This prevents certain optimizations that depend on knowing the array bounds. iykyk.-fcrossjumpingโ Perform cross-jumping transformation. This transformation unifies equivalent code and saves code size. The resulting code may or may not perform better than without cross-jumping. Enabled at levels-O2,-O3,-Os.-fauto-inc-decโ Combine increments or decrements of addresses with memory accesses. This pass is always skipped on architectures that do not have instructions to support this. Enabled by default at-Oand higher on architectures that support this.-fdceโ Perform dead code elimination (DCE) onRTL. Enabled by default at-Oand higher.-fdseโ Perform dead store elimination (DSE) onRTL. Enabled by default at-Oand higher.-fif-conversionโ Attempt to transform conditional jumps into branch-less equivalents. This includes use of conditional moves, min, max, set flags and abs instructions, and some tricks doable by standard arithmetics. The use of conditional execution on chips where it is available is controlled by-fif-conversion2. Enabled at levels-O,-O2,-O3,-Os, but not with-Og.-fif-conversion2โ Use conditional execution (where available) to transform conditional jumps into branch-less equivalents. Enabled at levels-O,-O2,-O3,-Os, but not with-Og.-fdeclone-ctor-dtorโ The C++ ABI requires multiple entry points for constructors and destructors: one for a base subobject, one for a complete object, and one for a virtual destructor that 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. 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. In addition, other optimization passes in GCC use this flag to control global dataflow analyses that eliminate useless checks for null pointers; these assume that a memory access to address zero always results in a trap, so that if a pointer is checked after it has already been dereferenced, it cannot be null. Note however that in some environments this assumption is not true. Use-fno-delete-null-pointer-checksto disable this optimization for programs that depend on that behavior. This option is enabled by default on most targets. On Nios II ELF, it defaults to off. On AVR, CR16, 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, determine for a given call the set of likely targets. If the set is small, preferably of size 1, change the call into a conditional deciding between direct and indirect calls. The speculative calls enable more optimizations, such as inlining. When they seem useless after further optimization, they are converted back into original form. main character energy.-fdevirtualize-at-ltransโ Stream extra information needed for aggressive devirtualization when running the link-time optimizer in local transformation mode. This option enables more devirtualization but significantly increases the size of streamed data. For this reason it is disabled by default.-fexpensive-optimizationsโ Perform a number of minor optimizations that are relatively expensive. Enabled at levels-O2,-O3,-Os.-freeโ Attempt to remove redundant extension instructions. This is especially helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit registers after writing to their lower 32-bit half. Enabled for Alpha, AArch64 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 will take advantage of this; if your code relies on the value of the object storage persisting beyond the lifetime of the object, you can use this flag to disable this optimization. To preserve stores before the constructor starts (e.g. because youroperator newclears 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.-flifetime-dse=0is equivalent to-fno-lifetime-dse.-flive-range-shrinkageโ Attempt to decrease register pressure through register live range shrinkage. This is helpful for fast processors with small or moderate size register sets.-fira-algorithm=algorithmโ Use the specified coloring algorithm for the integrated register allocator. Thealgorithmargument 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.-fira-region=regionโ Use specified regions for the integrated register allocator. Theregionargument 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โ bestie, this makes IRA (that's the Integrated Register Allocator, the whole vibe) actually do a vibe check on register pressure inside the code hoisting pass, so it can decide whether hoisting an expression is even worth it. Usually this gives you smaller code, but it can slow the compiler down, ngl. ๐ธ
This option is enabled at level -Os for all targets.
-fira-loop-pressureโ same energy but for loops: use IRA to check register pressure in loops when deciding whether to move loop invariants around. On machines with big register files (>= 32 registers) this usually generates faster and smaller code, but yeah, it can slow the compiler down. โจ
This option is enabled at level -O3 for some targets.
-fno-ira-share-save-slotsโ turns OFF the sharing of stack slots used to save call-used hard registers that are still alive across a call. Every hard register gets its own separate stack slot, and the consequence is that function stack frames get bigger. It's giving "personal space era". ๐-fno-ira-share-spill-slotsโ turns OFF sharing of stack slots allocated for pseudo-registers. Every pseudo-register that doesn't score a hard register gets its own separate stack slot, so again: bigger function stack frames. ๐ญ-flra-rematโ enables CFG-sensitive rematerialization in LRA. Instead of reloading values of spilled pseudos, LRA tries to rematerialize (aka recalculate) those values if it's profitable. iconic behavior honestly. ๐
Enabled at levels -O2, -O3, -Os.
-fdelayed-branchโ if the target machine supports it, try to reorder instructions so it can exploit the instruction slots available after delayed branch instructions. filling the gaps, we love to see it. ๐ฆ
Enabled at levels -O, -O2, -O3, -Os, but not at -Og.
-fschedule-insnsโ if the target machine supports it, try to reorder instructions to eliminate execution stalls caused by needed data not being ready yet. This is a lifesaver for machines with slow floating point or memory load instructions, because it lets other instructions get issued while everyone waits for that load or FP result. โญ
Enabled at levels -O2, -O3.
-fschedule-insns2โ like-fschedule-insnsbut it asks for an extra pass of instruction scheduling after register allocation is done. Super useful on machines with a relatively small number of registers, and where memory load instructions take more than one cycle. ๐ง
Enabled at levels -O2, -O3, -Os.
-fno-sched-interblockโ disables instruction scheduling across basic blocks. That cross-block scheduling is normally on when scheduling before register allocation happens, 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. ๐-fsched-pressureโ enables register-pressure-sensitive instruction scheduling before register allocation. Heads up: this only makes sense when scheduling before register allocation is actually on, i.e. with-fschedule-insnsor at-O2or higher. Using it can improve the generated code and shrink it, by stopping register pressure from rising above the number of available hard registers โ which stops the subsequent spills in register allocation. no spills, no stress. ๐ซถ-fsched-spec-loadโ allows speculative motion of some load instructions. Again, only makes sense when scheduling before register allocation is on, i.e. with-fschedule-insnsor at-O2or higher. โจ-fsched-spec-load-dangerousโ allows speculative motion of more load instructions. Same deal: only makes sense when scheduling before register allocation is on, i.e. with-fschedule-insnsor at-O2or higher. the name literally warns you bestie, it's giving dangerous ๐-fsched-stalled-insnsโ-fsched-stalled-insns=nโ defines how many insns (if any) can be moved prematurely out of the queue of stalled insns and into the ready list, during the second scheduling pass.-fno-sched-stalled-insnsmeans no insns get moved prematurely.-fsched-stalled-insns=0means there is no limit on how many queued insns can be moved prematurely. And-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. โ ๏ธ This option is experimental, because not all machine descriptions used by GCC model the CPU closely enough to avoid unreliable results from the algorithm.
Also, this only makes sense when scheduling after register allocation, i.e. with -fschedule-insns2 or at -O2 or higher.
-fsched-group-heuristicโ enables the group heuristic in the scheduler, which favors the instruction that belongs to a schedule group. Enabled by default when scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher. ๐-fsched-critical-path-heuristicโ enables the critical-path heuristic in the scheduler, which favors instructions on the critical path. Enabled by default when scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher. โญ-fsched-spec-insn-heuristicโ enables the speculative instruction heuristic in the scheduler, which favors speculative instructions with greater dependency weakness. Enabled by default when scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher. ๐ฆ-fsched-rank-heuristicโ enables the rank heuristic in the scheduler, which favors the instruction belonging to a basic block with greater size or frequency. Enabled by default when scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher. ๐-fsched-last-insn-heuristicโ enables the last-instruction heuristic in the scheduler, which favors the instruction that is less dependent on the last instruction scheduled. Enabled by default when scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher. ๐-fsched-dep-count-heuristicโ enables the dependent-count heuristic in the scheduler, which favors the instruction that has more instructions depending on it. Enabled by default when scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher. ๐-freschedule-modulo-scheduled-loopsโ modulo scheduling happens before traditional scheduling. So if a loop is modulo scheduled, later scheduling passes might change its schedule. Use this option to control that behavior. ๐-fselective-schedulingโ schedule instructions using the selective scheduling algorithm. Selective scheduling runs instead of the first scheduler pass. ๐-fselective-scheduling2โ schedule instructions using the selective scheduling algorithm. Selective scheduling runs instead of the second scheduler pass. โจ-fsel-sched-pipeliningโ enables software pipelining of innermost loops during selective scheduling. Heads up: this option 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 option has no effect unless-fsel-sched-pipeliningis turned on. ๐ธ-fsemantic-interpositionโ okay so some object formats, like ELF, let the dynamic linker interpose symbols. That means for symbols exported from the DSO, the compiler can't do interprocedural propagation, inlining and other optimizations, because the function or variable in question might change. While this feature is useful โ like, for rewriting memory allocation functions with a debugging implementation โ it is expensive in terms of code quality. ๐ญ
With -fno-semantic-interposition the compiler assumes that if interposition happens for functions, the overwriting function will have precisely the same semantics (and side effects). Similarly, if interposition happens for variables, the constructor of the variable will be the same.
Also: this flag has no effect for functions explicitly declared inline (where it's never allowed for interposition to change semantics) and for symbols explicitly declared weak. ๐
-fshrink-wrapโ emit function prologues only before the parts of the function that actually need them, instead of at the top of the function. minimal effort, maximal slay. ๐
This flag is enabled by default at -O and higher.
-fshrink-wrap-separateโ shrink-wrap separate parts of the prologue and epilogue separately, so those parts are only executed when needed. This option is on by default, but it has no effect unless-fshrink-wrapis also turned on and the target supports it. ๐-fcaller-savesโ enables allocation of values to registers that get clobbered by function calls, by emitting extra instructions to save and restore the registers around those calls. Such 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. tidy. ๐ง
Enabled by default at -O1 and higher.
-fipa-raโ use caller save registers for allocation if those registers aren't used by any called function. In that case 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, however the option is disabled if the generated code will be instrumented for profiling (-p, or -pg) or if the callee's register usage can't be known exactly (this happens on targets that don't expose prologues and epilogues in RTL).
-fconserve-stackโ ok so this one tries to keep your stack usage smol ๐ซถ like the compiler will literally use less stack space even if it makes the program slower. It implies setting thelarge-stack-frameparameter to100and thelarge-stack-frame-growthparameter to400. trade-off queen behavior, no cap.-ftree-reassocโ performs reassociation on trees. enabled by default at-Oand higher โจ-fcode-hoistingโ performs code hoisting. so what that does is it 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 honestly it often helps for code speed too ๐ this flag is enabled by default at-O2and higher.-ftree-preโ performs partial redundancy elimination (PRE) on trees. this flag is enabled by default at-O2and-O3.-ftree-partial-preโ makes partial redundancy elimination (PRE) more aggressive ๐ค enabled by default at-O3.-ftree-forwpropโ performs forward propagation on trees. enabled by default at-Oand higher.-ftree-freโ performs full redundancy elimination (FRE) on trees. the difference between FRE and PRE? 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. enabled by default at-Oand higher.-ftree-phipropโ performs hoisting of loads from conditional pointers on trees. this pass is enabled by default at-Oand 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โ performs copy propagation on trees. this pass eliminates unnecessary copy operations, like bye bestie ๐ enabled by default at-Oand higher.-fipa-pure-constโ discovers which functions are pure or constant. enabled by default at-Oand higher.-fipa-referenceโ discovers which static variables do not escape the compilation unit. enabled by default at-Oand higher.-fipa-reference-addressableโ discovers read-only, write-only and non-addressable static variables. enabled by default at-Oand higher.-fipa-stack-alignmentโ reduces stack alignment on call sites if possible. enabled by default.-fipa-ptaโ performs interprocedural pointer analysis and interprocedural modification and reference analysis. โ ๏ธ heads up bestie, this option can cause excessive memory and compile-time usage on large compilation units. it is not enabled by default at any optimization level.-fipa-profileโ performs interprocedural profile propagation. functions called only from cold functions get marked as cold. also, functions executed once (likecold,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-Oand higher.-fipa-cpโ performs interprocedural constant propagation. this optimization analyzes the program to figure out when values passed to functions are constants and then optimizes accordingly. it can substantially increase performance if the application has constants passed to functions ๐ enabled by default at-O2,-Osand-O3. it's also enabled by-fprofile-useand-fauto-profile.-fipa-cp-cloneโ performs function cloning to make interprocedural constant propagation stronger. when enabled, interprocedural constant propagation performs function cloning when an externally visible function can be called with constant arguments. because this optimization can create multiple copies of functions, it may significantly increase code size (see--param ipcp-unit-growth=value). this flag is enabled by default at-O3. it's also enabled by-fprofile-useand-fauto-profile.-fipa-bit-cpโ when enabled, performs interprocedural bitwise constant propagation. enabled by default at-O2and by-fprofile-useand-fauto-profile. it requires that-fipa-cpis enabled.-fipa-vrpโ when enabled, performs interprocedural propagation of value ranges. enabled by default at-O2. it requires that-fipa-cpis enabled.-fipa-icfโ performs Identical Code Folding for functions and read-only variables. this optimization reduces code size and may disturb unwind stacks by replacing a function with an equivalent one that has a different name ๐ the optimization works more effectively with link-time optimization enabled.
ok so even though the behavior is similar to the Gold Linker's ICF optimization, GCC ICF works on different levels and thus the optimizations are not the same โ there are equivalences found only by GCC and equivalences found only by Gold. iykyk.
this flag is enabled by default at -O2 and -Os.
-flive-patching=levelโ controls GCC's optimizations to produce output suitable for live-patching.
here's the tea: if the compiler's optimization uses a function's body or information extracted from its body to optimize/change another function, that latter one 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 functions, IPA optimizations can be partially enabled at two different levels.
the level argument should be one of the following:
inline-cloneโ only enable inlining and cloning optimizations, which includes inlining, cloning, interprocedural scalar replacement of aggregates and partial inlining. as a result, when patching a function, all its callers and its clones' callers are impacted, therefore need to be patched as well.
-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
inline-only-staticโ only enable inlining of static functions. as a result, when patching a static function, all its callers are impacted and so need to be patched as well.
in addition to all the flags that -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. 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 and depends on-fdelete-null-pointer-checksalso being enabled.-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. 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โ performs forward store motion on trees. enabled by default at-Oand higher.-ftree-bit-ccpโ performs sparse conditional bit constant propagation on trees and propagates pointer alignment information. this pass only operates on local scalar variables and is enabled by default at-O1and higher, except for-Og. it requires that-ftree-ccpis enabled.-ftree-ccpโ performs sparse conditional constant propagation (CCP) on trees. this pass only operates on local scalar variables and is enabled by default at-Oand higher.-fssa-backpropโ propagates information about uses of a value up the definition chain in order to simplify the definitions. for example, this pass strips sign operations if the sign of a value never matters. enabled by default at-Oand higher.-fssa-phioptโ performs 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โ performs conversion of simple initializations in a switch to initializations from a scalar array. enabled by default at-O2and higher.-ftree-tail-mergeโ looks for identical code sequences. when found, it replaces one with a jump to the other. this optimization is known as tail merging or cross jumping ๐ฆ enabled by default at-O2and higher. the compilation time in this pass can be limited using themax-tail-merge-comparisonsparameter and themax-tail-merge-iterationsparameter.-ftree-dceโ performs dead code elimination (DCE) on trees. enabled by default at-Oand higher.-ftree-builtin-call-dceโ performs conditional dead code elimination (DCE) for calls to built-in functions that may seterrnobut are otherwise free of side effects. this flag is enabled by default at-O2and higher if-Osis not also specified.-ftree-dominator-optsโ bestie this one does a whole lil spa day of simple scalar cleanups: constant/copy propagation, redundancy elimination, range propagation and expression simplification, all based on a dominator tree traversal ๐ it also does jump threading (so jumps that just go to other jumps get tidied up, obsessed). enabled by default at-Oand higher โจ-ftree-dseโ dead store elimination (DSE) on trees ๐ง a dead store is when you store into a memory location and then later overwrite it with another store, with no loads in between. so the earlier store? literally can be deleted. enabled by default at-Oand higher ๐-ftree-chโ performs loop header copying on trees ๐ this is a win because it makes code motion optimizations more effective, and it also saves one jump. enabled by default at-Oand higher. but heads up โ it is not enabled for-Os, because it usually increases code size ๐ญ-ftree-loop-optimizeโ performs loop optimizations on trees. enabled by default at-Oand higher ๐ธ-ftree-loop-linear,-floop-strip-mine,-floop-blockโ performs 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. iykyk-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. the code generator isl also does some minimal optimizations, like index splitting and dead code elimination in loops ๐-floop-nest-optimizeโ enables the isl based loop nest optimizer ๐ฅ this is a generic loop nest optimizer based on the Pluto optimization algorithms. it calculates a loop structure optimized for data-locality and parallelism. lowkey important: this option is experimental ๐-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 โ and it does this without checking that it is profitable to parallelize the loops. periodt, it just goes for it ๐-ftree-coalesce-varsโ while transforming the program out of the SSA representation, this attempts to reduce copying by coalescing versions of different user-defined variables, instead of just compiler temporaries ๐ง but queen beware: 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 ๐ธ-ftree-loop-if-convertโ attempts to transform conditional jumps in the innermost loops to branch-less equivalents โจ the whole intent is to remove control-flow from the innermost loops so the vectorization pass can handle these loops better. enabled by default if vectorization is enabled ๐-ftree-loop-distributionโ performs loop distribution ๐ this can improve cache performance on big loop bodies and let further loop optimizations, like parallelization or vectorization, take place. for example, the 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-O3, 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 โจ this flag is enabled by default at -O3. it is also enabled by -fprofile-use and -fauto-profile ๐ธ
-floop-interchangeโ performs loop interchange outside of graphite ๐ฅ this can improve cache performance on loop nest and let further loop optimizations, like vectorization, take place. for example, the loop
for (int i = 0; i < N; i++)
for (int j = 0; j < N; j++)
for (int k = 0; k < N; k++)
c[i][j] = c[i][j] + a[i][k]*b[k][j];
is transformed to
for (int i = 0; i < N; i++)
for (int k = 0; k < N; k++)
for (int j = 0; j < N; j++)
c[i][j] = c[i][j] + a[i][k]*b[k][j];
this flag is enabled by default at -O3. it is also enabled by -fprofile-use and -fauto-profile ๐
-floop-unroll-and-jamโ applies unroll and jam transformations on feasible loops ๐ in a loop nest this unrolls the outer loop by some factor and fuses the resulting multiple inner loops. 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 for which determining 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, then uses of the final value get replaced by such a computation โ provided it is sufficiently cheap. this reduces data dependencies and may allow further simplifications. enabled by default at-Oand higher ๐-fivoptsโ performs induction variable optimizations (strength reduction, induction variable merging and induction variable elimination) on trees ๐ฅ- *
-ftree-parallelize-loops=n*** โ parallelize loops, i.e., split their iteration space to run in *n* threads ๐ this is only possible for loops whose iterations are independent and can be arbitrarily reordered. the optimization is only profitable on multiprocessor machines, for loops that are CPU-intensive, rather than constrained e.g. by memory bandwidth. this option implies-pthread, and thus is only supported on targets that have support for-pthread` ๐ -ftree-ptaโ performs function-local points-to analysis on trees. 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โ performs merging of narrow stores to consecutive memory addresses ๐ this pass merges contiguous stores of immediate values narrower than a word into fewer wider stores to reduce the number of instructions. enabled by default at-O2and higher as well as-Osโจ-ftree-terโ performs temporary expression replacement during the SSA->normal phase ๐ single use/single def temporaries are replaced at their use location with their defining expression. this results in non-GIMPLE code, but gives the expanders much more complex trees to work on, resulting in better RTL generation. enabled by default at-Oand 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-Oand 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 ๐ this flag is enabled by default at-O3and by-ftree-vectorize,-fprofile-use, and-fauto-profile๐-ftree-slp-vectorizeโ performs basic block vectorization on trees ๐ this flag is enabled by default at-O3and by-ftree-vectorize,-fprofile-use, and-fauto-profile๐- *
-fvect-cost-model=model*** โ alters the cost model used for vectorization ๐ง the *model* argument should be one ofunlimited,dynamicorcheap. with theunlimitedmodel the vectorized code-path is assumed to be profitable ๐ while with thedynamicmodel a runtime check guards the vectorized code-path so it's only enabled for iteration counts that will likely execute faster than when executing the original scalar loop. thecheapmodel 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 default cost model depends on other optimization flags and is eitherdynamicorcheap` ๐ - *
-fsimd-cost-model=model*** โ alters the cost model used for vectorization of loops marked with the OpenMP simd directive โจ the *model* argument should be one ofunlimited,dynamic,cheap. all values of *model* have the same meaning as described in-fvect-cost-model, and by default a cost model defined with-fvect-cost-model` is used ๐ฆ -ftree-vrpโ bestie this one does Value Range Propagation on trees โจ and it's giving "constant propagation but make it โจrangesโจ". So instead of yeeting actual values around, it yeets ranges of values. Why do we care?? Because now the optimizer can straight up delete unnecessary range checks โ think array bound checks and null pointer checks โ like they never happened ๐ . It's on by default at-O2and higher. One lil caveat tho: null pointer check elimination only happens if-fdelete-null-pointer-checksis also enabled. No cap.-fsplit-pathsโ splits paths that lead to loop backedges ๐ฆ. This can level up dead code elimination and common subexpression elimination. Enabled by default at-O3and above. Iconic.-fsplit-ivs-in-unrollerโ okay so this one enables expression of the values of induction variables in later iterations of the unrolled loop using the value from the first iteration ๐. It breaks those long dependency chains, which makes the scheduling passes way more efficient. Periodt.
A combo of -fweb and CSE is often enough to get the same effect โ however, that's not reliable when the loop body is more complicated than a single basic block. Also it literally does not work at all on some architectures because of restrictions in the CSE pass ๐ญ. This optimization is enabled by default.
-fvariable-expansion-in-unrollerโ with this option the compiler makes multiple copies of some local variables when it unrolls a loop, which can result in superior code ๐ฅ.-fpartial-inliningโ inline parts of functions ๐ซถ. Heads up tho: this has any effect only when inlining itself is turned on by-finline-functionsor-finline-small-functions. Enabled at levels-O2,-O3,-Os.-fpredictive-commoningโ performs the predictive commoning optimization, i.e. reusing computations (especially memory loads and stores) that were performed in previous iterations of loops โป๏ธ. Enabled at level-O3. It's also enabled by-fprofile-useand-fauto-profile.-fprefetch-loop-arraysโ if the target machine supports it, this generates instructions to prefetch memory so loops that access large arrays go brrr ๐โโ๏ธ. Real talk tho: this option may generate better or worse code โ results are highly dependent on the structure of the loops inside your source. Disabled at level-Os.-fno-printf-return-valueโ do NOT substitute constants for the known return value of formatted output functions likesprintf,snprintf,vsprintf, andvsnprintf(but notprintforfprintf, note the distinction bestie ๐ ). This transformation is what lets GCC optimize or even fully eliminate branches based on the known return value of these functions when they're called with arguments that are either constant, or whose values are known to be in a range that makes determining the exact return value possible. For example, when-fprintf-return-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. And -fprintf-return-value is enabled by default ๐.
-fno-peephole-fno-peephole2โ these disable any machine-specific peephole optimizations ๐. The difference between-fno-peepholeand-fno-peephole2is in how they're implemented in the compiler; some targets use one, some use the other, and a few use both.-fpeepholeis enabled by default.-fpeephole2is enabled at levels-O2,-O3,-Os.-fno-guess-branch-probabilityโ do not guess branch probabilities using heuristics ๐ซ. Here's the tea: GCC uses heuristics to guess branch probabilities if they weren't 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_expectinfo into account. The interactions between the heuristics and__builtin_expectcan be complex, and in some cases it may be useful to disable the heuristics so the effects of__builtin_expectare easier to understand ๐ง .
It's also possible to specify the expected probability of the expression with the __builtin_expect_with_probability built-in function.
The default is -fguess-branch-probability at levels -O, -O2, -O3, -Os.
-freorder-blocksโ reorders basic blocks in the compiled function so there are fewer taken branches and better code locality ๐. Enabled at levels-O,-O2,-O3,-Os.-freorder-blocks-algorithm=algorithmโ use the specified algorithm for basic block reordering. 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 -O, -Os, and stc at levels -O2, -O3.
-freorder-blocks-and-partitionโ on top of reordering basic blocks in the compiled function (to reduce the number of taken branches), this partitions hot and cold basic blocks into separate sections of the assembly and.ofiles, to improve paging and cache locality performance ๐ .
Important caveat: this optimization is automatically turned off in the presence of exception handling or unwind tables (on targets using setjump/longjump or a target specific scheme), for linkonce sections, for functions with a user-defined section attribute, and on any architecture that does not support named sections. When -fsplit-stack is used, this option is not enabled by default (to avoid linker errors), but it may be enabled explicitly (if you're using a working linker) ๐ซถ.
Enabled for x86 at levels -O2, -O3, -Os.
-freorder-functionsโ reorders functions in the object file to improve code locality โจ. This is implemented using special subsections.text.hotfor the most frequently executed functions and.text.unlikelyfor the unlikely-executed ones. The reordering is done by the linker, so the object file format must support named sections and the linker must place them in a reasonable way.
This option isn't effective unless you either provide profile feedback (see -fprofile-arcs for the details) or manually annotate functions with hot or cold attributes ๐. Enabled at levels -O2, -O3, -Os.
-fstrict-aliasingโ lets the compiler assume the strictest aliasing rules that apply to the language being compiled ๐ . For C (and C++), this activates optimizations based on the type of expressions. In particular, an object of one type is assumed to never reside at the same address as an object of a different type โ unless the types are almost the same. For example, anunsigned intcan alias anint, but not avoid*or adouble. A character type may alias any other type.
Pay special attention to code like this:
union a_union {
int i;
double d;
};
int f() {
union a_union t;
t.d = 3.0;
return t.i;
}
The practice of reading from a different union member than the one most recently written to (this is called "type-punning") is common, and even with -fstrict-aliasing, type-punning is allowed provided the memory is accessed through the union type. So, the code above works as expected ๐. However, this code might not:
int f() {
union a_union t;
int* ip;
t.d = 3.0;
ip = &t.i;
return *ip;
}
Similarly, access by taking the address, casting the resulting pointer and dereferencing the result has undefined behavior, even if the cast uses a union type, e.g.:
int f() {
double d = 3.0;
return ((union a_union *) &d)->i;
}
The -fstrict-aliasing option is enabled at levels -O2, -O3, -Os. ๐
-falign-functions-falign-functions=n-falign-functions=n:m-falign-functions=n:m:n2-falign-functions=n:m:n2:m2โ align the start of functions to the next power-of-two greater than n, skipping up to m-1 bytes ๐ธ. This ensures that at least the first m bytes of the function can be fetched by the CPU without crossing an n-byte alignment boundary.
If m is not specified, it defaults to n.
Examples bestie, so you get it: -falign-functions=32 aligns functions to the next 32-byte boundary, -falign-functions=24 aligns to the next 32-byte boundary only if this can be done by skipping 23 bytes or less, and -falign-functions=32:7 aligns to the next 32-byte boundary only if this can be done by skipping 6 bytes or less.
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 this can be done by skipping 6 bytes or less, otherwise it aligns to the next 32-byte boundary if this can be done by skipping 2 bytes or less. If m2 is not specified, it defaults to n2.
Some assemblers only support this flag when n is a power of two; in that case, it's rounded up ๐.
-fno-align-functions and -falign-functions=1 are equivalent and mean that functions are not aligned.
If n is not specified or is zero, use a machine-dependent default. The maximum allowed n option value is 65536.
Enabled at levels -O2, -O3.
-flimit-function-alignmentโ if this is enabled, the compiler tries to avoid unnecessarily overaligning functions ๐ซถ. It attempts to instruct the assembler to align by the amount specified by-falign-functions, but not to skip more bytes than the size of the function.-falign-labels-falign-labels=n-falign-labels=n:m-falign-labels=n:m:n2-falign-labels=n:m:n2:m2โ align all branch targets to a power-of-two boundary โจ. The parameters of this option are analogous to the-falign-functionsoption.-fno-align-labelsand-falign-labels=1are equivalent and mean that labels are not aligned.
If -falign-loops or -falign-jumps are applicable and are greater than this value, then their values are used instead. (the alignment options lowkey negotiate with each other, bestie โ whoever's bigger wins โจ)
If n is not specified or is zero, use a machine-dependent default which is very likely to be 1, meaning no alignment. The maximum allowed n option value is 65536. (yes, that's a hard cap, don't fight it)
Enabled at levels -O2, -O3.
-falign-loops,-falign-loops=n,-falign-loops=n:m,-falign-loops=n:m:n2,-falign-loops=n:m:n2:m2โ align loops to a power-of-two boundary. If the loops are executed many times, this makes up for any execution of the dummy padding instructions. ๐
Parameters of this option are analogous to the -falign-functions option. -fno-align-loops and -falign-loops=1 are equivalent and mean that loops are not aligned. The maximum allowed n option value is 65536.
If n is not specified or is zero, use a machine-dependent default.
Enabled at levels -O2, -O3.
-falign-jumps,-falign-jumps=n,-falign-jumps=n:m,-falign-jumps=n:m:n2,-falign-jumps=n:m:n2:m2โ align branch targets to a power-of-two boundary, for branch targets where the targets can only be reached by jumping. In this case, no dummy operations need be executed. ๐ฆ
Parameters of this option are analogous to the -falign-functions option. -fno-align-jumps and -falign-jumps=1 are equivalent and mean that loops are not aligned.
If n is not specified or is zero, use a machine-dependent default. The maximum allowed n option value is 65536.
Enabled at levels -O2, -O3.
-funit-at-a-timeโ okay so this one is literally just vibing here for compatibility reasons.-funit-at-a-timehas no effect, while-fno-unit-at-a-timeimplies-fno-toplevel-reorderand-fno-section-anchors.
Enabled by default. (it's giving "I'm here but I do nothing" ๐ญ)
-fno-toplevel-reorderโ do not reorder top-level functions, variables, andasmstatements. Output them in the same order that they appear in the input file. When this option is used, unreferenced static variables are not removed. This option is intended to support existing code that relies on a particular ordering. For new code, it is better to use attributes when possible. ๐ธ
-ftoplevel-reorder is the default at -O1 and higher, and also at -O0 if -fsection-anchors is explicitly requested. Additionally -fno-toplevel-reorder implies -fno-section-anchors.
-fwebโ constructs webs as commonly used for register allocation purposes and assign each web individual pseudo register. This allows the register allocation pass to operate on pseudos directly, but also strengthens several other optimization passes, such as CSE, loop optimizer and trivial dead code remover. It can, however, make debugging impossible, since variables no longer stay in a "home register". ๐
Enabled by default with -funroll-loops.
-fwhole-programโ assume that the current compilation unit represents the whole program being compiled. All public functions and variables with the exception ofmainand those merged by attributeexternally_visiblebecome static functions and in effect are optimized more aggressively by interprocedural optimizers. ๐
This option should not be used in combination with -flto. Instead relying on a linker plugin should provide safer and more precise information. (fr fr, don't do it)
-flto[=n]โ this option runs the standard link-time optimizer. big main character energy โจ When invoked with source code, it generates GIMPLE (one of GCC's internal representations) and writes it to special ELF sections in the object file. When the object files are linked together, all the function bodies are read from these ELF sections and instantiated as if they had been part of the same translation unit.
To use the link-time optimizer, -flto and optimization options should be specified at compile time and during the final link. It is recommended that you compile all the files participating in the same link with the same options and also specify those options at link time. For example:
gcc -c -O2 -flto foo.c
gcc -c -O2 -flto bar.c
gcc -o myprog -flto -O2 foo.o bar.o
The first two invocations to GCC save a bytecode representation of GIMPLE into special ELF sections inside foo.o and bar.o. The final invocation reads the GIMPLE bytecode from foo.o and bar.o, merges the two files into a single internal image, and compiles the result as usual. Since both foo.o and bar.o are merged into a single image, this causes all the interprocedural analyses and optimizations in GCC to work across the two files as if they were a single one. This means, for example, that the inliner is able to inline functions in bar.o into functions in foo.o and vice-versa. (obsessed, honestly โ they're literally sharing a brain now ๐ง ๐)
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. (so it auto-detects, but you can say "not today" ๐
)
To make whole program optimization effective, it is necessary to make certain whole program assumptions. The compiler needs to know what functions and variables can be accessed by libraries and runtime outside of the link-time optimized unit. When supported by the linker, the linker plugin (see -fuse-linker-plugin) passes information to the compiler about used and externally visible symbols. When the linker plugin is not available, -fwhole-program should be used to allow the compiler to make these assumptions, which leads to more aggressive optimization decisions.
When a file is compiled with -flto without -fuse-linker-plugin, the generated object file is larger than a regular object file because it contains GIMPLE bytecodes and the usual final code (see -ffat-lto-objects. This means that object files with LTO information can be linked as normal object files; if -fno-lto is passed to the linker, no interprocedural optimizations are applied. Note that when -fno-fat-lto-objects is enabled the compile stage is faster but you cannot perform a regular, non-LTO link on them. (faster compile, but no take-backsies on the linking ๐ฌ)
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. (mix & match, we love a flexible queen ๐)
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. (tl;dr: set your -O at compile time too, bestie, don't be lazy ๐)
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: -fPIC, -fpic, -fpie, -fcommon, -fexceptions, -fnon-call-exceptions, -fgnu-tm and all the -m target flags.
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. (nope, these gotta agree, no negotiation ๐)
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.
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. (just be consistent, okay? consistency is the vibe check here โจ)
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 explicitely repeated at the linker command line and mixing different settings in different translation units is discouraged. (mixing = messy = not cute)
If LTO encounters objects with C linkage declared with incompatible types in separate translation units to be linked together (undefined behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be issued. The behavior is still undefined at run time. Similar diagnostics may be raised for other languages. ๐ญ
Another feature of LTO is that it is possible to apply interprocedural optimizations on files written in different languages:
gcc -c -flto foo.c
g++ -c -flto bar.cc
gfortran -c -flto baz.f90
g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
Notice that the final link is done with g++ to get the C++ runtime libraries and -lgfortran is added to get the Fortran runtime libraries. In general, when mixing languages in LTO mode, you should use the same link command options as when mixing languages in a regular (non-LTO) compilation. ๐ (multilingual icon behavior, we stan ๐ซถ)
Okay so if you've got object files with GIMPLE bytecode chillin' inside a library archive โ like, say libfoo.a โ you can pull them out and use them in an LTO link, but only if your linker has plugin support, bestie. ๐
To make static libraries that are LTO-ready, use gcc-ar and gcc-ranlib instead of plain ar and ranlib. And if you wanna peek at the symbols inside object files that have GIMPLE bytecode? That's gcc-nm's whole job. โจ
Heads up though โ those commands needar,ranlibandnmto have been compiled with plugin support. No plugin support, no party. ๐
At link time, throw in the flag -fuse-linker-plugin so your library actually participates in the LTO optimization process:
gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
With the linker plugin on, the linker yoinks the GIMPLE files it needs out of libfoo.a and hands them over to the running GCC so they become part of the aggregated GIMPLE image that gets optimized. ๐ซถ
But listen โ if you're not using a linker with plugin support, and/or you don't enable the linker plugin, then the objects inside libfoo.a get extracted and linked like normal. They just... don't get to be part of the LTO optimization process. ๐ญ Fomo for your object files, honestly.
So if you want a static library that works for both LTO optimization and usual linkage, compile its object files with -flto -ffat-lto-objects. Both worlds, no cap. ๐
Link-time optimizations don't need your whole program present to do their thing. If your program doesn't require any symbols to be exported, you can combine -flto and -fwhole-program so the interprocedural optimizers get to use more aggressive assumptions โ which may lead to improved optimization opportunities. ๐ฅ
But note: you don't need-fwhole-programwhen the linker plugin is active (see-fuse-linker-plugin). It's already doing the thing.
The current implementation of LTO makes no attempt to generate bytecode that's portable between different types of hosts. The bytecode files are versioned and there's a strict version check, so bytecode files generated in one version of GCC do not work with an older or newer version of GCC. Periodt. It's giving exclusive. ๐
Also, link-time optimization does not work well with generation of debugging information on systems other than those using a combination of ELF and DWARF. Sorry to those systems. ๐ธ
If you specify the optional n, the optimization and code generation done at link time runs in parallel using n parallel jobs, by utilizing an installed make program. And the environment variable MAKE can be used to override which program gets used. ๐ง
You can also specify -flto=jobserver to use GNU make's job server mode to figure out 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. And this option likely only works ifMAKEis GNU make. iykyk.
Use -flto=auto to use GNU make's job server if it's available, or otherwise fall back to autodetecting the number of CPU threads present in your system. Auto-pilot energy. ๐
-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. 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-odr-type-mergingโ Enable streaming of mangled types names of C++ types and their unification at link time. This increases the size of LTO object files, but enables diagnostics about One Definition Rule violations. Bigger files, better receipts. ๐-flto-compression-level=nโ This option specifies the level of compression used for intermediate language written to LTO object files, and it's only meaningful in conjunction with LTO mode (-flto). Valid values are0(no compression) to9(maximum compression). Values outside this range are clamped to either0or9. If the option isn't given, a default balanced compression setting is used. โจ-fuse-linker-pluginโ Enables the use of a linker plugin during link-time optimization. This option relies on plugin support in the linker, which is available ingoldor in GNU ld 2.21 or newer.
This option enables the extraction of object files with GIMPLE bytecode out of library archives. This improves the quality of optimization by exposing more code to the link-time optimizer. This information specifies what symbols can be accessed externally (by non-LTO object or during dynamic linking). Resulting code quality improvements on binaries (and shared libraries that use hidden visibility) are similar to -fwhole-program. See -flto for a description of the effect of this flag and how to use it. ๐
This option is enabled by default when LTO support in GCC is enabled and GCC was configured for use with a linker supporting plugins (GNU ld 2.21 or newer, or gold). Default-on, as a treat. ๐
-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-objects improves compilation time over plain LTO, but requires the complete toolchain to be aware of LTO. It requires a linker with linker plugin support for basic functionality. Additionally, nm, ar and ranlib need to support linker plugins to allow a full-featured build environment (capable of building static libraries etc). GCC provides the gcc-ar, gcc-nm, gcc-ranlib wrappers to pass the right options to these tools. With non fat LTO, makefiles need to be modified to use them. ๐ค
Note that modern binutils provide a plugin auto-load mechanism. Installing the linker plugin into $libdir/bfd-plugins has the same effect as usage of the command wrappers (gcc-ar, gcc-nm and gcc-ranlib). ๐ช
The default is -fno-fat-lto-objects on targets with linker plugin support.
-fcompare-elimโ 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. Sneaky efficient. ๐
This pass only applies to certain targets that cannot explicitly represent the comparison operation before register allocation is complete.
Enabled at levels -O, -O2, -O3, -Os.
-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 -O, -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-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. No profile, no feedback. โจ
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
path is the name of a file containing AutoFDO profile information. If omitted, it defaults to fbdata.afdo in the current directory. ๐
Producing an AutoFDO profile data file requires running your program with the perf utility on a supported GNU/Linux target system. For more information, see <https://perf.wiki.kernel.org/>.
E.g.
perf record -e br_inst_retired:near_taken -b -o perf.data \
-- your_program
Then use the create_gcov tool to convert the raw profile data to a format that can be used by GCC. You must also 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
New vibe checkpoint, besties! ๐ The following options control compiler behavior regarding floating-point arithmetic. These options trade off between speed and correctness. And every single one of them must be specifically enabled โ nothing here is coming along for the ride on its own. ๐ฆ
-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. ๐
(still riding with -ffloat-store btw, we didn't forget her ๐
) this one blocks that undesirable excess precision on machines like the 68000, where the floating registers (the 68881 ones, iconic) keep more precision than a double is supposed to have. same situation on x86. for most programs that extra precision is doing nothing but good, but a few lil programs are out here relying on the precise definition of IEEE floating point. so for those, use -ffloat-store โ after you've modified them to store all pertinent intermediate computations into variables. ๐
-fexcess-precision=styleโ this one gives you further control over excess precision on machines where floating-point operations happen in a format with more precision or range than the IEEE standard and interchange floating-point types. by default,-fexcess-precision=fastis in effect; that 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, if-fexcess-precision=standardis specified then excess precision follows the rules specified in ISO C99; in particular, both casts and assignments cause values to be rounded to their semantic types (whereas-ffloat-storeonly affects assignments). this option is enabled by default for C if a strict conformance option such as-std=c99is used.-ffast-mathenables-fexcess-precision=fastby default regardless of whether a strict conformance option is used.
heads up bestie:-fexcess-precision=standardis not implemented for languages other than C. on the x86, it has no effect if-mfpmath=sseor-mfpmath=sse+387is specified; in the former case, IEEE semantics apply without excess precision, and in the latter, rounding is unpredictable. ๐ญ
-ffast-mathโ sets the options-fno-math-errno,-funsafe-math-optimizations,-ffinite-math-only,-fno-rounding-math,-fno-signaling-nans,-fcx-limited-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, 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, 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, since it can result in incorrect output for programs that depend on an exact implementation of IEEE or ISO rules/specifications for math functions. it may, however, yield faster code for programs that do not require the guarantees of these specifications.
the default is -fno-finite-math-only.
-fno-signed-zerosโ allow optimizations for floating-point arithmetic that ignore the signedness of zero. IEEE arithmetic specifies the behavior of distinct +0.0 and -0.0 values, which then prohibits simplification of expressions such as x+0.0 or 0.0*x (even with-ffinite-math-only). this option implies that the sign of a zero result isn't significant. ๐ซถ
the default is -fsigned-zeros.
-fno-trapping-mathโ compile code assuming that floating-point operations cannot generate user-visible traps. these traps include division by zero, overflow, underflow, inexact result and invalid operation. this option requires that-fno-signaling-nansbe in effect. setting this option may allow faster code if one relies on "non-stop" IEEE arithmetic, for example. ๐ชค
this option should never be turned on by any -O option, since it can result in incorrect output for programs that depend on an exact implementation of IEEE or ISO rules/specifications for math functions.
the default is -ftrapping-math.
-frounding-mathโ disable transformations and optimizations that assume default floating-point rounding behavior. this is round-to-zero for all floating point to integer conversions, and round-to-nearest for all other arithmetic truncations. 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'sFENV_ACCESSpragma. this command-line option will be used to specify the default state forFENV_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.
-fno-fp-int-builtin-inexactโ do not 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, does not allow these functions to do so. ๐
the default is -ffp-int-builtin-inexact, allowing the exception to be raised. this option does nothing unless -ftrapping-math is in effect.
even if -fno-fp-int-builtin-inexact is used, if the functions generate a call to a library function then the inexact exception may be raised if the library implementation does not follow TS 18661. ๐ญ
-fsingle-precision-constantโ treat floating-point constants as single precision instead of implicitly converting them to double-precision constants. ๐ฏ-fcx-limited-rangeโ when enabled, this option states that a range reduction step is not needed when performing complex division. also, there is no checking whether the result of a complex multiplication or division isNaN + I*NaN, with an attempt to rescue the situation in that case. the default is-fno-cx-limited-range, but is enabled by-ffast-math. ๐
this option controls the default setting of the ISO C99 CX_LIMITED_RANGE pragma. nevertheless, the option applies to all languages.
-fcx-fortran-rulesโ complex multiplication and division follow Fortran rules. range reduction is done as part of complex division, but there is no checking whether the result of a complex multiplication or division isNaN + I*NaN, with an attempt to rescue the situation in that case. ๐ง
the default is -fno-cx-fortran-rules.
okay so the following options control optimizations that may improve performance, but are not enabled by any -O options. this section includes experimental options that may produce broken code. ๐ you've been warned, bestie.
-fbranch-probabilitiesโ okay so bestie, here's the tea โ: after you've run a program you compiled with-fprofile-arcs, you can compile it a second time using-fbranch-probabilities, and it'll level up the optimizations based on how many times each branch actually got taken. When a program compiled with-fprofile-arcsexits, it saves arc execution counts to a file calledsourcename.gcdafor each source file. Important though: the info in that data file is super dependent on the structure of the generated code, so you must use the same source code and the same optimization options for both compilations. No switching up your fit between takes ๐
With -fbranch-probabilities, GCC puts a REG_BR_PROB note on each JUMP_INSN and CALL_INSN. These can be used to improve optimization. Currently, they are only used in one place: in reorg.c, 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. fr fr, no more guessing games ๐ฏ
Enabled by -fprofile-use and -fauto-profile.
-fprofile-valuesโ if you pair this with-fprofile-arcs, it adds code so that some data about values of expressions in the program is gathered. โจ
With -fbranch-probabilities, it reads back the data gathered from profiling values of expressions for usage in optimizations.
Enabled by -fprofile-generate, -fprofile-use, and -fauto-profile.
-fprofile-reorder-functionsโ function reordering based on profile instrumentation collects first time of execution of a function and orders these functions in ascending order. it's giving organized ๐๏ธ
Enabled with -fprofile-use.
-fvptโ if combined with-fprofile-arcs, this option tells the compiler to add code to gather information about values of expressions.
With -fbranch-probabilities, it reads back the data gathered and actually performs the optimizations based on them. Currently the optimizations include specialization of division operations using 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 making use of registers left over after register allocation. This optimization most benefits processors with lots of registers. But heads up: depending on the debug information format adopted by the target, it can make debugging impossible, since variables no longer stay in a "home register". ๐ญ
Enabled by default with -funroll-loops.
-fschedule-fusionโ performs a target dependent pass over the instruction stream to schedule instructions of same type together because target machine can execute them more efficiently if they are adjacent to each other in the instruction flow. matching outfits, but for instructions ๐ฏ
Enabled at levels -O2, -O3, -Os.
-ftracerโ perform tail duplication to enlarge superblock size. This transformation simplifies the control flow of the function allowing other optimizations to do a better job. main character optimization energy tbh ๐
Enabled by -fprofile-use and -fauto-profile.
-funroll-loopsโ unroll loops whose number of iterations can be determined at compile time or upon entry to the loop.-funroll-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. the duality of compiler flags ๐
Enabled by -fprofile-use and -fauto-profile.
-funroll-all-loopsโ unroll all loops, even if their number of iterations is uncertain when the loop is entered. This usually makes programs run more slowly. ๐ฌ-funroll-all-loopsimplies the same options as-funroll-loops.-fpeel-loopsโ peels loops for which there is enough information that they do not roll much (from profile feedback or static analysis). It also turns on complete loop peeling (i.e. complete removal of loops with small constant number of iterations). ๐
Enabled by -O3, -fprofile-use, and -fauto-profile.
-fmove-loop-invariantsโ enables the loop invariant motion pass in the RTL loop optimizer. Enabled at level-O1and higher, except for-Og.-fsplit-loopsโ split a loop into two if it contains a condition that's always true for one side of the iteration space and false for the other. it's giving divide and conquer โ๏ธ
Enabled by -fprofile-use and -fauto-profile.
-funswitch-loopsโ move branches with loop invariant conditions out of the loop, with duplicates of the loop on both branches (modified according to result of the condition).
Enabled by -fprofile-use and -fauto-profile.
-fversion-loops-for-stridesโ if a loop iterates over an array with a variable stride, create another version of the loop that assumes the stride is always one. For example:
for (int i = 0; i < n; ++i)
x[i * stride] = ...;
becomes:
if (stride == 1)
for (int i = 0; i < n; ++i)
x[i] = ...;
else
for (int i = 0; i < n; ++i)
x[i * stride] = ...;
This is particularly useful for assumed-shape arrays in Fortran where (for example) it allows better vectorization assuming contiguous accesses. This flag is enabled by default at -O3. It is also enabled by -fprofile-use and -fauto-profile.
-ffunction-sections-fdata-sectionsโ place each function or data item into its own section in the output file if the target supports arbitrary sections. The name of the function or the name of the data item determines the section's name in the output file. everyone gets their own little room ๐
Use these options on systems where the linker can perform optimizations to improve locality of reference in the instruction space. Most systems using the ELF object format have linkers with such optimizations. On AIX, the linker rearranges sections (CSECTs) based on the call graph. The performance impact varies.
Together with a linker garbage collection (linker --gc-sections option) these options may lead to smaller statically-linked executables (after stripping).
On ELF/DWARF systems these options do not degenerate the quality of the debug information. There could be issues with other object files/debug info formats.
Only use these options when there are significant benefits from doing so. When you specify these options, the assembler and linker create larger object and executable files and are also slower. These options affect code generation. They prevent optimizations by the compiler and assembler using relative locations inside a translation unit since the locations are unknown until link time. An example of such an optimization is relaxing calls to short call instructions. so like, know what you're doing bestie ๐
-fbranch-target-load-optimizeโ perform branch target register load optimization before prologue / epilogue threading. The use of target registers can typically be exposed only during reload, thus hoisting loads out of loops and doing inter-block scheduling needs a separate optimization pass.-fbranch-target-load-optimize2โ perform branch target register load optimization after prologue / epilogue threading. (yes bestie, order matters ๐ )-fbtr-bb-exclusiveโ when performing branch target register load optimization, don't reuse branch target registers within any basic block.-fstdarg-optโ optimize the prologue of variadic argument functions with respect to usage of those arguments.
NOTE: In Ubuntu 14.10 and later versions,-fstack-protector-strongis enabled by default for C, C++, ObjC, ObjC++, if none of-fno-stack-protector,-nostdlib, nor-ffreestandingare found.
-fsection-anchorsโ try to reduce the number of symbolic address calculations by using shared "anchor" symbols to address nearby objects. This transformation can help to reduce the number of GOT entries and GOT accesses on some targets. โ
For example, the implementation of the following function 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. ๐ซถ
--param name=valueโ in some places, GCC uses various constants to control the amount of optimization that is done. For example, GCC does not inline functions that contain more than a certain number of instructions. You can control some of these constants on the command line using the--paramoption.
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. โ ๏ธ so like, don't get too attached
In order to get minimal, maximal and default value of a parameter, one can use --help=param -Q options.
In each case, the value is an integer. The allowable choices for name are:
predictable-branch-outcomeโ when branch is predicted to be taken with probability lower than this threshold (in percent), then it is considered well predictable.max-rtl-if-conversion-insnsโ RTL if-conversion tries to remove conditional branches around a block and replace them with conditionally executed instructions. This parameter gives the maximum number of instructions in a block which should be considered for if-conversion. The compiler will also use other heuristics to decide whether if-conversion is likely to be profitable.max-rtl-if-conversion-predictable-costmax-rtl-if-conversion-unpredictable-costโ RTL if-conversion will try to remove conditional branches around a block and replace them with conditionally executed instructions. These parameters give the maximum permissible cost for the sequence that would be generated by if-conversion depending on whether the branch is statically determined to be predictable or not. The units for this parameter are the same as those for the GCC internalseq_costmetric. The compiler will try to provide a reasonable default for this parameter using theBRANCH_COSTtarget macro.
max-crossjump-edgesโ the max number of incoming edges we even bother looking at for cross-jumping โจ. The algorithm behind-fcrossjumpingis O(N^2) in the number of edges coming into each block, so yeah โ crank this up and you get more aggressive optimization, but compilation time goes up too, and the payoff in executable size is probably tiny. iykyk.min-crossjump-insnsโ the minimum number of instructions that have to match at the end of two blocks before we cross-jump them ๐ . Fun lil exception: this value is ignored when all instructions in the block being cross-jumped from are matched.max-grow-copy-bb-insnsโ the max code-size expansion factor when we copy basic blocks instead of jumping ๐ซถ. That expansion is measured relative to a jump instruction.max-goto-duplication-insnsโ the max number of instructions to duplicate into a block that jumps to a computed goto ๐. So here's the tea: to dodge O(N^2) behavior in a bunch of passes, GCC factors computed gotos early in the compilation process and unfactors them as late as possible. Only computed jumps sitting at the end of a basic block with no more thanmax-goto-duplication-insnsget unfactored.max-delay-slot-insn-searchโ the max number of instructions to look at when hunting for an instruction to fill a delay slot ๐ธ. If we've searched past this arbitrary number, the time savings from filling the delay slot are minimal, so we stop searching, periodt. Bigger values = more aggressive optimization, more compile time, and probably just a tiny improvement in execution time.max-delay-slot-live-searchโ when trying to fill delay slots, this is the max number of instructions to consider while searching for a block with valid live register information ๐ฆ. Increasing this (arbitrarily chosen!) value means more aggressive optimization and more compilation time. Also, straight from the source: this parameter should be removed when the delay slot code is rewritten to maintain the control-flow graph. not me reading dev notes ๐.max-gcse-memoryโ the approximate max amount of memory we're allowed to allocate for the global common subexpression elimination optimization ๐. If it needs more memory than specified, the optimization just... doesn't happen. sorry bestie.max-gcse-insertion-ratioโ if the ratio of expression insertions to deletions is larger than this value for any expression, then RTL PRE inserts or removes the expression and thus leaves partially redundant computations in the instruction stream โจ.max-pending-list-lengthโ the max number of pending dependencies scheduling allows before it flushes the current state and starts over ๐ฅ. Large functions with few branches or calls can create excessively large lists, which needlessly eat memory and resources. lowkey wasteful fr.max-modulo-backtrack-attemptsโ the max number of backtrack attempts the scheduler should make when modulo scheduling a loop ๐ . Larger values can exponentially increase compilation time. be so serious.max-inline-insns-singleโ okay so several parameters control the tree inliner in GCC ๐. This number sets the max number of instructions (counted in GCC's internal representation) in a single function that the tree inliner will consider for inlining. It only affects functions declared inline and methods implemented in a class declaration (C++).max-inline-insns-autoโ when you use-finline-functions(included in-O3), a whole lot of functions that would otherwise never be considered for inlining get investigated ๐. For those functions, a different (and more restrictive) limit compared to functions declared inline can be applied.max-inline-insns-smallโ this is the bound applied to calls that are considered relevant with-finline-small-functions๐.max-inline-insns-sizeโ this is the bound applied to calls that are optimized for size ๐ธ. A little growth can be desirable to anticipate optimization opportunities exposed by inlining.uninlined-function-insnsโ number of instructions the inliner accounts for function overhead, like the function prologue and epilogue ๐ซถ.uninlined-function-timeโ extra time the inliner accounts for function overhead, like the time needed to execute the function prologue and epilogue ๐.uninlined-thunk-insns,uninlined-thunk-timeโ same as--param uninlined-function-insnsand--param uninlined-function-time, but applied to function thunks โจ.inline-min-speedupโ when the estimated performance improvement of caller + callee runtime exceeds this threshold (in percent), the function can be inlined regardless of the limit on--param max-inline-insns-singleand--param max-inline-insns-auto๐.large-function-insnsโ the limit that specifies really large functions ๐. For functions larger than this limit after inlining, inlining is constrained by--param large-function-growth. This parameter is useful primarily to avoid extreme compilation time caused by the non-linear algorithms used by the back end. it's giving damage control.large-function-growthโ specifies the maximal growth of a large function caused by inlining, in percents ๐ฅ. For example, parameter value100limits large function growth to 2.0 times the original size.large-unit-insnsโ the limit specifying a large translation unit ๐. Growth caused by inlining of units larger than this limit is limited by--param inline-unit-growth. For small units this might be too tight. For example, consider a unit consisting of function A that is inline and B that just calls A three times. If B is small relative to A, the growth of the unit is 300% and yet such inlining is very sane ๐ . For very large units consisting of small inlineable functions, however, the overall unit growth limit is needed to avoid exponential explosion of code size. Thus for smaller units, the size is increased to--param large-unit-insnsbefore applying--param inline-unit-growth.inline-unit-growthโ specifies the maximal overall growth of the compilation unit caused by inlining ๐ฆ. For example, parameter value20limits unit growth to 1.2 times the original size. Cold functions (either marked cold via an attribute or by profile feedback) are not accounted into the unit size. we love an exemption.ipcp-unit-growthโ specifies the maximal overall growth of the compilation unit caused by interprocedural constant propagation ๐. For example, parameter value10limits unit growth to 1.1 times the original size.large-stack-frameโ the limit specifying large stack frames ๐ธ. While inlining, the algorithm is trying not to grow past this limit too much.large-stack-frame-growthโ specifies the maximal growth of large stack frames caused by inlining, in percents โญ. For example, parameter value1000limits large stack frame growth to 11 times the original size. iconic numbers honestly.max-inline-insns-recursive,max-inline-insns-recursive-autoโ specifies the max number of instructions an out-of-line copy of a self-recursive inline function can grow into by performing recursive inlining ๐.--param max-inline-insns-recursiveapplies to functions declared inline. For functions not declared inline, recursive inlining happens only when-finline-functions(included in-O3) is enabled;--param max-inline-insns-recursive-autoapplies instead.max-inline-recursive-depth,max-inline-recursive-depth-autoโ specifies the max recursion depth used for recursive inlining ๐ฆ.--param max-inline-recursive-depthapplies to functions declared inline. For functions not declared inline, recursive inlining happens only when-finline-functions(included in-O3) is enabled;--param max-inline-recursive-depth-autoapplies instead.min-inline-recursive-probabilityโ recursive inlining is profitable only for a function having deep recursion on average, and it can actually hurt for a function with little recursion depth, by increasing the prologue size or the complexity of the function body for other optimizers ๐. When profile feedback is available (see-fprofile-generate), the actual recursion depth can be guessed from the probability that the function recurses via a given call expression. This parameter limits inlining only to call expressions whose probability exceeds the given threshold (in percents) โจ.early-inlining-insnsโ specify the growth that the early inliner can make ๐ธ. In effect, it increases the amount of inlining for code having a large abstraction penalty.max-early-inliner-iterationsโ the limit of iterations of the early inliner ๐. This basically bounds the number of nested indirect calls the early inliner can resolve. Deeper chains are still handled by late inlining.comdat-sharing-probabilityโ probability (in percent) that a C++ inline function with comdat visibility is shared across multiple compilation units ๐.profile-func-internal-idโ a parameter to control whether to use the function internal id in profile database lookup ๐. If the value is0, the compiler uses an id that's based on the function assembler name and filename, which makes old profile data more tolerant to source changes such as function reordering etc.min-vect-loop-boundโ the minimum number of iterations under which loops are not vectorized when-ftree-vectorizeis used ๐ฅ. The number of iterations after vectorization needs to be greater than the value specified by this option to allow vectorization.gcse-cost-distance-ratioโ the scaling factor used when GCSE optimizations figure out the max distance an expression is allowed to travel. Currently only supported in the code hoisting pass, bestie. The bigger this ratio, the more feral code hoisting gets with simple expressions โ aka the ones whose cost is less thangcse-unrestricted-cost. Set it to0and hoisting of simple expressions just... stops. ๐gcse-unrestricted-costโ the cost (roughly, the cost of one typical machine instruction) at which GCSE optimizations stop constraining how far an expression can travel. Currently only supported in the code hoisting pass. Lower cost = more aggressive hoisting. Set it to0and literally every expression gets to travel unrestricted distances. ๐ฆmax-hoist-depthโ how deep into the dominator tree we go searching for expressions to hoist. It exists to dodge quadratic behavior in the hoisting algorithm. Set it to0and the search isn't limited at all โ but heads up, that may slow down compilation of huge functions. ๐ญmax-tail-merge-comparisonsโ the maximum number of similar bbs to compare a bb against. This one's here to avoid quadratic behavior in tree tail merging.max-tail-merge-iterationsโ the max number of iterations of the pass over the function. It's a compilation-time limiter for tree tail merging. โณstore-merging-allow-unalignedโ lets the store merging pass introduce unaligned stores, if it's legal to do so. That's the whole vibe. โจmax-stores-to-mergeโ the maximum number of stores the store merging pass will attempt to merge into wider stores.max-unrolled-insnsโ the max number of instructions a loop can have and still be unrolled. And if a loop does get unrolled, this parameter also decides how many times the loop code is unrolled. Two jobs, one param, main character energy. ๐max-average-unrolled-insnsโ same idea as above but the instruction count is biased by the probabilities of their execution. The max number of those a loop can have to be unrolled, and again, if the loop gets unrolled, this also determines how many times the loop code is unrolled. ๐max-unroll-timesโ the max number of unrollings of a single loop. That's it, that's the whole thing.max-peeled-insnsโ the max number of instructions a loop can have to be peeled. And yes, if a loop gets peeled, this parameter also determines how many times the loop code is peeled. ๐max-peel-timesโ the max number of peelings of a single loop.max-peel-branchesโ the max number of branches on the hot path through the peeled sequence. ๐ฅmax-completely-peeled-insnsโ the max number of insns of a completely peeled loop.max-completely-peel-timesโ the max number of iterations of a loop for it to be suitable for complete peeling.max-completely-peel-loop-nest-depthโ the max depth of a loop nest that's suitable for complete peeling.max-unswitch-insnsโ the max number of insns of an unswitched loop.max-unswitch-levelโ the max number of branches unswitched in a single loop. ๐lim-expensiveโ the minimum cost of an expensive expression in loop invariant motion.iv-consider-all-candidates-boundโ a bound on the number of induction variable candidates. Below it, all candidates get considered for every use in induction variable optimizations. Above it, only the most relevant ones get considered โ purely to avoid quadratic time complexity. โกiv-max-considered-usesโ the induction variable optimizations just give up on loops that contain more induction variable uses than this.iv-always-prune-cand-set-boundโ if the number of candidates in the set is smaller than this value, always try to remove unnecessary ivs from the set when adding a new one.avg-loop-niterโ the average number of iterations of a loop.dse-max-object-sizeโ the max size, in bytes, of objects tracked bytewise by dead store elimination. Bigger values may result in larger compilation times. ๐ฌdse-max-alias-queries-per-storeโ the max number of queries into the alias oracle per store. Bigger values mean larger compilation times <em>and</em> may result in more removed dead stores. Trade-offs, bestie. โ๏ธscev-max-expr-sizeโ a bound on the size of expressions used in the scalar evolutions analyzer. Large expressions slow the analyzer down. ๐scev-max-expr-complexityโ a bound on the complexity of the expressions in the scalar evolutions analyzer. Complex expressions slow the analyzer down. Same energy, different metric.max-tree-if-conversion-phi-argsโ the max number of arguments in a PHI that TREE if conversion supports โ unless the loop is marked withsimdpragma.vect-max-version-for-alignment-checksโ the max number of run-time checks that can be performed when doing loop versioning for alignment in the vectorizer.vect-max-version-for-alias-checksโ the max number of run-time checks that can be performed when doing loop versioning for alias in the vectorizer.vect-max-peeling-for-alignmentโ the max number of loop peels to enhance access alignment for the vectorizer. A value of-1means no limit. ๐max-iterations-to-trackโ the max number of iterations of a loop that the brute-force algorithm tries to evaluate when analyzing the number of iterations of the loop. (Say that five times fast. ๐ญ)hot-bb-count-ws-permilleโ a basic block profile count counts as hot if it contributes to the given permillage (i.e.0...1000) of the entire profiled execution. ๐ฅhot-bb-frequency-fractionโ picks the fraction of the entry block frequency of executions of a basic block in a function that the given basic block needs to have to be considered hot.max-predicted-iterationsโ the max number of loop iterations we predict statically. This is useful when a function contains a single loop with a known bound and another loop with an unknown bound: the known number of iterations gets predicted correctly, while the unknown number of iterations averages out to roughly10. Which means the loop without bounds appears artificially cold relative to the other one. ๐builtin-expect-probabilityโ controls the probability of the expression having the specified value. This parameter takes a percentage (i.e.0 ... 100) as input.builtin-string-cmp-inline-lengthโ the max length of a constant string for a builtin string cmp call to be eligible for inlining.align-thresholdโ selects the fraction of the maximal frequency of executions of a basic block in a function needed to align that basic block.align-loop-iterationsโ a loop expected to iterate at least the selected number of iterations gets aligned. โจtracer-dynamic-coverage,tracer-dynamic-coverage-feedbackโ this value limits superblock formation once the given percentage of executed instructions is covered, which limits unnecessary code size expansion. ๐
The tracer-dynamic-coverage-feedback parameter is used only when profile feedback is available โ real profiles (as opposed to statically estimated ones) are much less balanced, which lets the threshold be a larger value.
tracer-max-code-growthโ stops tail duplication once code growth hits the given percentage. Ngl this is a rather artificial limit, since most of the duplicates get eliminated later in cross jumping โ so it may be set to <em>much higher</em> values than the code growth you actually want. ๐tracer-min-branch-ratioโ stops reverse growth when the reverse probability of the best edge is less than this threshold, in percent.tracer-min-branch-probability,tracer-min-branch-probability-feedbackโ stops forward growth if the best edge has a probability lower than this threshold. ๐
Just like tracer-dynamic-coverage, two parameters are provided: tracer-min-branch-probability-feedback is used for compilation with profile feedback, and tracer-min-branch-probability for compilation without. The value for compilation with profile feedback needs to be more conservative (higher) to make tracer effective.
stack-clash-protection-guard-sizeโ specifies the size of the operating system provided stack guard as2raised to num bytes. Higher values may reduce the number of explicit probes, but a value larger than the operating system provided guard will leave code vulnerable to stack clash style attacks. ๐ฑstack-clash-protection-probe-intervalโ stack clash protection involves probing stack space as it's allocated. This param controls the max distance between probes into the stack as2raised to num bytes. Higher values may reduce the number of explicit probes, but a value larger than the operating system provided guard will leave code vulnerable to stack clash style attacks. ๐max-cse-path-lengthโ the max number of basic blocks on a path that CSE considers.max-cse-insnsโ the max number of instructions CSE processes before flushing.ggc-min-expandโ GCC uses a garbage collector to manage its own memory allocation, and this parameter specifies the minimum percentage by which the garbage collector's heap should be allowed to expand between collections. Tuning it may improve compilation speed; it has no effect on code generation. ๐๏ธ
The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when RAM >= 1GB. If getrlimit is available, the notion of "RAM" is the smallest of actual RAM and RLIMIT_DATA or RLIMIT_AS. If GCC isn't able to calculate RAM on a particular platform, the lower bound of 30% is used. Setting this parameter and ggc-min-heapsize to zero causes a full collection to occur at every opportunity โ this is extremely slow, but it can be useful for debugging. ๐ข
ggc-min-heapsize ๐ธ
okay so this one is the minimum size of the garbage collector's heap before it even bothers to start collecting garbage. like, it's not gonna lift a finger until the heap has grown enough. the first collection happens after the heap expands by ggc-min-expand% beyond ggc-min-heapsize. and yeah, tuning this can speed up compilation, and it has no effect on code generation at all โ it's purely a compiler-speed vibe thing, not a "your binary changes" thing.
the default is the smaller of RAM/8, RLIMIT_RSS, or a limit that tries to make sure RLIMIT_DATA or RLIMIT_AS don't get exceeded, but with a lower bound of 4096 (four megabytes) and an upper bound of 131072 (128 megabytes). if GCC can't figure out your RAM on a particular platform, the lower bound is what you get. setting this parameter very large effectively disables garbage collection (not me casually turning off the GC ๐). and setting this parameter and ggc-min-expand to zero causes a full collection to occur at every opportunity. slay, I guess.
max-reload-search-insns โจ
the maximum number of instructions reload should look backward for an equivalent register. bigger values mean more aggressive optimization, so compilation time goes up but you probably get slightly better performance. it's giving "pay with time, maybe get speed."
max-cselib-memory-locations ๐
the maximum number of memory locations cselib should take into account. again, increasing values mean more aggressive optimization, compilation time increases, and you probably get slightly better performance. same energy, different parameter.
max-sched-ready-insns ๐ฆ
the maximum number of instructions that are ready to be issued that the scheduler should consider at any given time during the first scheduling pass. increasing values mean more thorough searches, so compilation time increases with probably little benefit. bestie, don't touch this one unless you're feeling spicy.
max-sched-region-blocks ๐
the maximum number of blocks in a region to be considered for interblock scheduling. that's it, that's the whole vibe.
max-pipeline-region-blocks ๐
the maximum number of blocks in a region to be considered for pipelining in the selective scheduler. sibling energy to the one above, different pass.
max-sched-region-insns ๐ฆ
the maximum number of insns in a region to be considered for interblock scheduling.
max-pipeline-region-insns ๐ฆ
the maximum number of insns in a region to be considered for pipelining in the selective scheduler.
min-spec-prob โญ
the minimum probability, in percents, of reaching a source block for interblock speculative scheduling. percentages, so don't go typing 0.5, iykyk.
max-sched-extend-regions-iters ๐
the maximum number of iterations through CFG to extend regions. and listen โ a value of 0 disables region extensions entirely. zero means nope, none, not happening.
max-sched-insn-conflict-delay ๐
the maximum conflict delay for an insn to be considered for speculative motion.
sched-spec-prob-cutoff ๐
the minimal probability of speculation success, in percents, so that speculative insns are scheduled. again with the percents, keep up bestie.
sched-state-edge-prob-cutoff ๐
the minimum probability an edge must have for the scheduler to save its state across it.
sched-mem-true-dep-cost ๐
minimal distance, in CPU cycles, between a store and a load targeting the same memory locations.
selsched-max-lookahead ๐ฅ
the maximum size of the lookahead window of selective scheduling. it's a depth of search for available instructions. think of it as how far ahead the scheduler is allowed to peek.
selsched-max-sched-times ๐ฅ
the maximum number of times that an instruction is scheduled during selective scheduling. this is the limit on the number of iterations through which the instruction may be pipelined.
selsched-insns-to-rename โจ
the maximum number of best instructions in the ready list that are considered for renaming in the selective scheduler.
sms-min-sc ๐
the minimum value of stage count that swing modulo scheduler generates.
max-last-value-rtl ๐ธ
the maximum size measured as number of RTLs that can be recorded in an expression in combiner for a pseudo register as the last known value of that register.
max-combine-insns ๐ธ
the maximum number of instructions the RTL combiner tries to combine.
integer-share-limit ๐
small integer constants can use a shared data structure, which reduces the compiler's memory usage and increases its speed. this parameter sets the maximum value of a shared integer constant. cute, efficient, iconic.
ssp-buffer-size ๐ก๏ธ
the minimum size of buffers (i.e. arrays) that receive stack smashing protection when -fstack-protection is used.
this default before Ubuntu 10.10 was "8". currently it is "4", to increase the number of functions protected by the stack protector. so yeah, they lowered it on purpose to protect more stuff. the more you know ๐
min-size-for-stack-sharing ๐ง
the minimum size of variables taking part in stack slot sharing when not optimizing.
max-jump-thread-duplication-stmts ๐ฆ
maximum number of statements allowed in a block that needs to be duplicated when threading jumps.
max-fields-for-field-sensitive ๐
maximum number of fields in a structure treated in a field sensitive manner during pointer analysis.
prefetch-latency โก
an estimate of the average number of instructions that are executed before a prefetch finishes. the distance prefetched ahead is proportional to this constant. heads up though โ increasing this number may also lead to less streams being prefetched, see simultaneous-prefetches.
simultaneous-prefetches โก
maximum number of prefetches that can run at the same time.
l1-cache-line-size ๐
the size of a cache line in L1 data cache, in bytes.
l1-cache-size ๐พ
the size of L1 data cache, in kilobytes.
l2-cache-size ๐พ
the size of L2 data cache, in kilobytes. yes bestie, kilobytes, not bytes. don't mix them up ๐
prefetch-dynamic-strides ๐
whether the loop array prefetch pass should issue software prefetch hints for strides that are non-constant. in some cases this may be beneficial, though the fact the stride is non-constant may make it hard to predict when there is a clear benefit to issuing these hints.
set to 1 if the prefetch hints should be issued for non-constant strides. set to 0 if prefetch hints should be issued only for strides that are known to be constant and below prefetch-minimum-stride.
prefetch-minimum-stride ๐
minimum constant stride, in bytes, to start using prefetch hints for. if the stride is less than this threshold, prefetch hints will not be issued.
this setting is useful for processors that have hardware prefetchers, in which case there may be conflicts between the hardware prefetchers and the software prefetchers. if the hardware prefetchers have a maximum stride they can handle, it should be used here to improve the use of software prefetchers.
a value of -1 means we don't have a threshold and therefore prefetch hints can be issued for any constant stride.
this setting is only useful for strides that are known and constant. periodt. ๐
loop-interchange-max-num-stmts ๐
the maximum number of stmts in a loop to be interchanged.
loop-interchange-stride-ratio ๐
the minimum ratio between the stride of two loops for interchange to be profitable.
min-insn-to-prefetch-ratio โ๏ธ
the minimum ratio between the number of instructions and the number of prefetches to enable prefetching in a loop.
prefetch-min-insn-to-mem-ratio โ๏ธ
the minimum ratio between the number of instructions and the number of memory references to enable prefetching in a loop.
use-canonical-types ๐
whether the compiler should use the "canonical" type system. this should always be 1, which uses a more efficient internal mechanism for comparing types in C++ and Objective-C++. however โ and this is the important part โ if bugs in the canonical type system are causing compilation failures, set this value to 0 to disable canonical types. emergency escape hatch energy fr fr.
switch-conversion-max-branch-ratio ๐
switch initialization conversion refuses to create arrays that are bigger than switch-conversion-max-branch-ratio times the number of branches in the switch.
max-partial-antic-length ๐ญ
maximum length of the partial antic set computed during the tree partial redundancy elimination optimization (-ftree-pre) when optimizing at -O3 and above. for some sorts of source code the enhanced partial redundancy elimination optimization can run away, consuming all of the memory available on the host machine. yeah. all of it. this parameter sets a limit on the length of the sets that are computed, which prevents the runaway behavior. setting a value of 0 for this parameter allows an unlimited set length โ which is exactly as chaotic as it sounds.
rpo-vn-max-loop-depth ๐
maximum loop depth that is value-numbered optimistically. when the limit hits, the innermost rpo-vn-max-loop-depth loops and the outermost loop in the loop nest are value-numbered optimistically and the remaining ones are not.
sccvn-max-alias-queries-per-access ๐
maximum number of alias-oracle queries we perform when looking for redundancies for loads and stores. if this limit is hit, the search is aborted and the load or store is not considered redundant. the number of queries is algorithmically limited to the number of stores on all paths from the load to the function entry.
ira-max-loops-num ๐
IRA uses regional register allocation by default. if a function contains more loops than the number given by this parameter, only at most the given number of the most frequently-executed loops form regions for regional register allocation.
ira-max-conflict-table-size ๐
so IRA uses a sophisticated algorithm to compress the conflict table, but even with all that, the table can still require excessive amounts of memory for huge functions. if the conflict table for a function could be more than the size in MB given by this parameter, the register allocator instead uses a faster, simpler, and lower-quality algorithm that does not require building a pseudo-register conflict table. tradeoff city, but at least it doesn't eat your RAM ๐ซถ
ira-loop-reserved-regsโ bestie, IRA can vibe-check register pressure way more accurately inside loops when it's deciding whether to hoist loop invariants out (peep-O3for that whole situation โจ). This param tells it how many available registers get reserved for other stuff. The default? Found from literally so many experiments, it's the best one they could find. ๐lra-inheritance-ebb-probability-cutoffโ LRA is out here trying to reuse values that got reloaded into registers in the insns that come after, and that whole glow-up is called inheritance. EBB is the region where it does the thing ๐ฆ. This param sets a minimum fall-through edge probability, in percent, that a BB needs to get added to the inheritance EBB in LRA. Default value was picked from numerous runs of SPEC2000 on x86-64. no cap.loop-invariant-max-bbs-in-loopโ Loop invariant motion can be SO expensive, both in compilation time and in the compile-time memory it eats, when loops are huge ๐ญ. Loops with more basic blocks than this param? They just don't get loop invariant motion optimization performed on them. not invited to the party, sorry.loop-max-datarefs-for-datadepsโ Building data dependencies is expensive for very large loops, fr fr. This param caps the number of data references in loops that even get considered for data dependence analysis. Those giant loops are just not handled by the optimizations that use loop data dependencies. ๐ซถmax-vartrack-sizeโ Sets a maximum number of hash table slots to use during variable tracking dataflow analysis of any function. If this limit gets exceeded while variable tracking at assignments is enabled, the analysis for that function is retried without it โ after removing all debug insns from the function. And if the limit is exceeded even without debug insns? Then var tracking analysis is completely disabled for that function ๐. Setting the parameter to zero makes it unlimited. iconic.max-vartrack-expr-depthโ Sets a maximum number of recursion levels when it's trying to map variable names or debug temporaries to value expressions. It's a trade: compilation time in exchange for more complete debug information โจ. Set it too low and value expressions that are actually available and could be represented in debug info may end up not being used ๐ญ. Set it higher and the compiler may find more complex debug expressions, but compile time and memory use may grow.max-debug-marker-countโ Sets a threshold on the number of debug markers (like begin stmt markers) so things don't complexity-explode at inlining or expanding to RTL ๐. If a function has more of these gimple stmts than the set limit, those stmts get dropped from the inlined copy of a function, and from its RTL expansion.min-nondebug-insn-uidโ Use uids starting at this parameter for nondebug insns. The range below the parameter is reserved exclusively for debug insns created by-fvar-tracking-assignments, but debug insns may get (non-overlapping) uids above it if the reserved range is exhausted. ๐ipa-sra-ptr-growth-factorโ IPA-SRA will replace a pointer to an aggregate with one or more new parameters, but only when their cumulative size is less or equal toipa-sra-ptr-growth-factortimes the size of the original pointer parameter. the way that it does math on ur pointers ๐sra-max-scalarization-size-Ospeedandsra-max-scalarization-size-Osizeโ the two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) are aiming to replace scalar parts of aggregates with uses of independent scalar variables ๐ฆ. These parameters control the maximum size, in storage units, of an aggregate that's considered for replacement when compiling for speed (sra-max-scalarization-size-Ospeed) or for size (sra-max-scalarization-size-Osize) respectively.sra-max-propagationsโ The maximum number of artificial accesses that Scalar Replacement of Aggregates (SRA) will track, per one local variable, so it can facilitate copy propagation. lowkey a whole tracking situation.tm-max-aggregate-sizeโ When making copies of thread-local variables in a transaction, this parameter specifies the size in bytes after which variables are saved with the logging functions, instead of save/restore code sequence pairs ๐ธ. This option only applies when using-fgnu-tm.graphite-max-nb-scop-paramsโ To avoid exponential effects in the Graphite loop transforms, the number of parameters in a Static Control Part (SCoP) is bounded. A value of zero can be used to lift the bound entirely ๐. And fyi, a variable whose value is unknown at compilation time and defined outside a SCoP is a parameter of the SCoP.loop-block-tile-sizeโ Loop blocking or strip mining transforms, which get enabled with-floop-blockor-floop-strip-mine, strip mine each loop in the loop nest by a given number of iterations. The strip length can be changed using theloop-block-tile-sizeparameter โจ.ipa-cp-value-list-sizeโ IPA-CP is out here attempting to track all possible values and types passed to a function's parameter, so it can propagate them and perform devirtualization.ipa-cp-value-list-sizeis the maximum number of values and types it stores per one formal parameter of a function. ๐ipa-cp-eval-thresholdโ IPA-CP calculates its own score of cloning profitability heuristics and performs those cloning opportunities with scores that exceedipa-cp-eval-threshold. gatekept by a number, periodt.ipa-cp-recursion-penaltyโ Percentage penalty the recursive functions will receive when they are evaluated for cloning. ๐ญ recursive besties pay a tax.ipa-cp-single-call-penaltyโ Percentage penalty functions containing a single call to another function will receive when they are evaluated for cloning. yeah. one call and you're getting docked points.ipa-max-agg-itemsโ IPA-CP is also capable of propagating a number of scalar values passed in an aggregate ๐ซถ.ipa-max-agg-itemscontrols the maximum number of such values per one parameter.ipa-cp-loop-hint-bonusโ When IPA-CP determines that a cloning candidate would make the number of iterations of a loop known, it adds a bonus ofipa-cp-loop-hint-bonusto the profitability score of the candidate. bonus points for knowing the loop count ๐ฅipa-cp-array-index-hint-bonusโ When IPA-CP determines that a cloning candidate would make the index of an array access known, it adds a bonus ofipa-cp-array-index-hint-bonusto the profitability score of the candidate. ๐ipa-max-aa-stepsโ During its analysis of function bodies, IPA-CP employs alias analysis in order to track values pointed to by function parameters. So it doesn't spend too much time analyzing huge functions, it gives up and considers all memory clobbered after examiningipa-max-aa-stepsstatements modifying memory. ๐ it literally quits.lto-partitionsโ Specify desired number of partitions produced during WHOPR compilation. The number of partitions should exceed the number of CPUs used for compilation โจ.lto-min-partitionโ Size of minimal partition for WHOPR (in estimated instructions). This prevents expenses of splitting very small programs into too many partitions. nobody wants a thousand tiny partitions ๐.lto-max-partitionโ Size of max partition for WHOPR (in estimated instructions), to provide an upper bound for individual size of partition. Meant to be used only with balanced partitioning. ๐ธlto-max-streaming-parallelismโ Maximal number of parallel processes used for LTO streaming. parallel besties go brrr.cxx-max-namespaces-for-diagnostic-helpโ The maximum number of namespaces to consult for suggestions when C++ name lookup fails for an identifier. it's the "did you mean" but for namespaces ๐sink-frequency-thresholdโ The maximum relative execution frequency (in percents) of the target block relative to a statement's original block, to allow statement sinking of a statement ๐ฆ. Larger numbers result in more aggressive statement sinking. A small positive adjustment is applied for statements with memory operands, as those are even more profitable to sink.max-stores-to-sinkโ The maximum number of conditional store pairs that can be sunk. Set to 0 if either vectorization (-ftree-vectorize) or if-conversion (-ftree-loop-if-convert) is disabled โญ.allow-store-data-racesโ Allow optimizers to introduce new data races on stores. Set to 1 to allow, otherwise to 0. > bestie this one is a deliberate "yes let it race" switch, so don't just flip it for funsies ๐ญcase-values-thresholdโ The smallest number of different values for which it is best to use a jump-table instead of a tree of conditional branches. If the value is 0, use the default for the machine ๐.tree-reassoc-widthโ Set the maximum number of instructions executed in parallel in reassociated tree. This parameter overrides target dependent heuristics used by default if it has a non zero value. ๐ฅsched-pressure-algorithmโ Choose between the two available implementations of-fsched-pressure. Algorithm 1 is the original implementation and is the more likely to prevent instructions from being reordered. Algorithm 2 was designed to be a compromise between the relatively conservative approach taken by algorithm 1 and the rather aggressive approach taken by the default scheduler ๐. It relies more heavily on having a regular register file and accurate register pressure classes. Seehaifa-sched.cin the GCC sources for more details.
The default choice depends on the target. โจ
max-slsr-cand-scanโ Set the maximum number of existing candidates that are considered when seeking a basis for a new straight-line strength reduction candidate. ๐asan-globalsโ Enable buffer overflow detection for global objects. This kind of protection is enabled by default if you are using the-fsanitize=addressoption. To disable global objects protection use--param asan-globals=0. ๐ฆasan-stackโ Enable buffer overflow detection for stack objects. This kind of protection is enabled by default when using-fsanitize=address. To disable stack protection use--param asan-stack=0option. ๐asan-instrument-readsโ bestie this one turns ON buffer overflow detection for memory reads ๐ it's already on by default the second you use-fsanitize=address. wanna turn the read protection off? then hit it with--param asan-instrument-reads=0๐ซถasan-instrument-writesโ same energy but for memory writes โ๏ธ also enabled by default when you're using-fsanitize=address. to kill the write protection, use the--param asan-instrument-writes=0option ๐asan-memintrinโ this enables detection for built-in functions ๐ง it's on by default when you're using-fsanitize=address. want the built-in function protection gone?--param asan-memintrin=0and you're set โจasan-use-after-returnโ enables detection of use-after-return ๐ธ on by default when you're using the-fsanitize=addressoption. to disable it,--param asan-use-after-return=0๐
Note: by default the check is disabled at run time. to actually enable it, add"detect_stack_use_after_return=1"to the environment variableASAN_OPTIONSโ ๏ธ like, it's compiled in but asleep, okay?
asan-instrumentation-with-call-thresholdโ if the number of memory accesses in the function being instrumented is greater than or equal to this number, callbacks get used instead of inline checks ๐ e.g. to disable inline code use--param asan-instrumentation-with-call-threshold=0๐ซuse-after-scope-direct-emission-thresholdโ if the size of a local variable in bytes is smaller or equal to this number, we directly poison (or unpoison) shadow memory instead of using run-time callbacks ๐งชmax-fsm-thread-path-insnsโ the max number of instructions to copy when duplicating blocks on a finite state automaton jump thread path ๐max-fsm-thread-lengthโ the max number of basic blocks on a finite state automaton jump thread path ๐งฑmax-fsm-thread-pathsโ the max number of new jump thread paths to create for a finite state automaton ๐ค๏ธparloops-chunk-sizeโ the chunk size of omp schedule for loops parallelized by parloops ๐ฐparloops-scheduleโ the schedule type of omp schedule for loops parallelized by parloops (static,dynamic,guided,auto,runtime) โฐparloops-min-per-threadโ the minimum number of iterations per thread of an innermost parallelized loop for which the parallelized variant is preferred over the single threaded one ๐ heads up tho: for a parallelized loop nest, the minimum number of iterations of the outermost loop per thread is two โ๏ธmax-ssa-name-query-depthโ the max depth of recursion when querying properties of SSA names in things like fold routines ๐ one level of recursion = following a use-def chain, iykykhsa-gen-debug-storesโ enables emission of special debug stores within HSA kernels which are then read and reported by thelibgompplugin ๐ generation of these stores is disabled by default, so use--param hsa-gen-debug-stores=1to turn it on โจmax-speculative-devirt-maydefsโ the maximum number of may-defs we analyze when looking for a must-def specifying the dynamic type of an object that invokes a virtual call we may be able to devirtualize speculatively ๐ต๏ธmax-vrp-switch-assertionsโ the maximum number of assertions to add along the default edge of aswitchstatement during VRP ๐ฏunroll-jam-min-percentโ the minimum percentage of memory references that must be optimized away for the unroll-and-jam transformation to even be considered profitable ๐ฐunroll-jam-max-unrollโ the maximum number of times the outer loop should be unrolled by the unroll-and-jam transformation ๐max-rtl-if-conversion-unpredictable-costโ maximum permissible cost for the sequence that would be generated by the RTL if-conversion pass for a branch that is considered unpredictable ๐ฒmax-variable-expansions-in-unrollerโ if-fvariable-expansion-in-unrolleris used, this is the maximum number of times that an individual variable will be expanded during loop unrolling ๐ชtracer-min-branch-probability-feedbackโ stop forward growth if the probability of the best edge is less than this threshold (in percent) ๐ used when profile feedback is available ๐partial-inlining-entry-probabilityโ maximum probability of the entry BB of split region (in percent relative to entry BB of the function) to make partial inlining happen โ๏ธmax-tracked-strlensโ maximum number of strings for which thestrlenoptimization pass will track string lengths ๐งตgcse-after-reload-partial-fractionโ the threshold ratio for performing partial redundancy elimination after reload ๐gcse-after-reload-critical-fractionโ the threshold ratio of critical edges execution count that permit performing redundancy elimination after reload ๐ฅmax-loop-header-insnsโ the maximum number of insns in loop header duplicated by the copy loop headers pass ๐vect-epilogues-nomaskโ enables loop epilogue vectorization using smaller vector size ๐slp-max-insns-in-bbโ maximum number of instructions in basic block to be considered for SLP vectorization ๐งฎavoid-fma-max-bitsโ maximum number of bits for which we avoid creating FMAs ๐ซsms-loop-average-count-thresholdโ a threshold on the average loop count considered by the swing modulo scheduler โ๏ธsms-dfa-historyโ the number of cycles the swing modulo scheduler considers when checking conflicts using DFA ๐hot-bb-count-fractionโ select fraction of the maximal count of repetitions of basic block in program given basic block needs to have to be considered hot (used in non-LTO mode) ๐ก๏ธmax-inline-insns-recursive-autoโ the maximum number of instructions a non-inline function can grow to via recursive inlining ๐graphite-allow-codegen-errorsโ whether codegen errors should be ICEs when-fchecking๐sms-max-ii-factorโ a factor for tuning the upper bound that swing modulo scheduler uses for scheduling a loop ๐๏ธlra-max-considered-reload-pseudosโ the max number of reload pseudos which are considered during spilling a non-reload pseudo ๐งmax-pow-sqrt-depthโ maximum depth of sqrt chains to use when synthesizing exponentiation by a real constant ๐งฎmax-dse-active-local-storesโ maximum number of active local stores in RTL dead store elimination ๐๏ธasan-instrument-allocasโ enable asan allocas/VLAs protection ๐ก๏ธmax-iterations-computation-costโ bound on the cost of an expression to compute the number of iterations ๐งพmax-isl-operationsโ maximum number of isl operations,0means unlimited โพ๏ธgraphite-max-arrays-per-scopโ maximum number of arrays per scop ๐max-vartrack-reverse-op-sizeโ max. size of loc list for which reverse ops should be added ๐unlikely-bb-count-fractionโ the minimum fraction of profile runs a given basic block execution count must be not to be considered unlikely ๐tracer-dynamic-coverage-feedbackโ the percentage of function, weighted by execution frequency, that must be covered by trace formation ๐ used when profile feedback is available ๐max-inline-recursive-depth-autoโ the maximum depth of recursive inlining for non-inline functions ๐ณ๏ธfsm-scale-path-stmtsโ scale factor to apply to the number of statements in a threading path when comparing to the number of (scaled) blocks โ๏ธfsm-maximum-phi-argumentsโ maximum number of arguments a PHI may have before the FSM threader will not try to thread through its block ๐งuninit-control-dep-attemptsโ maximum number of nested calls to search for control dependencies during uninitialized variable analysis ๐งindir-call-topn-profileโ track top N target addresses in indirect-call profile ๐max-once-peeled-insnsโ the maximum number of insns of a peeled loop that rolls only once ๐sra-max-scalarization-size-Osizeโ maximum size, in storage units, of an aggregate which should be considered for scalarization when compiling for size ๐ฆfsm-scale-path-blocksโ scale factor to apply to the number of blocks in a threading path when comparing to the number of (scaled) statements โ๏ธsched-autopref-queue-depthโ hardware autoprefetcher scheduler model control flag ๐๏ธ number of lookahead cycles the model looks into; at' 'only enable instruction sorting heuristic ๐loop-versioning-max-inner-insnsโ the maximum number of instructions that an inner loop can have before the loop versioning pass considers it too big to copy ๐loop-versioning-max-outer-insnsโ the maximum number of instructions that an outer loop can have before the loop versioning pass considers it too big to copy, discounting any instructions in inner loops that directly benefit from versioning ๐ssa-name-def-chain-limitโ the maximum number ofSSA_NAMEassignments to follow in determining a property of a variable such as its value ๐ this limits the number of iterations or recursive calls GCC performs when optimizing certain statements or when determining their validity prior to issuing diagnostics ๐ฆ
๐ Program Instrumentation Options ๐
okay bestie, so GCC supports a whole bunch of command-line options that control adding run-time instrumentation to the code it normally generates ๐ like, one purpose of instrumentation is to collect profiling statistics for use in finding program hot spots, code coverage analysis, or profile-guided optimizations ๐ another class of program instrumentation is adding run-time checking to detect programming errors like invalid pointer dereferences or out-of-bounds array accesses, as well as deliberately hostile attacks such as stack smashing or C++ vtable hijacking ๐ and there's also a general hook which can be used to implement other forms of tracing or function-level instrumentation for debug or program analysis purposes ๐ช slay ๐ซถ
-p,-pgโ okay so these two besties generate extra code that writes out profile info, the kind the analysis programsprof(that's-p) orgprof(that's-pg) are literally built to eat up. ๐ But listen: you must use this option when you compile the source files you want data about, and you also have to use it when linking. Both times, no skipping. And if there's one lil function you want to leave out of the whole profiling thing? You can slap the function attributeno_instrument_functionon it to suppress profiling of individual functions while compiling with these options. ๐-fprofile-arcsโ adds code so that program flow arcs get instrumented. While the program runs, it records how many times each branch and call is executed and how many times it is taken or returns. On targets that support constructors with priority support, the 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 all this data to a file called auxname.gcda for each source file. That data can be used for profile-directed optimizations (-fbranch-probabilities), or for test coverage analysis (-ftest-coverage). Each object file's auxname gets generated from the name of the output file, if it's explicitly specified and it's not the final executable; otherwise it's the basename of the source file. Either way, any suffix gets removed (so like foo.gcda for input file dir/foo.c, or dir/foo.gcda for output file specified as -o dir/foo.o). ๐
--coverageโ this one's your girl for compiling and linking code that's instrumented for coverage analysis. She's a synonym for-fprofile-arcs -ftest-coverage(when compiling) and-lgcov(when linking). Check the docs for those options for the deets. โจ
Here's the whole recipe, step by step, no cap:
- 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 letsgcovfind the correct sources in projects where compilations happen 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. You can repeat this any number of times, fr fr. You can even run concurrent instances of your program, and as long as 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. ๐ - 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 more.
With -fprofile-arcs, for each function of your program GCC creates a program flow graph, then finds a spanning tree for the graph. Only the arcs that are not on the spanning tree have to be instrumented โ the compiler adds code to count the number of times those arcs get executed. When an arc is the only exit or only entrance to a block, the instrumentation code can just be added to the block; otherwise, a whole new basic block has to be created to hold the instrumentation code. ๐ฆ
-ftest-coverageโ produces a notes file that thegcovcode-coverage utility can use to show program coverage. Each source file's note file is calledauxname.gcno. Peep the-fprofile-arcsoption above for a description ofauxnameand instructions on how to generate test coverage data. Fun fact: coverage data matches the source files way more closely if you do not optimize. ๐-fprofile-abs-pathโ automatically converts relative source file names to absolute path names in the.gcnofiles. This letsgcovfind the correct sources in projects where compilations occur with different working directories. ๐-fprofile-dir=pathโ sets the directory to search for the profile data files topath. This option only affects 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 work. By default, GCC uses the current directory aspath, so the profile data file shows up in the same directory as the object file. To prevent file name clashing, if the object file name isn't an absolute path, we mangle the absolute path of thesourcename.gcdafile and use it as the file name of a.gcdafile. ๐
When an executable is run in a massive parallel environment, it's recommended to save the profile to different folders. You can do that with variables in path that get exported during run-time:
%pโ process ID.%q{VAR}โ value of environment variableVAR
-fprofile-generate,-fprofile-generate=pathโ enables the options usually used for instrumenting an application to produce a profile that's 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-update=methodโ changes up the update method for an application instrumented for profile feedback based optimization. Themethodargument 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-atomic would be transformed either to atomic, when supported by a target, or to single otherwise. The GCC driver automatically selects prefer-atomic when -pthread is present in the command line.
-fprofile-filter-files=regexโ instruments only functions from files where names match any regular expression (separated by a semi-colon). ๐
For example, -fprofile-filter-files=main.c;module.*.c will instrument only main.c and all C files starting with 'module'.
-fprofile-exclude-files=regexโ instruments only functions from files where names do not match all the regular expressions (separated by a semi-colon). ๐ง
For example, -fprofile-exclude-files=/usr/* will prevent instrumentation of all files that are located in the /usr/ folder.
-fsanitize=addressโ enables AddressSanitizer, a fast memory error detector. Memory access instructions get 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 it's 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. ๐ This option cannot be combined with-fsanitize=thread.-fsanitize=kernel-addressโ enables AddressSanitizer for the Linux kernel. Seehttps://github.com/google/kasan/wikifor more details. ๐-fsanitize=pointer-compareโ instruments comparison operations (<,<=,>,>=) with pointer operands. This option must be combined with either-fsanitize=kernel-addressor-fsanitize=address. It cannot be combined with-fsanitize=thread. Note: by default the check is disabled at run time. To enable it, adddetect_invalid_pointer_pairs=2to the environment variableASAN_OPTIONS. Usingdetect_invalid_pointer_pairs=1detects invalid operation only when both pointers are non-null. ๐-fsanitize=pointer-subtractโ instruments subtraction with pointer operands. This option must be combined with either-fsanitize=kernel-addressor-fsanitize=address. It cannot be combined with-fsanitize=thread. Note: by default the check is disabled at run time. To enable it, adddetect_invalid_pointer_pairs=2to the environment variableASAN_OPTIONS. Usingdetect_invalid_pointer_pairs=1detects invalid operation only when both pointers are non-null. ๐ธ-fsanitize=threadโ enables ThreadSanitizer, a fast data race detector. Memory access instructions get instrumented to detect data race bugs. Seehttps://github.com/google/sanitizers/wiki#threadsanitizerfor more details. The run-time behavior can be influenced using theTSAN_OPTIONSenvironment variable; seehttps://github.com/google/sanitizers/wiki/ThreadSanitizerFlagsfor a list of supported options. This option cannot be combined with-fsanitize=address,-fsanitize=leak. ๐ฅ
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, and the executable gets linked against a library that overridesmallocand other allocator functions. Seehttps://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizerfor more details. The run-time behavior can be influenced using theLSAN_OPTIONSenvironment variable. This option cannot be combined with-fsanitize=thread. ๐ง-fsanitize=undefinedโ enables UndefinedBehaviorSanitizer, a fast undefined behavior detector. Various computations get instrumented to detect undefined behavior at runtime. Seehttps://clang.llvm.org/docs/UndefinedBehaviorSanitizer.htmlfor more details. The run-time behavior can be influenced using theUBSAN_OPTIONSenvironment variable. โญ The current suboptions are:-fsanitize=shiftโ this one checks that the result of a shift operation isn't undefined โจ. Heads up though, what counts as "undefined" is a little different between C and C++, and also between ISO C90 and C99 and so on. This option has two suboptions:-fsanitize=shift-baseand-fsanitize=shift-exponent.-fsanitize=shift-exponentโ checks that the second argument of a shift operation isn't negative, and that it's smaller than the precision of the promoted first argument ๐ .-fsanitize=shift-baseโ if the second argument of a shift operation is within range, this checks that the result of the shift isn't undefined. Again, "undefined" is defined slightly differently between C and C++, and between ISO C90 and C99, etc. etc. ๐ธ-fsanitize=integer-divide-by-zeroโ catches integer division by zero, plusINT_MIN / -1division ๐.-fsanitize=unreachableโ with this, the compiler turns the__builtin_unreachablecall into a diagnostics message call instead. And bestie, when you actually reach that__builtin_unreachablecall, the behavior is undefined. No cap.-fsanitize=vla-boundโ tells the compiler to check that the size of a variable length array is positive โจ.-fsanitize=nullโ pointer checking, periodt. An application built with this on will throw an error message when it tries to dereference aNULLpointer, or if a reference (possibly an rvalue reference) gets bound to aNULLpointer, or if a method is invoked on an object that's pointed to by aNULLpointer ๐ซถ.-fsanitize=returnโ return statement checking. Programs built with this on will throw an error message when the end of a non-void function is reached without actually returning a value. This one only works in C++ ๐.-fsanitize=signed-integer-overflowโ signed integer overflow checking. We check that the result of+,*, and both unary and binary-doesn't overflow in signed arithmetic. Note: integer promotion rules must be taken into account, meaning the following is not an overflow:
signed char a = SCHAR_MAX;
a++;
-fsanitize=boundsโ instruments array bounds. Various out-of-bounds accesses get detected ๐. Flexible array members, flexible array member-like arrays, and initializers of variables with static storage are not instrumented.-fsanitize=bounds-strictโ strict array bounds instrumentation. Most out-of-bounds accesses get detected, including flexible array members and flexible array member-like arrays ๐ฅ. Initializers of variables with static storage are still not instrumented.-fsanitize=alignmentโ checks pointer alignment when pointers 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โ instruments memory references using the__builtin_object_sizefunction. Various out-of-bounds pointer accesses get detected โจ.-fsanitize=float-divide-by-zeroโ detects floating-point division by zero. Unlike other similar options,-fsanitize=float-divide-by-zerois not enabled by-fsanitize=undefined, because floating-point division by zero can legitimately be how you get infinities and NaNs ๐.-fsanitize=float-cast-overflowโ floating-point type to integer conversion checking. We check that the result of the conversion doesn't overflow. Unlike other similar options,-fsanitize=float-cast-overflowis not enabled by-fsanitize=undefined. Also, this option doesn't work well withFE_INVALIDexceptions enabled ๐ฅฒ.-fsanitize=nonnull-attributeโ instruments calls, checking whether null values are passed to arguments marked as requiring a non-null value by thenonnullfunction attribute ๐.-fsanitize=returns-nonnull-attributeโ instruments return statements in functions marked with thereturns_nonnullfunction attribute, to detect null values being returned from those functions.-fsanitize=boolโ instruments loads from bool. If a value other than 0/1 is loaded, you get a run-time error ๐.-fsanitize=enumโ instruments loads from an enum type. If a value outside the range of values for that enum type is loaded, run-time error โจ.-fsanitize=vptrโ instruments C++ member function calls, member accesses and some conversions between pointers to base and derived classes, to verify the referenced object has the correct dynamic type ๐ฆ.-fsanitize=pointer-overflowโ instruments pointer arithmetic. If the pointer arithmetic overflows, run-time error ๐ฅ.-fsanitize=builtinโ instruments arguments to selected builtin functions. If an invalid value is passed to such arguments, run-time error. E.g. passing 0 as the argument to__builtin_ctzor__builtin_clzinvokes undefined behavior and gets diagnosed by this option ๐.
So real talk: -ftrapv causes traps for signed overflows to be emitted, whereas -fsanitize=undefined gives a diagnostic message instead. This currently works only for the C family of languages.
-fno-sanitize=allโ disables all previously enabled sanitizers. Note that-fsanitize=allis not allowed, because some sanitizers can't 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. Each si may contain wildcards ๐.-fsanitize-recover[=opts]โ controls error recovery mode for sanitizers mentioned in the comma-separated list of opts. Enabling this for a sanitizer component makes it attempt to keep running the program as if no error happened. That 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 change this behavior: only the first detected error is reported, and then the program 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 are also accepted: the former enables recovery for all sanitizers that support it, the latter disables recovery for all sanitizers that support it โจ.
Even if recovery mode is turned on on the compiler side, it also needs to be enabled on the runtime library side, otherwise the failures are still fatal. The runtime library defaults to halt_on_error=0 for ThreadSanitizer and UndefinedBehaviorSanitizer, while the default value for AddressSanitizer is halt_on_error=1. You can override this by setting the halt_on_error flag in the corresponding environment variable ๐
.
Syntax without an explicit opts parameter is deprecated. It'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. This option sets-fstack-reusetonone๐.-fsanitize-undefined-trap-on-errorโ instructs the compiler to report undefined behavior using__builtin_traprather than alibubsanlibrary routine. The glow-up here is that thelibubsanlibrary isn't needed and isn't linked in, so this is usable even in freestanding environments ๐.-fsanitize-coverage=trace-pcโ enables coverage-guided fuzzing code instrumentation. Inserts a call to__sanitizer_cov_trace_pcinto every basic block โจ.-fsanitize-coverage=trace-cmpโ enables dataflow-guided fuzzing code instrumentation. Inserts a call to__sanitizer_cov_trace_cmp1,__sanitizer_cov_trace_cmp2,__sanitizer_cov_trace_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,__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]โ enables code instrumentation of control-flow transfers to increase program security by checking that target addresses of control-flow transfer instructions (like indirect function call, function return, indirect jump) are valid ๐ก๏ธ. This prevents diverting the flow of control to an unexpected target. It's intended to protect against threats like Return-oriented Programming (ROP), and similarly call/jmp-oriented programming (COP/JOP) ๐.
The value "branch" tells the compiler to do the validity check on control-flow transfers right at the indirect branch instructions, aka the call/jmp instructions. The value "return" does the validity checking at the point where you're returning from a function. The value "full" is just an alias for saying both "branch" and "return" at once. And the value "none" turns the whole instrumentation thing off, bye. ๐
The value "check" is for the final link with link-time optimization (LTO). If your LTO object files were compiled with different -fcf-protection values, it throws an error at you. And "check" is literally ignored at compile time, no cap.
The macro __CET__ gets defined whenever -fcf-protection is used. The first bit of __CET__ is set to 1 for the "branch" value, and the second bit of __CET__ is set to 1 for the "return". Bit manipulation girlies, that one's for you. ๐ง
You can also use the nocf_check attribute to point out exactly which functions and calls should be skipped from instrumentation. iykyk.
Currently the x86 GNU/Linux target provides an implementation based on Intel Control-flow Enforcement Technology (CET) which works for i686 processor or newer. ๐ฆ
NOTE: In Ubuntu 19.10 and later versions,-fcf-protectionis enabled by default for C, C++, ObjC, ObjC++, if none of-fno-cf-protectionnor-fcf-protection=*are found.
-fstack-protectorโ bestie, this emits extra code to check for buffer overflows, like stack smashing attacks. How? By adding a guard variable to functions that have vulnerable objects. That includes functions that callalloca, and functions with buffers larger than 8 bytes. The guards get initialized when a function is entered and then checked when the function exits. If a guard check fails? An error message is printed and the program exits. periodt. ๐-fstack-protector-allโ same as-fstack-protectorexcept that all functions are protected. all of them. every single one. ๐ค-fstack-protector-strongโ like-fstack-protectorbut it includes extra functions to be protected --- specifically those that have local array definitions, or that have references to local frame addresses. it's giving thorough. โจ-fstack-protector-explicitโ like-fstack-protectorbut it only protects those functions which have thestack_protectattribute. picky queen behavior, and we respect it. ๐-fstack-checkโ generates code to verify that you don't go beyond the boundary of the stack. You should specify this flag if you're running in an environment with multiple threads, but honestly 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. ๐ธ
Okay so real talk: this switch does not actually cause checking to be done. The operating system or the language runtime has to do that. The switch just 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, and specific means use the best checking method and is equivalent to bare -fstack-check.
Old-style checking is a generic mechanism that needs no specific target support in the compiler, but bestie it comes with the following 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 is not 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. it's giving slow. ๐
Note that old-style stack checking is also the fallback method for specific if no target support has been added in the compiler.
-fstack-check= is designed for Ada's needs to detect infinite recursion and stack overflows. specific is an excellent choice when compiling Ada code. It is not generally sufficient to protect against stack-clash attacks though. To protect against those you want -fstack-clash-protection.
-fstack-clash-protectionโ generates code to prevent stack clash style attacks. When this option is enabled, the compiler will only allocate one page of stack space at a time, and each page is accessed immediately after allocation. So it prevents allocations from jumping over any stack guard page provided by the operating system. no jumping. not today. ๐ซ
Most targets don't fully support stack clash protection. However, on those targets -fstack-clash-protection will protect dynamic stack allocations. -fstack-clash-protection may also provide limited protection for static stack allocations if the target supports -fstack-check=specific.
NOTE: In Ubuntu 19.10 and later versions,-fstack-clash-protectionis enabled by default for C, C++, ObjC, ObjC++, unless-fno-stack-clash-protectionis found.
-fstack-limit-register=reg-fstack-limit-symbol=sym-fno-stack-limitโ these generate code to make sure the stack doesn't grow beyond a certain value, either the value of a register or the address of a symbol. If a larger stack is required, a signal is raised at run time. For most targets, the signal is raised before the stack overruns the boundary, so it's possible to catch the signal without taking special precautions. ๐
For instance, if the stack starts at absolute address 0x80000000 and grows downwards, you can use the flags -fstack-limit-symbol=__stack_limit and -Wl,--defsym,__stack_limit=0x7ffe0000 to enforce a stack limit of 128KB. Note that this may only work with the GNU linker. ๐ค
You can locally override stack limit checking by using the no_stack_limit function attribute.
-fsplit-stackโ generates code to automatically split the stack before it overflows. The resulting program has a discontiguous stack which can only overflow if the program is unable to allocate any more memory. This is most useful when running threaded programs, since it's no longer necessary to calculate a good stack size to use for each thread. This is currently only implemented for the x86 targets running GNU/Linux. ๐ง
When code compiled with -fsplit-stack calls code compiled without -fsplit-stack, there may not be much stack space available for the latter code to run. If compiling all code, including library code, with -fsplit-stack 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. slay. โจ
-fvtable-verify=[std|preinit|none]โ this option is only available when compiling C++ code. It turns on (or off, if you're using-fvtable-verify=none) the security feature that verifies at run time, for every virtual call, that the vtable pointer through which the call is made is valid for the type of the object, and hasn't been corrupted or overwritten. If an invalid vtable pointer is detected at run time, an error is reported and execution of the program is immediately halted. caught in 4k. ๐ธ
This option causes run-time data structures to be built at program startup, which are used for verifying the vtable pointers. The options std and preinit control the timing of when these data structures are built. In both cases the data structures are built before execution reaches main. Using -fvtable-verify=std causes the data structures to be built after shared libraries have been loaded and initialized. -fvtable-verify=preinit causes them to be built before shared libraries have been loaded and initialized. โฐ
If this option appears multiple times in the command line with different values specified, none takes highest priority over both std and preinit; preinit takes priority over std. priority drama, but make it compiler flags. ๐
-fvtv-debugโ when used in conjunction with-fvtable-verify=stdor-fvtable-verify=preinit, this causes debug versions of the runtime functions for the vtable verification feature to be called. This flag also causes the compiler to log information about which vtable pointers it finds for each class. This information is written to a file namedvtv_set_ptr_data.login the directory named by the environment variableVTV_LOGS_DIRif that's defined, or the current working directory otherwise. ๐๏ธ
Note: This feature appends data to the log file. If you want a fresh log file, be sure to delete any existing one.
-fvtv-countsโ this is a debugging flag. When used in conjunction with-fvtable-verify=stdor-fvtable-verify=preinit, this causes the compiler to keep track of the total number of virtual calls it encounters and the number of verifications it inserts. It also counts the number of calls to certain run-time library functions that it inserts and logs this information for each compilation unit. The compiler writes this information to a file namedvtv_count_data.login the directory named by the environment variableVTV_LOGS_DIRif that's defined, or the current working directory otherwise. It also counts the size of the vtable pointer sets for each class, and writes this information tovtv_class_set_sizes.login the same directory. ๐
Note: This feature appends data to the log files. To get fresh log files, be sure to delete any existing ones.
-finstrument-functionsโ generates instrumentation calls for entry and exit to functions. Just after function entry and just before function exit, the following profiling functions are 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 information may not be available to the profiling functions otherwise.) ๐ฏ
void __cyg_profile_func_enter (void *this_fn,
void *call_site);
void __cyg_profile_func_exit (void *this_fn,
void *call_site);
The first argument is the address of the start of the current function, which may be looked up exactly in the symbol table. ๐ซถ
okay so this instrumentation also happens for functions that get expanded inline inside other functions ๐ the profiling calls literally show where โ conceptually โ the inline function gets entered and exited. Which means addressable versions of those functions have to exist. And if all your uses of a function get expanded inline, that can mean extra code size on top, no cap. Also, if you use extern inline in your C code, an addressable version of such functions must be provided. (That's normally the case anyway, but if you get lucky and the optimizer always expands the functions inline, you might have gotten away without providing static copies. lucky you ๐)
A function can also be given the attribute no_instrument_function, and then this instrumentation just... doesn't happen, periodt. Use it for the profiling functions listed above, for high-priority interrupt routines, and for any functions the profiling functions can't safely be called from (maybe signal handlers, if the profiling routines generate output or allocate memory ๐).
-finstrument-functions-exclude-file-list=file,file,...
Sets the list of functions that are excluded from instrumentation (peep the description of -finstrument-functions for context). If the file that contains a function definition matches one of file, then that function is not instrumented. The match is done on substrings: if the file parameter is a substring of the file name, it counts as a match. iykyk โจ
For example:
-finstrument-functions-exclude-file-list=/bits/stl,include/sys
excludes any inline function defined in files whose pathnames contain /bits/stl or include/sys.
If, for some reason, you want to include letter , in one of sym, write ,. For example, -finstrument-functions-exclude-file-list=',,tmp' (note the single quote surrounding the option) ๐
-finstrument-functions-exclude-function-list=sym,sym,...
This one's similar to -finstrument-functions-exclude-file-list, except it sets the list of function names to be excluded from instrumentation. The function name being matched is its user-visible name, like "vector<int> blah(const vector<int> &)", not the internal mangled name (e.g., "_Z4blahRSt6vectorIiSaIiEE"). Match is done on substrings: if the sym parameter is a substring of the function name, it's a match. And for C99 and C++ extended identifiers, the function name must be given in UTF-8, not using universal character names ๐ธ
-fpatchable-function-entry=N[,M]
Generates N NOPs right at the beginning of each function, with the function entry point before the *M*th NOP. If M is omitted, it defaults to 0, so the function entry points to the address just at the first NOP. Those NOP instructions reserve extra space you can use 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 interface gen_nop. This behavior is target-specific and may also depend on the architecture variant and/or other compilation options, so don't @ me ๐
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. Use it to increase the area size or to remove it completely on a single function. IfN=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.
โจ Options Controlling the Preprocessor โจ
These options control the C preprocessor, which is run on each C source file before actual compilation. main character energy tbh ๐ฆ
If you use the -E option, nothing is done except preprocessing. Some of these options make sense only together with -E, because they cause the preprocessor output to be unsuitable for actual compilation.
In addition to the options listed here, there are a bunch of options controlling search paths for include files, documented in Directory Options. Options controlling preprocessor diagnostics are listed in Warning Options.
-D name
Predefine name as a macro, with definition 1. simple as that ๐ซถ
-D name=definition
The contents of definition are tokenized and processed as if they appeared during translation phase three in a #define directive. In particular, the definition is truncated by embedded newline characters ๐ญ
If you're invoking the preprocessor from a shell or shell-like program, you may need to use the shell's quoting syntax to protect characters like spaces that 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 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. periodt.
-U name
Cancel any previous definition of name, whether it was built in or provided with a -D option. bye bye macro ๐
-include file
Process file as if #include "file" appeared as the first line of the primary source file. However, the first directory searched for file is the preprocessor's working directory instead of the directory containing the main source file. If it's not found there, it gets searched for in the remainder of the #include "..." search chain as normal.
If multiple -include options are given, the files are included in the order they appear on the command line. order matters bestie โจ
-imacros file
Exactly like -include, except that any output produced by scanning file is thrown away. The macros it defines remain defined though. This lets you acquire all the macros from a header without also processing its declarations. iconic tbh ๐
All files specified by -imacros are processed before all files specified by -include.
-undef
Do not predefine any system-specific or GCC-specific macros. The standard predefined macros remain defined ๐ธ
-pthread
Define additional macros required for using the POSIX threads library. You should use this option consistently for both compilation and linking, fr fr. This option is supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets ๐ง
-M
Instead of outputting the result of preprocessing, output a rule suitable for make describing the dependencies of the main source file. The preprocessor outputs one make rule containing the object file name for that source file, a colon, and the names of all the included files โ including those coming from -include or -imacros command-line options.
Unless specified explicitly (with -MT or -MQ), the object file name consists of the name of the source file with any suffix replaced with the object file suffix and with any leading directory parts removed. If there are many included files, the rule is split into several lines using \-newline. The rule has no commands.
This option does not suppress the preprocessor's debug output, such as -dM. To avoid mixing such debug output with the dependency rules, you should explicitly specify the dependency output file with -MF, or use an environment variable like DEPENDENCIES_OUTPUT. Debug output is still sent to the regular output stream as normal.
Passing-Mto the driver implies-E, and suppresses warnings with an implicit-w. ๐
-MM
Like -M but it does not mention header files that are found in system header directories, nor header files that are included, directly or indirectly, from such a header.
This implies that the choice of angle brackets or double quotes in an #include directive does not in itself determine whether that header appears in -MM dependency output. sneaky ๐
-MF file
When used with -M or -MM, specifies a file to write the dependencies to. If no -MF switch is given, the preprocessor sends the rules to the same place it would send preprocessed output.
When used with the driver options -MD or -MMD, -MF overrides the default dependency output file.
If file is -, then the dependencies are written to stdout โญ
-MG
In conjunction with an option such as -M requesting dependency generation, -MG assumes missing header files are generated files and adds them to the dependency list without raising an error. The dependency filename is taken directly from the #include directive without prepending any path. -MG also suppresses preprocessed output, since a missing header file renders this useless.
This feature is used in automatic updating of makefiles ๐
-MP
This option instructs CPP to add a phony target for each dependency other than the main file, causing each to depend on nothing. These dummy rules work around errors make gives if you remove header files without updating the Makefile to match. lifesaver tbh ๐ซถ
This is typical output:
test.o: test.c test.h
test.h:
-MT target
Change the target of the rule emitted by dependency generation. By default CPP takes the name of the main input file, deletes any directory components and any file suffix such as .c, and appends the platform's usual object suffix. That result is the target.
An -MT option sets the target to be exactly the string you specify. If you want multiple targets, you can specify them as a single argument to -MT, or use multiple -MT options.
For example, -MT '$(objpfx)foo.o' might give
$(objpfx)foo.o: foo.c
-MQ target
Same as -MT, but it quotes any characters which are special to make. So -MQ '$(objpfx)foo.o' gives
$$(objpfx)foo.o: foo.c
The default target is automatically quoted, as if it were given with -MQ โจ
-MDโ okay so-MDis literally-M -MF file, except it does not imply-E. Bestie, the driver picks file based on whether you gave it an-o. If you did? It takes that argument but slaps a.dsuffix on it. If you didn't? It takes the name of the input file, yeets any directory components and the suffix, then applies a.dsuffix. โจ
And here's the plot twist ๐ if -MD shows up alongside -E, any -o switch is understood to mean the dependency output file โ but if you use it without -E, each -o means a target object file. Since -E is not implied, -MD can generate a dependency output file as a side effect of the compilation process. main character behavior fr ๐
-MMDโ same energy as-MDexcept it only mentions user header files, not system header files. ๐-fpreprocessedโ tells the preprocessor the input file has already been preprocessed. This suppresses things like macro expansion, trigraph conversion, escaped newline splicing, and processing of most directives. It still recognizes and removes comments though, 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. Those are the extensions GCC uses for preprocessed files created by -save-temps.
-fdirectives-onlyโ when preprocessing, handle directives but do not expand macros. The option's behavior depends on the-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 -dD option is implicitly enabled.
With -fpreprocessed, predefinition of command line and most builtin macros is disabled. Macros such as __LINE__, which are contextually dependent, are handled normally. This enables compilation of files previously preprocessed with -E -fdirectives-only.
With both -E and -fpreprocessed, the rules for -fpreprocessed take precedence. This enables full preprocessing of files previously preprocessed with -E -fdirectives-only. ๐ซ
-fdollars-in-identifiersโ accept$in identifiers. ๐ฐ-fextended-identifiersโ accept universal character names in identifiers. This option is enabled by default for C99 (and later C standard versions) and C++. ๐-fno-canonical-system-headersโ when preprocessing, do not shorten system header paths with canonicalization. ๐ฆ-ftabstop=widthโ set the distance between tab stops. This helps the preprocessor report correct column numbers in warnings or errors, even if tabs appear on the line. If the value is less than1or greater than100, the option is ignored. The default is8. ๐-ftrack-macro-expansion[=level]โ track 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. ๐ญ
The level parameter chooses the level of precision of token location tracking, thus decreasing the memory consumption if necessary. Value 0 of level de-activates this option. Value 1 tracks 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 2 tracks token locations completely, and this value is the most memory hungry. When this option is given no argument, the default parameter value is 2.
Note that -ftrack-macro-expansion=2 is activated by default.
-fmacro-prefix-map=old=newโ when preprocessing files residing in directory old, expand the__FILE__and__BASE_FILE__macros as if the files resided in directory new instead. This can be used to change an absolute path to a relative path by using.for new, which can result in more reproducible builds that are location independent. This option also affects__builtin_FILE()during compilation. See also-ffile-prefix-map. ๐บ๏ธ-fexec-charset=charsetโ set 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. ๐ค-fwide-exec-charset=charsetโ set the wide execution character set, used for wide string and character constants. The default isUTF-32orUTF-16, whichever corresponds to the width ofwchar_t. As with-fexec-charset, charset can be any encoding supported by the system'siconvlibrary routine; however, you will have problems with encodings that do not fit exactly inwchar_t. ๐-finput-charset=charsetโ set the input character set, used for translation from the character set of the input file to the source character set used by GCC. If the locale does not specify, or GCC cannot get this information from the locale, the default isUTF-8. This can be overridden by either the locale or this command-line option. Currently the command-line option takes precedence if there's a conflict. charset can be any encoding supported by the system'siconvlibrary routine. ๐ธ-fpch-depsโ when using precompiled headers, this flag causes the dependency-output flags to also list the files from the precompiled header's dependencies. If not specified, only the precompiled header is listed and not the files that were used to create it, because those files are not consulted when a precompiled header is used. ๐ฆ-fpch-preprocessโ this option allows use of a precompiled header together with-E. It inserts a special#pragma,#pragma GCC pch_preprocess "filename", in the output to mark the place where the precompiled header was found, and 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 is switched on by -save-temps.
You should not write this #pragma in your own code, but it is safe to edit the filename if the PCH file is available in a different location. The filename may be absolute or it may be relative to GCC's current directory. ๐
-fworking-directoryโ enable generation of linemarkers in the preprocessor output that let the compiler know the current working directory at the time of preprocessing. When this option is enabled, the preprocessor emits, after the initial linemarker, a second linemarker with the current working directory followed by two slashes. GCC uses this directory, when it's present in the preprocessed input, as the directory emitted as the current working directory in some debugging information formats.
This option is implicitly enabled if debugging information is enabled, but this can be inhibited with the negated form -fno-working-directory. If the -P flag is present in the command line, this option has no effect, since no #line directives are emitted whatsoever. ๐
-A predicate=answerโ make an assertion with the predicate predicate and answer answer. This form is preferred to the older form-A predicate(answer), which is still supported, because it does not use shell special characters. ๐ซถ-A -predicate=answerโ cancel an assertion with the predicate predicate and answer answer. ๐ซ-Cโ do not discard comments. All comments are passed through to the output file, except for comments in processed directives, which are deleted along with the directive.
You should 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โ do not discard comments, including during macro expansion. This is like-C, except that comments contained within macros are also passed through to the output file where the macro is expanded.
In addition to the side effects of the -C option, the -CC option causes all C++-style comments inside a macro to be converted to C-style comments. This is to prevent later use of that macro from inadvertently commenting out the remainder of the source line.
The -CC option is generally used to support lint comments. ๐ฌ
-Pโ inhibit generation of linemarkers in the output from the preprocessor. This might be useful when running the preprocessor on something that is not C code, and will be sent to a program which might be confused by the linemarkers. ๐ซโจ-traditional-traditional-cppโ try to imitate the behavior of pre-standard C preprocessors, as opposed to ISO C preprocessors. See the GNU CPP manual for 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โ support ISO C trigraphs. These are three-character sequences, all starting with??, that are defined by ISO C to stand for single characters. For example,??/stands for\, so'??/n'is a character constant for a newline. ๐ต๐ซ
The nine trigraphs and their replacements are
Trigraph: ??( ??) ??< ??> ??= ??/ ??' ??! ??-
Replacement: [ ] { } # \ ^ | ~
By default, GCC ignores trigraphs, but in standard-conforming modes it converts them. See the -std and -ansi options. ๐ฅ
-remapโ enable special code to work around file systems which only permit very short file names, such as MS-DOS. ๐น๏ธ-Hโ print the name of each header file used, in addition to other normal activities. Each name is indented to show how deep in the#includestack it is. Precompiled header files are also printed, even if they are found to be invalid; an invalid precompiled header file is printed with...xand a valid one with...!. ๐
-dlettersโ bestie, this one says "make debugging dumps during compilation" and letters is you picking which ones ๐ . The flags documented right here are the ones that matter to the preprocessor. Other letters get interpreted by the compiler proper, or they're reserved for future versions of GCC, so they're just silently ignored (rude, but ok). And if you specify letters whose behavior conflicts? the result is undefined. No cap. ๐ซ-dMโ instead of the normal output, it generates a list of#definedirectives for all the macros defined during the execution of the preprocessor, predefined macros included. Basically it's your little detective for finding out what's predefined in your version of the preprocessor. Assuming you have no filefoo.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. (iykyk)
-dDโ like-dMexcept in two respects: it does not include the predefined macros, and it outputs both the#definedirectives and the result of preprocessing. Both kinds of output go to the standard output file. ๐-dNโ like-dD, but it emits only the macro names, not their expansions.-dIโ outputs#includedirectives in addition to the result of preprocessing.-dUโ like-dDexcept that only macros that are expanded, or whose definedness is tested in preprocessor directives, are output; the output is delayed until the use or test of the macro; and#undefdirectives are also output for macros tested but undefined at the time.
-fdebug-cppโ this one is only useful for debugging GCC itself. When you use it from CPP or with-E, it dumps debugging information about location maps, and every token in the output is preceded by the dump of the map its location belongs to. ๐บ๏ธ
When used from GCC without -E, this option has no effect.
-Wp,optionโ you can use-Wp,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. But heads up bestie: a lot of options get modified, translated or interpreted by the compiler driver before they reach the preprocessor, and-Wpforcibly bypasses that whole 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. ๐-Xpreprocessor optionโ passes option as an option to the preprocessor. Use this when you gotta 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โ performs preprocessing as a separate pass before compilation. By default, GCC does 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 one may be useful with the-Bor-wrapperoptions to specify an alternate preprocessor or do additional processing of the program source between normal preprocessing and compilation. ๐ฆ
Passing Options to the Assembler ๐
You can pass options to the assembler, bestie.
-Wa,optionโ passes option as an option to the assembler. If option contains commas, it gets split into multiple options at the commas.-Xassembler optionโ passes option as an option to the assembler. 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. They are meaningless if the compiler is not doing a link step.
- object-file-name โ a file name that does not end in a special recognized suffix is considered to name an object file or library. (Object files are distinguished from libraries by the linker according to the file contents.) If linking is done, these object files are used as input to the linker.
-c,-S,-Eโ if any of these options is used, then the linker is not run, and object file names should not be used as arguments.-flinker-output=typeโ this option controls the code generation of the link time optimizer. By default the linker output is determined by the linker plugin automatically. For debugging the compiler and in the case of incremental linking to non-lto object file is desired, it may be useful to control the type manually.- If type is
execthe code generation is configured to produce static binary. In this case-fpicand-fpieare both disabled. - If type is
dynthe code generation is configured to produce shared library. In this case-fpicor-fPICis preserved, but not enabled automatically. This makes it possible to build shared libraries without position independent code on architectures this is possible, i.e. on x86. - If type is
piethe code generation is configured to produce-fpieexecutable. This result in similar optimizations asexecexcept that-fpieis not disabled if specified at compilation time. - If type is
relthe compiler assumes that incremental linking is done. The sections containing intermediate code for link-time optimization are merged, pre-optimized, and output to the resulting object file. In addition, if-ffat-lto-objectsis specified the binary code is produced for future non-lto linking. The object file produced by incremental linking will be smaller than a static library produced from the same object files. At link-time the result of incremental linking will also load faster to compiler than a static library assuming that majority of objects in the library are used. - Finally
nolto-relconfigure compiler to for incremental linking where code generation is forced, 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 will be optimized better than with link time optimizations disabled (for example, the cross-module inlining will happen), most of benefits of whole program optimizations are however lost.
- If type is
During the incremental link (by -r) the linker plugin will default to rel. With current interfaces to GNU Binutils it is however not possible to link incrementally LTO objects and non-LTO objects into a single mixed object file. In the case any of object files in incremental link cannot be used for link-time optimization the linker plugin will output warning and use nolto-rel. To maintain the whole program optimization it is recommended to link such objects into static library instead. Alternatively it is possible to use H.J. Lu's binutils with support for mixed objects.
-fuse-ld=bfdโ use the bfd linker instead of the default linker.-fuse-ld=goldโ use the gold linker instead of the default linker.-fuse-ld=lldโ use the LLVM lld linker instead of the default linker.-llibrary,-l libraryโ searches 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.)
The -l option is passed directly to the linker by GCC. Refer to your linker documentation for exact details. The general description below applies to the GNU linker.
The linker searches a standard list of directories for the library. The directories searched include several standard system directories plus any that you specify with -L.
Static libraries are archives of object files, and have file names like liblibrary.a. Some targets also support shared libraries, which typically have names like liblibrary.so. If both static and shared libraries are found, the linker gives preference to linking with the shared library unless the -static option is used.
It makes a difference where in the command you write this option; the linker searches and processes libraries and object files in the order they are specified. Thus, foo.o -lz bar.o searches library z after file foo.o but before bar.o. If bar.o refers to functions in z, those functions may not be loaded. ๐ญ
-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.
The compiler may generate calls to memcmp, memset, memcpy and memmove. These entries are usually resolved by entries in libc. These entry points should be supplied through some other mechanism when this option is specified.
-nolibcโ do not use the C library or system libraries tightly coupled with it when linking. Still link with the startup files, libgcc or toolchain provided language support libraries such as libgnat, libgfortran or libstdc++ unless options preventing their inclusion are used as well. This typically removes-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โ 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.
The compiler may generate calls to memcmp, memset, memcpy and memmove. Bestie these entries are usually resolved by entries in libc โ so when you specify this option, you've gotta supply those entry points through some other mechanism. No cap. ๐
One of the standard libraries bypassed by -nostdlib and -nodefaultlibs is libgcc.a โ a library of internal subroutines that GCC uses to overcome shortcomings of particular machines, or special needs for some languages. ๐
In most cases, you need libgcc.a even when you 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.) ๐ซถ
-e entry,--entry=entryโ 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. main character entry point energy โจ-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. the anti-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. threads bestie, use it consistently fr fr-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. backtrace slay-sโ remove all symbol table and relocation information from the executable. gone. deleted. stripped. periodt. ๐-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โ 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. ๐ญ
Therefore, the G++ driver automatically adds -shared-libgcc whenever you build a shared library or a main executable, because C++ programs typically use exceptions, so this is the right thing to do. it's giving correct behavior ๐
If, instead, you use the GCC driver to create shared libraries, you may find that they are not always linked with the shared libgcc. If GCC finds, at its configuration time, that you have a non-GNU linker or a GNU linker that does not support option --eh-frame-hdr, it links the shared version of libgcc into shared libraries by default. Otherwise, it takes advantage of the linker and optimizes away the linking with the shared version of libgcc, linking with the static version of libgcc by default. This allows exceptions to propagate through such shared libraries, without incurring relocation costs at library load time.
However, if a library or main executable is supposed to throw or catch exceptions, you must link it using the G++ driver, or using the option -shared-libgcc, such that it is linked with the shared libgcc. don't skip this one bestie
-static-libasanโ when the-fsanitize=addressoption is used to link a program, the GCC driver automatically links against libasan. If libasan is available as a shared library, and the-staticoption is not used, then this links against the shared version of libasan. The-static-libasanoption directs the GCC driver to link libasan statically, without necessarily linking other libraries statically. ๐ฆ-static-libtsanโ when the-fsanitize=threadoption is used to link a program, the GCC driver automatically links against libtsan. If libtsan is available as a shared library, and the-staticoption is not used, then this links against the shared version of libtsan. The-static-libtsanoption directs the GCC driver to link libtsan statically, without necessarily linking other libraries statically. ๐ง-static-liblsanโ when the-fsanitize=leakoption is used to link a program, the GCC driver automatically links against liblsan. If liblsan is available as a shared library, and the-staticoption is not used, then this links against the shared version of liblsan. The-static-liblsanoption directs the GCC driver to link liblsan statically, without necessarily linking other libraries statically. ๐-static-libubsanโ when the-fsanitize=undefinedoption is used to link a program, the GCC driver automatically links against libubsan. If libubsan is available as a shared library, and the-staticoption is not used, then this links against the shared version of libubsan. The-static-libubsanoption directs the GCC driver to link libubsan statically, without necessarily linking other libraries statically. โจ-static-libstdc++โ when the g++ program is used to link a C++ program, it normally automatically links against libstdc++. If libstdc++ is available as a shared library, and the-staticoption is not used, then this links against the shared version of libstdc++. That is normally fine. However, it is sometimes useful to freeze the version of libstdc++ used by the program without going all the way to a fully static link. The-static-libstdc++option directs the g++ driver to link libstdc++ statically, without necessarily linking other libraries statically. freeze the vibe ๐ง-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. rare + exclusive ๐-T scriptโ use script as the linker script. This option is supported by most systems using the GNU linker. On some targets, such as bare-board targets without an operating system, the-Toption may be required when linking to avoid references to undefined symbols. ๐ฅ-Xlinker optionโ pass option as an option to the linker. You can use this to supply system-specific linker options that GCC does not recognize.
If you want to pass an option that takes a separate argument, you must use -Xlinker twice, once for the option and once for the argument. For example, to pass -assert definitions, you must write -Xlinker -assert -Xlinker definitions. It does not work to write -Xlinker "-assert definitions", because this passes the entire string as a single argument, which is not what the linker expects. do NOT do that, it's a trap ๐
When using the GNU linker, it is usually more convenient to pass arguments to linker options using the option=value syntax than as separate arguments. For example, you can specify -Xlinker -Map=output.map rather than -Xlinker -Map -Xlinker output.map. Other linkers may not support this syntax for command-line options.
-Wl,optionโ 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. ๐ธ
NOTE: In Ubuntu 8.10 and later versions, for LDFLAGS, the option-Wl,-z,relrois used. To disable, use-Wl,-z,norelro.
-u symbolโ 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. manifesting symbols into existence โจ-z keywordโ-zis passed directly on to the linker along with the keyword keyword. See the section in the documentation of your linker for permitted values and their meanings. go read your linker's docs bestie, iykyk
๐ธ Options for Directory Search ๐ธ
These options specify directories to search for header files, for libraries and for parts of the compiler. the treasure map of include paths ๐บ๏ธ
-I dir,-iquote dir,-isystem dir,-idirafter dirโ add the directory dir to the list of directories to be searched for header files during preprocessing. If dir begins with=or$SYSROOT, then the=or$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 you gave with
-iquoteget searched in left-to-right order, exactly as they appeared on the command line. order matters, bestie - Directories specified with
-Ioptions get scanned in left-to-right order. - Directories specified with
-isystemoptions get scanned in left-to-right order. - Standard system directories get scanned.
- Directories specified with
-idirafteroptions get scanned in left-to-right order.
Okay so you can use -I to override a system header file and swap in your own version, because these directories get searched before the standard system header file directories. slay, custom headers But โ and this is the part where people mess up โ you should not use this option to add directories that contain vendor-supplied system header files. Use -isystem for that. Periodt.
The -isystem and -idirafter options also mark the directory as a system directory, so it gets the exact same special treatment that gets applied to the standard system directories. ๐
And if a standard system include directory, or a directory specified with -isystem, is also specified with -I, then the -I option is ignored. The directory is still searched โ but as a system directory, at its normal position in the system include chain. Why tho? To ensure that GCC's procedure to fix buggy system headers and the ordering for the "#include_next" directive are not inadvertently changed. If you really need to change the search order for system directories, use the -nostdinc and/or -isystem options. ๐ซถ
-I-โ Split the include path. This option has been deprecated. Please use-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 you add extra directories with -I options after the -I-, those directories are searched for all #include directives.
Also, -I- inhibits the use of the directory of the current file as the first search directory for "#include "file"". And there is no way to override this effect of -I-. no take-backs, no loopholes
-iprefixprefix โ Specify prefix as the prefix for subsequent-iwithprefixoptions. If the prefix represents a directory, you should include the final/. (yes, literally the slash, don't forget it ๐)-iwithprefixdir,-iwithprefixbeforedir โ 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.-isysrootdir โ This option is like the--sysrootoption, but it applies only to header files (except for Darwin targets, where it applies to both header files and libraries). See the--sysrootoption for more information. ๐-imultilibdir โ Use dir as a subdirectory of the directory containing target-specific C++ headers.-nostdincโ 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. that's the whole list, nothing else gets a look-in-nostdinc++โ Do not search for header files in the C++-specific standard directories, but do still search the other standard directories. (This option is used when building the C++ library.)- *
-iplugindir=dir* โ Set the directory to search for plugins that are passed by-fplugin=nameinstead of-fplugin=path/name.so. Heads up tho: this option is not meant to be used by the user, but only passed by the driver. -Ldirโ Add directory dir to the list of directories to be searched for-l.-Bprefixโ This option specifies where to find the executables, libraries, include files, and data files of the compiler itself. ๐
The compiler driver program runs one or more of the subprograms cpp, cc1, as and ld. It tries prefix as a prefix for each program it tries to run, both with and without machine/version/ for the corresponding target machine and compiler version.
For each subprogram to be run, the compiler driver first tries the -B prefix, if any. If that name 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.
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.
-B prefixes that effectively specify directory names also apply to libraries in the linker, because the compiler translates these options into -L options for the linker. They also apply to include files in the preprocessor, because the compiler translates these options into -isystem options for the preprocessor. In this case, the compiler appends include to the prefix.
The runtime support file libgcc.a can also be searched for using the -B prefix, if needed. If it is not found there, the two standard prefixes above are tried, and that is all. The file is left out of the link if it is not found by those means. ๐
Another way to specify a prefix much like the -B prefix is to use the environment variable GCC_EXEC_PREFIX.
As a special kludge, if the path provided by -B is [dir/]stageN/, where N is a number in the range 0 to 9, then it is replaced by [dir/]include. This is to help with boot-strapping the compiler.
-no-canonical-prefixesโ Do not expand any symbolic links, resolve references to/../or/./, or make the path absolute when generating a relative prefix.- *
--sysroot=dir* โ Use dir as 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. ๐
If you use both this option and the -isysroot option, then the --sysroot option applies to libraries, but the -isysroot option applies to header files.
The GNU linker (beginning with version 2.16) has the necessary support for this option. If your linker does not support this option, the header file aspect of --sysroot still works, but the library aspect does not. ๐ญ
--no-sysroot-suffixโ For some targets, a suffix 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.
๐ ๏ธ Options for Code Generation Conventions ๐ ๏ธ
These machine-independent options control the interface conventions used in code generation. vibe check for your calling conventions
Most of them have both positive and negative forms; the negative form of -ffoo is -fno-foo. In the table below, only one of the forms is listed โ the one that is not the default. You can figure out the other form by either removing no- or adding it. ๐
- *
-fstack-reuse=reuse-level* โ This option controls stack space reuse for user declared local/auto variables and compiler generated temporaries. reuse_level can 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. The option is needed when the program extends the lifetime of a scoped local variable or a compiler generated temporary beyond the end point defined by the language. When a lifetime of a variable ends, and if the variable lives in memory, the optimizing compiler has the freedom to reuse its stack space with other temporaries or scoped local variables whose live range does not overlap with it. Legacy code extending local lifetime is likely to break with the stack reuse optimization.
For example,
int *p;
{
int local1;
p = &local1;
local1 = 10;
....
}
{
int local2;
local2 = 20;
...
}
if (*p == 10) // out of scope use of local1
{
}
Another example:
struct A
{
A(int k) : i(k), j(k) { }
int i;
int j;
};
A *ap;
void foo(const A& ar)
{
ap = &ar;
}
void bar()
{
foo(A(10)); // temp object's lifetime ends when foo returns
{
A a(20);
....
}
ap->i+= 10; // ap references out of scope temp whose space
// is reused with a. What is the value of ap->i?
}
The lifetime of a compiler generated temporary is well defined by the C++ standard. When a lifetime of a temporary ends, and if the temporary lives in memory, the optimizing compiler has the freedom to reuse its stack space with other temporaries or scoped local variables whose live range does not overlap with it. However some of the legacy code relies on the behavior of older compilers in which temporaries' stack space is not reused, the aggressive stack reuse can lead to runtime errors. This option is used to control the temporary stack reuse optimization.
-ftrapvโ This option generates traps for signed overflow on addition, subtraction, multiplication operations. The options-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. last one standing wins, bestie-fwrapvโ bestie, this tells the compiler to assume that signed arithmetic overflow from+,-, and*just wraps around using twos-complement representation. ๐ซ This flag turns some optimizations on and others off. And heads up:-ftrapvand-fwrapvoverride each other, so if you do-ftrapv -fwrapvon the command line,-fwrapvis what's actually in charge. Also important: only active options override, so-ftrapv -fwrapv -fno-wrapvon the command line means-ftrapvwins. the way these flags just pass the crown around ๐-fwrapv-pointerโ this one is like-fwrapvbut for pointers, telling the compiler to assume that pointer arithmetic overflow on addition and subtraction wraps around using twos-complement representation. This flag disables some optimizations that assume pointer overflow is invalid. ๐ฆ-fstrict-overflowโ this option implies-fno-wrapv -fno-wrapv-pointer, and when you negate it, it implies-fwrapv -fwrapv-pointer. so it's basically the whole vibe shift in one flag โจ-fexceptionsโ enable exception handling, bestie! ๐ It generates the extra code you need to propagate exceptions. For some targets this implies GCC generates frame unwind information for all functions, which can produce significant data size overhead, although it does not affect execution. If you don't specify this option, GCC enables it by default for languages like C++ that normally require exception handling, and disables it for languages like C that don't normally require it. But โ and this is the plot twist โ you may need to enable this option when compiling C code that needs to interoperate properly with exception handlers written in C++. You may also wish to disable this option if you're compiling older C++ programs that don't use exception handling. no cap, it's giving versatility ๐-fnon-call-exceptionsโ generate code that allows trapping instructions to throw exceptions. Note that this requires platform-specific runtime support that doesn't exist everywhere, so it's not universally iconic. 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". so dramatic, so limited ๐-fdelete-dead-exceptionsโ consider that instructions that may throw exceptions but don't otherwise contribute to the execution of the program can be optimized away. This option is enabled by default for the Ada front end, as permitted by the Ada language specification. Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels. ๐ง-funwind-tablesโ similar to-fexceptions, except that it just generates any needed static data, but does not affect the generated code in any other way. You normally do not need to enable this option; instead, a language processor that needs this handling enables it on your behalf. it's the lowkey sibling of-fexceptionsfr fr ๐ธ-fasynchronous-unwind-tablesโ generate an unwind table in DWARF format, if supported by the target machine. The table is exact at each instruction boundary, so it can be used for stack unwinding from asynchronous events (such as a debugger or garbage collector). precise queen behavior โญ-fno-gnu-uniqueโ okay so on systems with a recent GNU assembler and C library, the C++ compiler uses the"STB_GNU_UNIQUE"binding to make sure that definitions of template static data members and static local variables in inline functions are unique even in the presence of"RTLD_LOCAL". This is necessary to avoid problems with a library used by two different"RTLD_LOCAL"plugins depending on a definition in one of them and therefore disagreeing with the other one about the binding of the symbol. But ๐ญ this causes"dlclose"to be ignored for affected DSOs; if your program relies on reinitialization of a DSO via"dlclose"and"dlopen", you can use-fno-gnu-unique.-fpcc-struct-returnโ return"short""struct"and"union"values in memory like longer ones, rather than in registers. This convention is less efficient, but it has the advantage of allowing intercallability between GCC-compiled files and files compiled with other compilers, particularly the Portable C Compiler (pcc). ๐ซถ
The precise convention for returning structures in memory depends on the target configuration macros.
Short structures and unions are those whose size and alignment match that of some integer type.
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โ return"struct"and"union"values in registers when possible. This is more efficient for small structures than-fpcc-struct-return. slay efficiency ๐
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. main character decision-making honestly ๐
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โ allocate to an"enum"type only as many bytes as it needs for the declared range of possible values. Specifically, the"enum"type is equivalent to the smallest integer type that has enough room. frugal and iconic โจ
Warning: the -fshort-enums switch causes GCC to generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface. ๐
-fshort-wcharโ override the underlying type for"wchar_t"to be"short unsigned int"instead of the default for the target. This 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. ๐
-fno-commonโ in C code, this option controls the placement of global variables defined without an initializer, known as tentative definitions in the C standard. Tentative definitions are distinct from declarations of a variable with the"extern"keyword, which do not allocate storage. ๐
Unix C compilers have traditionally allocated storage for 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 is the behavior specified by -fcommon, and is the default for GCC on most targets. On the other hand, this behavior is not required by ISO C, and on some targets may carry a speed or code size penalty on variable references. ๐ญ
The -fno-common option specifies that the compiler should instead place 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 defined in more than one compilation unit. Compiling with -fno-common is useful on targets for which it provides better performance, or if you wish to verify that the program will work on other systems that always treat uninitialized variable definitions this way. periodt ๐
-fno-identโ ignore the"#ident"directive. simple. clean. iconic. ๐-finhibit-size-directiveโ don't output a".size"assembler directive, or anything else that would cause trouble if the function is split in the middle, and the two halves are placed at locations far apart in memory. This option is used when compilingcrtstuff.c; you should not need to use it for anything else. it's a very niche queen ๐ฆ-fverbose-asmโ put extra commentary information in the generated assembly code to make it more readable. This option is generally only of use to those who actually need to read the generated assembly code (perhaps while debugging the compiler itself). ๐
-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
Those comments? Yeah, they're for humans, not machines, so bestie โ the exact format of them is subject to change. Don't build your whole personality on parsing them. ๐
-frecord-gcc-switchesโ okay so this one literally snitches. It takes the command line you used to invoke the compiler and records it into the object file</> being created. Only implemented on some targets, and the exact format of the recording depends on the target and the binary file format โ but usually it's just a section holding ASCII text. Related to-fverbose-asm, except that one only writes info into the assembler output file as comments, so it never reaches the object file. Also peep-grecord-gcc-switchesfor a whole other way of stashing compiler options into the object file. ๐ซถ-fpicโ generate position-independent code (PIC) suitable for use in a shared library, if the target machine supports it. This kind of code accesses all constant addresses through a global offset table (GOT). The dynamic loader resolves the GOT entries when the program starts โ and no, the dynamic loader is not part of GCC, it's part of the operating system, bestie, don't @ me. If the GOT size for the linked executable exceeds a machine-specific maximum size, you get an error from the linker saying-fpicdoesn't work; in that case, recompile with-fPICinstead. (Those maximums are8kon the SPARC,28kon AArch64 and32kon the m68k and RS/6000. The x86 has no such limit.)
Position-independent code needs special support, so it only works on certain machines. For the x86, GCC supports PIC for System V but not for the Sun 386i. Code generated for the IBM RS/6000 is always position-independent.
When this flag is set, the macros "__pic__" and "__PIC__" are defined to 1.
-fPICโ if supported for the target machine, emit position-independent code, suitable for dynamic linking and avoiding any limit on the size of the global offset table. This option makes a difference on AArch64, m68k, PowerPC and SPARC.
Position-independent code requires special support, and therefore works only on certain machines.
When this flag is set, the macros "__pic__" and "__PIC__" are defined to 2.
-fpie-fPIEโ these are like-fpicand-fPICbut the generated position-independent code can only be linked into executables. Usually you use these to compile code that'll be linked using the-pieGCC option.
-fpie and -fPIE both define the macros "__pie__" and "__PIE__". The macros have the value 1 for -fpie and 2 for -fPIE.
-fno-pltโ do not use the PLT for external function calls in position-independent code. Instead, load the callee address at call sites from the GOT and branch to it. This gives more efficient code by eliminating PLT stubs and exposing GOT loads to optimizations. On architectures like 32-bit x86 where PLT stubs expect the GOT pointer in a specific register, this hands the compiler more register allocation freedom. Lazy binding requires use of the PLT; with-fno-pltall external symbols are resolved at load time.
Alternatively, the function attribute "noplt" can be used to avoid calls through the PLT for specific external functions.
In position-dependent code, a few targets also convert calls to functions marked to not use the PLT so they use the GOT instead. ๐
-fno-jump-tablesโ do not use jump tables forswitchstatements, even where it'd be more efficient than other code generation strategies. This one's useful alongside-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 don't require a GOT and this option isn't needed at all.-ffixed-regโ treat the register named reg as a fixed register; generated code should never refer to it (except maybe as a stack pointer, frame pointer or in some other fixed role).
reg must be the name of a register. The register names accepted are machine-specific and are defined in the "REGISTER_NAMES" macro in the machine description macro file.
This flag has no negative form, because it specifies a three-way choice. ๐
-fcall-used-regโ treat the register named reg as an allocable register that's clobbered by function calls. It may be allocated for temporaries or variables that don't live across a call. Functions compiled this way don't save and restore the register reg.
It's an error to use this flag with the frame pointer or stack pointer. Using this flag for other registers that have fixed pervasive roles in the machine's execution model produces disastrous results. ๐ญ
This flag has no 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's an error to use this flag with the frame pointer or stack pointer. Using this flag for other registers that have fixed pervasive roles in the machine's execution model produces disastrous results.
And a different sort of disaster results from using this flag for a register in which function values may be returned. ๐
This flag has no negative form, because it specifies a three-way choice.
-fpack-struct[=n]โ without a value specified, pack all structure members together with no 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 makes GCC generate code that is not binary compatible with code generated without that switch. Plus 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 helping you link with legacy assembly code.
โ ๏ธ Warning: the -fleading-underscore switch makes GCC generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface. And ngl, not all targets provide complete support for this switch.
-ftls-model=modelโ change the thread-local storage model to be used. The model argument should be one ofglobal-dynamic,local-dynamic,initial-execorlocal-exec. Heads up: the choice is subject to optimization โ the compiler may use a more efficient model for symbols not visible outside the translation unit, or if-fpicisn't given on the command line.
The default without -fpic is initial-exec; with -fpic the default is global-dynamic.
-ftrampolinesโ for targets that normally need trampolines for nested functions, always generate them instead of using descriptors. Otherwise, for targets that don't need them โ like for example HP-PA or IA-64 โ do nothing.
A trampoline is a small piece of code created at run time on the stack when the address of a nested function is taken, and it's used to call the nested function indirectly. So yeah, it requires the stack to be made executable for the program to work properly. ๐ณ
-fno-trampolines is enabled by default on a language-by-language basis, letting the compiler avoid generating them if it computes that this is safe, and replace them with descriptors instead. Descriptors are made up of data only, but the generated code must be prepared to deal with them. As of this writing, -fno-trampolines is enabled by default only for Ada.
Moreover, code compiled with -ftrampolines and code compiled with -fno-trampolines are not binary compatible if nested functions are present. So this option must be used on a program-wide basis and manipulated with extreme care. ๐ซถ
-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 can very substantially improve linking and load times of shared object libraries, produce more optimized code, provide near-perfect API export and prevent symbol clashes. It is strongly recommended that you use this in any shared objects you distribute. โจ
Despite the nomenclature, default always means public โ i.e., available to be linked against from outside the shared object. protected and internal are pretty useless in real-world usage, so the only other commonly used option is hidden. The default if -fvisibility isn't specified is default, i.e., make every symbol public.
Okay bestie, we're still deep in the -fvisibility lore and honestly? it's giving "your linker will thank you." ๐
If you want the full glow-up on why correct ELF symbol visibility is such a serve, Ulrich Drepper wrote the whole thing up in "How To Write Shared Libraries" (you can find it at <https://www.akkadia.org/drepper/>). But lowkey there's an even better move than marking stuff hidden while the default is public: flip the default to hidden and mark the things you want public as public instead. That's the norm with DLLs on Windows, and if you use -fvisibility=hidden together with "__attribute__ ((visibility("default")))" instead of "__declspec(dllexport)", you get almost identical semantics with identical syntax. Fr fr this is a whole boon to everyone doing cross-platform projects. ๐โจ
For anyone bolting visibility support onto existing code, "#pragma GCC visibility" is your girl. She works by you wrapping the declarations you wanna set visibility for with stuff like "#pragma GCC visibility push(hidden)" and "#pragma GCC visibility pop". Keep in mind: symbol visibility is part of the API interface contract, so all new code should always specify visibility when it isn't the default. Like, declarations that are only for use within the local DSO should always be explicitly marked hidden so you dodge those PLT indirection overheads โ and making it abundantly clear also helps readability and self-documentation of the code. ๐ Also heads up: because ISO C++ specification requirements say so, "operator new" and "operator delete" must always be of default visibility. No negotiating with the standard, bestie.
Be aware that headers from outside your project โ especially system headers and headers from any other library you use โ may not be expecting to be compiled with visibility other than the default. So you may need to explicitly say "#pragma GCC visibility push(default)" before you include any of those headers. ๐
Also: "extern" declarations are not affected by -fvisibility, which means a lot of code can be recompiled with -fvisibility=hidden with zero modifications. The catch? That also means calls to "extern" functions with no explicit visibility go through the PLT, so it's way more effective to use "__attribute ((visibility))" and/or "#pragma GCC visibility" to tell the compiler which "extern" declarations should be treated as hidden.
And note that -fvisibility does affect C++ vague linkage entities. So for example, an exception class that gets thrown between DSOs must be explicitly marked with default visibility, otherwise the type_info nodes won't be unified between the DSOs. ๐ญ
There's an overview of all these techniques, their benefits, and how to use them over at <http://gcc.gnu.org/wiki/Visibility>. Go read it, it eats. ๐ฅ
-fstrict-volatile-bitfieldsโ reach for this one if accesses to volatile bit-fields (or other structure fields, though 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. Picture this: 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 those targets) to force GCC to use 16-bit accesses instead of, maybe, a more efficient 32-bit access. โจ
If this option is disabled, the compiler uses the most efficient instruction. In the previous example, that might be a 32-bit load instruction โ even though that accesses bytes that don't contain any portion of the bit-field, or memory-mapped registers unrelated to the one being updated. ๐
In some cases, like when the "packed" attribute is applied to a structure field, it may not be possible to access the field with a single read or write that's correctly aligned for the target machine. When that happens, GCC falls back to generating multiple accesses rather than code that will fault or truncate the result at run time. ๐ซถ
Note: Due to restrictions of the C/C++11 memory model, write accesses are not allowed to touch non bit-field members. So it's recommended to define all bits of the field's type as bit-field members.
The default value of this option is determined by the application binary interface for the target processor.
-fsync-libcallsโ this option controls whether any out-of-line instance of the"__sync"family of functions may be used to implement the C++11"__atomic"family of functions.
The default value of this option is enabled, so the only useful form of the option is -fno-sync-libcalls. This option is used in the implementation of the libatomic runtime library. ๐ง
โจ GCC Developer Options โจ
This section is the VIP lounge: it describes command-line options that are primarily of interest to GCC developers, including options to support compiler testing and investigation of compiler bugs and compile-time performance problems. That covers options that produce debug dumps at various points in the compilation, options that print statistics such as memory use and execution time, and options that print information about GCC's configuration โ like where it searches for libraries. Real talk: you should rarely need any of these for ordinary compilation and linking tasks. ๐
Many developer options that cause GCC to dump output to a file take an optional =filename suffix. You can specify stdout or - to dump to standard output, and stderr for standard error.
If =filename is omitted, a default dump file name is constructed by concatenating the base dump file name, a pass number, a phase letter, and a pass name. The base dump file name is the name of 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. This is generally the same as the order of execution, but passes registered by plugins, target-specific passes, or passes that are otherwise registered late are numbered higher than the pass named final โ even if they're executed earlier. The phase letter is one of i (inter-procedural analysis), l (language-specific), r (RTL), or t (tree). The files are created in the directory of the output file. ๐ธ
๐ The dump options ๐
-dletters-fdump-rtl-pass-fdump-rtl-pass=filename
Says to make debugging dumps during compilation at times specified by letters. This is used for debugging the RTL-based passes of the compiler.
Some -dletters switches have different meaning when -E is used for preprocessing.
Debug dumps can be enabled with a -fdump-rtl switch or some -d option letters. Here are the possible letters for use in pass and letters, and their meanings:
-fdump-rtl-alignmentsโ dump after branch alignments have been computed. โจ-fdump-rtl-asmconsโ dump after fixing rtl statements that have unsatisfied in/out constraints.-fdump-rtl-auto_inc_decโ dump after auto-inc-dec discovery. This pass is only run on architectures that have auto inc or auto dec instructions.-fdump-rtl-barriersโ dump after cleaning up the barrier instructions.-fdump-rtl-bbpartโ dump after partitioning hot and cold basic blocks.-fdump-rtl-bbroโ dump after block reordering.-fdump-rtl-btl1-fdump-rtl-btl2โ-fdump-rtl-btl1and-fdump-rtl-btl2enable dumping after the two branch target load optimization passes.-fdump-rtl-bypassโ dump after jump bypassing and control flow optimizations.-fdump-rtl-combineโ dump after the RTL instruction combination pass.-fdump-rtl-compgotosโ dump after duplicating the computed gotos.-fdump-rtl-ce1-fdump-rtl-ce2-fdump-rtl-ce3โ-fdump-rtl-ce1,-fdump-rtl-ce2, and-fdump-rtl-ce3enable dumping after the three if conversion passes.-fdump-rtl-cprop_hardregโ dump after hard register copy propagation.-fdump-rtl-csaโ dump after combining stack adjustments.-fdump-rtl-cse1-fdump-rtl-cse2โ-fdump-rtl-cse1and-fdump-rtl-cse2enable dumping after the two common subexpression elimination passes.-fdump-rtl-dceโ dump after the standalone dead code elimination passes.-fdump-rtl-dbrโ dump after delayed branch scheduling.-fdump-rtl-dce1-fdump-rtl-dce2โ-fdump-rtl-dce1and-fdump-rtl-dce2enable dumping after the two dead store elimination passes.-fdump-rtl-ehโ dump after finalization of EH handling code.-fdump-rtl-eh_rangesโ dump after conversion of EH handling range regions.-fdump-rtl-expandโ dump after RTL generation.-fdump-rtl-fwprop1-fdump-rtl-fwprop2โ-fdump-rtl-fwprop1and-fdump-rtl-fwprop2enable dumping after the two forward propagation passes.-fdump-rtl-gcse1-fdump-rtl-gcse2โ-fdump-rtl-gcse1and-fdump-rtl-gcse2enable dumping after global common subexpression elimination.-fdump-rtl-init-regsโ dump after the initialization of the registers.-fdump-rtl-initvalsโ dump after the computation of the initial value sets.-fdump-rtl-into_cfglayoutโ dump after converting to cfglayout mode.-fdump-rtl-iraโ dump after iterated register allocation.-fdump-rtl-jumpโ dump after the second jump optimization.-fdump-rtl-loop2โ-fdump-rtl-loop2enables dumping after the rtl loop optimization passes.-fdump-rtl-machโ dump after performing the machine dependent reorganization pass, if that pass exists.-fdump-rtl-mode_swโ dump after removing redundant mode switches.-fdump-rtl-rnregโ dump after register renumbering.-fdump-rtl-outof_cfglayoutโ dump after converting from cfglayout mode.-fdump-rtl-peephole2โ dump after the peephole pass.-fdump-rtl-postreloadโ dump after post-reload optimizations.-fdump-rtl-pro_and_epilogueโ dump after generating the function prologues and epilogues.-fdump-rtl-sched1-fdump-rtl-sched2โ-fdump-rtl-sched1and-fdump-rtl-sched2enable dumping after the basic block scheduling passes.-fdump-rtl-reeโ dump after sign/zero extension elimination.-fdump-rtl-seqabstrโ dump after common sequence discovery.
โฆand bestie, we are NOT done with the dump list, so hold that thought. ๐
-fdump-rtl-shortenโ dumps the RTL right after branch shortening happens ๐ short branches, cute.-fdump-rtl-siblingโ dumps after sibling call optimizations. yes bestie, sibling calls are real and they are iconic ๐ซถ-fdump-rtl-split1,-fdump-rtl-split2,-fdump-rtl-split3,-fdump-rtl-split4,-fdump-rtl-split5โ these five give you a dump after each of the five rounds of instruction splitting. five rounds. she's committed ๐-fdump-rtl-smsโ dumps after modulo scheduling. heads up tho: this pass only runs on some architectures, so don't come for me if you get nothing โจ-fdump-rtl-stackโ dumps after the conversion from GCC's "flat register file" registers over to the x87's stack-like registers. and this pass? only on x86 variants. periodt.-fdump-rtl-subreg1,-fdump-rtl-subreg2โ these two enable dumping after the two subreg expansion passes. two passes, two flags, so organized ๐ธ-fdump-rtl-unshareโ dumps after all rtl has been unshared. unshared. freed. main character energy ๐ฆ-fdump-rtl-vartrackโ dumps after variable tracking.-fdump-rtl-vregsโ dumps after converting virtual registers to hard registers. glow-up fr fr ๐-fdump-rtl-webโ dumps after live range splitting.-fdump-rtl-regclass,-fdump-rtl-subregs_of_mode_init,-fdump-rtl-subregs_of_mode_finish,-fdump-rtl-dfinit,-fdump-rtl-dfinishโ okay so these dumps are defined, they exist, they're validโฆ and they always produce empty files. literally empty. not me being handed an empty file and saying thank you ๐ญ-da,-fdump-rtl-allโ produce all the dumps listed above. all of them. every single one. go off ๐-dAโ annotate the assembler output with miscellaneous debugging information.-dDโ dump all macro definitions, at the end of preprocessing, in addition to normal output.-dHโ produce a core dump whenever an error occurs. yes, on purpose. dramatic but valid ๐-dpโ annotate the assembler output with a comment indicating which pattern and alternative is used. the length and cost of each instruction also get printed, because she's thorough ๐-dPโ dump the RTL in the assembler output as a comment before each instruction. also turns on-dpannotation, so you get both, bestie ๐-dxโ just generate RTL for a function instead of compiling it. usually used with-fdump-rtl-expand.-fdump-debugโ dump debugging information generated during the debug generation phase.-fdump-earlydebugโ dump debugging information generated during the early debug generation phase. early. she woke up and chose debug ๐-fdump-noaddrโ when doing debugging dumps, suppress address output. this makes it more feasible to usediffon debugging dumps for compiler invocations with different compiler binaries and/or different text / bss / data / heap / stack / dso start locations. so basically it's the diff-friendly girlie โจ-freport-bugโ collect and dump debug information into a temporary file if an internal compiler error (ICE) occurs. it's giving "if you're gonna crash, at least leave receipts" ๐-fdump-unnumberedโ when doing debugging dumps, suppress instruction numbers and address output. makes it more feasible to usediffon debugging dumps for compiler invocations with different options, in particular with and without-g.-fdump-unnumbered-linksโ when doing debugging dumps (see-doption above), suppress instruction numbers for the links to the previous and next instructions in a sequence.
-fdump-ipa-switch,-fdump-ipa-switch-optionsโ control the dumping at various stages of inter-procedural analysis language tree to a file. the file name is generated by appending a switch specific suffix to the source file name, and the file is created in the same directory as the output file. the following dumps are possible:allโ enables all inter-procedural analysis dumps.cgraphโ dumps information about call-graph optimization, unused function removal, and inlining decisions.inlineโ dump after function inlining.
additionally, the options -optimized, -missed, -note, and -all can be provided, with the same meaning as for -fopt-info, defaulting 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 kinds of receipts, bestie ๐งพ
by default, the dump will contain messages about successful optimizations (equivalent to -optimized) together with low-level details about the analysis.
-fdump-lang-all,-fdump-lang-switch,-fdump-lang-switch-options,-fdump-lang-switch-options=filenameโ control the dumping of language-specific information. the options and filename portions behave as described in the-fdump-treeoption. the following switch values are accepted:allโ enable all language-specific dumps.classโ dump class hierarchy information. virtual table information is emitted unlessslimis specified. this option is applicable to C++ only.rawโ dump the raw internal tree data. this option is applicable to C++ only.
-fdump-passesโ print on stderr the list of optimization passes that are turned on and off by the current command-line options. lowkey the most useful thing here, iykyk ๐-fdump-statistics-optionโ enable and control dumping of pass statistics in 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. stats girlies rise ๐
-fdump-tree-all,-fdump-tree-switch,-fdump-tree-switch-options,-fdump-tree-switch-options=filenameโ control the dumping at various stages of processing the intermediate language tree to a file. if the-optionsform is used, options is a list of-separated options which control the details of the dump. not all options are applicable to all dumps; those that are not meaningful are ignored. the following options are available:addressโ print the address of each node. usually this is not meaningful as it changes according to the environment and source file. its primary use is for tying up a dump file with a debug environment.asmnameโ ifDECL_ASSEMBLER_NAMEhas been set for a given decl, use that in the dump instead ofDECL_NAME. its primary use is ease of use working backward from mangled names in the assembly file.slimโ when dumping front-end intermediate representations, inhibit dumping of members of a scope or body of a function merely because that scope has been reached. only dump such items when they are directly reachable by some other path.
when dumping pretty-printed trees, this option inhibits dumping the bodies of control structures.
when dumping RTL, print the RTL in slim (condensed) form instead of the default LISP-like representation. she's โจslimโจ now.
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.
this option currently only works for RTL dumps, and the RTL is always dumped in slim form. no cap, slim only ๐
vopsโ enable showing virtual operands for every statement.linenoโ enable showing line numbers for statements.uidโ enable showing the unique ID (DECL_UID) for each variable.verboseโ enable showing the tree dump for each statement.ehโ enable showing the EH region number holding each statement.scevโ enable showing scalar evolution analysis details.optimizedโ enable showing optimization information (only available in certain passes).missedโ enable showing missed optimization information (only available in certain passes).noteโ enable other detailed optimization information (only available in certain passes).allโ turn on all options, exceptraw,slim,verboseandlineno. (yes, "all" doesn't mean all. she's got boundaries ๐)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 thestderroutput 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. so don't hardcode them, bestie ๐
-fopt-info,-fopt-info-options,-fopt-info-options=filenameโ controls optimization dumps from various optimization passes. if the-optionsform 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:
so basically the whole -fopt-info situation splits into three lil squads ๐
- 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 groups don't overlap at all, so you can mix and match them however you want, no cap ๐ but the second there's a conflict, the later option on the command line eats the earlier one. the earlier one is simply not invited to the party.
the following options control which kinds of messages should be emitted:
optimizedโ prints info when an optimization is successfully applied. it's up to each pass to decide what info is relevant โ like, the vectorizer passes print the source location of loops that got successfully vectorized. slay ๐missedโ prints info about missed optimizations. individual passes decide what goes in the output. (the missed opportunities... we don't talk about those ๐ญ)noteโ prints verbose info about optimizations: certain transformations, more detailed messages about decisions, that whole vibe.allโ the full detailed optimization info. this includesoptimized,missed, andnote. it's giving "give me everything" โจ
the following option controls the dump verbosity:
internalsโ by default only "high-level" messages are emitted. this option unlocks the extra, more detailed messages, which are likely to only be of interest to GCC developers. iykyk ๐ง
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 all the optimization groups listed above. main character energy fr fr ๐
if options is omitted, it defaults to optimized-optall, which means: dump messages about successful optimizations from all the passes, and skip the stuff that's treated as "internals".
if the filename is provided, then the dumps from all the applicable optimizations get concatenated into that filename. otherwise the dump just goes straight onto stderr. and yeah, multiple -fopt-info options are accepted, but only one of them can include a filename. if other filenames show up, every option after the first one is ignored, sorry bestie ๐
note that the output filename is overwritten in case of multiple translation units. if you want a combined output from multiple translation units, use stderr instead. periodt.
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 a missed optimization report from all the passes into missed.all. and this one:
gcc -O2 -ftree-vectorize -fopt-info-vec-missed
prints info about missed optimization opportunities from vectorization passes on stderr. heads up: -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 literally does not matter ๐
as another example,
gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
outputs info 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, because only one output file is allowed. in this case only the first option takes effect and the subsequent options are ignored. so only vec.miss gets produced, and it contains dumps from the vectorizer about missed opportunities. rip loop.opt ๐
-fsave-optimization-recordโ writes aSRCFILE.opt-record.json.gzfile detailing what optimizations were performed, for those optimizations that support-fopt-info.
this option is experimental and the format of the data inside that compressed JSON file is subject to change. don't build your whole life on it ๐ซถ
it's roughly equivalent to a machine-readable version of -fopt-info-all: a collection of messages with source file, line number and column number, plus these extra data bits for each message:
- the execution count of the code being optimized, along with metadata about whether this came from actual profile data or is just an estimate โ this lets consumers 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 gets inlined into several different places (which might themselves be inlined), the reader can tell the copies apart,
- 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. it's giving nested lore ๐ธ
-fsched-verbose=nโ on targets that use instruction scheduling, this option controls how much debugging output the scheduler prints to the dump files.
for n greater than zero, -fsched-verbose outputs the same information as -fdump-rtl-sched1 and -fdump-rtl-sched2. for n greater than one, it also outputs basic block probabilities, detailed ready list information and unit/insn info. for n greater than two, it includes RTL at abort point, control-flow and regions info. and for n over four, -fsched-verbose also includes dependence info. the more n, the more chaos โจ
-fenable-kind-pass-fdisable-kind-pass=range-listโ this is a whole set of options used to explicitly disable/enable optimization passes.
these options are intended for use for debugging GCC. compiler users should use regular options for enabling/disabling passes instead. fr fr, this is the dev-only backstage area ๐
-fdisable-ipa-passโ disable IPA pass pass. pass is the pass name. if the same pass is statically invoked in the compiler multiple times, the pass name should be appended with a sequential number starting from1.-fdisable-rtl-pass-fdisable-rtl-pass=range-listโ disable RTL pass pass. pass is the pass name. if the same pass is statically invoked in the compiler multiple times, the pass name should be appended with a sequential number starting from1. range-list is 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, the number pair can be simplified as a single number. if the function's call graph node's uid falls within one of the specified ranges, the pass is disabled for that function. the uid is shown in the function header of a dump file, and the pass names can be dumped by using option-fdump-passes.-fdisable-tree-pass-fdisable-tree-pass=range-listโ disable tree pass pass. see-fdisable-rtlfor the description of option arguments.-fenable-ipa-passโ enable IPA pass pass. pass is the pass name. if the same pass is statically invoked in the compiler multiple times, the pass name should be appended with a sequential number starting from1.-fenable-rtl-pass-fenable-rtl-pass=range-listโ enable RTL pass pass. see-fdisable-rtlfor option argument description and examples.-fenable-tree-pass-fenable-tree-pass=range-listโ enable tree pass pass. see-fdisable-rtlfor the description of option arguments.
here are some examples showing uses of these options.
# disable ccp1 for all functions
-fdisable-tree-ccp1
# disable complete unroll for function whose cgraph node uid is 1
-fenable-tree-cunroll=1
# disable gcse2 for functions at the following ranges [1,1],
# [300,400], and [400,1000]
# disable gcse2 for functions foo and foo2
-fdisable-rtl-gcse2=foo,foo2
# disable early inlining
-fdisable-tree-einline
# disable ipa inlining
-fdisable-ipa-inline
# enable tree full unroll
-fenable-tree-unroll
-fchecking-fchecking=nโ enable internal consistency checking. the default depends on the compiler configuration.-fchecking=2enables further internal consistency checking that might affect code generation. ๐-frandom-seed=stringโ this option provides a seed that GCC uses 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. you can use the-frandom-seedoption to produce reproducibly identical object files. so satisfying honestly ๐
the string can either be a number (decimal, octal or hex) or an arbitrary string โ in which case it's converted to a number by computing CRC32.
the string should be different for every file you compile. every. single. one. ๐
-save-temps-save-temps=cwdโ store the usual "temporary" intermediate files permanently; place them in the current directory and name them based on the source file. so compilingfoo.cwith-c -save-tempsproduces filesfoo.iandfoo.s, as well asfoo.o. this creates a preprocessedfoo.ioutput file even though the compiler now normally uses an integrated preprocessor. iconic behavior โจ
when used in combination with the -x command-line option, -save-temps is sensible enough to avoid overwriting an input source file that has the same extension as an intermediate file. the corresponding intermediate file may be obtained by renaming the source file before using -save-temps. it's looking out for you ๐ซถ
-save-temps=objโ bestie, this one also keeps those "temporary" intermediate files around forever, but here's the โจtwistโจ: if you're using-o, the temp files get named off the object file instead. And if there's no-oin sight? Then-save-temps=objjust acts exactly like plain-save-temps. ๐
Example time:
gcc -save-temps=obj -c foo.c
gcc -save-temps=obj -c bar.c -o dir/xbar.o
gcc -save-temps=obj foobar.c -o dir2/yfoobar
...and that gives you foo.i, foo.s, dir/xbar.i, dir/xbar.s, dir2/yfoobar.i, dir2/yfoobar.s, and dir2/yfoobar.o. iconic behavior honestly ๐
Okay so real talk about -save-temps and parallel compiles, because this bites people: if you invoke GCC in parallel โ like, compiling several different source files that share a common base name but live in different subdirectories, or the same source file compiled for multiple output destinations โ it is likely that the different parallel compilers will interfere with each other, and overwrite the temporary files. For instance:
gcc -save-temps -o outdir1/foo.o indir1/foo.c&
gcc -save-temps -o outdir2/foo.o indir2/foo.c&
...may result infoo.iandfoo.obeing written to simultaneously by both compilers. ๐ญ chaos. not the vibe.
-time[=file]โ report the CPU time taken by each subprocess in the compilation sequence, bestie. For C source files, that means the compiler proper and the assembler (plus the linker if linking is happening). โฑ๏ธ
Without specifying 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's time spent executing the program itself. The second number is "system time" โ time spent executing operating system routines on behalf of the program. Both numbers are in seconds. โจ
With an output file specified, the output gets 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" get moved before the program name, and the options passed to the program are displayed too โ so later you can tell exactly what file was being compiled, and with which options. ๐ซถ
-fdump-final-insns[=file]โ dump the final internal representation (RTL) to file. If the optional argument is omitted (or if file is.), the dump file name is determined by appending.gkdto the compilation output file name.-fcompare-debug[=opts]โ if no error occurs during compilation, run the compiler a second time, adding opts and-fcompare-debug-secondto the arguments passed to that second compilation. Then dump the final internal representation in both compilations, and print an error if they differ. ๐
If the equal sign is omitted, the default -gtoggle is used.
The environment variable GCC_COMPARE_DEBUG, if defined, non-empty and nonzero, implicitly enables -fcompare-debug. If GCC_COMPARE_DEBUG is defined to a string starting with a dash, then it's used for opts; otherwise the default -gtoggle is used.
-fcompare-debug=, with the equal sign but without opts, is equivalent to -fno-compare-debug, which disables the dumping of the final representation and the second compilation โ preventing even GCC_COMPARE_DEBUG from taking effect. ๐
To verify full coverage during -fcompare-debug testing, set GCC_COMPARE_DEBUG to say -fcompare-debug-not-overridden, which GCC rejects as an invalid option in any actual compilation (rather than preprocessing, assembly or linking). To get just a warning instead, setting GCC_COMPARE_DEBUG to -w%n-fcompare-debug not overridden will do. ๐
-fcompare-debug-secondโ this option is implicitly passed to the compiler for the second compilation requested by-fcompare-debug, along with options to silence warnings, and omitting other options that would cause the compiler to produce output to files or to standard output as a side effect. Dump files and preserved temporary files get renamed so they contain the.gkadditional extension during the second compilation, so they don't overwrite the ones generated by the first. ๐
When this option is passed to the compiler driver, it causes the first compilation to be skipped, which makes it useful for little other than debugging the compiler proper.
-gtoggleโ turn off generation of debug info if leaving out this option generates it, or turn it on at level 2 otherwise. The position of this argument in the command line does not matter; it takes effect after all other options are processed, and it does so only once, no matter how many times it's given. This is mainly intended to be used with-fcompare-debug. ๐-fvar-tracking-assignments-toggleโ toggles-fvar-tracking-assignments, in exactly the same way that-gtoggletoggles-g.-Qโ makes the compiler print out each function name as it's compiled, and print some statistics about each pass when it finishes. ๐-ftime-reportโ makes the compiler print some statistics about the time consumed by each pass when it finishes. โฐ-ftime-report-detailsโ records the time consumed by infrastructure parts separately for each pass.-fira-verbose=nโ control the verbosity of the dump file for the integrated register allocator. The default value is5. If the value n is greater or equal to10, the dump output is sent tostderrusing the same format as n minus10. โจ-flto-reportโ prints a report with internal details on the workings of the link-time optimizer. The contents of this report vary from version to version. It's meant to be useful to GCC developers when processing object files in LTO mode (via-flto).
Disabled by default. ๐
-flto-report-wpaโ like-flto-report, but only print for the WPA phase of Link Time Optimization.-fmem-reportโ makes the compiler print some statistics about permanent memory allocation when it finishes. ๐ง-fmem-report-wpaโ makes the compiler print some statistics about permanent memory allocation for the WPA phase only.-fpre-ipa-mem-reportโ makes the compiler print some statistics about permanent memory allocation before interprocedural optimization.-fpost-ipa-mem-reportโ makes the compiler print some statistics about permanent memory allocation after interprocedural optimization.-fprofile-reportโ makes the compiler print some statistics about consistency of the (estimated) profile and the effect of individual passes.-fstack-usageโ makes the compiler output stack usage information for the program, on a per-function basis. The filename for the dump is made by appending.suto the auxname. auxname is generated from the name of the output file, if explicitly specified and it is not an executable; otherwise it's the basename of the source file. An entry is made up of three fields:- The name of the function.
- A number of bytes.
- One or more qualifiers:
"static","dynamic","bounded".
The qualifier "static" means the function manipulates the stack statically: a fixed number of bytes are allocated for the frame on function entry and released on function exit; no stack adjustments are otherwise made in the function. The second field is this fixed number of bytes.
The qualifier "dynamic" means the function manipulates the stack dynamically: in addition to the static allocation described above, stack adjustments are made in the body of the function, for example to push/pop arguments around function calls. If the qualifier "bounded" is also present, the amount of these adjustments is bounded at compile time and the second field is an upper bound of the total amount of stack used by the function. If it 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. ๐-fdbg-cnt-listโ print the name and the counter upper bound for all debug counters.-fdbg-cnt=counter-value-listโ set the internal debug counter lower and upper bound. counter-value-list is a comma-separated list ofname:lower_bound:upper_boundtuples which sets the lower and the upper bound of each debug counter name. The lower_bound is optional and is zero initialized if not set. All debug counters have the initial upper bound ofUINT_MAX; thusdbg_cntreturns true always unless the upper bound is set by this option. For example, with-fdbg-cnt=dce:2:4,tail_call:10,dbg_cnt(dce)returns true only for third and fourth invocation. Fordbg_cnt(tail_call)true is returned for first 10 invocations. ๐ฅ-print-file-name=libraryโ print the full absolute name of the library file library that would be used when linking โ and don't do anything else. With this option, GCC does not compile or link anything; it just prints the file name. ๐-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 the mapping from multilib directory names to compiler switches that enable them. The directory name is separated from the switches by;, and each switch starts with an@instead of the-, without spaces between multiple switches. This is supposed to ease shell processing. ๐-print-multi-os-directoryโ print the path to OS libraries for the selected multilib, relative to 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 the path to OS libraries for the selected multiarch, relative to somelibsubdirectory. โจ-print-prog-name=programโ like-print-file-name, but searches for a program such ascpp. ๐-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โ prints the name of the installation directory it was configured with, plus a whole list of the program and library directories gcc goes looking in. And then it does nothing else, okay? That's the whole job. Slay.
This one is your bestie when gcc hits you with the error message installation problem, cannot exec cpp0: No such file or directory. To fix that, you either need to put cpp0 and the other compiler components exactly where gcc expects to find them, or you can set the environment variable GCC_EXEC_PREFIX to the directory where you actually installed them.
Do not forget the trailing /. She means it. That slash is load-bearing. ๐
-print-sysrootโ prints the target sysroot directory that gets used during compilation. That's the target sysroot you specified either at configure time or with the--sysrootoption, and it may have an extra suffix tacked on that depends on your compilation options. If no target sysroot is specified at all, this option just prints nothing. Silence. Iconic behaviour, honestly. ๐-print-sysroot-headers-suffixโ prints the suffix that gets added to the target sysroot when searching for headers, or throws an error if the compiler was never configured with such a suffix โ and, you guessed it, does nothing else.-dumpmachineโ prints the compiler's target machine (for example,i686-pc-linux-gnu) โ and does not do anything else. One line, one job, out. โจ-dumpversionโ prints 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). So like, it varies, bestie. Don't assume the shape. ๐ฆ-dumpfullversionโ prints the full compiler version โ and don't do anything else. This one is consistent: the output is always three numbers separated by dots, major, minor and patchlevel version. Periodt. ๐-dumpspecsโ prints the compiler's built-in specs โ and don't do anything else. (This is used when GCC itself is being built, so it's very much an iykyk situation.)
๐ธ Machine-Dependent Options ๐ธ
Every target machine that GCC supports can have its own little pile of options โ like, to let you compile for a particular processor variant or ABI, or to control optimizations that are specific to that machine. By convention, the names of machine-specific options start with -m. That's the tell. ๐ต๏ธ
Some configurations of the compiler also support additional target-specific options, usually for compatibility with other compilers on the same platform. Team players.
๐ AArch64 Options ๐
These options are defined for AArch64 implementations:
-mabi=nameโ generate code for the specified data model. The permissible values areilp32for a SysV-like data model whereint,long intand pointers are 32 bits, andlp64for a 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. Mixing them is not a vibe, it's a โจcrashโจ.
-mbig-endianโ generate big-endian code. This is the default when GCC is configured for anaarch64_be-*-*target.-mgeneral-regs-onlyโ generate code which uses only the general-purpose registers. This will prevent the compiler from using floating-point and Advanced SIMD registers but will not impose any restrictions on the assembler. Compiler's hands are tied, assembler's are free.-mlittle-endianโ generate little-endian code. This is the default when GCC is configured for anaarch64-*-*but not anaarch64_be-*-*target.-mcmodel=tinyโ generate code for the tiny code model. The program and its statically defined symbols must be within 1MB of each other. Programs can be statically or dynamically linked. Cozy. Everyone's close.-mcmodel=smallโ generate code for the small code model. The program and its statically defined symbols must be within 4GB of each other. Programs can be statically or dynamically linked. This is the default code model. ๐-mcmodel=largeโ generate code for the large code model. This makes no assumptions about addresses and sizes of sections. Programs can be statically linked only.-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. One of them is polite, one of them is feral, you pick.-momit-leaf-frame-pointer-mno-omit-leaf-frame-pointerโ omit or keep the frame pointer in leaf functions. The former behavior is the default.-mstack-protector-guard=guard-mstack-protector-guard-reg=reg-mstack-protector-guard-offset=offsetโ generate stack protection code using canary at guard. Supported locations areglobalfor a global canary orsysregfor a canary in an appropriate system register.
With the latter choice the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which system register to use as base register for reading the canary, and from what offset from that base register. There is no default register or offset as this is entirely for use within the Linux kernel.
-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 orsysregfor a canary in an appropriate system register.
With the latter choice the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which system register to use as base register for reading the canary, and from what offset from that base register. There is no default register or offset as this is entirely for use within the Linux kernel.
Yes, bestie, she said it twice. That's genuinely how it's written in the source. Double the canary, double the drama. ๐ค๐ค
-mtls-dialect=descโ use TLS descriptors as the thread-local storage mechanism for dynamic accesses of TLS variables. This is the default.-mtls-dialect=traditionalโ use traditional TLS as the thread-local storage mechanism for dynamic accesses of TLS variables.-mtls-size=sizeโ specify bit size of immediate TLS offsets. Valid values are12,24,32,48. This option requires binutils 2.26 or newer. Check your binutils before you come for her.-mfix-cortex-a53-835769-mno-fix-cortex-a53-835769โ enable or disable the workaround for the ARM Cortex-A53 erratum number 835769. This involves inserting aNOPinstruction between memory instructions and 64-bit integer multiply-accumulate instructions. One little NOP, saving your whole afternoon.-mfix-cortex-a53-843419-mno-fix-cortex-a53-843419โ enable or disable the workaround for the ARM Cortex-A53 erratum number 843419. This erratum workaround is made at link time and this will only pass the corresponding flag to the linker.-mlow-precision-recip-sqrt-mno-low-precision-recip-sqrtโ enable or disable the reciprocal square root approximation. This option only has an effect if-ffast-mathor-funsafe-math-optimizationsis used as well. Enabling this reduces precision of reciprocal square root results to about 16 bits for single precision and to 32 bits for double precision. Fast and loose, but she's telling you the numbers up front.-mlow-precision-sqrt-mno-low-precision-sqrtโ enable or disable the square root approximation. This option only has an effect if-ffast-mathor-funsafe-math-optimizationsis used as well. Enabling this reduces precision of square root results to about 16 bits for single precision and to 32 bits for double precision. If enabled, it implies-mlow-precision-recip-sqrt. She brings her friend along. ๐ซถ-mlow-precision-div-mno-low-precision-divโ enable or disable the division approximation. This option only has an effect if-ffast-mathor-funsafe-math-optimizationsis used as well. Enabling this reduces precision of division results to about 16 bits for single precision and to 32 bits for double precision.-mtrack-speculation-mno-track-speculationโ enable or disable generation of additional code to track speculative execution through conditional branches. The tracking state can then be used by the compiler when expanding calls to__builtin_speculation_safe_copyto permit a more efficient code sequence to be generated. Fancy. Speculation with receipts.-moutline-atomics-mno-outline-atomicsโ enable or disable calls to out-of-line helpers to implement atomic operations. These helpers will, at runtime, determine if the LSE instructions from ARMv8.1-A can be used; if not, they will use the load/store-exclusive instructions that are present in the base ARMv8.0 ISA.
This option is only applicable when compiling for the base ARMv8.0 instruction set. If using a later revision, e.g. -march=armv8.1-a or -march=armv8-a+lse, the ARMv8.1-Atomics instructions will be used directly. The same applies when using -mcpu= when the selected cpu supports the lse feature.
-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 permissible values for arch are armv8-a, armv8.1-a, armv8.2-a, armv8.3-a, armv8.4-a, armv8.5-a or native.
The value armv8.5-a implies armv8.4-a and enables compiler support for the ARMv8.5-A architecture extensions.
The value armv8.4-a implies armv8.3-a and enables compiler support for the ARMv8.4-A architecture extensions.
The value armv8.3-a implies armv8.2-a and enables compiler support for the ARMv8.3-A architecture extensions.
The value armv8.2-a implies armv8.1-a and enables compiler support for the ARMv8.2-A architecture extensions.
The value armv8.1-a implies armv8-a and enables compiler support for the ARMv8.1-A architecture extension. In particular, it enables the +crc, +lse, and +rdma features. Chain reaction, each one pulling the one before it. ๐ซ
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,
The permissible values for feature are listed in the sub-section on aarch64-feature-modifiers,,-march and -mcpu Feature Modifiers. Where conflicting feature modifiers are specified, the right-most feature is used.
GCC uses name to determine what kind of instructions it can emit when generating assembly code. If -march is specified without either of -mtune or -mcpu also being specified, the code is tuned to perform well across a range of target processors implementing the target architecture. She's doing her best for everyone, not just one chip.
-mtune=nameโ okay so this one tells GCC which target processor to tune the code's performance for. The permissible values are literally this whole girliepop lineup:
generic, cortex-a35, cortex-a53, cortex-a55, cortex-a57,
cortex-a72, cortex-a73, cortex-a75, cortex-a76, ares, exynos-m1,
emag, falkor, neoverse-e1, neoverse-n1, neoverse-n2, neoverse-v1,
neoverse-512tvb, qdf24xx, saphira, phecda, xgene1, vulcan, octeontx,
octeontx81, octeontx83, a64fx, thunderx, thunderxt88,
thunderxt88p1, thunderxt81, tsv110, thunderxt83, thunderx2t99, 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
native
The values cortex-a57.cortex-a53, cortex-a72.cortex-a53, cortex-a73.cortex-a35, cortex-a73.cortex-a53, cortex-a75.cortex-a55, cortex-a76.cortex-a55 are the big.LITTLE girlies โ they tell GCC to tune for a big.LITTLE system. ๐
The value neoverse-512tvb means tune for Neoverse cores that (a) implement SVE and (b) have a total vector bandwidth of 512 bits per cycle. Translating from nerd to human: it tells GCC to tune 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 (2 for 256-bit SVE, 4 for 128-bit SVE). It's more general than tuning for one specific core like Neoverse V1, but more specific than the default tuning described below. iconic range tbh
Also, on native AArch64 GNU/Linux systems, the value native tunes performance to the host system. No cap. But heads up bestie โ this option has no effect if the compiler can't recognize the processor of the host system. ๐
Where none of -mtune=, -mcpu= or -march= are specified, the code is tuned to perform well across a range of target processors.
Lowkey important: this option cannot be suffixed by feature modifiers. Like, don't even try it. ๐ซ
-mcpu=nameโ same vibe, but you can tack on one or more feature modifiers. The form is-mcpu=cpu{+[no]feature}*, where the permissiblecpuvalues are exactly the same ones as for-mtune. The permissiblefeaturevalues are documented in the sub-section onaarch64-feature-modifiers,,-march and -mcpu Feature Modifiers. And if you specify conflicting feature modifiers? The right-most feature wins. periodt.
GCC uses name to figure out what kind of instructions it can emit when generating assembly code (as if by -march), and to figure out the target processor to tune for performance (as if by -mtune). And when this option shows up alongside -march or -mtune? Those options take precedence over the appropriate part of this option. The way that hierarchy worksโฆ know your place bestie.
-mcpu=neoverse-512tvb is special โ it doesn't refer to a specific core, it refers to all Neoverse cores that (a) implement SVE and (b) have a total vector bandwidth of 512 bits a cycle. Unless overridden by -march, -mcpu=neoverse-512tvb generates code that can run on a Neoverse V1 core, since Neoverse V1 is the first Neoverse core with these properties. And unless overridden by -mtune, -mcpu=neoverse-512tvb tunes code in the same way as for -mtune=neoverse-512tvb. โจ
-moverride=stringโ overrides tuning decisions made by the back-end in response to a-mtune=switch. The syntax, semantics, and accepted values forstringhere are not guaranteed to be consistent across releases โ so like, don't build your whole personality on it. This option is only intended to be useful when developing GCC.-mverbose-cost-dumpโ turns on verbose cost model dumping in the debug dump files. This option is provided for use in debugging the compiler. ๐-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 to1MB. This is enabled by default for-mcmodel=tiny. ๐-msign-return-address=scopeโ selects the function scope on which return address signing will be applied. 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=none|standard|pac-ret[+leaf]|btiโ selects the branch protection features to use.noneis the default and turns off all types of branch protection.standardturns on all types of branch protection features โ and if a feature has additional tuning options, thenstandardsets it to its standard level.pac-ret[+leaf]turns on return address signing to its standard level: signing functions that save the return address to memory (non-leaf functions will practically always do this) using thea-key. The optional argumentleafcan be used to extend the signing to include leaf functions.btiturns on branch target identification mechanism. ๐ก๏ธ-mharden-sls=optsโ enables 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.
-msve-vector-bits=bitsโ specifies 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 lets GCC make assumptions about the vector length when it's 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. 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 does not change code generation from GCC, but is passed 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-aaesandpmullcrypto extension. This also enables Advanced SIMD instructions.sha2โ enable the Armv8-asha2crypto extension. This also enables Advanced SIMD instructions.sha3โ enable thesha512andsha3crypto extension. This also enables Advanced SIMD instructions. Use of this option with architectures prior to Armv8.2-A is not supported.sm4โ enable thesm3andsm4crypto 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. This option is only to enable the extension at the assembler level and does not affect code generation.sbโ enable the Armv8-a Speculation Barrier instruction. This option is only to enable the extension at the assembler level and does not affect code generation. This option is enabled by default for-march=armv8.5-a.ssbsโ enable the Armv8-a Speculative Store Bypass Safe instruction. This option is only to enable the extension at the assembler level and does not affect code generation. This option is enabled by default for-march=armv8.5-a.predresโ enable the Armv8-a Execution and Data Prediction Restriction instructions. This option is only to enable the extension at the assembler level and does not affect code generation. This option is enabled by default for-march=armv8.5-a.
Feature crypto implies aes, sha2, and simd, which implies fp. Conversely, nofp implies nosimd, which implies nocrypto, noaes and nosha2. The way that dependency chain cascadesโฆ it's giving dominos bestie ๐ข๐ฃ
๐ง Adapteva Epiphany Options ๐ง
These -m options are defined for Adapteva Epiphany:
-mhalf-reg-fileโ don't allocate any register in the range"r32"..."r63". That allows code to run on hardware variants that lack these registers. ๐-mprefer-short-insn-regsโ preferentially allocate registers that allow short instruction generation. This can result in increased instruction count, so this may either reduce or increase overall code size. a little chaotic, but we respect it-mbranch-cost=numโ sets how expensive a branch is, roughly in "simple" instruction units. Heads up bestie: this is a heuristic only, so it is not guaranteed to produce consistent results across releases. It's a vibe, not a promise. ๐-mcmoveโ turns on generation of conditional moves. Slay, branchless.-mnops=numโ emitsnumNOPs before every other generated instruction. Yes, on purpose. Padding is a look. โจ-mno-soft-cmpsfโ for single-precision floating-point comparisons, emit anfsubinstruction and test the flags. This is faster than a software comparison, but it can get incorrect results in the presence of NaNs, or when two different small numbers are compared such that their difference is calculated as zero. ๐ญ The default is-msoft-cmpsf, which uses slower, but IEEE-compliant, software comparisons. Correct > quick, bestie.-mstack-offset=numโ sets the offset between the top of the stack and the stack pointer. So like, a value of8means the eight bytes in the rangesp+0...sp+7can be used by leaf functions without stack allocation. Values other than8or16are 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. iykyk.
-mno-round-nearestโ makes the scheduler assume that the rounding mode has been set to truncating. The default is-mround-nearest.-mlong-callsโ unless an attribute says otherwise, assumes all calls might be beyond the offset range of theb/blinstructions, and therefore loads the function address into a register before performing a (otherwise direct) call. This is the default.-mshort-callsโ unless an attribute says otherwise, assumes all direct calls are in the range of theb/blinstructions, so it uses these instructions for direct calls. The default is-mlong-calls.-msmall16โ assumes addresses can be loaded as 16-bit unsigned values. This does not apply to function addresses, for which-mlong-callssemantics are in effect.-mfp-mode=modeโ sets 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 of the following values:
callerโ any mode at function entry is valid, and retained or restored when the function returns, and when it calls other functions. This mode is useful for compiling libraries or other compilation units you might want to incorporate into different programs with different prevailing FPU modes, and the convenience of being able to use a single object file outweighs the size and speed overhead for any extra mode switching that might be needed, compared with what would be needed with a more specific choice of prevailing FPU mode.truncateโ this is the mode used for floating-point calculations with truncating (i.e. round towards zero) rounding mode. That includes conversion from floating point to integer.round-nearestโ this is the mode used for floating-point calculations with round-to-nearest-or-even rounding mode.intโ this is the mode used to perform integer calculations in the FPU, e.g. integer multiply, or integer multiply-and-accumulate.
The default is -mfp-mode=caller.
-mno-split-lohi,-mno-postinc,-mno-postmodifyโ code generation tweaks that disable, respectively, splitting of 32-bit loads, generation of post-increment addresses, and generation of post-modify addresses. The defaults aremsplit-lohi,-mpost-inc, and-mpost-modify. (Yes, we are quoting it exactly, typos and all. No cap. ๐ซถ)-mnovect-doubleโ changes the preferred SIMD mode to SImode. The default is-mvect-double, which uses DImode as preferred SIMD mode.-max-vect-align=numโ the maximum alignment for SIMD vector mode types.nummay be4or8. The default is8. Note that this is an ABI change, even though many library function interfaces are unaffected if they don't use SIMD vector modes in places that affect size and/or alignment of relevant types. โ ๏ธ-msplit-vecmove-earlyโ splits 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โ specifies 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 that no register is used for this purpose. The default is-m1reg-none.
๐ AMD GCN Options ๐
These options are defined specifically for the AMD GCN port. ๐
-march=gpu-mtune=gpu
Set architecture type or tuning for gpu. Supported values for gpu are:
fijiโ compile for GCN3 Fiji devices (gfx803).gfx900โ compile for GCN5 Vega 10 devices (gfx900).
-mstack-size=bytesโ specifies how many bytes of stack space will be requested for each GPU thread (wave-front). Beware that there may be many threads and limited memory available. The size of the stack allocation may also have an impact on run-time performance. The default is32KBwhen using OpenACC or OpenMP, and1MBotherwise. ๐ซฃ
๐ฆ ARC Options ๐ฆ
The following options control the architecture variant for which code is being compiled:
-mbarrel-shifterโ generates instructions supported by barrel shifter. This is the default unless-mcpu=ARC601or-mcpu=ARCEMis in effect.-mjli-alwaysโ forces a call to a function using thejli_sinstruction. This option is valid only for ARCv2 architecture.-mcpu=cpuโ sets architecture type, register usage, and instruction scheduling parameters forcpu. There are also shortcut alias options available for backward compatibility and convenience. Supported values forcpuare: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.arc600_normโ compile for ARC 600 CPU withnorminstructions enabled.arc600_mul32x16โ compile for ARC 600 CPU withnormand 32x16-bit multiply instructions enabled.arc600_mul64โ compile for ARC 600 CPU withnormandmul64-family instructions enabled.arc601_normโ compile for ARC 601 CPU withnorminstructions enabled.arc601_mul32x16โ compile for ARC 601 CPU withnormand 32x16-bit multiply instructions enabled.arc601_mul64โ compile for ARC 601 CPU withnormandmul64-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โ generates double-precision FPX instructions, tuned for the fast implementation.-mno-dpfp-lrsrโ disableslrandsrinstructions from using FPX extension aux registers.-meaโ generates extended arithmetic instructions. Currently onlydivaw,adds,subs, andsat16are supported. This is always enabled for-mcpu=ARC700.-mno-mpyโ do not generatempy-family instructions for ARC700. This option is deprecated. ๐ซ-mmul32x16โ generates 32x16-bit multiply and multiply-accumulate instructions.-mmul64โ generatesmul64andmulu64instructions. Only valid for-mcpu=ARC600.-mnormโ generatesnorminstructions. This is the default if-mcpu=ARC700is in effect.-mspfp-mspfp-compact
Generate single-precision FPX instructions, tuned for the compact implementation.
-mspfp-fastโ generates single-precision FPX instructions, tuned for the fast implementation.-msimdโ enables generation of ARC SIMD instructions via target-specific builtins. Only valid for-mcpu=ARC700.-msoft-floatโ this option ignored; it is provided for compatibility purposes only. Software floating-point code is emitted by default, and this default can overridden by FPX options;-mspfp,-mspfp-compact, or-mspfp-fastfor single precision, and-mdpfp,-mdpfp-compact, or-mdpfp-fastfor double precision. (We are not fixing that sentence, bestie. It stays. ๐ )-mswapโ generatesswapinstructions.-matomicโ this enables use of the locked load/store conditional extension to implement atomic memory built-in functions. Not available for ARC 6xx or ARC EM cores.-mdiv-remโ enablesdivandreminstructions for ARCv2 cores.-mcode-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 thread pointer register number.
okay bestie we're still deep in ARC territory and there's so much more, lock in ๐ซถ
-mmpy-option=multoโ compile ARCv2 code with a multiplier design option. You can hand over multo as either a string or a numeric value.wlh1is the default. The recognized values are:0,noneโ no multiplier available. nada. zero. it's giving bare minimum ๐1,wโ 16x16 multiplier, fully pipelined. This turns on these instructions:mpywandmpyuw.2,wlh1โ 32x32 multiplier, fully pipelined (1 stage). These instructions get enabled on top:mpy,mpyu,mpym,mpymu, andmpy_s. (this is the default one, remember โจ)3,wlh2โ 32x32 multiplier, fully pipelined (2 stages). Also additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.4,wlh3โ two 16x16 multipliers, blocking, sequential. Also additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.5,wlh4โ one 16x16 multiplier, blocking, sequential. Also additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.6,wlh5โ one 32x4 multiplier, blocking, sequential. Also 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.
heads up: this option is only available for ARCv2 cores. no ARCv2, no multiplier menu, sorry babe ๐
-mfpu=fpuโ enables support for specific floating-point hardware extensions for ARCv2 cores. Supported values for fpu are:fpusโ enables support for single-precision floating-point hardware extensions.fpudโ enables support for double-precision floating-point hardware extensions. The single-precision floating-point extension is also enabled. Not available for ARC EM.fpudaโ enables support for double-precision floating-point hardware extensions using double-precision assist instructions. The single-precision floating-point extension is also enabled. This one 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. 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. Only available for ARC EM.fpuda_allโ enables support for double-precision floating-point hardware extensions using double-precision assist instructions. All single-precision floating-point hardware extensions are also enabled. Only available for ARC EM.fpus_divโ enables support for single-precision floating-point, square-root and divide hardware extensions.fpud_divโ enables support for double-precision floating-point, square-root and divide hardware extensions. This option includes 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. all of them. the whole collection ๐fpud_allโ enables support for all single- and double-precision floating-point hardware extensions. Not available for ARC EM.
-mirq-ctrl-saved=register-range, blink, lp_countโ tells the compiler which general-purpose registers the processor automatically saves/restores on interrupt entry and exit. register-range is two registers separated by a dash. The register range always starts withr0, and the upper limit is thefpregister.blinkandlp_countare optional. This option is only valid for ARC EM and ARC HS cores.-mrgf-banked-regs=numberโ specifies how many registers get replicated in the second register bank when you enter a fast interrupt. Fast interrupts are the ones with the highest priority level P0. These interrupts save only the PC and STATUS32 registers, so they skip memory transactions during interrupt entry and exit sequences. Use this option when you're using fast interrupts on an ARC V2 family processor. Permitted values are4,8,16, and32.-mlpc-width=widthโ specify the width of thelp_countregister. Valid values for width are8,16,20,24,28and32bits. 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 you specify, the compiler and run-time library might continue to use the loop mechanism for various needs. This option defines macro__ARC_LPC_WIDTH__with the value of width.-mrf16โ instructs the compiler to generate code for a 16-entry register file. This option defines the__ARC_RF16__preprocessor macro.-mbranch-indexโ enable use ofbiorbihinstructions to implement jump tables.
The following options are passed through to the assembler, and also define preprocessor macro symbols. ๐ฆ
-mdsp-packaโ passed down to the assembler to enable the DSP Pack A extensions. Also sets the preprocessor symbol__Xdsp_packa. This option is deprecated.-mdvbfโ passed down to the assembler to enable the dual Viterbi butterfly extension. Also sets the preprocessor symbol__Xdvbf. This option is deprecated.-mlockโ passed down to the assembler to enable the locked load/store conditional extension. Also sets the preprocessor symbol__Xlock.-mmac-d16โ passed down to the assembler. Also sets the preprocessor symbol__Xxmac_d16. This option is deprecated.-mmac-24โ passed down to the assembler. Also sets the preprocessor symbol__Xxmac_24. This option is deprecated.-mrtscโ passed down to the assembler to enable the 64-bit time-stamp counter extension instruction. Also sets the preprocessor symbol__Xrtsc. This option is deprecated.-mswapeโ passed down to the assembler to enable the swap byte ordering extension instruction. Also sets the preprocessor symbol__Xswape.-mtelephonyโ passed down to the assembler to enable dual- and single-operand instructions for telephony. Also sets the preprocessor symbol__Xtelephony. This option is deprecated.-mxyโ passed down to the assembler to enable the XY memory extension. Also sets the preprocessor symbol__Xxy.
The following options control how the assembly code is annotated: ๐
-misizeโ annotate assembler instructions with estimated addresses.-mannotate-alignโ explain what alignment considerations lead to the decision to make an instruction short or long.
The following options are passed through to the linker: ๐
-marclinuxโ 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โ 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.
The following options control the semantics of generated code: โญ
-mlong-callsโ generate calls as register indirect calls, which gives you access to the full 32-bit address range. iconic reach, honestly ๐-mmedium-callsโ don't use less than 25-bit addressing range for calls, which is the offset available for an unconditional branch-and-link instruction. Conditional execution of function calls is suppressed 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โ put definitions of externally-visible data in a small data section if that data is no bigger than num bytes. The default value of num is4for any ARC configuration, or8when we have double load/store operations.-mno-sdataโ do not generate sdata references. This is the default for tool chains built forarc-linux-uclibcandarceb-linux-uclibctargets.-mvolatile-cacheโ use ordinarily cached memory accesses for volatile references. This is the default.-mno-volatile-cacheโ enable cache bypass for volatile references.
The following options fine tune code generation: โจ
-malign-callโ do alignment optimizations for call instructions.-mauto-modify-regโ enable the use of pre/post modify with register displacement.-mbbit-peepholeโ enable bbit peephole2.-mno-brccโ this option disables a target-specific pass inarc_reorgto generate compare-and-branch (brcc) instructions. It has no effect on generation of these instructions driven by the combiner pass.-mcase-vector-pcrelโ use PC-relative switch case tables to enable case table shortening. This is the default for-Os.-mcompact-casesiโ enable compactcasesipattern. This is the default for-Os, and only available for ARCv1 cores. This option is deprecated.-mno-cond-execโ disable the ARCompact-specific pass to generate conditional execution instructions.
and yes there's STILL more coming bestie, don't you dare close the tab ๐
okay so real talk bestie ๐ โ because of delay slot scheduling and the way operand numbers, literal sizes, instruction lengths and conditional-execution support all interact with each other, the target-independent pass that's supposed to generate conditional execution is often just... not it ๐. So the ARC port kept a special pass around that goes hunting for extra conditional-execution generation opportunities after register allocation, branch shortening and delay slot scheduling have already happened. This pass usually (but not always, ngl) makes performance and code size better, and the price you pay is extra compilation time โ which is literally exactly why there's an option to switch it off. And if you're having a problem with call instructions blowing past their allowable offset range because they got conditionalized, you should lowkey consider using -mmedium-calls instead. ๐
-mearly-cbranchsiโ turn on pre-reload use of the"cbranchsi"pattern. โจ-mexpand-adddiโ expand"adddi3"and"subdi3"at RTL generation time into"add.f","adc"etc. Heads up bestie: this option is deprecated. ๐ซ-mindexed-loadsโ enable the use of indexed loads. Kinda spicy ๐ถ๏ธ because some optimizers then go ahead and assume indexed stores exist too, which... they do not. ๐-mlraโ enable Local Register Allocation. Still experimental for ARC, so by default the compiler just uses standard reload (i.e.-mno-lra). ๐งช-mlra-priority-noneโ don't indicate any priority for target registers.-mlra-priority-compactโ indicate target register priority forr0..r3/r12..r15. ๐ฏ-mlra-priority-noncompactโ reduce target register priority forr0..r3/r12..r15.-mmillicodeโ when you're optimizing for size (using-Os), prologues and epilogues that have to save or restore a big pile of registers often get shortened by calling a special function in libgcc; that's what we call a millicode call. โจ Since these calls can cause performance issues and/or linking issues when you link in a nonstandard way, this option is here so you can turn millicode call generation on or off.-mcode-density-frameโ lets the compiler emit"enter"and"leave"instructions. Heads up: these are only valid for CPUs that have the code-density feature. ๐-mmixed-codeโ tweaks register allocation to help 16-bit instruction generation. Generally this decreases the average instruction size while increasing the instruction count. ๐ฆ-mq-classโ enable q instruction alternatives. This is the default for-Os.-mRcqโ enable Rcq constraint handling. Most short code generation depends on this. Default vibes only. โ-mRcwโ enable Rcw constraint handling. Most ccfsm condexec mostly depends on this. Also the default. โ-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.
-mmultcost=numโ cost to assume for a multiply instruction, with4being equal to a normal instruction. ๐ข-munalign-prob-threshold=probabilityโ set probability threshold for unaligning branches. When you're tuning for ARC700 and optimizing for speed, branches without a filled delay slot are preferably emitted unaligned and long โ unless profiling says the probability of the branch being taken is below probability. The default is(REG_BR_PROB_BASE/2), i.e.5000.
The following options are maintained for backward compatibility, but are now deprecated and will be removed in a future release. Bestie, do not build new stuff on these ๐ญ:
-margonautโ obsolete FPX. ๐ชฆ-mbig-endian,-EBโ compile code for big-endian targets. Use of these options is now deprecated. Big-endian code is supported by configuring GCC to build"arceb-elf32"and"arceb-linux-uclibc"targets, for which big endian is the default.-mlittle-endian,-ELโ compile code for little-endian targets. Use of these options is now deprecated. Little-endian code is supported by configuring GCC to build"arc-elf32"and"arc-linux-uclibc"targets, for which little endian is the default.-mbarrel_shifterโ replaced by-mbarrel-shifter.-mdpfp_compactโ replaced by-mdpfp-compact.-mdpfp_fastโ replaced by-mdpfp-fast.-mdsp_packaโ replaced by-mdsp-packa.-mEAโ replaced by-mea.-mmac_24โ replaced by-mmac-24.-mmac_d16โ replaced by-mmac-d16.-mspfp_compactโ replaced by-mspfp-compact.-mspfp_fastโ replaced by-mspfp-fast.-mtune=cpuโ valuesarc600,arc601,arc700andarc700-xmacfor cpu are replaced byARC600,ARC601,ARC700andARC700-xmacrespectively.-multcost=numโ replaced by-mmultcost.
๐ ARM Options ๐
These -m options are defined for the ARM port, bestie ๐:
-mabi=nameโ generate code for the specified ABI. Permissible values are:apcs-gnu,atpcs,aapcs,aapcs-linuxandiwmmxt.-mapcs-frameโ generate a stack frame that's compliant with the ARM Procedure Call Standard for all functions, even if it's not strictly necessary for correct execution of the code. Specifying-fomit-frame-pointerwith this option causes stack frames to not 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.-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. ๐ฆ-mno-sched-prologโ prevent the reordering of instructions in the function prologue, or the merging of those instructions with the instructions in the function's body. This means all functions start with a recognizable set of instructions (or actually one of a choice from a small set of different function prologues), and that info can be used to locate the start of functions inside an executable piece of code. The default is-msched-prolog. ๐-mfloat-abi=nameโ specifies which floating-point ABI to use. Permissible values are:soft,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. Also note that the hard-float and soft-float ABIs are not link-compatible โ you must compile your entire program with the same ABI, and link with a compatible set of libraries. ๐
-mgeneral-regs-onlyโ generate code which uses only the general-purpose registers. This 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. โ-mbig-endianโ generate code for a processor running in big-endian mode; the default is to compile code for a little-endian processor.-mbe8,-mbe32โ when linking a big-endian image, select between BE8 and BE32 formats. The option has no effect for little-endian images and is ignored. The default depends on the selected target architecture. For ARMv6 and later architectures the default is BE8, for older architectures the default is BE32. BE32 format has been deprecated by ARM. ๐ซ-march=name[+extension...]โ specifies the name of the target ARM architecture. GCC uses this name to figure out what kind of instructions it can emit when generating assembly code. This option can be used in conjunction with or instead of the-mcpu=option.
Permissible names are: armv4t, armv5t, armv5te, armv6, armv6j, armv6k, armv6kz, armv6t2, armv6z, armv6zk, armv7, armv7-a, armv7ve, armv8-a, armv8.1-a, armv8.2-a, armv8.3-a, armv8.4-a, armv8.5-a, armv7-r, armv8-r, armv6-m, armv6s-m, armv7-m, armv7e-m, armv8-m.base, armv8-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. ๐ง
So like, most of these extension names are generically named on purpose, but bestie โ what they actually do depends entirely on the architecture you're slapping them onto. For example, the +simd option can be applied to both armv7-a and armv8-a architectures, but it'll enable the original ARMv7-A Advanced SIMD (Neon) extensions for armv7-a and the ARMv8-A variant for armv8-a. Same name, different flavor, iykyk. ๐ฆ
The list below is the full menu of supported extensions for each architecture. Architectures not mentioned? They don't support any extensions. That's it, that's the vibe. โจ
armv5tearmv6armv6jarmv6karmv6kzarmv6t2armv6zarmv6zk+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โ Disable the Advanced SIMD instructions (does not disable floating point).+nofpโ Disable the floating-point and Advanced SIMD instructions.
armv7ve- The extended version of the ARMv7-A architecture with support for virtualization.
+fpโ The VFPv4 floating-point instructions, with 16 double-precision registers. The extension+vfpv4-d16can be used as an alias for this extension.+simdโ The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions. The extension+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. The extension+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โ Disable the Advanced SIMD instructions (does not disable floating point).+nofpโ Disable the floating-point and Advanced SIMD instructions.
armv8-a+crcโ The Cyclic Redundancy Check (CRC) instructions.+simdโ The ARMv8-A Advanced SIMD and floating-point instructions.+cryptoโ The cryptographic instructions.+nocryptoโ Disable the cryptographic instructions.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.
armv8.1-a+simdโ The ARMv8.1-A Advanced SIMD and floating-point instructions.+cryptoโ The cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions.+nocryptoโ Disable the cryptographic instructions.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.
armv8.2-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โ Enable the Dot Product extension. This also enables Advanced SIMD instructions.+nocryptoโ Disable the cryptographic extension.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.
armv8.4-a+fp16โ The half-precision floating-point data processing instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension and the half-precision floating-point fmla extension.+simdโ The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the Dot Product extension.+cryptoโ The cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension.+nocryptoโ Disable the cryptographic extension.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.
armv8.5-a+fp16โ The half-precision floating-point data processing instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension and the half-precision floating-point fmla extension.+simdโ The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the Dot Product extension.+cryptoโ The cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension.+nocryptoโ Disable the cryptographic extension.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions.
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โ Disable the floating-point extension.+idivโ The ARM-state integer division instructions.+noidivโ Disable 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โ Disable the floating-point extensions.
armv8-m.main+dspโ the DSP instructions, bestie. ๐ซ+nodspโ turns the DSP extension off.+fpโ the single-precision floating-point instructions.+fp.dpโ the single- and double-precision floating-point instructions. both of them. iconic.+nofpโ turns the floating-point extension off.
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โ turns the cryptographic instructions off.+nofpโ turns off the floating-point, Advanced SIMD and cryptographic instructions. all of them, at once, no survivors. ๐
-march=native makes the compiler go โจauto-detectโจ the architecture of the build computer. ok but listen โ at present this feature is only supported on GNU/Linux, and not all architectures are recognized. and if the auto-detect fails? the option just... has no effect. it's giving "I tried my best." ๐ซ
-mtune=name โ this one tells GCC which target ARM processor it should tune the performance of the code for. for some ARM implementations you genuinely get better performance by using this option. ๐
Permissible names are:
arm7tdmi, arm7tdmi-s, arm710t, arm720t, arm740t, strongarm, strongarm110,
strongarm1100, 0strongarm1110, 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, ares,
cortex-r4, cortex-r4f, cortex-r5, cortex-r7, cortex-r8, cortex-r52, cortex-m0,
cortex-m0plus, cortex-m1, cortex-m3, cortex-m4, cortex-m7, cortex-m23,
cortex-m33, 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, xgene1
and additionally, this option can specify that GCC should tune the performance of the code for a big.LITTLE system. ๐๐ญ the permissible names for that are:
cortex-a15.cortex-a7, cortex-a17.cortex-a7, cortex-a57.cortex-a53,
cortex-a72.cortex-a53, cortex-a72.cortex-a35, cortex-a73.cortex-a53,
cortex-a75.cortex-a55, cortex-a76.cortex-a55
-mtune=generic-arch says GCC should tune the performance for a blend of processors within architecture arch. the whole goal is to generate code that runs well on the current most popular processors โ balancing between optimizations that benefit some CPUs in the range and avoiding performance pitfalls of other CPUs. ๐ the effects of this option may change in future GCC versions as CPU models come and go. it's fluid, it's a vibe.
-mtune permits the same extension options as -mcpu, but heads up โ the extension options do not affect the tuning of the generated code.
-mtune=native makes the compiler auto-detect the CPU of the build computer. at present, this feature is only supported on GNU/Linux, and not all architectures are recognized. if the auto-detect is unsuccessful, the option has no effect. same energy as -march=native, fr fr. ๐ซถ
-mcpu=name[+extension...] โ this specifies the name of the target ARM processor. GCC uses this name to derive the name of the target ARM architecture (as if you'd specified it with -march) and the ARM processor type to tune for performance (as if you'd specified it with -mtune). ๐
and here's the plot twist: where this option is used together with -march or -mtune, those options take precedence over the appropriate part of this option. so they win. periodt.
many of the supported CPUs implement optional architectural extensions. where that's the case, the architectural extensions are normally enabled by default. if implementations that lack the extension exist, then you can use the extension syntax 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. slay, options. โจ
permissible names for this option are the same as those for -mtune.
the following extension options are common to the listed CPUs:
+nodspโ disables the DSP instructions oncortex-m33.+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-m7andcortex-m33. and it 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-r52andcortex-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 it's equivalent to -march=arch -mtune=generic-arch. see -mtune for more info, bestie.
-mcpu=native makes the compiler auto-detect the CPU of the build computer. at present, this feature is only supported on GNU/Linux, and not all architectures are recognized. if the auto-detect is unsuccessful, the option has no effect. (yes, third time. it's a whole thing.) ๐ฆ
-mfpu=name โ this specifies what floating-point hardware (or hardware emulation) is available on the target. permissible names are: auto, vfpv2, vfpv3, vfpv3-fp16, vfpv3-d16, vfpv3-d16-fp16, vfpv3xd, vfpv3xd-fp16, neon-vfpv3, neon-fp16, vfpv4, vfpv4-d16, fpv4-sp-d16, neon-vfpv4, fpv5-d16, fpv5-sp-d16, fp-armv8, neon-fp-armv8 and crypto-neon-fp-armv8. ๐
note:neonis an alias forneon-vfpv3, andvfpis an alias forvfpv2. iykyk.
the setting auto is the default, and it's special. it makes the compiler select the floating-point and Advanced SIMD instructions based on the settings of -mcpu and -march. it just knows. โจ
if the selected floating-point hardware includes the NEON extension (e.g. -mfpu=neon), then heads up โ floating-point operations are not generated by GCC's auto-vectorization pass unless -funsafe-math-optimizations is also specified. why? because NEON hardware doesn't fully implement the IEEE 754 standard for floating-point arithmetic (in particular, denormal values are treated as zero), so using NEON instructions may lead to a loss of precision. ๐ญ no cap, that's real.
you can also set the fpu name at function level by using the target("fpu=") function attributes or pragmas. cute, right? ๐
-mfp16-format=name โ specifies the format of the __fp16 half-precision floating-point type. permissible names are none, ieee, and alternative; the default is none, in which case the __fp16 type is not defined. ๐ซถ
-mstructure-size-boundary=n โ the sizes of all structures and unions get rounded up to a multiple of the number of bits set by this option. permissible values are 8, 32 and 64. the default value varies for different toolchains. for the COFF targeted toolchain the default value is 8. a value of 64 is only allowed if the underlying ABI supports it. ๐
specifying a larger number can produce faster, more efficient code, but it can also increase the size of the program. and โ major caveat โ 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. ๐จ like, they will simply not speak the same language.
this option is deprecated. โ ๏ธ
-mabort-on-noreturn โ generates a call to the function abort at the end of a noreturn function. it gets executed if the function tries to return. it's giving "you said you wouldn't come back but here you are." ๐
-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 the subroutine call instruction. 64 megabytes. that's the limit, bestie.
even if this switch is enabled, not all function calls are turned into long calls. the heuristic is that these are not turned into long calls:
- static functions
- functions that have the
short_callattribute - functions that are inside the scope of a
#pragma no_long_callsdirective - functions whose definitions have already been compiled within the current compilation unit
and the exceptions to that rule โ these are always turned into long calls:
- weak function definitions
- functions with the
long_callattribute or thesectionattribute - functions that are within the scope of a
#pragma long_callsdirective ๐
This feature is not on by default. Say -mno-long-calls and you're back to the default vibe, and so is wrapping your function calls in a #pragma long_calls_off directive. But heads up bestie โ these switches do nothing to how the compiler generates code for function calls that go through function pointers. Zero. Zilch. ๐
-msingle-pic-baseโ treat the register used for PIC addressing as read-only instead of reloading it in the prologue of every single function. The runtime system is the one responsible for initializing this register with a suitable value before execution even starts. Teamwork, fr fr ๐ค-mpic-register=regโ pick which register gets used for PIC addressing. For the standard PIC base case, the default is whatever suitable register the compiler vibes out. For the single PIC base case, the default isR9if the target is EABI based or stack-checking is enabled โ otherwise it'sR10. That's just the rules, iykyk โจ-mpic-data-is-text-relativeโ assume the displacement between the text and data segments is fixed at static link time. This lets you use PC-relative addressing operations to access data you know is chillin' in the data segment. ๐ For non-VxWorks RTP targets this option is on by default. And when you disable it on those targets, it will enable-msingle-pic-baseby default. Surprise mechanic ๐-mpoke-function-nameโ write the name of each function into the text section, directly before the function prologue. The generated code is giving:
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 you're doing a stack backtrace, the code can peek at 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 there's a function name embedded immediately before this location and it has length ((pc[-3]) & 0xff000000). Detective work slay ๐
-mthumb-marmโ choose between generating code that runs in ARM state vs Thumb state. For most configurations the default is generating code that executes in ARM state, but that default can be changed by configuring GCC with the--with-mode=stateconfigure option. Configurable queen ๐
You can also override the ARM and Thumb mode for each function by using the target("thumb") and target("arm") function attributes or pragmas. Per-function glow-ups โจ
-mflip-thumbโ switch ARM/Thumb modes on alternating functions. This one is here for regression testing of mixed Thumb/ARM code generation, and it is not intended for ordinary use when compiling code. Not for the girlies, this is lab equipment ๐งช-mtpcs-frameโ generate a stack frame that's compliant with the Thumb Procedure Call Standard for all non-leaf functions. (A leaf function is one that doesn't call any other functions โ no children, just vibes ๐) The default is-mno-tpcs-frame.-mtpcs-leaf-frameโ generate a stack frame that's compliant with the Thumb Procedure Call Standard for all leaf functions. (Again: a leaf function is one that doesn't call any other functions.) The default is-mno-apcs-leaf-frame. Note the mismatch, bestie โ that's exactly how it's written ๐-mcallee-super-interworkingโ gives every externally visible function in the file being compiled an ARM instruction set header which switches to Thumb mode before running the rest of the function. This lets these functions be called from non-interworking code. This option is not valid in AAPCS configurations because interworking is enabled by default there. ๐-mcaller-super-interworkingโ lets calls via function pointers (including virtual functions) execute correctly regardless of whether the target code was compiled for interworking or not. There's a small overhead in the cost of executing a function pointer if this is enabled. Also not valid in AAPCS configurations because interworking is enabled by default there. ๐-mtp=nameโ specify the access model for the thread local storage pointer. The valid models are:softโ generates calls to__aeabi_read_tpcp15โ fetches the thread pointer fromcp15directly (supported in thearm6karchitecture)autoโ uses the best available method for the selected processor
The default setting is auto. Let the compiler cook ๐ฉโ๐ณ
-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 it 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. Untouched, unbothered ๐-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 those instructions. It's enabled by default when-mcpu=cortex-m3is specified. Protective queen ๐ก๏ธ-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 isn't enabled then words in packed data structures are accessed a byte at a time. Byte by byte, one at a time, iconic patience ๐
The ARM attribute Tag_CPU_unaligned_access is set in the generated object file to either true or false, depending on the setting of this option. If unaligned access is enabled then the preprocessor symbol __ARM_FEATURE_UNALIGNED is also defined. โจ
-mneon-for-64bitsโ enables using Neon to handle scalar 64-bit operations. This is disabled by default since the cost of moving data from core registers to Neon is high. Neon's cute but the commute is brutal ๐-mslow-flash-dataโ assume loading data from flash is slower than fetching instructions. Therefore literal load is minimized for better performance. This option is only supported when compiling for ARMv7 M-profile and is 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. ๐-mprint-tune-infoโ print CPU tuning information as a comment in the assembler file. This is an option used only for regression testing of the compiler and is not intended for ordinary use in compiling code. This option is disabled by default. ๐งช-mverbose-cost-dumpโ enable verbose cost model dumping in the debug dump files. This option is provided for use in debugging the compiler. Compiler-girlie business only ๐ง-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. Strict, exclusive, no mixing โจ-mcmseโ generate secure code as per the "ARMv8-M Security Extensions: Requirements on Development Tools Engineering Specification", which can be found on <https://developer.arm.com/documentation/ecm0359818/latest/>. ๐
โจ AVR Options โจ
These options are defined for AVR implementations: ๐ธ
-mmcu=mcuโ specify Atmel AVR instruction set architectures (ISA) or MCU type. The default for this option isavr2. ๐
GCC supports the following AVR devices and ISAs:
"avr2"โ "Classic" devices with up to 8 KiB of program memory.mcu ="attiny22","attiny26","at90s2313","at90s2323","at90s2333","at90s2343","at90s4414","at90s4433","at90s4434","at90c8534","at90s8515","at90s8535"."avr25"โ "Classic" devices with up to 8 KiB of program memory and with the"MOVW"instruction.mcu ="attiny13","attiny13a","attiny24","attiny24a","attiny25","attiny261","attiny261a","attiny2313","attiny2313a","attiny43u","attiny44","attiny44a","attiny45","attiny48","attiny441","attiny461","attiny461a","attiny4313","attiny84","attiny84a","attiny85","attiny87","attiny88","attiny828","attiny841","attiny861","attiny861a","ata5272","ata6616c","at86rf401"."avr3"โ "Classic" devices with 16 KiB up to 64 KiB of program memory.mcu ="at76c711","at43usb355"."avr31"โ "Classic" devices with 128 KiB of program memory.mcu ="atmega103","at43usb320"."avr35"โ "Classic" devices with 16 KiB up to 64 KiB of program memory and with the"MOVW"instruction.mcu ="attiny167","attiny1634","atmega8u2","atmega16u2","atmega32u2","ata5505","ata6617c","ata664251","at90usb82","at90usb162"."avr4"โ "Enhanced" devices with up to 8 KiB of program memory.mcu ="atmega48","atmega48a","atmega48p","atmega48pa","atmega48pb","atmega8","atmega8a","atmega8hva","atmega88","atmega88a","atmega88p","atmega88pa","atmega88pb","atmega8515","atmega8535","ata6285","ata6286","ata6289","ata6612c","at90pwm1","at90pwm2","at90pwm2b","at90pwm3","at90pwm3b","at90pwm81". Look at all these little guys ๐ฆ
"avr5" ๐
"Enhanced" devices rocking 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", "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", "ata5795", "ata5790", "ata5790n", "ata5791", "ata6613c", "ata6614q", "ata5782", "ata5831", "ata8210", "ata8510", "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 a 3-byte PC, aka 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".
"avrxmega3" ๐
"XMEGA" devices with up to 64 KiB of combined program memory and RAM, and with program memory visible in the RAM address space. mcu = "attiny202", "attiny204", "attiny212", "attiny214", "attiny402", "attiny404", "attiny406", "attiny412", "attiny414", "attiny416", "attiny417", "attiny804", "attiny806", "attiny807", "attiny814", "attiny816", "attiny817", "attiny1604", "attiny1606", "attiny1607", "attiny1614", "attiny1616", "attiny1617", "attiny3214", "attiny3216", "attiny3217", "atmega808", "atmega809", "atmega1608", "atmega1609", "atmega3208", "atmega3209", "atmega4808", "atmega4809".
"avrxmega4" ๐
"XMEGA" devices with more than 64 KiB and up to 128 KiB of program memory. mcu = "atxmega64a3", "atxmega64a3u", "atxmega64a4u", "atxmega64b1", "atxmega64b3", "atxmega64c3", "atxmega64d3", "atxmega64d4".
"avrxmega5" ๐
"XMEGA" devices with more than 64 KiB and up to 128 KiB of program memory and more than 64 KiB of RAM. mcu = "atxmega64a1", "atxmega64a1u".
"avrxmega6" โญ
"XMEGA" devices with more than 128 KiB of program memory. mcu = "atxmega128a3", "atxmega128a3u", "atxmega128b1", "atxmega128b3", "atxmega128c3", "atxmega128d3", "atxmega128d4", "atxmega192a3", "atxmega192a3u", "atxmega192c3", "atxmega192d3", "atxmega256a3", "atxmega256a3b", "atxmega256a3bu", "atxmega256a3u", "atxmega256c3", "atxmega256d3", "atxmega384c3", "atxmega384d3".
"avrxmega7" ๐
"XMEGA" devices with more than 128 KiB of program memory and more than 64 KiB of RAM. mcu = "atxmega128a1", "atxmega128a1u", "atxmega128a4u".
"avrtiny" ๐ง
"TINY" Tiny core devices with 512 B up to 4 KiB of program memory. mcu = "attiny4", "attiny5", "attiny9", "attiny10", "attiny20", "attiny40".
"avr1" ๐ซถ
This ISA is implemented by the minimal AVR core and is supported for assembler only. mcu = "attiny11", "attiny12", "attiny15", "attiny28", "at90s1200".
-mabsdata ๐
Assume that all data in static storage can be accessed by LDS / STS instructions. Lowkey this option only does anything on reduced Tiny devices like the ATtiny40. Also peek the absdata AVR Variable Attributes variable attribute. iykyk.
-maccumulate-args ๐
Accumulate outgoing function arguments and acquire/release the needed stack space for outgoing function arguments once in function prologue/epilogue. Without this option, outgoing arguments get pushed before calling a function and popped afterwards.
Popping the arguments after the function call can be expensive on AVR, so accumulating the stack space might lead to smaller executables, because arguments need not be removed from the stack after such a function call.
This option can lead to reduced code size for functions that perform several calls to functions that get their arguments on the stack, like calls to printf-like functions.
*-mbranch-cost=cost* ๐
Set the branch costs for conditional branch instructions to cost. Reasonable values for cost are small, non-negative integers. The default branch cost is 0.
-mcall-prologues โจ
Functions' prologues/epilogues get expanded as calls to appropriate subroutines. Code size is smaller. Slay.
-mgas-isr-prologues ๐ฆ
Interrupt service routines (ISRs) may use the "__gcc_isr" pseudo instruction supported by GNU Binutils. If this option is on, the feature can still be disabled for individual ISRs by means of the AVR Function Attributes "no_gccisr" function attribute. This feature is activated per default if optimization is on (but not with -Og, check the Optimize Options section), and if GNU Binutils support PR21683 (https://sourceware.org/PR21683).
-mint8 ๐ญ
Assume "int" to be an 8-bit integer. This affects the sizes of all the types: a "char" is 1 byte, an "int" is 1 byte, a "long" is 2 bytes, and "long long" is 4 bytes. Heads up bestie: this option does not conform to the C standards, but it results in smaller code size.
-mmain-is-OS_task ๐
Do not save registers in "main". The effect is the same like attaching attribute AVR Function Attributes "OS_task" to "main". It is activated per default if optimization is on.
*-mn-flash=num* ๐ธ
Assume that the flash memory has a size of num times 64 KiB.
-mno-interrupts ๐
Generated code is not compatible with hardware interrupts. Code size is smaller though.
-mrelax ๐ฅ
Try to replace "CALL" resp. "JMP" instruction by the shorter "RCALL" resp. "RJMP" instruction if applicable. Setting -mrelax just adds the --mlink-relax option to the assembler's command line and the --relax option to the linker's command line.
Jump relaxing is performed by the linker, because jump offsets are not known before code is located. Therefore, the assembler code generated by the compiler is the same, but the instructions in the executable may differ from instructions in the assembler code.
Relaxing must be turned on if linker stubs are needed โ see the section on "EIND" and linker stubs below. Don't skip it fr fr.
-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 internally for multilib selection. It is not an optimization option, and you don't need to set it by hand.
-msp8 ๐
Treat the stack pointer register as an 8-bit register, i.e. assume the high byte of the stack pointer is zero. In general, you don't need to set this option by hand.
This option is used internally by the compiler to select and build multilibs for architectures "avr2" and "avr25". These architectures mix devices with and without "SPH". For any setting other than -mmcu=avr2 or -mmcu=avr25 the compiler driver adds or removes this option from the compiler proper's command line, because the compiler then knows if the device or architecture has an 8-bit stack pointer and thus no "SPH" register or not.
-mstrict-X ๐ง
Use address register "X" in a way proposed by the hardware. This means that "X" is only used in indirect, post-increment or pre-decrement addressing.
Without this option, the "X" register may be used in the same way as "Y" or "Z", which then is emulated by additional instructions. For example, loading a value with "X+const" addressing with a small non-negative "const < 64" to a register Rn is performed as
adiw r26, const ; X += const
ld <Rn>, X ; <Rn> = *X
sbiw r26, const ; X -= const
-mtiny-stack ๐
Only change the lower 8 bits of the stack pointer.
-mfract-convert-truncate ๐
Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
-nodevicelib ๐
Don't link against AVR-LibC's device specific library "lib<mcu>.a".
-nodevicespecs ๐ซถ
Don't add -specs=device-specs/specs-<mcu> to the compiler driver's command line. The user takes responsibility for supplying the sub-processes like compiler proper, assembler and linker with appropriate command line options.
-Waddr-space-convert ๐
Warn about conversions between address spaces in the case where the resulting address space is not contained in the incoming address space.
-Wmisspelled-isr ๐ญ
Warn if the ISR is misspelled, i.e. without __vector prefix. Enabled by default.
"EIND" and Devices with More Than 128 Ki Bytes of Flash ๐
Pointers in the implementation are 16 bits wide. The address of a function or label is represented as word address, so that indirect jumps and calls can target any code address in the range of 64 Ki words.
okay so bestie, 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 by the compiler like this, and ngl they come with some limitations:
- The compiler never sets
EIND. ๐ซ - The compiler uses
EINDimplicitly inEICALL/EIJMPinstructions, or it might readEINDdirectly 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. ๐ค - For indirect calls to functions and computed goto, the linker generates stubs. Stubs are jump pads, sometimes also called trampolines. So the indirect call/jump jumps to such a stub. The stub contains a direct jump to the desired address. ๐
- 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. ๐ - 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
libgccnever setsEIND. Notice that startup code is a blend of code fromlibgccand AVR-LibC. For the impact of AVR-LibC onEIND, see the AVR-LibC user manual (http://nongnu.org/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. โจ
#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 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. 0๏ธโฃ - If a AVR Named Address Spaces, named address space other than generic or
__flashis used, thenRAMPZis set as needed before the operation. โจ - If the device supports RAM larger than
64 KiBand the compiler needs to changeRAMPZto 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 KiBis not supported by GCC for AVR targets. If you use inline assembler to read from locations outside the16-bitaddress range and change one of theRAMPregisters, you must reset it to zero after the access. โ ๏ธ
โจ 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=mcuoption. Possible values are:
2, 25, 3, 31, 35, 4, 5, 51, 6
for mcu="avr2", mcu="avr25", mcu="avr3", mcu="avr31", mcu="avr35", mcu="avr4", mcu="avr5", mcu="avr51", mcu="avr6",
respectively and
100, 102, 103, 104, 105, 106, 107
for mcu="avrtiny", mcu="avrxmega2", mcu="avrxmega3", mcu="avrxmega4", mcu="avrxmega5", mcu="avrxmega6", mcu="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=devicedefines this built-in macro which reflects the device's name. For example,-mmcu=atmega8defines the built-in macro__AVR_ATmega8__,-mmcu=attiny261adefines__AVR_ATtiny261A__, etc. ๐ท๏ธ
The built-in macros' names follow the scheme __AVR_Device__ where Device is the device name as from the AVR user manual. The difference between Device in the built-in macro and device in -mmcu=device is that the latter is always lowercase. ๐ก
If device is not a device but only a core architecture like avr51, this macro is not defined. ๐ซ
__AVR_DEVICE_NAME__โ Setting-mmcu=devicedefines this built-in macro to the device's name. For example, with-mmcu=atmega8the macro is defined toatmega8. ๐
If device is not a device but only a core architecture like avr51, this macro is not defined. ๐ซ
__AVR_XMEGA__โ The device / architecture belongs to the XMEGA family of devices. ๐ซ__AVR_HAVE_ELPM__โ The device has theELPMinstruction. ๐__AVR_HAVE_ELPMX__โ The device has theELPM Rn,ZandELPM Rn,Z+instructions. ๐__AVR_HAVE_MOVW__โ The device has theMOVWinstruction to perform 16-bit register-register moves. ๐__AVR_HAVE_LPMX__โ The device has theLPM Rn,ZandLPM Rn,Z+instructions. ๐__AVR_HAVE_MUL__โ The device has a hardware multiplier. โ๏ธ__AVR_HAVE_JMP_CALL__โ The device has theJMPandCALLinstructions. This is the case for devices with more than8 KiBof program memory. ๐__AVR_HAVE_EIJMP_EICALL__,__AVR_3_BYTE_PC__โ The device has theEIJMPandEICALLinstructions. This is the case for devices with more than128 KiBof program memory. This also means that the program counter (PC) is 3 bytes wide. ๐ง__AVR_2_BYTE_PC__โ The program counter (PC) is 2 bytes wide. This is the case for devices with up 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 theRAMPD,RAMPX,RAMPY,RAMPZspecial 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 areSBRS,SBRC,SBIS,SBICandCPSE. 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 likeIN,OUT,SBI, etc. may use a different address as if addressed by an instruction to access RAM likeLDorSTS. 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"โ okay so some devices can read from flash memory usingLD*instructions?? iconic. The flash memory shows up in the data address space at an offset of__AVR_PM_BASE_ADDRESS__. If this macro isn't defined, bestie, that feature just doesn't exist. If it is defined, the address space is linear and you don't need to put.rodatainto RAM. The default linker description file handles all of this, and rn it's available foravrtinyandavrxmega3. Even more convenient? You don't need to use address spaces like__flashor features like attributeprogmemandpgm_read_*. periodt. ๐"__WITH_AVRLIBC__"โ the compiler is configured to be used together with AVR-Libc. See the--with-avrlibcconfigure option. ๐ซถ
๐ Blackfin Options ๐
-mcpu=cpu[-sirevision]โ tells you the name of the target Blackfin processor. rn, cpu can be one ofbf512,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 is the silicon revision of the target Blackfin processor, and any workarounds available for that targeted silicon revision get enabled. If sirevision is none, no workarounds get enabled. If sirevision is any, all workarounds for the targeted processor get 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, __SILICON_REVISION__ is defined to be 0xffff. If you don't use this optional sirevision, 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 makes the hardware BSP provided by libgloss get linked in if -msim isn't 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โ says the program is gonna run on the simulator. This makes the simulator BSP provided by libgloss get linked in. It only does anything for thebfin-elftoolchain. Certain other options, like-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โ when enabled, the compiler makes sure the generated code doesn't contain speculative loads after jump instructions. If you use this option,__WORKAROUND_SPECULATIVE_LOADSis defined. ๐-mno-specld-anomalyโ don't generate extra code to prevent speculative loads from happening.-mcsync-anomalyโ when enabled, the compiler makes sure the generated code doesn't containCSYNCorSSYNCinstructions too soon after conditional branches. If you use this option,__WORKAROUND_SPECULATIVE_SYNCSis defined.-mno-csync-anomalyโ don't generate extra code to preventCSYNCorSSYNCinstructions from happening too soon after a conditional branch.-mlow64kโ when enabled, the compiler is free to take advantage of the knowledge that the whole entire program fits into the low 64k of memory. ๐-mno-low64kโ assume the program is arbitrarily large. This is the default.-mstack-check-l1โ do stack checking using information placed into L1 scratchpad memory by the uClinux kernel.-mid-shared-libraryโ generate code that supports shared libraries via the library ID method. This allows for execute in place and shared libraries in an environment without virtual memory management. This option implies-fPIC. With abfin-elftarget, this option implies-msim.-mno-id-shared-libraryโ generate code that doesn't assume ID-based shared libraries are being used. This is the default.-mleaf-id-shared-libraryโ generate code that supports shared libraries via the library ID method, but assumes that this library or executable won't link against any other ID shared libraries. That lets the compiler use faster code for jumps and calls. ๐ฅ-mno-leaf-id-shared-libraryโ don't assume the code being compiled won't link against any ID shared libraries. Slower code gets generated for jump and call insns. ๐-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 just omitting this option.-msep-dataโ generate code that allows the data segment to be located in a different area of memory from the text segment. This allows for execute in place in an environment without virtual memory management by eliminating relocations against the text section.-mno-sep-dataโ generate code that assumes the data segment follows the text segment. This is the default.-mlong-calls,-mno-long-callsโ tells the compiler to do function calls by first loading the address of the function into a register and then doing a subroutine call on this register. You need this switch if the target function lies outside of the 24-bit addressing range of the offset-based version of the subroutine call instruction. ๐ซถ
This feature is not enabled by default. Specifying -mno-long-calls restores the default behavior. Note that these switches have no effect on how the compiler generates code to handle function calls via function pointers.
-mfast-fpโ link with the fast floating-point library. This library relaxes some of the IEEE floating-point standard's rules for checking inputs against Not-a-Number (NAN), in the interest of performance.-minline-pltโ enable inlining of PLT entries in function calls to functions that aren't known to bind locally. It has no effect without-mfdpic.-mmulticoreโ build a standalone application for multicore Blackfin processors. This option makes proper start files and link scripts supporting multicore get used, and defines the macro__BFIN_MULTICORE. It can only be used with-mcpu=bf561[-sirevision]. โจ
This option can be used with -mcorea or -mcoreb, which selects the one-application-per-core programming model. Without -mcorea or -mcoreb, the single-application/dual-core programming model is used. In this model, the main function of Core B should be named as coreb_main.
If this option isn't used, the single-core application programming model is used.
-mcoreaโ build a standalone application for Core A of BF561 when using the one-application-per-core programming model. Proper start files and link scripts get used to support Core A, and the macro__BFIN_COREAis defined. This option can only be used in conjunction with-mmulticore. ๐-mcorebโ build a standalone application for Core B of BF561 when using the one-application-per-core programming model. Proper start files and link scripts get used to support Core B, and the macro__BFIN_COREBis defined. When this option is used,coreb_mainshould be used instead ofmain. This option can only be used in conjunction with-mmulticore.-msdramโ build a standalone application for SDRAM. Proper start files and link scripts get used to put the application into SDRAM, and the macro__BFIN_SDRAMis defined. The loader should initialize SDRAM before loading the application.-micplbโ assume 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โ this specifies the name of the target architecture. GCC uses this name to figure out what kind of instructions it can emit when generating assembly code. Permissible names are:c62x,c64x,c64x+,c67x,c67x+,c674x.-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.neardatasection, which is pointed to by registerB14. Put small uninitialized global and static data in the.bsssection, which is adjacent to the.neardatasection. Put small read-only data into the.rodatasection. The corresponding sections used for large pieces of data are.fardata,.farand.const. ๐-msdata=allโ put all data, not just small objects, into the sections reserved for small data, and use addressing relative to theB14register 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.fardatasection, and all uninitialized data in the.farsection. Put all constant data into the.constsection.
๐ธ CRIS Options ๐ธ
These options are defined specifically for the CRIS ports. iykyk.
-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 isv0except forcris-axis-linux-gnu, where the default isv10. โจ-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-stack-frame=nโ warn when the stack frame of a function exceeds n bytes.-metrax4,-metrax100โ the options-metrax4and-metrax100are synonyms for-march=v3and-march=v8respectively. slay. ๐-mmul-bug-workaround,-mno-mul-bug-workaroundโ okay so there's a bug in themulsandmuluinstructions on the CPU models where that lil guy actually applies, and this option works around it. It's active by default bestie, so it's already slaying for you ๐-mpdebugโ turns on CRIS-specific verbose debug-related info in the assembly code. Also (bonus behavior โจ) it turns off</> the#NO_APPformatted-code indicator that goes to the assembler at the beginning of the assembly file. Two-for-one, we love that ๐-mcc-initโ do not use condition-code results from the previous instruction. Always emit compare and test instructions before condition codes get used. No shortcuts, no relying on leftovers ๐-mno-side-effectsโ don't emit instructions with side effects in addressing modes other than post-increment. Periodt.-mstack-align,-mno-stack-align,-mdata-align,-mno-data-align,-mconst-align,-mno-const-alignโ these (and theirno-counterparts) arrange โ or, for theno-versions, eliminate the arrangement โ for the stack frame, individual data and constants to be aligned for the maximum single data access size of the CPU model you picked. Default vibe is 32-bit alignment. And important: ABI details like structure layout are not affected by these options, so don't panic ๐ซถ-m32-bit,-m16-bit,-m8-bitโ same energy as the stack-, data- and const-align options above, except these make the stack frame, writable data and constants all be 32-bit, 16-bit or 8-bit aligned respectively. 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.
โ ๏ธ bestie use this one only together with visual inspection of the compiled code โ no warnings or errors get generated when call-saved registers must be saved, or when storage for local variables needs to be allocated. It will simply not tell you ๐ญ
-mno-gotplt,-mgotpltโ with-fpicand-fPIC, don't generate (or do generate, for-mgotplt) instruction sequences that load addresses for functions from the PLT part of the GOT, rather than (which is the traditional behavior on other architectures) calls to the PLT. Default is-mgotplt๐-melfโ a legacy no-op option, only recognized with thecris-axis-elfandcris-axis-linux-gnutargets. It's giving decorative โจ-mlinuxโ also a legacy no-op, only recognized with thecris-axis-linux-gnutarget.-simโ recognized forcris-axis-elf, this one arranges to link with input-output functions from a simulator library. Code, initialized data and zero-initialized data all get allocated consecutively ๐ง-sim2โ like-sim, but it passes linker options to locate initialized data at0x40000000and zero-initialized data at0x80000000๐
โจ CR16 Options โจ
These options are defined specifically for the CR16 ports. Niche but iconic ๐
-mmacโ enable the use of multiply-accumulate instructions. Disabled by default.-mcr16cplus,-mcr16cโ generate code for the CR16C or CR16C+ architecture. CR16C+ is the default ๐ธ-msimโ links the librarylibsim.awhich is in compatible with simulator. Applicable to ELF compiler only.-mint32โ choose integer type as 32-bit wide.-mbit-opsโ generatessbit/cbitinstructions for bit manipulations ๐ง-mdata-model=modelโ choose a data model. The choices for model arenear,farormedium.mediumis the default. However,faris not valid with-mcr16c, because the CR16C architecture does not support the far data model โ so don't try it ๐
โจ 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. (Yes, it's a whole roster ๐)-mbig-endian,-EB,-mlittle-endian,-ELโ select big- or little-endian code. The default is little-endian.-mhard-float,-msoft-floatโ select hardware or software floating-point implementations. The default is soft float.-mdouble-float,-mno-double-floatโ when-mhard-floatis in effect, enable generation of double-precision float instructions. This is the default except when compiling for CK803.-mfdivdu,-mno-fdivduโ when-mhard-floatis in effect, enable generation offrecipd,fsqrtd, andfdivdinstructions. This is the default except when compiling for CK803.-mfpu=fpuโ select the floating-point processor. This option can only be used with-mhard-float. Values for fpu 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โ enable multiprocessor instructions; the default is off.-mcpโ enable coprocessor instructions; the default is off.-mcacheโ enable coprocessor instructions; the default is off.-msecurityโ enable C-SKY security instructions; the default is off.-mtrustโ enable C-SKY trust instructions; the default is off.-mdsp,-medsp,-mvdspโ enable C-SKY DSP, Enhanced DSP, or Vector DSP instructions, respectively. All of these options default to off.-mdiv,-mno-divโ generate divide instructions. Default is off.-msmart,-mno-smartโ generate code for Smart Mode, using only registers numbered0-7so 16-bit instructions can be used. 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,-mstm,-mno-multiple-stld,-mno-stmโ 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 roughly n instructions. 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. So like, proceed with caution bestie ๐ญ
โจ 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. It's giving โจchaosโจ ngl
-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 ๐
So like, picture this: a framework directory is just a directory with frameworks in it, bestie. And a framework? It's a directory that has a Headers and/or PrivateHeaders directory sitting directly inside it, and its name ends in .framework. That's the whole vibe. The name of the framework is literally the name of that directory minus the .framework part. โจ
The headers that belong to the framework live in one of those two directories, and Headers gets searched first. Simple as that. ๐
Now, a subframework is a framework directory that lives inside a framework's Frameworks directory. And here's the rule, no cap: includes of subframework headers can only show up 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 really shouldn't have the same name as a framework โ if you do that, a warning gets issued. Currently a subframework cannot have subframeworks; in the future the mechanism may be extended to support this. ๐ฆ
The standard frameworks live in /System/Library/Frameworks and /Library/Frameworks. An example include looks like #include <Framework/header.h>, where Framework is the name of the framework and header.h is found in the PrivateHeaders or Headers directory. ๐
-iframeworkdirโ okay so this one is like-F, EXCEPT the directory gets treated as a system directory. The main difference between-iframeworkand-Fis that with-iframeworkthe compiler does not warn about constructs contained within header files found via dir. Heads up tho: this option is valid only for the C family of languages. ๐ซถ-gusedโ emits debugging information for symbols that are used. For stabs debugging format, this enables-feliminate-unused-debug-symbols. And guess what, it's by default ON. ๐-gfullโ emits debugging information for all symbols and types. The full meal, no crumbs left behind. ๐-mmacosx-version-min=versionโ the earliest version of MacOS X that this executable will run on is version. Typical values of version include10.1,10.2, and10.3.9. ๐ธ
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. It's giving "we tried to be flexible." ๐
-mkernelโ enables kernel development mode, main character energy only. 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. ๐ฅ-mone-byte-boolโ overrides the defaults forboolso thatsizeof(bool)==1. By defaultsizeof(bool)is4when compiling for Darwin/PowerPC and1when 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. Like, seriously bestie, be careful. ๐ญ
-mfix-and-continue-ffix-and-continue-findirect-data
Generate code suitable for fast turnaround development โ like, to allow GDB to dynamically load .o files into already-running programs. -findirect-data and -ffix-and-continue are provided for backwards compatibility. ๐ง
-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. No chill mode. ๐-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_loader executableโ 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 Darwinlibtoolcommand. ๐ฆ-force_cpusubtype_ALLโ this causes GCC's output file to have theALLsubtype, instead of one controlled by the-mcpuor-marchoption. โญ
And now, the moment you've all been waiting for โ the big ol' list of options that get passed straight to the Darwin linker, in all their glory, exactly as listed, duplicates and all (yes bestie, some of these really do show up twice, and I'm not about to edit the source, periodt ๐):
-allowable_client client_name-client_name-compatibility_version-current_version-dead_strip-dependency-file-dylib_file-dylinker_install_name-dynamic-exported_symbols_list-filelist-flat_namespace-force_flat_namespace-headerpad_max_install_names-image_base-init-install_name-keep_private_externs-multi_module-multiply_defined-multiply_defined_unused-noall_load-no_dead_strip_inits_and_terms-nofixprebinding-nomultidefs-noprebind-noseglinkedit-pagezero_size-prebind-prebind_all_twolevel_modules-private_bundle-read_only_relocs-sectalign-sectobjectsymbols-whyload-seg1addr-sectcreate-sectobjectsymbols-sectorder-segaddr-segs_read_only_addr-segs_read_write_addr-seg_addr_table-seg_addr_table_filename-seglinkedit-segprot-segs_read_only_addr-segs_read_write_addr-single_module-static-sub_library-sub_umbrella-twolevel_namespace-umbrella-undefined-unexported_symbols_list-weak_reference_mismatches-whatsloaded
These options are passed to the Darwin linker. The Darwin linker man page describes them in detail. Iykyk. ๐
๐ธ DEC Alpha Options ๐ธ
These -m options are defined for the DEC Alpha implementations, bestie. Let's get into it. โจ
-mno-soft-float-msoft-float
Use (do not use) the hardware floating-point instructions for floating-point operations. When -msoft-float is specified, functions in libgcc.a are used to perform floating-point operations. Unless they are replaced by routines that emulate the floating-point operations, or compiled in such a way as to call such emulations routines, these routines issue floating-point operations. If you are compiling for an Alpha without floating-point operations, you must ensure that the library is built so as not to call them. ๐ซถ
Note that Alpha implementations without floating-point operations are required to have floating-point registers. Wild, I know. ๐
-mfp-reg-mno-fp-regs
Generate code that uses (does not use) the floating-point register set. -mno-fp-regs implies -msoft-float. If the floating-point register set is not used, floating-point operands are passed in integer registers as if they were integers and floating-point results are passed in $0 instead of $f0. This is a non-standard calling sequence, so any function with a floating-point argument or return value called by code compiled with -mno-fp-regs must also be compiled with that option. ๐
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-mieeeexcept the generated code also maintains the IEEE inexact-flag. Turning on this option causes the generated code to implement fully-compliant IEEE math. In addition to_IEEE_FP,_IEEE_FP_EXACTis defined as a preprocessor macro. On some Alpha implementations the resulting code may execute significantly slower than the code generated by default. Since there is very little code that depends on the inexact-flag, you should normally not specify this option. Other Alpha compilers call this option-ieee_with_inexact. ๐ฅ-mfp-trap-mode=trap-modeโ this option controls what floating-point related traps are enabled. Other Alpha compilers call this option-fptm trap-mode. The trap mode can be set to one of four values: ๐nโ this is the default (normal) setting. The only traps that are enabled are the ones that cannot be disabled in software (e.g., division by zero trap).uโ in addition to the traps enabled 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. This means without software assistance it is impossible to recover from a floating trap and program execution normally needs to be terminated. GCC can generate code that can assist operating system trap handlers in determining the exact location that caused a floating-point trap. Depending on the requirements of an application, different levels of precisions can be selected: ๐pโ Program precision. This one's the default, bestie, and it means a trap handler can only figure out which program caused a floating-point exception. That's it, that's the whole tea. ๐ซfโ Function precision. Now the trap handler can clock which function caused a floating-point exception. Upgrade. โจiโ Instruction precision. The trap handler can pinpoint the exact instruction that caused the floating-point exception. maximum detail unlocked ๐
Other Alpha compilers ship the equivalent options under the names -scope_safe and -resumption_safe, iykyk.
-mieee-conformantโ This one stamps the generated code as IEEE conformant. Big warning though: 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. That's literally it. That's the whole job. ๐-mbuild-constantsโ Okay so normally GCC looks at a 32- or 64-bit integer constant and checks whether it can construct it from smaller constants in two or three instructions. If it can't, it just dumps 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 reach for this when building a shared library dynamic loader โ itself a shared library, it has to relocate itself in memory before it can find the variables and constants in its own data segment. Iconic self-referential behavior fr.
-mbwx,-mno-bwx,-mcix,-mno-cix,-mfix,-mno-fix,-mmax,-mno-maxโ These say whether GCC should generate code that uses the optional BWX, CIX, FIX and MAX instruction sets. The default is to use the instruction sets supported by the CPU type you specified via-mcpu=โ or, if you didn't specify one, the instruction sets of the CPU on which GCC was built.-mfloat-vax,-mfloat-ieeeโ Generate code that uses (or does not use) VAX F and G floating-point arithmetic instead of IEEE single and double precision. Pick your fighter. ๐ฅ-mexplicit-relocs,-mno-explicit-relocsโ Back in the day, older Alpha assemblers had literally no way to generate symbol relocations except through assembler macros. And those macros? They do not allow optimal instruction scheduling. Rude. ๐ค GNU binutils as of version 2.12 supports a new syntax that lets the compiler explicitly mark which relocations should apply to which instructions. This option is mostly useful for debugging, since GCC detects the capabilities of the assembler when it is built and sets the default accordingly.-msmall-data,-mlarge-dataโ When-mexplicit-relocsis in effect, static data gets accessed via gp-relative relocations. With-msmall-data, 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 caps the small data area at 64KB, but lets the variables be directly accessed with a single instruction. Efficiency slay. โจ
The default is -mlarge-data. With that option the data area is limited to just below 2GB. Programs that need 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. Sorry bestie, that's just the rules. ๐ซถ
When generating code for shared libraries, -fpic implies -msmall-data and -fPIC implies -mlarge-data.
-msmall-text,-mlarge-textโ With-msmall-text, the compiler assumes that the code of the entire program (or shared library) fits in 4MB, so it's reachable with a branch instruction. When-msmall-datais used, the compiler can assume that all local symbols share the same$gpvalue, which cuts the number of instructions required for a function call from 4 down to 1. Glow up.
The default is -mlarge-text.
-mcpu=cpu_typeโ Sets the instruction set and instruction scheduling parameters for machine type cpu_type. You can give either the EV style name or the corresponding chip number. GCC supports scheduling parameters for the EV4, EV5 and EV6 family of processors and picks the default values for the instruction set from the processor you specify. If you don't specify a processor type at all, GCC defaults to the processor on which the compiler was built.
Supported values for cpu_type are:
ev4ev4521064โ Schedules as an EV4 and has no instruction set extensions.ev521164โ Schedules as an EV5 and has no instruction set extensions.ev5621164aโ Schedules as an EV5 and supports the BWX extension.pca5621164pc21164PCโ Schedules as an EV5 and supports the BWX and MAX extensions.ev621264โ Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.ev6721264aโ 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โ Sets only the instruction scheduling parameters for machine type cpu_type. The instruction set is not changed. Tuning only, no architecture drama. ๐
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. Basically vibes-based hardware math, but make it precise. ๐ง
Valid options for time are:
numberโ A decimal number representing clock cycles.L1L2L3mainโ 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.
๐ FR30 Options ๐
These options are defined specifically for the FR30 port.
-msmall-modelโ Use the small address space model. This can produce smaller code, but it does assume that all symbolic values and addresses fit into a 20-bit range. Small but mighty, assuming you stay in your lane. ๐-mno-lsimโ Assume that runtime support has been provided, so there's no need to include the simulator library (libsim.a) on the linker command line.
๐ FT32 Options ๐
These options are defined specifically for the FT32 port.
-msimโ Specifies that the program will be run on the simulator. This causes an alternate runtime startup and library to be linked. You must not use this option when generating programs that will run on real hardware โ you have to provide your own runtime library for whatever I/O functions are needed. Simulator only, no cap. ๐ซ-mlraโ Enable Local Register Allocation. This is still experimental for FT32, so by default the compiler uses standard reload. Living on the edge, I respect it. โจ-mnodivโ Do not usedivandmodinstructions.-mft32bโ Enable use of the extended instructions of the FT32B processor.-mcompressโ Compress all code using the Ft32B code compression scheme.-mnopmโ Do not generate code that reads program memory.
๐ฆ FRV Options ๐ฆ
-mgpr-32โ Only use the first 32 general-purpose registers.-mgpr-64โ Use all 64 general-purpose registers. Go big.-mfpr-32โ Use only the first 32 floating-point registers.-mfpr-64โ Use all 64 floating-point registers.-mhard-floatโ Use hardware instructions for floating-point operations.-msoft-floatโ Use library routines for floating-point operations.-malloc-ccโ Dynamically allocate condition code registers.-mfixed-ccโ Do not try to dynamically allocate condition code registers, only useicc0andfcc0.-mdwordโ Change ABI to use double word insns.-mno-dwordโ Do not use double word instructions.-mdoubleโ Use floating-point double instructions.-mno-doubleโ Do not use floating-point double instructions.-mmediaโ Use media instructions.-mno-mediaโ Do not use media instructions.-mmuladdโ Use multiply and add/subtract instructions.-mno-muladdโ Do not use multiply and add/subtract instructions.-mfdpicโ Select the FDPIC ABI, which uses function descriptors to represent pointers to functions. Without any PIC/PIE-related options, it implies-fPIE. With-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. So many implications, it's giving domino effect. ๐ข-minline-pltโ Enable inlining of PLT entries in function calls to functions that are not known to bind locally. It has no effect without-mfdpic. It's enabled by default if optimizing for speed and compiling for shared libraries (i.e.,-fPICor-fpic), or when an optimization option such as-O3or above is present in the command line.-mTLSโ Assume a large TLS segment when generating thread-local code.-mtlsโ Do not assume a large TLS segment when generating thread-local code.-mgprel-roโ Enable the use ofGPRELrelocations 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. Leave it alone bestie, it's fine. ๐-mlinked-fpโ Follow the EABI requirement of always creating a frame pointer whenever a stack frame is allocated. This option is enabled by default and can be disabled with-mno-linked-fp.-mlong-callsโ bestie, this one uses indirect addressing to call functions that live outside the current compilation unit ๐ซถ which means those functions can be dropped literally anywhere in the 32-bit address space. iconic, flexible, no cap.-malign-labelsโ tries to line up labels on an 8-byte boundary by sliding NOPs into the previous packet โจ heads up tho: this only does anything when VLIW packing is turned on. It does not make new packets โ it just sprinkles NOPs into the ones that already exist. it's giving "decoration, not construction" ๐-mlibrary-picโ generates position-independent EABI code. slay.-macc-4โ use only the first four media accumulator registers. four. that's it. that's the whole vibe.-macc-8โ use all eight media accumulator registers ๐ go big.-mpackโ pack VLIW instructions. ๐ฆ-mno-packโ do not pack VLIW instructions. ๐-mno-eflagsโ do not mark ABI switches ine_flags.-mcond-moveโ enables the use of conditional-move instructions (this is the default). ๐
real talk: this switch is mainly for debugging the compiler and will likely be removed in a future version. so, like, don't build your whole personality on it.
-mno-cond-moveโ disables the use of conditional-move instructions.
same warning, bestie: mainly for debugging the compiler, probably getting deleted in a future version.
-msccโ enables the use of conditional set instructions (default). โจ
and yes โ mainly for debugging the compiler, likely removed in a future version.
-mno-sccโ disables the use of conditional set instructions.
also mainly for debugging the compiler, also likely to get removed in a future version.
-mcond-execโ enables the use of conditional execution (default). ๐
mainly for debugging the compiler, likely removed in a future version.
-mno-cond-execโ disables the use of conditional execution.
mainly for debugging the compiler, likely removed in a future version.
-mvliw-branchโ runs a pass to pack branches into VLIW instructions (default). ๐
mainly for debugging the compiler, likely removed in a future version.
-mno-vliw-branchโ does not run a pass to pack branches into VLIW instructions.
mainly for debugging the compiler, likely removed in a future version.
-mmulti-cond-execโ enables optimization of"&&"and"||"in conditional execution (default). ๐ฅ
mainly for debugging the compiler, likely removed in a future version.
-mno-multi-cond-execโ disables optimization of"&&"and"||"in conditional execution.
mainly for debugging the compiler, likely removed in a future version.
-mnested-cond-execโ enables nested conditional execution optimizations (default). ๐ฆ
mainly for debugging the compiler, likely removed in a future version.
-mno-nested-cond-execโ disables nested conditional execution optimizations.
mainly for debugging the compiler, likely removed in a future version.
-moptimize-membarโ this switch removes redundant"membar"instructions from the compiler-generated code. It is enabled by default. so it's already doing the thing, you don't have to ask ๐-mno-optimize-membarโ this switch disables the automatic removal of redundant"membar"instructions from the generated code. let them pile up, I guess ๐-mtomcat-statsโ causesgasto print out tomcat statistics. numbers!! stats!! ๐- *
-mcpu=cpu* โ selects the processor type you're generating code for. the possible values arefrv,fr550,tomcat,fr500,fr450,fr405,fr400,fr300andsimple. pick your fighter ๐
๐ง GNU/Linux Options ๐ง
these -m options are defined for GNU/Linux targets, bestie:
-mglibcโ use the GNU C library. this is the default except on*-*-linux-*uclibc*,*-*-linux-*musl*and*-*-linux-*android*targets. the classic ๐-muclibcโ use uClibc C library. this is the default on*-*-linux-*uclibc*targets.-mmuslโ use the musl C library. this is the default on*-*-linux-*musl*targets. โจ-mbionicโ use Bionic C library. this is the default on*-*-linux-*android*targets. ๐ค-mandroidโ compile code compatible with 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, it makes the GCC driver pass Android-specific options to the linker. and finally โ because it's an overachiever โ it causes the preprocessor macro "__ANDROID__" to be defined. three jobs, one flag, main character energy fr fr ๐ฅ
-tno-android-ccโ disables the compilation effects of-mandroid, i.e. it does not enable-mbionic,-fPIC,-fno-exceptionsand-fno-rttiby default.-tno-android-ldโ disables the linking effects of-mandroid, i.e. it passes standard Linux linking options to the linker.
๐ H8/300 Options ๐
these -m options are defined for the H8/300 implementations:
-mrelaxโ shortens some address references at link time, when possible; it uses the linker option-relax. tiny but mighty ๐-mhโ generate code for the H8/300H.-msโ generate code for the H8S.-mnโ generate code for the H8S and H8/300H in the normal mode. this switch must be used either with-mhor-ms. no solo runs, it's a duo ๐ซถ-ms2600โ generate code for the H8S/2600. this switch must be used with-ms.-mexrโ extended registers are stored on the stack before execution of a function with the monitor attribute. the default option is-mexr. this option is valid only for H8S targets.-mno-exrโ extended registers are not stored on the stack before execution of a function with the monitor attribute. the default option is-mno-exr. this option is valid only for H8S targets.-mint32โ make"int"data 32 bits by default. glow up โจ-malign-300โ on the H8/300H and H8S, use the same alignment rules as for the H8/300. the default for the H8/300H and H8S is to align longs and floats on 4-byte boundaries.-malign-300causes them to be aligned on 2-byte boundaries. this option has no effect on the H8/300. (rude, but okay ๐)
๐ HPPA Options ๐
these -m options are defined for the HPPA family of computers:
-march=architecture-type โ generate 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. refer to/usr/lib/sched.modelson an HP-UX system to determine the proper architecture option for your machine. code compiled for lower-numbered architectures runs on higher-numbered architectures, but **not the other way around. โฌ๏ธ only. one-way street, bestie.-mpa-risc-1-0-mpa-risc-1-1-mpa-risc-2-0
these are synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively. same energy, different spelling ๐
-mcaller-copiesโ the caller copies function arguments passed by hidden reference. use this one with care, because it is not compatible with the default 32-bit runtime ๐ญ however โ and this is the redemption arc โ only aggregates larger than eight bytes are passed by hidden reference, and the option provides better compatibility with OpenMP. slay, honestly.-mjump-in-delayโ this option is ignored and provided for compatibility purposes only. it's just here vibing. literally just a decoration ๐-mdisable-fpregsโ prevents floating-point registers from being used in any manner. this is necessary for compiling kernels that perform lazy context switching of floating-point registers. but listen: if you use this option and attempt to perform floating-point operations, the compiler aborts. ๐ no warning shot, just gone.-mdisable-indexingโ prevents the compiler from using indexing address modes. this avoids some rather obscure problems when compiling MIG generated code under MACH.-mno-space-regsโ generate code that assumes the target has no space registers. this lets GCC generate faster indirect calls and use unscaled index address modes. ๐๏ธ
such code is suitable for level 0 PA systems and kernels.
-mfast-indirect-callsโ generate code that assumes calls never cross space boundaries. this allows GCC to emit code that performs faster indirect calls. ๐ฅ
this option does not work in the presence of shared libraries or nested functions. fr fr, it will not go.
- *
-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. ๐ฆ -mlong-load-storeโ generate 3-instruction load and store sequences, as sometimes required by the HP-UX 10 linker. this is equivalent to the+koption to the HP compilers.-mportable-runtimeโ use the portable calling conventions proposed by HP for ELF systems.-mgasโ enable the use of assembler directives only GAS understands. insider knowledge, iykyk โจ- *
-mschedule=cpu-type* โ schedule code according to the constraints for the machine type cpu-type. the choices for cpu-type are700,7100,7100LC,7200,7300and8000. refer to/usr/lib/sched.modelson an HP-UX system to determine the proper scheduling option for your machine. the default scheduling is8000. ๐ -mlinker-optโ enable the optimization pass in the HP-UX linker. note this makes symbolic debugging impossible. ๐ญ it also triggers a bug in the HP-UX 8 and HP-UX 9 linkers in which they give bogus error messages when linking some programs. so... trade-offs, bestie.-msoft-floatโ generate output containing library calls for floating point. Warning: the requisite libraries are not available for all HPPA targets. normally the facilities of the machine's usual C compiler are used, but this cannot be done directly in cross-compilation. you must make your own arrangements to provide suitable library functions for cross-compilation. ๐ซถ do your homework.
-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. all of it or none of it, no halfsies ๐
-msioโ generate the predefine"_SIO"for server IO. the default is-mwsio. this generates the predefines"__hp9000s700","__hp9000s700__"and"_WSIO", for workstation IO. these options are available under HP-UX and HI-UX. ๐ธ-mgnu-ldโ okay so this one tells GCC to use the options that are specific to GNUld๐ซถ. When you're building a shared library, it passes-sharedtold. It's the default when GCC is configured, either explicitly or implicitly, with the GNU linker. Important vibe check tho: this option does not change whichldgets called โ it only changes what parameters get passed to thatld. Theldthat actually gets called is decided by the--with-ldconfigure option, then GCC's program search path, and finally by the user'sPATH. Wanna see which linker GCC is using? Rungcc -print-prog-name=ldand it'll spill the tea ๐ . Heads up: this option is only available on the 64-bit HP-UX GCC, i.e. configured withhppa*64*-*-hpux*.-mhp-ldโ the HPldversion of the above โจ. When building a shared library it passes-btold, and it passes+Accept TypeMismatchtoldon all links. It's the default when GCC is configured, explicitly or implicitly, with the HP linker. Same deal as before: it does not affect whichldis called, only what parameters get passed to it. Whichldis called is determined by the--with-ldconfigure option, GCC's program search path, and finally the user'sPATH. And again,gcc -print-prog-name=ldprints which linker GCC uses. Only available on the 64-bit HP-UX GCC, i.e. configured withhppa*64*-*-hpux*.-mlong-callsโ generates code that uses long call sequences ๐ฅ. This guarantees a call can always reach linker-generated stubs. The default behavior 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. Sibcalls are always limited at240,000bytes.
Distances are measured from the beginning of functions when you use -ffunction-sections, or when you use -mgas and -mno-portable-runtime together under HP-UX with the SOM linker.
Ngl bestie, it's normally not desirable to use this option because it degrades performance ๐ญ. But it can be useful in large applications, particularly when partial linking is used to build the application.
The types of long calls used depend on the capabilities of the assembler and linker, and on the type of code being generated. The impact on systems that support long absolute calls, and long pic symbol-difference or pc-relative calls, should be relatively small. However, an indirect call is used on 32-bit ELF systems in pic code and it is quite long. ๐
-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.98is available on HP-UX 11.11 and later. The default values are93for HP-UX 10.00,95for HP-UX 10.10 through 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, and the startfile unix95.o. -munix=98 provides additional predefines for _XOPEN_UNIX, _XOPEN_SOURCE_EXTENDED, _INCLUDE__STDC_A1_SOURCE and _INCLUDE_XOPEN_SOURCE_500, and the startfile unix98.o.
๐จ Okay this part matters: it's important to note that this option changes the interfaces for various library routines. It also affects the operational behavior of the C library. So extreme care is needed when using this option. Fr fr.
Library code that's intended to operate with more than one UNIX standard must test, set and restore the variable __xpg4_extended_mask as appropriate. Most GNU software doesn't provide this capability. ๐
-nolibdldโ suppresses the generation of link options to searchlibdld.slwhen the-staticoption is specified on HP-UX 10 and later. ๐-staticโ so here's the situation: the HP-UX implementation ofsetlocalein libc has a dependency onlibdld.sl. There isn't an archive version oflibdld.sl. Which means when the-staticoption is specified, special link options are needed to resolve this dependency. ๐ซ
On HP-UX 10 and later, the GCC driver adds the necessary options to link with libdld.sl when the -static option is specified. This causes the resulting binary to be dynamic. On the 64-bit port, the linkers generate dynamic binaries by default in any case. The -nolibdld option can be used to prevent the GCC driver from adding these link options. โจ
-threadsโ adds support for multithreading with the dce thread library under HP-UX ๐ง. This option sets flags for both the preprocessor and the linker.
๐ IA-64 Options ๐
These are the -m options defined for the Intel IA-64 architecture. Buckle up bestie, there's a lot ๐
-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. The result is not position independent code, and it violates the IA-64 ABI ๐ญ.-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. This is useful when compiling kernel code.-mauto-picโ generate code that is self-relocatable. This implies-mconstant-gp. This is useful when compiling firmware code. ๐ฅ-minline-float-divide-min-latencyโ generate code for inline divides of floating-point values using the minimum latency algorithm.-minline-float-divide-max-throughputโ generate code for inline divides of floating-point values using the maximum throughput algorithm.-mno-inline-float-divideโ do not generate inline code for divides of floating-point values.-minline-int-divide-min-latencyโ generate code for inline divides of integer values using the minimum latency algorithm.-minline-int-divide-max-throughputโ generate code for inline divides of integer values using the maximum throughput algorithm.-mno-inline-int-divideโ do not generate inline code for divides of integer values.-minline-sqrt-min-latencyโ generate code for inline square roots using the minimum latency algorithm.-minline-sqrt-max-throughputโ generate code for inline square roots using the maximum throughput algorithm.-mno-inline-sqrtโ do not generate inline code forsqrt. ๐-mfused-madd,-mno-fused-maddโ do (don't) generate code that uses the fused multiply/add or multiply/subtract instructions. The default is to use these instructions.-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. ๐คท-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. ๐-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-prefer-non-data-spec-insns,-msched-prefer-non-data-spec-insnsโ turn this on and data-speculative instructions only get picked for the schedule if there's literally nothing else available at that moment. Translation: it makes data speculation way more conservative. Default is disabled, bestie.-mno-sched-prefer-non-control-spec-insns,-msched-prefer-non-control-spec-insnsโ same energy but for control-speculative instructions ๐ if enabled, they're only chosen when there are no other choices, which makes control speculation a whole lot more careful. Default: disabled.-mno-sched-count-spec-in-critical-path,-msched-count-spec-in-critical-pathโ enable this and speculative dependencies get counted when the compiler works out instruction priorities, making speculation a lil more conservative. Default: disabled.-msched-spec-ldcโ use a simple data speculation check. This one is on by default โจ-msched-control-spec-ldcโ use a simple check for control speculation. Also on by default ๐-msched-stop-bits-after-every-cycleโ place a stop bit after every cycle when scheduling. On by default, no cap.-msched-fp-mem-deps-zero-costโ assume floating-point stores and loads probably won't conflict when they land in the same instruction group. Disabled by default.-msel-sched-dont-check-control-specโ generate checks for control speculation in selective scheduling. This flag is disabled by default.- *
-msched-max-memory-insns=max-insns* โ caps how many memory insns can go in one instruction group, giving lower priority to later memory insns trying to schedule into the same group. Super useful for dodging cache bank conflicts. Default value is1. -msched-max-memory-insns-hard-limitโ makes the limit frommsched-max-memory-insnsa hard limit ๐ no more than that number, periodt. Without it, the limit is "soft", meaning non-memory operations get preferred once you hit the cap, but memory operations can still sneak in and schedule.
๐ธ LM32 Options ๐ธ
These -m options are defined for the LatticeMico32 architecture, bestie:
-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 ๐
๐ฆ M32C Options ๐ฆ
- *
-mcpu=name* โ pick the CPU that code gets generated for. name can 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โ says the program is gonna run on the simulator, which links in an alternate runtime library that supports stuff like file I/O. ๐ซถ
Do NOT use this option when you're generating programs that run on real hardware. You have to provide your own runtime library for whatever I/O functions you need. Like, actually.
-memregs=number โ sets how many memory-based pseudo-registers GCC uses during code generation. These pseudo-registers work like real registers, so there's a tradeoff between GCC's ability to fit code into the registers you have available and the performance hit from using memory instead of registers. Note that **all modules in a program must be compiled with the same value for this option โ and because of that, you must not use this option with GCC's default runtime libraries. ๐ญ
๐ M32R/D Options ๐
These -m options are defined for Renesas M32R/D architectures:
-m32r2โ generate code for the M32R/2.-m32rxโ generate code for the M32R/X.-m32rโ generate code for the M32R. This is the default.-mmodel=smallโ assume all objects live in the lower 16MB of memory (so their addresses can be loaded with 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 โ so the compiler generates the much slowerseth/add3/jlinstruction sequence ๐-msdata=noneโ disable use of the small data area. Variables get 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 don't generate special code to reference them.-msdata=useโ put small global and static data in the small data area, and do 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. Default for num is8. The-msdataoption must be set to one ofsdataorusefor this option to do literally anything.
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 print out some statistics that might help when debugging programs ๐-malign-loopsโ align all loops to a 32-byte boundary.-mno-align-loopsโ don't enforce a 32-byte alignment for loops. This is the default.- *
-missue-rate=number* โ issue number instructions per cycle. number can only be1or2. - *
-mbranch-cost=number* โ number can only be1or2. If it's1then branches are preferred over conditional code; if it's2, then the opposite applies. - *
-mflush-trap=number* โ specifies the trap number to use to flush the cache. Default is12. Valid numbers are between0and15inclusive. -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. 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. iykyk ๐
- *
-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
51:5151ac51ag51cn51em51je51jf51jg51jm51mm51qe51qm - Family
5206:520252045206 - Family
5206e:5206e - Family
5208:52075208 - Family
5211a:5210a5211a - Family
5213:521152125213 - Family
5216:52145216 - Family
52235:522305223152232522335223452235 - Family
5225:52245225 - Family
52259:522525225452255522565225852259 - Family
5235:5232523352345235523x - Family
5249:5249 - Family
5250:5250 - Family
5271:52705271 - Family
5272:5272 - Family
5275:52745275 - Family
5282:528052815282528x - Family
53017:53011530125301353014530155301653017 - Family
5307:5307 - Family
5329:532753285329532x - Family
5373:53725373537x - Family
5407:5407 - Family
5475:547054715472547354745475547x548054815482548354845485
- Family
-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โ bestie this one generates output for a 68000. It's the default when the compiler is configured for 68000-based systems, and it's literally equivalent to-march=68000.
Use this one for microcontrollers with a 68000 or EC000 core, including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356. ๐
-m68010โ generates output for a 68010. Default when the compiler is configured for 68010-based systems, and it's equivalent to-march=68010. periodt.-m68020,-mc68020โ generates output for a 68020. The default when the compiler is configured for 68020-based systems. Equivalent to-march=68020. โจ-m68030โ generates output for a 68030. Default when the compiler is configured for 68030-based systems. Equivalent to-march=68030.-m68040โ generates output for a 68040. Default when the compiler is configured for 68040-based systems. Equivalent to-march=68040.
Heads up: this option inhibits the use of 68881/68882 instructions that have to be emulated by software on the 68040. So use this option if your 68040 does not have code to emulate those instructions. ๐ซถ
-m68060โ generates output for a 68060. Default when the compiler is configured for 68060-based systems. Equivalent to-march=68060.
This one inhibits the use of 68020 and 68881/68882 instructions that have to be emulated by software on the 68060. Use it if your 68060 does not have code to emulate those instructions.
-mcpu32โ generates output for a CPU32. Default when the compiler is configured for CPU32-based systems. Equivalent to-march=cpu32.
Use this for microcontrollers with a CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334, 68336, 68340, 68341, 68349 and 68360. ๐
-m5200โ generates output for a 520X ColdFire CPU. Default when the compiler is configured for 520X-based systems. It's equivalent to-mcpu=5206, and it's now deprecated in favor of that option.
Use it for microcontrollers with a 5200 core, including the MCF5202, MCF5203, MCF5204 and MCF5206.
-m5206eโ generates output for a 5206e ColdFire CPU. This option is now deprecated in favor of the equivalent-mcpu=5206e.-m528xโ generates output for a member of the ColdFire 528X family. The option is now deprecated in favor of the equivalent-mcpu=528x.-m5307โ generates output for a ColdFire 5307 CPU. The option is now deprecated in favor of the equivalent-mcpu=5307.-m5407โ generates output for a ColdFire 5407 CPU. The option is now deprecated in favor of the equivalent-mcpu=5407.-mcfv4eโ generates 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 it's now deprecated in favor of that option.-m68020-40โ generates output for a 68040, without using any of the new instructions. This gives you code that can run relatively efficiently on either a 68020/68881 or a 68030 or a 68040. The generated code does use the 68881 instructions that are emulated on the 68040.
The option is equivalent to -march=68020 -mtune=68020-40. โจ
-m68020-60โ generates output for a 68060, without using any of the new instructions. This gives you code that can run relatively efficiently on either a 68020/68881 or a 68030 or a 68040. The generated code does use the 68881 instructions that are emulated on the 68060.
The option is equivalent to -march=68020 -mtune=68020-60.
-mhard-float,-m68881โ generate floating-point instructions. This is the default for 68020 and above, and for ColdFire devices that have an FPU. It defines the macro__HAVE_68881__on M680x0 targets and__mcffpu__on ColdFire targets. ๐-msoft-floatโ do not generate floating-point instructions; use library calls instead. This is the default for 68000, 68010, and 68832 targets. It's also the default for ColdFire devices that have no FPU.-mdiv,-mno-divโ generate (or don't generate, respectively) 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โ 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.-mno-shortโ do not consider typeintto be 16 bits wide. This is the default.-mnobitfield,-mno-bitfieldโ do not use the bit-field instructions. The-m68000,-mcpu32and-m5200options imply-mnobitfield.-mbitfieldโ do use the bit-field instructions. The-m68020option implies-mbitfield. This is the default if you use a configuration designed for a 68020.-mrtdโ use 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's no need to pop the arguments there. โจ
This calling convention is incompatible with the one normally used on Unix, so you cannot use it if you need to call libraries compiled with the Unix compiler. ๐ญ
Also, you must provide function prototypes for all functions that take variable numbers of arguments (including printf); otherwise incorrect code is generated for calls to those functions.
In addition, seriously incorrect code results if you call a function with too many arguments. (Normally, extra arguments are harmlessly ignored.)
The rtd instruction is supported by the 68010, 68020, 68030, 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
The default is -mno-rtd.
-malign-int,-mno-align-intโ control whether GCC 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. bestie pls read that twice ๐
-mpcrelโ use the pc-relative addressing mode of the 68000 directly, instead of using a global offset table. At present, this option implies-fpic, allowing at most a 16-bit offset for pc-relative addressing.-fPICis not presently supported with-mpcrel, though this could be supported for 68020 and higher processors.-mno-strict-align,-mstrict-alignโ do not (do) assume that unaligned memory references are handled by the system.-msep-dataโ generate code that 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. ๐ธ-mno-sep-dataโ generate code that assumes that the data segment follows the text segment. This is the default.-mid-shared-libraryโ generate code that supports shared libraries via the library ID method. This allows for execute-in-place and shared libraries in an environment without virtual memory management. This option implies-fPIC.-mno-id-shared-libraryโ generate code that doesn't assume ID-based shared libraries are being used. This is the default.-mshared-library-id=nโ specifies the identification number of the ID-based shared library being compiled. Specifying a value 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 than 8192 entries. 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.
-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. iykyk ๐
-mhardlit,-mno-hardlitโ inline constants into the code stream if it can be done in two instructions or less.-mdiv,-mno-divโ use the divide instruction. (Enabled by default). โจ-mrelax-immediate,-mno-relax-immediateโ allow arbitrary-sized immediates in bit operations.-mwide-bitfields,-mno-wide-bitfieldsโ always treat bit-fields 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-endian target. (yes, bestie, the page literally gives that same one-liner for both of them, I'm just passing the message along verbatim ๐)-m210,-m340โ Generate code for the 210 processor. iconic little number, no notes-mno-lsimโ Assume that runtime support has been provided, so leave the simulator library (libsim.a) off the linker command line entirely. she's self-sufficient ๐-mstack-increment=sizeโ Sets the max amount for a single stack increment operation. Big values can speed up programs that have functions needing a whole lot of stack space โ but they can also trigger a segmentation fault if the stack gets extended too much, so like, be careful. The default value is0x1000.
โจ MeP Options โจ
-mabsdiffโ Enables theabsinstruction, which is the absolute difference between two registers. difference, but make it absolute ๐-mall-optsโ Enables all the optional instructions: average, multiply, divide, bit operations, leading zero, absolute difference, min/max, clip, and saturation.-maverageโ Enables theaveinstruction, which computes the average of two registers.-mbased=nโ Variables of size n bytes or smaller get placed in the.basedsection by default. Based variables use the$tpregister as a base register, and there is a 128-byte limit to the.basedsection. (yes the section is literally called "based", we love that for her ๐)-mbitopsโ Enables the bit operation instructions: bit test (btstm), set (bsetm), clear (bclrm), invert (bnotm), and test-and-set (tas). bit girlies rise ๐-mc=nameโ Selects which section constant data is placed in. name may betiny,near, orfar.-mclipโ Enables theclipinstruction. Note that-mclipis not useful unless you also provide-mminmax. they're a package deal, no solo careers ๐ซถ-mconfig=nameโ Selects one of the built-in core configurations. Each MeP chip has one or more modules in it; each module has a core CPU plus a whole variety of coprocessors, optional instructions, and peripherals. TheMeP-Integratortool โ not part of GCC, okay? โ provides these configurations through this option; using this option is the same as using all the corresponding command-line options. The default configuration isdefault.-mcopโ Enables the coprocessor instructions. By default, this is a 32-bit coprocessor. Note that the coprocessor is normally enabled via the-mconfig=option.-mcop32โ Enables the 32-bit coprocessor's instructions.-mcop64โ Enables the 64-bit coprocessor's instructions.-mivc2โ Enables IVC2 scheduling. IVC2 is a 64-bit VLIW coprocessor. scheduling era ๐-mdcโ Causes constant variables to be placed in the.nearsection.-mdivโ Enables thedivanddivuinstructions.-mebโ Generate big-endian code.-melโ Generate little-endian code.-mio-volatileโ Tells the compiler that any variable marked with theioattribute is to be considered volatile. volatile as in unpredictable, not as in dramatic โจ (okay maybe both)-mlโ Causes variables to be assigned to the.farsection by default.-mleadzโ Enables theleadz(leading zero) instruction.-mmโ Causes variables to be assigned to the.nearsection by default.-mminmaxโ Enables theminandmaxinstructions.-mmultโ Enables the multiplication and multiply-accumulate instructions.-mno-optsโ Disables all the optional instructions enabled by-mall-opts. the off switch for the everything switch ๐-mrepeatโ Enables therepeatanderepeatinstructions, used for low-overhead looping. loops but make them cheap ๐ฅ-msโ Causes all variables to default to the.tinysection. Note that there is a 65536-byte limit to this section. Accesses to these variables use the%gpbase register.-msaturโ Enables the saturation instructions. Note that the compiler does not currently generate these itself, but this option is included for compatibility with other tools, likeas. (compatibility queen ๐ )-msdramโ Link the SDRAM-based runtime instead of the default ROM-based runtime.-msimโ Link the simulator run-time libraries.-msimnovecโ Link the simulator runtime libraries, excluding built-in support for reset and exception vectors and tables.-mtfโ Causes all functions to default to the.farsection. Without this option, functions default to the.nearsection.-mtiny=nโ Variables that are n bytes or smaller are allocated to the.tinysection. These variables use the$gpbase register. The default for this option is4, but note that there's a 65536-byte limit to the.tinysection.
๐ฆ MicroBlaze Options ๐ฆ
-msoft-floatโ Use software emulation for floating point (default). doing it by hand, but make it a default ๐-mhard-floatโ Use hardware floating-point instructions.-mmemcpyโ Do not optimize block moves, usememcpy.-mno-clearbssโ This option is deprecated. Use-fno-zero-initialized-in-bssinstead.-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. version girlies, this one's for you ๐-mxl-soft-mulโ Use software multiply emulation (default).-mxl-soft-divโ Use software emulation for divides (default).-mxl-barrel-shiftโ Use the hardware barrel shifter.-mxl-pattern-compareโ Use pattern compare instructions.-msmall-dividesโ Use table lookup optimization for small signed integer divisions. table lookup my beloved ๐-mxl-stack-checkโ This option is deprecated. Use-fstack-checkinstead.-mxl-gp-optโ Use GP-relative.sdata/.sbsssections.-mxl-multiply-highโ Use multiply high instructions for high part of32x32multiply.-mxl-float-convertโ Use hardware floating-point conversion instructions.-mxl-float-sqrtโ Use hardware floating-point square root instruction. square root era ๐-mbig-endianโ Generate code for a big-endian target.-mlittle-endianโ Generate code for a little-endian target.-mxl-reorderโ Use reorder instructions (swap and byte reversed load/store).-mxl-mode-app-modelโ Select application model app-model. Valid models are:executableโ normal executable (default), uses startup codecrt0.o.-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.xmdstubโ for use with 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.
Option-xl-mode-app-modelis a deprecated alias for-mxl-mode-app-model. she's the old name, still answers to it, but deprecated bestie ๐
๐ MIPS Options ๐
-EBโ Generate big-endian code.-ELโ 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,mips64r5andmips64r6. 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,xlrandxlp. The special valuefrom-abiselects the most compatible architecture for the selected ABI (that is,mips1for 32-bit ABIs andmips3for 64-bit ABIs). the full guest list, everybody showed up ๐ ๐ฅ
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. ratio math but make it โจaestheticโจ
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. no shortcuts in the macro, she's formal like that ๐
-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. run everywhere, slay in one specific place ๐
okay so quick follow-up before we keep going: -mtune also defines the macros "_MIPS_TUNE" and "_MIPS_TUNE_foo", and they work exactly the same way as the -march ones I just described above. no cap. โจ
-mips1โ equivalent to-march=mips1.-mips2โ equivalent to-march=mips2.-mips3โ equivalent to-march=mips3.-mips4โ equivalent to-march=mips4.-mips32โ equivalent to-march=mips32.-mips32r3โ equivalent to-march=mips32r3.-mips32r5โ equivalent to-march=mips32r5.-mips32r6โ equivalent to-march=mips32r6.-mips64โ equivalent to-march=mips64.-mips64r2โ equivalent to-march=mips64r2.-mips64r3โ equivalent to-march=mips64r3.-mips64r5โ equivalent to-march=mips64r5.-mips64r6โ equivalent to-march=mips64r6.-mips16,-mno-mips16โ generate (or like, don't generate) MIPS16 code, bestie. If GCC is targeting a MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE. ๐ฆ Also, MIPS16 code generation can be controlled on a per-function basis using the"mips16"and"nomips16"attributes. cute, right?-mflip-mips16โ generates MIPS16 code on alternating functions. ngl this one exists purely for regression testing of mixed MIPS16/non-MIPS16 code generation, and it is not intended for ordinary use in compiling user code. so likeโฆ don't, bestie. ๐-minterlink-compressed,-mno-interlink-compressedโ require (or don't require) that code using the standard (uncompressed) MIPS ISA be link-compatible with MIPS16 and microMIPS code, and vice versa. ๐ซ For example: code using the standard ISA encoding cannot jump directly to MIPS16 or microMIPS code โ it has to use either a call or an indirect jump. So-minterlink-compresseddisables direct jumps unless GCC knows that the target of the jump is not compressed. it's giving safety rails. ๐ก๏ธ-minterlink-mips16,-mno-interlink-mips16โ these are aliases of-minterlink-compressedand-mno-interlink-compressed. They predate the microMIPS ASE and are retained for backwards compatibility. vintage, but make it functional. ๐-mabi=32-mabi=o64-mabi=n32-mabi=64-mabi=eabi
Generate code for the given ABI. ๐ Heads up: 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 info about the O64 ABI, see <http://gcc.gnu.org/projects/mipso64-abi.html>. GCC also supports a variant of the o32 ABI in which floating-point registers are 64 rather than 32 bits wide. You select this combo 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 stay 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: FPXX (-mfpxx) and FP64A (-mfp64 -mno-odd-spreg). The FPXX extension mandates that all code must execute correctly when run using 32-bit or 64-bit registers. The code can be interlinked with either FP32 or FP64, but not both. The FP64A extension is similar to the FP64 extension but forbids the use of odd-numbered single-precision registers. This can be used in conjunction with the "FRE" mode of FPUs in MIPS32R5 processors and allows both FP32 and FP64A code to interlink and run in the same process without changing FPU modes. ๐ธ
-mabicalls,-mno-abicallsโ generate (or don't generate) code that is suitable for SVR4-style dynamic objects.-mabicallsis the default for SVR4-based systems.-mshared,-mno-sharedโ generate (or don't generate) code that is fully position-independent, and that can therefore be linked into shared libraries. This option only affects-mabicalls. โจ All-mabicallscode has traditionally been position-independent, regardless of options like-fPICand-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-shareddepends on binutils 2.16 or higher and generates objects that can only be linked by the GNU linker. But the option does not affect the ABI of the final executable โ it only affects the ABI of relocatable objects. Using-mno-sharedgenerally makes executables both smaller and quicker. ๐ฅ-msharedis the default.-mplt,-mno-pltโ assume (or don't assume) that the static and dynamic linkers support PLTs and copy relocations. This option only affects-mno-shared -mabicalls. For the n64 ABI, this option has no effect without-msym32. You can make-mpltthe default by configuring GCC with--with-mips-plt. Otherwise the default is-mno-plt.-mxgot,-mno-xgotโ lift (or don't lift) the usual restrictions on the size of the global offset table. ๐ GCC normally uses a single instruction to load values from the GOT. While that's relatively efficient, it only works if the GOT is smaller than about 64k. Anything larger makes the linker report an error such as:
relocation truncated to fit: R_MIPS_GOT16 foobar
If that happens to you, recompile your code with -mxgot. It works with very large GOTs, although the code is also less efficient, since it takes three instructions to fetch the value of a global symbol. Note that some linkers can create multiple GOTs. If you have such a linker, you should only need to use -mxgot when a single object file accesses more than 64k's worth of GOT entries. Very few do. These options have no effect unless GCC is generating position independent code. ๐ซถ
-mgp32โ assume that general-purpose registers are 32 bits wide.-mgp64โ assume that general-purpose registers are 64 bits wide.-mfp32โ assume that floating-point registers are 32 bits wide.-mfp64โ assume that floating-point registers are 64 bits wide.-mfpxxโ do not assume the width of floating-point registers.-mhard-floatโ use floating-point coprocessor instructions.-msoft-floatโ do not use floating-point coprocessor instructions. Implement floating-point calculations using library calls instead.-mno-floatโ equivalent to-msoft-float, but additionally asserts that the program being compiled does not perform any floating-point operations. This option is presently supported only by some bare-metal MIPS configurations, where it may select a special set of libraries that lack all floating-point support (including, for example, the floating-point"printf"formats).
๐จ bestie, listen: if code compiled with -mno-float accidentally contains floating-point operations, it is likely to suffer a link-time or run-time failure. so likeโฆ don't play with it. ๐
-msingle-floatโ assume that the floating-point coprocessor only supports single-precision operations.-mdouble-floatโ assume that the floating-point coprocessor supports double-precision operations. This is the default.-modd-spreg,-mno-odd-spregโ enable the use of odd-numbered single-precision floating-point registers for the o32 ABI. This is the default for processors that are known to support these registers. When using the o32 FPXX ABI,-mno-odd-spregis set by default.-mabs=2008,-mabs=legacyโ these options control the treatment of the special not-a-number (NaN) IEEE 754 floating-point data with the"abs.fmt"and"neg.fmt"machine instructions. ๐ง By default, or when-mabs=legacyis used, the legacy treatment is selected. In this case these instructions are considered arithmetic and avoided where correct operation is required and the input operand might be a NaN. A longer sequence of instructions that manipulate the sign bit of floating-point datum manually is used instead โ unless the-ffinite-math-onlyoption has also been specified. The-mabs=2008option selects the IEEE 754-2008 treatment. In this case these instructions are considered non-arithmetic and therefore operating correctly in all cases, including in particular where the input operand is a NaN. These instructions are therefore always used for the respective operations.-mnan=2008,-mnan=legacyโ these options control the encoding of the special not-a-number (NaN) IEEE 754 floating-point data. ๐ The-mnan=legacyoption selects the legacy encoding. In this case quiet NaNs (qNaNs) are denoted by the first bit of their trailing significand field being0, whereas signaling NaNs (sNaNs) are denoted by the first bit of their trailing significand field being1. The-mnan=2008option selects the IEEE 754-2008 encoding. In this case qNaNs are denoted by the first bit of their trailing significand field being1, whereas sNaNs are denoted by the first bit of their trailing significand field being0. The default is-mnan=legacyunless 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. โก-mllscis useful if the runtime environment can emulate the instructions, and-mno-llsccan be useful when compiling for nonstandard ISAs. You can make either option the default by configuring GCC with--with-llscand--without-llscrespectively.--with-llscis the default for some configurations; see the installation documentation for 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_rev"to1.-mdspr2,-mno-dspr2โ use (or don't use) revision 2 of the MIPS DSP ASE. โจ This option defines the preprocessor macros"__mips_dsp"and"__mips_dspr2". It also defines"__mips_dsp_rev"to2.-msmartmips,-mno-smartmipsโ turn the MIPS SmartMIPS ASE on (or off, bestie, your call ๐ ).-mpaired-single,-mno-paired-singleโ use paired-single floating-point instructions, or don't. Heads up tho: this one literally requires hardware floating-point support to be enabled, no cap. ๐ซถ-mdmx,-mno-mdmxโ MIPS Digital Media Extension instructions, yes or no. You can only use this when you're generating 64-bit code, and it also needs hardware floating-point support enabled. Both boxes gotta be ticked, fr fr. โ-mips3d,-mno-mips3dโ the MIPS-3D ASE, on or off. And omg the way-mips3djust implies-mpaired-singleโ it comes as a package deal, iykyk. ๐-mmicromips,-mno-micromipsโ generate (or don't generate) microMIPS code.
You can also control MicroMIPS code generation on a per-function basis using the "micromips" and "nomicromips" attributes. Per-function vibes, iconic. โจ
-mmt,-mno-mtโ use (or don't use) MT Multithreading instructions.-mmcu,-mno-mcuโ use (or don't use) the MIPS MCU ASE instructions.-meva,-mno-evaโ use (or don't use) the MIPS Enhanced Virtual Addressing instructions.-mvirt,-mno-virtโ use (or don't use) the MIPS Virtualization (VZ) instructions.-mxpa,-mno-xpaโ use (or don't use) the MIPS eXtended Physical Address (XPA) instructions.-mcrc,-mno-crcโ use (or don't use) the MIPS Cyclic Redundancy Check (CRC) instructions.-mginv,-mno-ginvโ use (or don't use) the MIPS Global INValidate (GINV) instructions.-mloongson-mmi,-mno-loongson-mmiโ use (or don't use) the MIPS Loongson MultiMedia extensions Instructions (MMI).-mloongson-ext,-mno-loongson-extโ use (or don't use) the MIPS Loongson EXTensions (EXT) instructions.-mloongson-ext2,-mno-loongson-ext2โ use (or don't use) the MIPS Loongson EXTensions r2 (EXT2) instructions.-mlong64โ forcelongtypes to be 64 bits wide. Wanna know about the default and how the pointer size gets decided? Go look at-mlong32, it explains the whole thing. ๐-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. It's giving "whichever fits" energy. ๐
-msym32,-mno-sym32โ assume (or don't assume) that all symbols have 32-bit values, no matter which ABI you picked. This one slaps in combination with-mabi=64and-mno-abicalls, because it lets GCC generate shorter and faster references to symbolic addresses. ๐ฅ-G numโ 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; the deets live in-mgpopt.
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, periodt.
If the linker starts complaining that an application is using too much small data, you might wanna try rebuilding the less performance-critical parts with -mno-local-sdata. You might also want to build large libraries with -mno-local-sdata, so the libraries leave more room for the main program. Sharing is caring, bestie. ๐ซถ
-mextern-sdata,-mno-extern-sdataโ assume (or don't assume) that externally-defined data is in a small data section if the size of that data is within the-Glimit.-mextern-sdatais the default for all configurations.
Okay so here's the situation, and it's a whole thing ๐ญ: if you compile a module Mod with -mextern-sdata -G num -mgpopt, and Mod references a variable Var that is no bigger than num bytes, you must make sure that Var is placed in a small data section. If Var is defined by another module, you must either compile that module with a high-enough -G setting or attach a "section" attribute to Var's definition. And if Var is common, you must link the application with a high-enough -G setting. No skipping steps!!
The easiest way of satisfying these restrictions is to compile and link every module with the same -G option. That said, you may wish to build a library that supports several different small data limits. You can do this by compiling the library with the highest supported -G setting and additionally using -mno-extern-sdata to stop the library from making assumptions about externally-defined data. Iconic workaround, honestly. โจ
-mgpopt,-mno-gpoptโ use (or don't use) GP-relative accesses for symbols that are known to be in a small data section; see-G,-mlocal-sdataand-mextern-sdata.-mgpoptis the default for all configurations.
-mno-gpopt is useful for cases where the $gp register might not hold the value of "_gp". For example, if the code is part of a library that might be used in a boot monitor, programs that call boot monitor routines pass an unknown value in $gp. (In such situations, the boot monitor itself is usually compiled with -G0.) Lowkey a whole niche scenario but okay. ๐
-mno-gpopt implies -mno-local-sdata and -mno-extern-sdata.
-membedded-data,-mno-embedded-dataโ allocate variables to the read-only data section first if possible, then next in the small data section if possible, otherwise in data. This gives slightly slower code than the default, but it reduces the amount of RAM required when executing, and thus may be preferred for some embedded systems. Trades a lil speed for memory, and that's valid. ๐-muninit-const-in-rodata,-mno-uninit-const-in-rodataโ put uninitializedconstvariables in the read-only data section. This option is only meaningful in conjunction with-membedded-data. They're a duo, fr fr.-mcode-readable=settingโ specify whether GCC may generate code that reads from executable sections. There are three possible settings:-mcode-readable=yesโ instructions may freely access executable sections. This is the default setting. ๐-mcode-readable=pcrelโ MIPS16 PC-relative load instructions can access executable sections, but other instructions must not do so. This option is useful on 4KSc and 4KSd processors when the code TLBs have the Read Inhibit bit set. It's also useful on processors that can be configured to have a dual instruction/data SRAM interface and that, like the M4K, automatically redirect PC-relative loads to the instruction RAM.-mcode-readable=noโ instructions must not access executable sections. This option can be useful on targets that are configured to have a dual instruction/data SRAM interface but that (unlike the M4K) do not automatically redirect PC-relative loads to the instruction RAM.
-msplit-addresses,-mno-split-addressesโ enable (or disable) use of the%hi()and%lo()assembler relocation operators. Ngl this option has been superseded by-mexplicit-relocsbut it's still here, retained for backwards compatibility. Respect the elders. ๐-mexplicit-relocs,-mno-explicit-relocsโ use (or don't use) assembler relocation operators when dealing with symbolic addresses. The alternative, selected by-mno-explicit-relocs, is to use assembler macros instead.
-mexplicit-relocs is the default if GCC was configured to use an assembler that supports relocation operators.
-mcheck-zero-division,-mno-check-zero-divisionโ trap (or don't 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 you can completely disable divide-by-zero checks with -mno-check-zero-division. ๐
-mload-store-pairs,-mno-load-store-pairsโ enable (or disable) an optimization that pairs consecutive load or store instructions to enable load/store bonding. This option is enabled by default but only takes effect when the selected architecture is known to support bonding. โจ-mmemcpy,-mno-memcpyโ force (or don't force) the use ofmemcpyfor non-trivial block moves. The default is-mno-memcpy, which allows GCC to inline most constant-sized copies.-mlong-calls,-mno-long-callsโ disable (or don't disable) use of thejalinstruction. Calling functions usingjalis more efficient but requires the caller and callee to be in the same 256 megabyte segment. So likeโฆ efficient but clingy. ๐ญ
This option has no effect on abicalls code. The default is -mno-long-calls.
-mmad,-mno-madโ enable (or disable) use of themad,maduandmulinstructions, as provided by the R4650 ISA.-mimadd,-mno-imaddโ enable (or 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. 74k caught lacking, sorry babe. ๐-mfused-madd,-mno-fused-maddโ enable (or disable) use of the floating-point multiply-accumulate instructions, when they're available. The default is-mfused-madd.
On the R8000 CPU when multiply-accumulate instructions are used, the intermediate product is calculated to infinite precision and is not subject to the FCSR Flush to Zero bit. This may be undesirable in some circumstances, just so you know. ๐ On other processors the result is numerically identical to the equivalent computation using separate multiply, add, subtract and negate instructions.
-nocppโ tell the MIPS assembler to not run its preprocessor over user assembler files (with a.ssuffix) when assembling them.-mfix-24k,-mno-fix-24kโ work around the 24K E48 (lost data on stores during refill) errata. The workarounds are implemented by the assembler rather than by GCC, fyi.-mfix-r4000,-mno-fix-r4000โ work around certain R4000 CPU errata:- A double-word or a variable shift may give an incorrect result if executed immediately after starting an integer division.
- A double-word or a variable shift may give an incorrect result if executed while an integer multiplication is in progress. ๐ญ
- An integer division may give an incorrect result if started in a delay slot of a taken branch or a jump. ๐
-mfix-r4400
-mno-fix-r4400
Bestie, work around certain R4400 CPU errata: ๐ ๏ธ
- A double-word or a variable shift may give an incorrect result if executed immediately after starting an integer division. ๐
-mfix-r10000
-mno-fix-r10000
Work around certain R10000 errata:
ll/scsequences may not behave atomically on revisions prior to 3.0. They may deadlock on revisions 2.6 and earlier. ๐ no cap, that's the drama
This option can only be used if the target architecture supports branch-likely instructions.-mfix-r10000is the default when-march=r10000is used;-mno-fix-r10000is the default otherwise. periodt โจ
-mfix-r5900
-mno-fix-r5900
Do not attempt to schedule the preceding instruction into the delay slot of a branch instruction placed at the end of a short loop of six instructions or fewer, and always schedule a nop instruction there instead. ๐
โโ๏ธ The short loop bug under certain conditions causes loops to execute only once or twice, due to a hardware bug in the R5900 chip. The workaround is implemented by the assembler rather than by GCC. ๐
-mfix-rm7000
-mno-fix-rm7000
Work around the RM7000 dmult/dmultu errata. The workarounds are implemented by the assembler rather than by GCC. ๐ ๏ธ
-mfix-vr4120
-mno-fix-vr4120
Work around certain VR4120 errata:
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
Work around the VR4130 mflo/mfhi errata. The workarounds are implemented by the assembler rather than by GCC, although GCC avoids using mflo and mfhi if the VR4130 macc, macchi, dmacc and dmacchi instructions are available instead. ๐
-mfix-sb1
-mno-fix-sb1
Work around certain SB-1 CPU core errata. (This flag currently works around the SB-1 revision 2 F1 and F2 floating-point errata.) ๐
-mr10k-cache-barrier=setting
Specify whether GCC should insert cache barriers to avoid the side effects of speculation on R10K processors. ๐ง โจ
In common with many processors, the R10K tries to predict the outcome of a conditional branch and speculatively executes instructions from the "taken" branch. It later aborts these instructions if the predicted outcome is wrong. However, on the R10K, even aborted instructions can have side effects. ๐ณ
This problem only affects kernel stores and, depending on the system, kernel loads. As an example, a speculatively-executed store may load the target memory into cache and mark the cache line as dirty, even if the store itself is later aborted. If a DMA operation writes to the same area of memory before the "dirty" line is flushed, the cached data overwrites the DMA-ed data. See the R10K processor manual for a full description, including other potential problems. ๐
One workaround is to insert cache barrier instructions before every memory access that might be speculatively executed and that might have side effects even if aborted. -mr10k-cache-barrier=setting controls GCC's implementation of this workaround. It assumes that aborted accesses to any byte in the following regions does not have side effects:
- 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.
It is the kernel's responsibility to ensure that speculative accesses to these regions are indeed safe. ๐ซก
If the input program contains a function declaration such as:
void foo (void);
then the implementation of foo must allow j foo and jal foo to be executed speculatively. GCC honors this restriction for functions it compiles itself. It expects non-GCC functions (such as hand-written assembly code) to do the same. ๐
The option has three forms:
-mr10k-cache-barrier=load-storeโ Insert a cache barrier before a load or store that might be speculatively executed and that might have side effects even if aborted. ๐ธ-mr10k-cache-barrier=storeโ Insert a cache barrier before a store that might be speculatively executed and that might have side effects even if aborted. ๐-mr10k-cache-barrier=noneโ Disable the insertion of cache barriers. This is the default setting. โจ
-mflush-func=func
-mno-flush-func
Specifies the function to call to flush the I and D caches, or to not call any such function. 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 number 3 (to flush both caches). The default depends on the target GCC was configured for, but commonly is either _flush_func or __cpu_flush. ๐งผโจ
mbranch-cost=num
Set the cost of branches to roughly num "simple" instructions. This cost is only a heuristic and is not guaranteed to produce consistent results across releases. A zero cost redundantly selects the default, which is based on the -mtune setting. ๐
-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. ๐ฌ periodt
-mcompact-branches=never
-mcompact-branches=optimal
-mcompact-branches=always
These options control which form of branches will be generated. The default is -mcompact-branches=optimal. โจ
The -mcompact-branches=never option ensures that compact branch instructions will never be generated. ๐
โโ๏ธ
The -mcompact-branches=always option ensures that a compact branch instruction will be generated if available. If a compact branch instruction is not available, a delay slot form of the branch will be used instead. ๐ซ
This option is supported from MIPS Release 6 onwards. ๐
The -mcompact-branches=optimal option will cause 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 will be 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. ๐ฅ
-msynci
-mno-synci
Enable (disable) generation of synci instructions on architectures that support it. The synci instructions (if enabled) are generated when __builtin___clear_cache is compiled. ๐งน
This option defaults to -mno-synci, but the default can be overridden by configuring GCC with --with-synci. โจ
When compiling code for single processor systems, it 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. ๐ญ bestie be careful
-mrelax-pic-calls
-mno-relax-pic-calls
Try to turn PIC calls that are normally dispatched via register $25 into direct calls. This is only possible if the linker can resolve the destination at link time and if the destination is within range for a direct call. ๐
-mrelax-pic-calls is the default if GCC was configured to use an assembler and a linker that support the .reloc assembly directive and -mexplicit-relocs is in effect. With -mno-explicit-relocs, this optimization can be performed by the assembler and the linker alone without help from the compiler. ๐
-mmcount-ra-address
-mno-mcount-ra-address
Emit (do not emit) code that allows _mcount to modify the calling function's return address. When enabled, this option extends the usual _mcount interface with a new ra-address parameter, which has type intptr_t * and is passed in register $12. _mcount can then modify the return address by doing both of the following:
- Returning the new address in register $31. ๐
- Storing the new address in
*ra-address, if ra-address is nonnull. ๐พ
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 will allocate 16 bytes on the stack for the called function to write out register arguments. When enabled, this optimization will suppress the allocation of the frame header if it can be determined that it is unused. ๐
This optimization is off by default at all optimization levels. ๐ด
-mlxc1-sxc1
-mno-lxc1-sxc1
When applicable, enable (disable) the generation of lwxc1, swxc1, ldxc1, sdxc1 instructions. Enabled by default. ๐โจ
-mmadd4,-mno-madd4โ bestie, this one turns the 4-operandmadd.s,madd.dand all their lil friends on (or off) whenever they actually apply. ๐ And it's enabled by default, so it's already slaying unless you say otherwise.
๐ธ MMIX Options ๐ธ
These options are defined for the MMIX, and they are so specific, iykyk:
-mlibfuncs,-mno-libfuncsโ says that intrinsic library functions are what's being compiled, so every value gets passed in registers, no matter the size. ๐-mepsilon,-mno-epsilonโ generate floating-point comparison instructions that compare against therEepsilon register. cute and precise fr.-mabi=mmixware,-mabi=gnuโ generate code that passes function parameters and return values which, inside the called function, show up as registers $0 and up โ as opposed to the GNU ABI which uses global registers $231 and up. two whole vibes.-mzero-extend,-mno-zero-extendโ when you're reading data from memory in sizes shorter than 64 bits, use (or don't use) zero-extending load instructions by default, instead of sign-extending ones. โจ-mknuthdiv,-mno-knuthdivโ makes the result of a division that yields a remainder have the same sign as the divisor. With the default,-mno-knuthdiv, the sign of the remainder follows the sign of the dividend. Both methods are arithmetically valid, but that second one is almost exclusively the one people use. ๐-mtoplevel-symbols,-mno-toplevel-symbolsโ prepend (or don't prepend) a:to all global symbols, so the assembly code can be used with thePREFIXassembly directive.-melfโ generate an executable in the ELF format instead of the default mmo format that the mmix simulator uses. main character format energy. ๐-mbranch-predict,-mno-branch-predictโ use (or don't use) the probable-branch instructions when static branch prediction says a branch is probable.-mbase-addresses,-mno-base-addressesโ generate (or don't generate) code that uses base addresses. Using a base address automatically generates a request โ handled by the assembler and the linker โ for a constant to be set up in a global register. That register then gets used for one or more base address requests within the range 0 to 255 from the value held in the register. This generally leads to short and fast code, but the number of different data items you can address is limited. Which means a program with lots of static data may need-mno-base-addresses. ๐ญ-msingle-exit,-mno-single-exitโ force (or don't force) the generated code to have a single exit point in each function. periodt.
๐ MN10300 Options ๐
These -m options are defined for Matsushita MN10300 architectures:
-mmult-bugโ generate code that dodges bugs in the multiply instructions for the MN10300 processors. This is the default. ๐โ-mno-mult-bugโ do not generate code to avoid bugs in the multiply instructions for the MN10300 processors.-mam33โ generate code using features specific to the AM33 processor.-mno-am33โ don't generate code using features specific to the AM33 processor. This is the default.-mam33-2โ generate code using features specific to the AM33/2.0 processor.-mam34โ generate code using features specific to the AM34 processor.-mtune=cpu-typeโ use the timing characteristics of the indicated CPU type when scheduling instructions. Note that this does not change the targeted processor type. The CPU type has to be one ofmn10300,am33,am33-2oram34.-mreturn-pointer-on-d0โ when generating a function that returns a pointer, return the pointer in botha0andd0. Otherwise the pointer comes back only ina0, and attempts to call such functions without a prototype result in errors. Heads up bestie: this option is on by default, so use-mno-return-pointer-on-d0to turn it off. ๐ซถ-mno-crt0โ do not link in the C run-time initialization object file.-mrelaxโ tells the linker it should run a relaxation optimization pass to shorten branches, calls and absolute memory addresses. This only does anything when it's used on the command line for the final link step.
okay but fr: this option makes symbolic debugging impossible. ๐ญ keep that in mind.
-mliwโ lets the compiler generate Long Instruction Word instructions if the target is AM33 or later. This is the default. It defines the preprocessor macro__LIW__. โจ-mno-liwโ don't let the compiler generate Long Instruction Word instructions. This defines the preprocessor macro__NO_LIW__.-msetlbโ lets the compiler generate the SETLB and Lcc instructions if the target is AM33 or later. This is the default. It defines the preprocessor macro__SETLB__. ๐-mno-setlbโ don't let the compiler generate SETLB or Lcc instructions. This defines the preprocessor macro__NO_SETLB__.
๐ฆ Moxie Options ๐ฆ
-mebโ generate big-endian code. This is the default formoxie-*-*configurations. ๐-melโ generate little-endian code.-mmul.xโ generatemul.xandumul.xinstructions. This is the 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:
-masm-hexโ force assembly output to always use hex constants. Normally those constants are signed decimals, but this option exists for testsuite and/or aesthetic purposes. ๐-mmcu=โ select the MCU to target. This gets used to create a C preprocessor symbol based on the MCU name, converted to upper case and pre- and post-fixed with__. Which is then used by themsp430.hheader file to select an MCU-specific supplementary header file.
The option also sets the ISA to use. If the MCU name is one that's known to only support the 430 ISA then that gets selected, otherwise the 430X ISA is selected. A generic MCU name of msp430 can also be used to select the 430 ISA. Similarly the generic msp430x MCU name selects the 430X ISA.
On top of that, an MCU-specific linker script gets added to the linker command line. The script's name is the name of the MCU with .ld appended. So specifying -mmcu=xxx on the gcc command line defines the C preprocessor symbol __XXX__ and causes the linker to search for a script called xxx.ld. โจ
This option is also passed on to the assembler.
-mwarn-mcu,-mno-warn-mcuโ enables or disables warnings about conflicts between the MCU name given 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. ๐ซถ-mcpu=โ specifies the ISA to use. Accepted values aremsp430,msp430xandmsp430xv2. > ngl bestie, this option is deprecated. Use the-mmcu=option to select the ISA instead. ๐-msimโ link to the simulator runtime libraries and linker script. This overrides any scripts that would've been selected by the-mmcu=option.-mlargeโ use large-model addressing (20-bit pointers, 32-bitsize_t).-msmallโ use small-model addressing (16-bit pointers, 16-bitsize_t).-mrelaxโ this option is passed to the assembler and linker, and lets the linker perform certain optimizations that can't be done until the final link. ๐ฅmhwmult=โ describes the type of hardware multiply supported by the target. Accepted values arenonefor no hardware multiply,16bitfor the original 16-bit-only multiply supported by early MCUs,32bitfor the 16/32-bit multiply supported by later MCUs, andf5seriesfor the 16/32-bit multiply supported by F5-series MCUs. A value ofautocan also be given. That tells GCC to deduce the hardware multiply support based on the MCU name provided by the-mmcuoption. If no-mmcuoption is specified, or if the MCU name isn't recognized, then no hardware multiply support is assumed.autois the default setting.
Hardware multiplies are normally performed by calling a library routine, which saves space in the generated code. But when compiling at -O3 or higher, the hardware multiplier gets invoked inline. Bigger, but faster code. โก
The hardware multiply routines disable interrupts while running and restore the previous interrupt state when they finish. So they're safe to use inside interrupt handlers as well as in normal code. iconic.
-minrtโ enable the use of a minimum runtime environment: no static initializers, no constructors. This is intended for memory-constrained devices. The compiler includes special symbols in some objects that tell the linker and runtime which code fragments are required. ๐ง-mcode-region=,-mdata-region=โ these options tell the compiler where to place functions and data that don't have one of thelower,upper,eitherorsectionattributes. Possible values 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.-msilicon-errata=โ this option passes on a request to the assembler to enable the fixes for the named silicon errata.-msilicon-errata-warn=โ this option passes on a request to the assembler to enable warning messages when a silicon errata might need to be applied.
๐ NDS32 Options ๐
These options are defined for NDS32 implementations:
-mbig-endianโ generate code in big-endian mode.-mlittle-endianโ generate code in little-endian mode.-mreduced-regsโ use reduced-set registers for register allocation.-mfull-regsโ use full-set registers for register allocation.-mcmovโ generate conditional move instructions.-mno-cmovโ do not generate conditional move instructions.-mext-perfโ generate performance extension instructions.-mno-ext-perfโ do not generate performance extension instructions.-mext-perf2โ generate performance extension 2 instructions.-mno-ext-perf2โ do not generate performance extension 2 instructions.-mext-stringโ generate string extension instructions.-mno-ext-stringโ do not generate string extension instructions.-mv3pushโ generate v3 push25/pop25 instructions.-mno-v3pushโ okay so do not generatev3 push25/pop25instructions. That's the whole tea. ๐ซโจ-m16-bitโ generate 16-bit instructions. cute and compact fr.-mno-16-bitโ do not generate 16-bit instructions. the opposite vibe, bestie. ๐ โโ๏ธ-misr-vector-size=numโ set the size of each interrupt vector. and it must be4or16, no in-between, no negotiating, periodt. ๐-mcache-block-size=numโ set the size of each cache block. this one has โจrulesโจ: it must be a power of 2, and it has to land somewhere between4and512.-march=archโ tell the compiler the name of the target architecture. iykyk, it needs to know who it's dressing for. ๐-mcmodel=code-modelโ set the code model to one of these, bestie:smallโ all the data and read-only data segments have to be within512KBof addressing space, and the text segment has to be within16MBof addressing space. lil and cozy. ๐mediumโ the data segment stays within512KB, but the read-only data segment can stretch out to4GBof addressing space. the text segment should still be within16MBof addressing space.largeโ everything goes big mode: all the text and data segments can be within4GBof addressing space. ๐
-mctor-dtorโ enable the constructor/destructor feature. the glow-up feature, if you will. โจ-mrelaxโ guide the linker to relax instructions. yes bestie, tell it to chill. ๐
๐ฆ Nios II Options ๐ฆ
these are the options defined for the Altera Nios II processor. very demure, very mindful, very niche. ๐
-G numโ put global and static objects that are less than or equal tonumbytes into the small data or BSS sections instead of the normal data or BSS sections. the default value ofnumis8. ๐-mgpopt=option,-mgpopt,-mno-gpoptโ generate (or do not generate) GP-relative accesses. here are the option names it recognizes:noneโ do not generate GP-relative accesses. nope, none, nada. ๐localโ generate GP-relative accesses for small data objects that are not external, weak, or uninitialized common symbols. it also uses GP-relative addressing for objects that have been explicitly placed in a small data section via a"section"attribute. ๐globalโ same aslocal, but it also generates GP-relative accesses for small data objects that are external, weak, or common. โ ๏ธ heads up: if you use this, you must make sure that all parts of your program (libraries included, bestie) are compiled with the same-Gsetting.dataโ generate GP-relative accesses for all data objects in the program. โ ๏ธ and if you use this one, the entire data and BSS segments of your program must fit in64Kof memory, and you must use an appropriate linker script to allocate them within the addressable range of the global pointer.allโ generate GP-relative addresses for function pointers as well as data pointers. โ ๏ธ and if you use this, the entire text, data, and BSS segments of your program must fit in64Kof memory, and again you must use an appropriate linker script to allocate them within the addressable range of the global pointer. it's giving all-in. ๐ฅ-mgpoptis equivalent to-mgpopt=local, and-mno-gpoptis equivalent to-mgpopt=none. no cap, that's the mapping.- the default is
-mgpoptโ except when-fpicor-fPICis specified to generate position-independent code. also note that the Nios II ABI does not permit GP-relative accesses from shared libraries. ๐ญ - you may need to specify
-mno-gpoptexplicitly when building programs that include large amounts of small data, including large GOT data sections. in that case, the 16-bit offset for GP-relative addressing may not be large enough to allow access to the entire small data section. so likeโฆ it just won't reach. ๐
-mgprel-sec=regexpโ this option specifies additional section names that can be accessed via GP-relative addressing. it's most useful in conjunction with"section"attributes on variable declarations and a custom linker script. theregexpis a POSIX Extended Regular Expression. ๐ง
this option does not affect the behavior of the -G option, and the specified sections are in addition to the standard ".sdata" and ".sbss" small-data sections that are recognized by -mgpopt.
-mr0rel-sec=regexpโ this option specifies names of sections that can be accessed via a 16-bit offset from"r0"; that is, in the low32Kor high32Kof the 32-bit address space. it's most useful in conjunction with"section"attributes on variable declarations and a custom linker script. theregexpis a POSIX Extended Regular Expression. ๐ธ
in contrast to the use of GP-relative addressing for small data, zero-based addressing is never generated by default, and there are no conventional section names used in standard linker scripts for sections in the low or high areas of memory. it's giving "you're on your own, bestie." ๐
-mel,-mebโ generate little-endian (default) or big-endian (experimental) code, respectively. yes,-mebis experimental, don't @ me. ๐ฆ-march=archโ this specifies the name of the target Nios II architecture. GCC uses this name to determine what kind of instructions it can emit when generating assembly code. permissible names are:r1,r2. ๐
the preprocessor macro "__nios2_arch__" is available to programs, with value 1 or 2, indicating the targeted ISA level.
-mbypass-cache,-mno-bypass-cacheโ force all load and store instructions to always bypass the cache by using I/O variants of the instructions. the default is not to bypass the cache. ๐ฆ-mno-cache-volatile,-mcache-volatileโ volatile memory access bypasses the cache using the I/O variants of the load and store instructions. the default is not to bypass the cache. โจ-mno-fast-sw-div,-mfast-sw-divโ do not use table-based fast divide for small numbers. the default is to use the fast divide at-O3and above. slay at high optimization, fr fr. โ-mno-hw-mul,-mhw-mul,-mno-hw-mulx,-mhw-mulx,-mno-hw-div,-mhw-divโ enable or disable emitting the"mul","mulx"and"div"family of instructions by the compiler. the default is to emit"mul"and not emit"div"and"mulx". that's the whole arrangement. ๐-mbmx,-mno-bmx,-mcdx,-mno-cdxโ enable or disable generation of Nios II R2 BMX (bit manipulation) and CDX (code density) instructions. โ ๏ธ enabling these instructions also requires-march=r2. since these instructions are optional extensions to the R2 architecture, the default is not to emit them. ๐-mcustom-insn=N,-mno-custom-insnโ each-mcustom-insn=Noption enables use of a custom instruction with encodingNwhen generating code that uses insn. for example,-mcustom-fadds=253generates custom instruction253for single-precision floating-point add operations instead of the default behavior of using a library call. not me out here hand-picking opcodes. ๐
the following values of insn are supported. except as otherwise noted, floating-point operations are expected to be implemented with normal IEEE 754 semantics and correspond directly to the C operators or the equivalent GCC built-in functions.
Single-precision floating point:
fadds,fsubs,fdivs,fmulsโ binary arithmetic operations. โโโ๏ธโfnegsโ unary negation. ๐fabssโ unary absolute value.fcmpeqs,fcmpges,fcmpgts,fcmples,fcmplts,fcmpnesโ comparison operations. โ๏ธfmins,fmaxsโ floating-point minimum and maximum. these instructions are only generated if-ffinite-math-onlyis specified. โ ๏ธfsqrtsโ unary square root operation. ๐ฑfcoss,fsins,ftans,fatans,fexps,flogsโ floating-point trigonometric and exponential functions. โ ๏ธ these instructions are only generated if-funsafe-math-optimizationsis also specified.
Double-precision floating point:
faddd,fsubd,fdivd,fmuldโ binary arithmetic operations. ๐ซfnegdโ unary negation.fabsdโ unary absolute value.fcmpeqd,fcmpged,fcmpgtd,fcmpled,fcmpltd,fcmpnedโ comparison operations. โ๏ธfmind,fmaxdโ double-precision minimum and maximum. โ ๏ธ these instructions are only generated if-ffinite-math-onlyis specified.fsqrtdโ unary square root operation. ๐ฑfcosd,fsind,ftand,fatand,fexpd,flogdโ double-precision trigonometric and exponential functions. โ ๏ธ these instructions are only generated if-funsafe-math-optimizationsis also specified.
Conversions:
fextsdโ conversion from single precision to double precision. ๐ftruncdsโ conversion from double precision to single precision. ๐fixsi,fixsu,fixdi,fixduโ conversion from floating point to signed or unsigned integer types, with truncation towards zero. โ๏ธroundโ conversion from single-precision floating point to signed integer, rounding to the nearest integer and ties away from zero. this corresponds to the"__builtin_lroundf"function when-fno-math-errnois used. ๐ฏfloatis,floatus,floatid,floatudโ conversion from signed or unsigned integer types to floating-point types. ๐
in addition, all of the following transfer instructions for internal registers X and Y must be provided to use any of the double-precision floating-point instructions. custom instructions taking two double-precision source operands expect the first operand in the 64-bit register X. the other operand (or only operand of a unary operation) is given to the custom arithmetic instruction with the least significant half in source register src1 and the most significant half in src2. a custom instruction that returns a double-precision result returns the most significant 32 bits in the destination register and the other half in 32-bit register Y. GCC automatically generates the necessary code sequences to write register X and/or read register Y when double-precision floating-point instructions are used. likeโฆ it just does it for you, bestie. ๐ซถ
fwrxโ writesrc1into the least significant half ofXandsrc2into the most significant half ofX.fwryโ writesrc1intoY.frdxhi,frdxloโ read the most or least (respectively) significant half ofXand store it indest.frdyโ read the value ofYand store it intodest.
note that you can gain more local control over generation of Nios II custom instructions by using the target("custom-insn=N") and target("no-custom-insn") function attributes or pragmas. so many knobs, so little time. ๐๏ธ
-mcustom-fpu-cfg=nameโ this option enables a predefined, named set of custom instruction encodings (see-mcustom-insnabove). currently, the following sets are defined:
okay so those FPU config presets? bestie, here's exactly what each one is secretly doing under the hood, no cap:
-mcustom-fpu-cfg=60-1 is equivalent to: -mcustom-fmuls=252
-mcustom-fadds=253 -mcustom-fsubs=254 -fsingle-precision-constant
-mcustom-fpu-cfg=60-2 is equivalent to: -mcustom-fmuls=252
-mcustom-fadds=253 -mcustom-fsubs=254 -mcustom-fdivs=255
-fsingle-precision-constant
-mcustom-fpu-cfg=72-3 is equivalent to: -mcustom-floatus=243
-mcustom-fixsi=244 -mcustom-floatis=245 -mcustom-fcmpgts=246
-mcustom-fcmples=249 -mcustom-fcmpeqs=250 -mcustom-fcmpnes=251
-mcustom-fmuls=252 -mcustom-fadds=253 -mcustom-fsubs=254
-mcustom-fdivs=255 -fsingle-precision-constant
And the tea โ โ custom instruction assignments you hand in with the individual -mcustom-insn= options override whatever -mcustom-fpu-cfg= said. Doesn't matter what order they appear in on the command line, the individual ones win. Order who? Never heard of her. periodt ๐
Also psa ๐ซถ you can grab way more local control over which FPU configuration gets picked by using the target("custom-fpu-cfg=name") function attribute or pragma. iykyk.
๐ฆ Altera Nios II ELF (bare-metal) era
These additional -m options are available for the Altera Nios II ELF (bare-metal) target:
-mhalโ link with HAL BSP. This suppresses linking with the GCC-provided C runtime startup and termination code, and is typically used in conjunction with-msys-crt0=to specify the location of the alternate startup code provided by the HAL BSP.-msmallcโ link with a limited version of the C library,-lsmallc, rather than Newlib.- *
-msys-crt0=startfile* โ startfile is the file name of the startfile (crt0) to use when linking. This option is only useful in conjunction with-mhal. - *
-msys-lib=systemlib* โ systemlib is the library name of the library that provides low-level system calls required by the C library, e.g."read"and"write". This option is typically used to link with a library provided by a HAL BSP.
๐ Nvidia PTX Options
These options are defined for Nvidia PTX:
-m32-m64โ generate code for 32-bit or 64-bit ABI.- *
-misa=ISA-string* โ generate code for given the specified PTX ISA (e.g.sm_35). ISA strings must be lower-case. Valid ISA strings includesm_30andsm_35. The default ISA issm_30. -mmainkernelโ link in code for a__mainkernel. This is for stand-alone instead of offloading execution.-moptimizeโ apply partitioned execution optimizations. This is the default when any level of optimization is selected.-msoft-stackโ generate code that does not use".local"memory directly for stack storage. Instead, a per-warp stack pointer is maintained explicitly. This enables variable-length stack allocation (with variable-length arrays or"alloca"), and when global memory is used for 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.-muniform-simtโ switch to code generation variant that allows to execute all threads in each warp, while maintaining memory state and side effects as if only one thread in each warp was active outside of OpenMP SIMD regions. All atomic operations and calls to runtime (malloc,free,vprintf) are conditionally executed (iff current lane index equals the master lane index), and the register being assigned is copied via a shuffle instruction from the master lane. Outside of SIMD regions lane 0 is the master; inside, each thread sees itself as the master. Shared memory array"int __nvptx_uni[]"stores all-zeros or all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD regions). Each thread can bitwise-and the bitmask at position"tid.y"with current lane index to compute the master lane index.-mgompโ generate code for use in OpenMP offloading: enables-msoft-stackand-muniform-simtoptions, and selects corresponding multilib variant.
๐ธ OpenRISC Options
These options are defined for OpenRISC:
- *
-mboard=name* โ configure a board specific runtime. This will be passed to the linker for newlib board library linking. The default is"or1ksim". -mnewlibโ for compatibility, it's always newlib for elf now.-mhard-divโ generate code for hardware which supports divide instructions. This is the default.-mhard-mulโ generate code for hardware which supports multiply instructions. This is the default.-mcmovโ generate code for hardware which supports the conditional move ("l.cmov") instruction.-mrorโ generate code for hardware which supports rotate right instructions.-msextโ generate code for hardware which supports sign-extension instructions.-msfimmโ generate code for hardware which supports set flag immediate ("l.sf*i") instructions.-mshftimmโ generate code for hardware which supports shift immediate related instructions (i.e."l.srai","l.srli","l.slli","1.rori"). Note, to enable generation of the"l.rori"instruction the-mrorflag must also be specified.-msoft-divโ generate code for hardware which requires divide instruction emulation.-msoft-mulโ generate code for hardware which requires multiply instruction emulation.
๐ PDP-11 Options
These options are defined for the PDP-11:
-mfpuโ use hardware FPP floating point. This is the default. (FIS floating point on the PDP-11/40 is not supported.) Implies-m45.-msoft-floatโ do not use hardware floating point.-mac0โ return floating-point results in ac0 (fr0 in Unix assembler syntax).-mno-ac0โ return floating-point results in memory. This is the default.-m40โ generate code for a PDP-11/40. Implies-msoft-float -mno-split.-m45โ generate code for a PDP-11/45. This is the default.-m10โ generate code for a PDP-11/10. Implies-msoft-float -mno-split.-mint16-mno-int32โ use 16-bit"int". This is the default.-mint32-mno-int16โ use 32-bit"int".-msplitโ target has split instruction and data space. Implies-m45.-munix-asmโ use Unix assembler syntax.-mdec-asmโ use DEC assembler syntax.-mgnu-asmโ use GNU assembler syntax. This is the default.-mlraโ use the new LRA register allocator. By default, the old"reload"allocator is used.
๐ picoChip Options
These -m options are defined for picoChip implementations:
- *
-mae=ae_type* โ set the instruction set, register set, and instruction scheduling parameters for array element type ae_type. Supported values for ae_type areANY,MUL, andMAC.-mae=ANYselects a completely generic AE type. Code generated with this option runs on any of the other AE types. The code is not as efficient as it would be if compiled for a specific AE type, and some types of operation (e.g., multiplication) do not work properly on all types of AE.-mae=MULselects a MUL AE type. This is the most useful AE type for compiled code, and is the default.-mae=MACselects a DSP-style MAC AE. Code compiled with this option may suffer from poor performance of byte (char) manipulation, since the DSP AE does not provide hardware support for byte load/stores.
-msymbol-as-addressโ enable the compiler to directly use a symbol name as an address in a load/store instruction, without first loading it into a register. Typically, the use of this option generates larger programs, which run faster than when the option isn't used. However, the results vary from program to program, so it is left as a user option, rather than being permanently enabled.-mno-inefficient-warningsโ disables warnings about the generation of inefficient code. These warnings can be generated, for example, when compiling code that performs byte-level memory operations on the MAC AE type. The MAC AE has no hardware support for byte-level memory operations, so all byte load/stores must be synthesized from word load/store operations. This is inefficient and a warning is generated to indicate that you should rewrite the code to avoid byte operations, or to target an AE type that has the necessary hardware support. This option disables these warnings.
โญ PowerPC Options
These are listed under
(no fr the sentence really does just end there in the page ๐ moving on bestie)
๐ RISC-V Options
These command-line options are defined for RISC-V targets:
- *
-mbranch-cost=n* โ set the cost of branches to roughly n instructions. -mplt-mno-pltโ when generating PIC code, do or don't allow the use of PLTs. Ignored for non-PIC. The default is-mplt.- *
-mabi=ABI-string* โ specify integer and floating-point calling convention. ABI-string contains two parts: the size of integer types and the registers used for floating-point types. For example-march=rv64ifd -mabi=lp64dmeans that long and pointers are 64-bit (implicitly defining int to be 32-bit), and that floating-point values up to 64 bits wide are passed in F registers. Contrast 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 will be passed in registers.
The default for this argument is system dependent, users who want a specific calling convention should specify one explicitly. The valid calling conventions are: ilp32, ilp32f, ilp32d, lp64, lp64f, and lp64d. Some calling conventions are impossible to implement on some ISAs: for example, -march=rv32if -mabi=ilp32d is invalid because the ABI requires 64-bit values be passed in F registers, but F registers are only 32 bits wide. There is also the ilp32e ABI that can only be used with the rv32e architecture. This ABI is not well specified at present, and is subject to change.
-mfdiv-mno-fdivโ do or don't use hardware floating-point divide and square root instructions. This requires the F or D extensions for floating-point registers. The default is to use them if the specified architecture has these instructions.-mdiv,-mno-divโ do we use the hardware instructions for integer division or not? ๐ Heads up: this needs the M extension. Default vibe is yes, use them if the architecture you picked actually has these instructions.-march=ISA-stringโ generate code for this specific RISC-V ISA (likerv64im). ISA strings gotta be lower-case, no exceptions bestie. Examples includerv64i,rv32g,rv32e, andrv32imaf.-mtune=processor-stringโ optimize the output for a given processor, specified by microarchitecture name. The permissible values are:rocket,sifive-3-series,sifive-5-series,sifive-7-series, andsize.
When -mtune= isn't specified, the default is rocket.
The size choice is not intended for use by end-users. It's used when -Os is specified. It overrides the instruction cost info provided by -mtune=, but it does not override the pipeline info. This helps reduce code size while still giving good performance. โจ
-mpreferred-stack-boundary=numโ attempt to keep the stack boundary aligned to a 2 raised to num byte boundary. If-mpreferred-stack-boundaryisn't 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. ๐ญ fr fr, all of them.
-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. ๐ซถ-mstrict-align,-mno-strict-alignโ do not or do generate unaligned memory accesses. The default is set depending on whether the processor we're optimizing for supports fast unaligned access or not.-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 GiBand+2 GiB. Programs can be statically or dynamically linked. This is the default code model. ๐-mcmodel=medanyโ generate code for the medium-any code model. The program and its statically defined symbols must be within any single 2 GiB address range. Programs can be statically or dynamically linked.-mexplicit-relocs,-mno-exlicit-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. (Yes, the-mno-one is spelledexlicitin the original, no cap, we are not fixing it ๐)-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. ๐ฅ-memit-attribute,-mno-emit-attributeโ emit (do not emit) RISC-V attribute to record extra information into ELF objects. This feature requires at least binutils2.32. โจ
๐ RL78 Options ๐
-msimโ links in additional target libraries to support operation within a simulator.-mmul=none,-mmul=g10,-mmul=g13,-mmul=g14,-mmul=rl78โ specifies the type of hardware multiplication and division support to be used. The simplest is"none", which uses software for both multiplication and division. This is the default. The"g13"value is for the hardware multiply/divide peripheral found on the RL78/G13 (S2 core) targets. The"g14"value selects the use of the multiplication and division instructions supported by the RL78/G14 (S3 core) parts. The value"rl78"is an alias for"g14"and the value"mg10"is an alias for"none". ๐
In addition a C preprocessor macro is defined, based upon the setting of this option. Possible values are: "__RL78_MUL_NONE__", "__RL78_MUL_G13__" or "__RL78_MUL_G14__".
-mcpu=g10,-mcpu=g13,-mcpu=g14,-mcpu=rl78โ specifies the RL78 core to target. The default is the G14 core, also known as an S3 core or just RL78. The G13 or S2 core does not have multiply or divide instructions, instead it uses a hardware peripheral for these operations. The G10 or S1 core does not have register banks, so it uses a different calling convention. ๐ฆ
If this option is set it also selects the type of hardware multiply support to use, unless this is overridden by an explicit -mmul=none option on the command line. Thus specifying -mcpu=g13 enables the use of the G13 hardware multiply peripheral and specifying -mcpu=g10 disables the use of hardware multiplications altogether.
Note, although the RL78/G14 core is the default target, specifying -mcpu=g14 or -mcpu=rl78 on the command line does change the behavior of the toolchain since it also enables G14 hardware multiply support. If these options are not specified on the command line then software multiplication routines will be used even though the code targets the RL78 core. This is for backwards compatibility with older toolchains which did not have hardware multiply and divide support. ๐
In addition a C preprocessor macro is defined, based upon the setting of this option. Possible values are: "__RL78_G10__", "__RL78_G13__" or "__RL78_G14__".
-mg10,-mg13,-mg14,-mrl78โ these are aliases for the corresponding-mcpu=option. They are provided for backwards compatibility.-mallregsโ allow the compiler to use all of the available registers. By default registers"r24..r31"are reserved for use in interrupt handlers. With this option enabled these registers can be used in ordinary functions as well. โจ-m64bit-doubles,-m32bit-doublesโ make the"double"data type be 64 bits (-m64bit-doubles) or 32 bits (-m32bit-doubles) in size. The default is-m32bit-doubles.-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-mg13needs to be passed for this to work as this feature is only available on the G13 target (S2 core). The MDUC registers will only be saved if the interrupt handler performs a multiplication or division operation or it calls another function. ๐ซถ
๐ IBM RS/6000 and PowerPC Options ๐
These -m options are defined for the IBM RS/6000 and PowerPC:
-mpowerpc-gpopt,-mno-powerpc-gpopt,-mpowerpc-gfxopt,-mno-powerpc-gfxopt,-mpowerpc64,-mno-powerpc64,-mmfcrf,-mno-mfcrf,-mpopcntb,-mno-popcntb,-mpopcntd,-mno-popcntd,-mfprnd,-mno-fprnd,-mcmpb,-mno-cmpb,-mmfpgpr,-mno-mfpgpr,-mhard-dfp,-mno-hard-dfpโ you use these options to specify which instructions are available on the processor you're using. The default value of these options is determined when configuring GCC. Specifying the-mcpu=cpu_typeoverrides the specification of these options. We recommend you use the-mcpu=cpu_typeoption rather than the options listed above. ๐
Specifying -mpowerpc-gpopt allows GCC to use the optional PowerPC architecture instructions in the General Purpose group, including floating-point square root. Specifying -mpowerpc-gfxopt allows GCC to use the optional PowerPC architecture instructions in the Graphics group, including floating-point select.
The -mmfcrf option allows GCC to generate the move from condition register field instruction implemented on the POWER4 processor and other processors that support the PowerPC V2.01 architecture. The -mpopcntb option allows GCC to generate the popcount and double-precision FP reciprocal estimate instruction implemented on the POWER5 processor and other processors that support the PowerPC V2.02 architecture. The -mpopcntd option allows GCC to generate the popcount instruction implemented on the POWER7 processor and other processors that support the PowerPC V2.06 architecture. The -mfprnd option allows GCC to generate the FP round to integer instructions implemented on the POWER5+ processor and other processors that support the PowerPC V2.03 architecture. The -mcmpb option allows GCC to generate the compare bytes instruction implemented on the POWER6 processor and other processors that support the PowerPC V2.05 architecture. The -mmfpgpr option allows GCC to generate the FP move to/from general-purpose register instructions implemented on the POWER6X processor and other processors that support the extended PowerPC V2.05 architecture. The -mhard-dfp option allows GCC to generate the decimal floating-point instructions implemented on some POWER processors. ๐ฅ
The -mpowerpc64 option allows GCC to generate the additional 64-bit instructions that are found in the full PowerPC64 architecture and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to -mno-powerpc64.
-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,powerpc,powerpc64,powerpc64le,rs64, andnative. โจ
-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. ๐
The other options specify a specific processor. Code generated under those options runs best on that processor, and may not run at all on others. ๐
The -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-mpower8-vector-mquad-memory-mquad-memory-atomic-mfloat128-mfloat128-hardware
okay so quick heads up bestie ๐
the exact bundle of options that gets switched on for any given CPU is not some universal constant โ it changes between compiler versions, depending on what setting looks like it'll spit out the most optimal code for that CPU. And ngl? It doesn't necessarily reflect what the actual hardware can even do. ๐ So if you wanna set one specific option to a specific value, just say it after the -mcpu option, like -mcpu=970 -mno-altivec. Order matters, bestie, that's the whole vibe. โจ
On AIX, the -maltivec and -mpowerpc64 options are not enabled or disabled by the -mcpu option at present, because AIX doesn't have full support for these options. You can still enable or disable them individually if you're sure it'll work in your environment. ๐ซถ
-mtune=cpu_typeโ sets the instruction scheduling parameters for machine type cpu_type, but does not set the architecture type or register usage the way-mcpu=cpu_typedoes. Same cpu_type values work here as for-mcpu. And if you pass both? The generated code uses the architecture and registers from-mcpu, but the scheduling parameters from-mtune. Both, at once, living their best lives. ๐-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. Main character energy fr fr. ๐-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 match array element order corresponding to the endianness of the target. That is, element zero identifies the leftmost element in a vector register when targeting a big-endian platform, and identifies the rightmost</c> element in a vector register when targeting a little-endian platform. ๐ฆ
-mvrsave-mno-vrsaveโ generate VRSAVE instructions when generating AltiVec code.-msecure-pltโ generate code that allowsldandld.soto build executables and shared libraries with non-executable.pltand.gotsections. This is a PowerPC 32-bit SYSV ABI option. ๐-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.
โ ๏ธ bestie that one wants sections that are both writable and executable. Just so you know. ๐
-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? we respect the honesty ๐)-mpower8-vector-mno-power8-vectorโ generate code that uses (does not use) the vector and scalar instructions that were added in version 2.07 of the PowerPC ISA. Also enable the use of built-in functions that allow more direct access to the vector instructions. ๐-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, -mcpu=power7, -mcpu=power8), or -mcpu=power9 must be enabled to use the IEEE 128-bit floating point support. The IEEE 128-bit floating point support only works on PowerPC Linux systems. ๐ง
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 (-mpower9-vector or -mcpu=power9) on a 64-bit system, the IEEE 128-bit floating point support will also enable the generation of ISA 3.0 IEEE 128-bit floating point instructions. Otherwise, if you do not specify to generate ISA 3.0 instructions or you are targeting a 32-bit big endian system, IEEE 128-bit floating point will be done with software emulation.
-mfloat128-hardware-mno-float128-hardwareโ enable/disable using ISA 3.0 hardware instructions to support the__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 that 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.
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โ enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bitlongtype, and the infrastructure needed to support them. Specifying-maix64implies-mpowerpc64, while-maix32disables the 64-bit ABI and implies-mno-powerpc64. GCC defaults to-maix32.-mxl-compat-mno-xl-compatโ produce code that conforms more closely to IBM XL compiler semantics when using AIX-compatible ABI. Pass floating-point arguments to prototyped functions beyond the register save area (RSA) on the stack in addition to argument FPRs. Do not assume that most significant double in 128-bit long double value is properly rounded when comparing values and converting to double. Use XL symbol names for long double support routines.
The AIX calling convention was extended but not initially documented to handle an obscure K&R C case of calling a function that takes the address of its arguments with fewer arguments than declared. IBM XL compilers access floating-point arguments that do not fit in the RSA from the stack when a subroutine is compiled without optimization. Because always storing floating-point arguments on the stack is inefficient and rarely needed, this option is not enabled by default and only is necessary when calling subroutines compiled by IBM XL compilers without optimization. ๐
-mpeโ support IBM RS/6000 SP Parallel Environment (PE). Link an application written to use message passing with special startup code to enable the application to run. The system must have PE installed in the standard location (/usr/lpp/ppe.poe/), or the specs file must be overridden with the-specs=option to specify the appropriate directory location. The Parallel Environment does not support threads, so the-mpeoption and the-pthreadoption are incompatible. ๐-malign-natural-malign-powerโ on AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option-malign-naturaloverrides the ABI-defined alignment of larger types, such as floating-point doubles, on their natural size-based boundary. The option-malign-powerinstructs GCC to follow the ABI-specified alignment rules. GCC defaults to the standard alignment defined in the ABI.
On 64-bit Darwin, natural alignment is the default, and -malign-power is not supported. ๐ซ
-msoft-float-mhard-floatโ generate code that does not use (uses) the floating-point register set. Software floating-point emulation is provided if you use the-msoft-floatoption, and pass the option to GCC when linking. ๐ฅ-mmultiple,-mno-multipleโ bestie, this one's about whether we generate code that uses the load multiple word instructions and the store multiple word instructions (or doesn't, for the-mno-version). These are generated by default on POWER systems, and not generated on PowerPC systems. > okay serious warning time: do not use-mmultipleon little-endian PowerPC systems, because those instructions literally do not work when the processor is in little-endian mode ๐ญ The only exceptions are PPC740 and PPC750, which do permit these instructions in little-endian mode. Slay for them specifically, I guess ๐-mupdate,-mno-updateโ controls whether we generate code that uses the load or store instructions that update the base register to the address of the calculated memory location (or doesn't use them). These instructions are generated by default. > but babes, if you use-mno-update, there's 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. be careful out there ๐-mavoid-indexed-addresses,-mno-avoid-indexed-addressesโ generate code that tries to avoid (or not avoid, with the-mno-version) the use of indexed load or store instructions. These instructions can incur a performance penalty on Power6 processors in certain situations, like when you're stepping through large arrays that cross a 16M boundary. This option is enabled by default when targeting Power6 and disabled otherwise.-mfused-madd,-mno-fused-maddโ generate code that uses (or doesn't use) the floating-point multiply and accumulate instructions. These are generated by default if hardware floating point is used. okay so the lore here: the machine-dependent-mfused-maddoption is now mapped to the machine-independent-ffp-contract=fastoption, and-mno-fused-maddis mapped to-ffp-contract=off. iykyk ๐ฆ-mmulhw,-mno-mulhwโ generate code that uses (or doesn't use) the half-word multiply and multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors. These instructions are generated by default when targeting those processors.-mdlmzb,-mno-dlmzbโ generate code that uses (or doesn't use) the string-searchdlmzbinstruction on the IBM 405, 440, 464 and 476 processors. This instruction is generated by default when targeting those processors.-mno-bit-align,-mbit-alignโ on System V.4 and embedded PowerPC systems, do not (or do, with-mbit-align) force structures and unions that contain bit-fields to be aligned to the base type of the bit-field.
For example, by default a structure containing nothing but 8 unsigned bit-fields of length 1 is aligned to a 4-byte boundary and has a size of 4 bytes. By using -mno-bit-align, the structure is aligned to a 1-byte boundary and is 1 byte in size. the way the numbers just... shrink โจ
-mno-strict-align,-mstrict-alignโ on System V.4 and embedded PowerPC systems, do not (or do) assume that unaligned memory references are handled by the system.-mrelocatable,-mno-relocatableโ generate code that allows (or does not allow) a static executable to be relocated to a different address at run time. A simple embedded PowerPC system loader should relocate the entire contents of.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. Also-mrelocatablecode aligns the stack to an 8-byte boundary. noted ๐-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. flexible queen ๐-mno-toc,-mtocโ on System V.4 and embedded PowerPC systems, do not (or do) assume that register 2 contains a pointer to a global area pointing to the addresses used in the program.-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.-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.-mdynamic-no-picโ on Darwin and Mac OS X 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. no shared libs bestie, that's the boundary ๐ซ-msingle-pic-baseโ treat the register used for PIC addressing as read-only, rather than loading it in the prologue for each function. The runtime system is responsible for initializing this register with an appropriate value before execution begins. so like, that's on runtime, not on us ๐- *
-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. - *
-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.-mcall-sysv-eabi,-mcall-eabiโ specify both-mcall-sysvand-meabioptions.-mcall-sysv-noeabiโ specify both-mcall-sysvand-mno-eabioptions.-mcall-aixdescโ on System V.4 and embedded PowerPC systems, compile code for the AIX operating system.-mcall-linuxโ on System V.4 and embedded PowerPC systems, compile code for the Linux-based GNU system. ๐ง-mcall-freebsdโ on System V.4 and embedded PowerPC systems, compile code for the FreeBSD operating system.-mcall-netbsdโ on System V.4 and embedded PowerPC systems, compile code for the NetBSD operating system.-mcall-openbsdโ on System V.4 and embedded PowerPC systems, compile code for the OpenBSD operating system.- *
-mtraceback=traceback_type* โ select the type of traceback table. Valid values for traceback_type arefull,part, andno. -maix-struct-returnโ return all structures in memory (as specified by the AIX ABI).-msvr4-struct-returnโ return structures smaller than 8 bytes in registers (as specified by the SVR4 ABI).- *
-mabi=abi-type* โ extend the current ABI with a particular extension, or remove such extension. Valid values arealtivec,no-altivec,ibmlongdouble,ieeelongdouble,elfv1,elfv2. -mabi=ibmlongdoubleโ change the current ABI to use IBM extended-precision long double. This is not likely to work if your system defaults to using IEEE extended-precision long double. If you change the long double type from IEEE extended-precision, the compiler will issue a warning unless you use the-Wno-psabioption. Requires-mlong-double-128to be enabled.-mabi=ieeelongdoubleโ change the current ABI to use IEEE extended-precision long double. This is not likely to work if your system defaults to using IBM extended-precision long double. If you change the long double type from IBM extended-precision, the compiler will issue a warning unless you use the-Wno-psabioption. Requires-mlong-double-128to be enabled.-mabi=elfv1โ change the current ABI to use the ELFv1 ABI. This is the default ABI for big-endian PowerPC 64-bit Linux. > Overriding the default ABI requires special system support and is likely to fail in spectacular ways. like genuinely spectacular, no notes ๐ญ-mabi=elfv2โ change the current ABI to use the ELFv2 ABI. This is the default ABI for little-endian PowerPC 64-bit Linux. > Overriding the default ABI requires special system support and is likely to fail in spectacular ways. same warning bestie, same energy ๐-mgnu-attribute,-mno-gnu-attributeโ emit.gnu_attributeassembly directives to set tag/value pairs in a.gnu.attributessection that specify ABI variations in function parameters or return values.-mprototype,-mno-prototypeโ on System V.4 and embedded PowerPC systems, assume that all calls to variable argument functions are properly prototyped. Otherwise, the compiler must insert an instruction before every non-prototyped call to set or clear bit 6 of the condition code register (CR) to indicate whether floating-point values are passed in the floating-point registers in case the function takes variable arguments. With-mprototype, only calls to prototyped variable argument functions set or clear the bit. the way this one single bit is doing so much heavy lifting ๐ซ-msimโ on embedded PowerPC systems, assume that the startup module is calledsim-crt0.oand that the standard C libraries arelibsim.aandlibc.a. This is the default forpowerpc-*-eabisimconfigurations.-mmvmeโ on embedded PowerPC systems, assume that the startup module is calledcrt0.oand the standard C libraries arelibmvme.aandlibc.a.
-madsโ on embedded PowerPC systems, bestie, this one just assumes the startup module is calledcrt0.oand that your standard C libraries arelibads.aandlibc.a. That's it, that's the whole vibe ๐-myellowknifeโ same energy as-madsbut make it Canadian ๐จ๐ฆ: on embedded PowerPC systems it assumes the startup module iscrt0.oand the standard C libraries arelibyk.aandlibc.a.-mvxworksโ on System V.4 and embedded PowerPC systems, this says "hey, we're compiling for a VxWorks system." slay.-membโ on embedded PowerPC systems, this sets the"PPC_EMB"bit in the ELF flags header to signal that eabi extended relocations are in use. periodt.-meabi,-mno-eabiโ on System V.4 and embedded PowerPC systems, these decide whether you do (or do not) adhere to the Embedded Applications Binary Interface (EABI), which is basically a set of modifications to the System V.4 specs.
Picking -meabi means:
- the stack gets aligned to an 8-byte boundary,
- a function
"__eabi"is called from"main"to set up the EABI environment, - and the
-msdataoption can use both"r2"and"r13"to point to two separate small data areas.
Picking -mno-eabi means:
- the stack gets aligned to a 16-byte boundary,
- no EABI initialization function is called from
"main", - and
-msdataonly uses"r13"to point to a single small data area.
-meabi is on by default if you configured GCC using one of the powerpc*-*-eabi* options. ๐
-msdata=eabiโ on System V.4 and embedded PowerPC systems: small initialized"const"global and static data goes in the.sdata2section, pointed to by register"r2". Small initialized non-"const"global and static data goes in the.sdatasection, pointed to by register"r13". Small uninitialized global and static data goes in the.sbsssection, which sits right next to.sdata.
Heads up bestie:-msdata=eabiis incompatible with the-mrelocatableoption. Also it sets the-memboption. ๐ซถ
-msdata=sysvโ on System V.4 and embedded PowerPC systems, small global and static data goes in the.sdatasection, pointed to by register"r13". Small uninitialized global and static data goes in.sbss, adjacent to.sdata. And yeah,-msdata=sysvis incompatible with-mrelocatabletoo. ๐ญ-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. choose your own adventure โจ-msdata=dataโ on System V.4 and embedded PowerPC systems, small global data goes in the.sdatasection, and small uninitialized global data goes in the.sbsssection. But โ and this is the key part โ do not use register"r13"to address small data. This is the default behavior unless other-msdataoptions are used. lowkey iconic.-msdata=none,-mno-sdataโ on embedded PowerPC systems, all initialized global and static data goes in the.datasection, and all uninitialized data goes in the.bsssection. simple. clean. done.-mreadonly-in-sdataโ puts read-only objects in the.sdatasection as well. This is the default, so it's already serving ๐-mblock-move-inline-limit=numโ inlines all block moves (like calls to"memcpy"or structure copies) that are less than or equal to num bytes. The minimum value for num is 32 bytes on 32-bit targets and 64 bytes on 64-bit targets. The default value is target-specific.-mblock-compare-inline-limit=numโ generates non-looping inline code for all block compares (like calls to"memcmp"or structure compares) that are less than or equal to num bytes. If num is 0, all inline expansion (non-loop and loop) of block compare is disabled. The default value is target-specific.-mblock-compare-inline-loop-limit=numโ generates an inline expansion using loop code for all block compares that are less than or equal to num bytes, but greater than the limit for non-loop inline block compare expansion. If the block length is not constant, at most num bytes will be compared before"memcmp"is called to compare the remainder of the block. The default value is target-specific.-mstring-compare-inline-limit=numโ compares at most num string bytes with inline code. If the difference or the end of the string isn't found at the end of the inline compare, a call to"strcmp"or"strncmp"takes care of the rest of the comparison. The default is 64 bytes.-G numโ on embedded PowerPC systems, put global and static items less than or equal to num bytes into the small data or BSS sections instead of the normal data or BSS section. By default, num is 8. The-G numswitch is also passed to the linker. All modules should be compiled with the same-G numvalue. fr fr, keep them matching ๐-mregnames,-mno-regnamesโ on System V.4 and embedded PowerPC systems, do (or do not) emit register names in the assembly language output using symbolic forms.-mlongcall,-mno-longcallโ by default this assumes all calls are far away, so a longer and more expensive calling sequence is required. That's needed for calls farther than 32 megabytes (33,554,432 bytes) from the current location. A short call is generated if the compiler knows the call can't be that far away. This setting can be overridden by the"shortcall"function attribute, or by#pragma longcall(0).
Some linkers can detect out-of-range calls and generate glue code on the fly. On those systems, long calls are unnecessary and generate slower code. As of this writing, the AIX linker can do this, as can the GNU linker for PowerPC/64. It's planned to add this feature to the GNU linker for 32-bit PowerPC systems as well.
On PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, GCC can generate long calls using an inline PLT call sequence (see -mpltseq). PowerPC with -mbss-plt and PowerPC64 ELFv1 (big-endian) do not support inline PLT calls.
On Darwin/PPC systems, #pragma longcall generates jbsr callee, L42, plus a branch island (glue code). The two target addresses represent the callee and the branch island. The Darwin/PPC linker prefers the first address and generates a bl callee if the PPC bl instruction reaches the callee directly; otherwise, the linker generates bl L42 to call the branch island. The branch island is appended to the body of the calling function; it computes the full 32-bit address of the callee and jumps to it.
On Mach-O (Darwin) systems, this option directs the compiler emit to the glue for every direct call, and the Darwin linker decides whether to use or discard it.
In the future, GCC may ignore all longcall specifications when the linker is known to generate glue. ๐
-mpltseq,-mno-pltseqโ implement (or do not 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 are enabled by default if the support is detected when configuring GCC, and, in the case of 32-bit PowerPC, if GCC is configured with--enable-secureplt.
Watch out:-mpltseqcode and-mbss-plt32-bit PowerPC relocatable objects may not be linked together. ๐
-mtls-markers,-mno-tls-markersโ mark (or do not mark) calls to"__tls_get_addr"with a relocation specifying the function argument. The relocation lets the linker reliably associate a function call with its argument setup instructions for TLS optimization, which in turn lets GCC better schedule the sequence. โจ-mrecip,-mno-recipโ this option enables use of the reciprocal estimate and reciprocal square root estimate instructions with additional Newton-Raphson steps to increase precision, instead of doing a divide or square root and divide for floating-point arguments. You should use the-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 equals 0.99999994) for reciprocal square roots. ๐ญ
-mrecip=optโ this option controls which reciprocal estimate instructions may be used. opt is a comma-separated list of options, which may be preceded by a"!"to invert the option:allโ enable all estimate instructions.defaultโ enable the default instructions, equivalent to-mrecip.noneโ disable all estimate instructions, equivalent to-mno-recip.divโ enable the 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. the way that comma-separated list eats ๐
-mrecip-precision,-mno-recip-precisionโ assume (or do not assume) that the reciprocal estimate instructions provide higher-precision estimates than is mandated by the PowerPC ABI. Selecting-mcpu=power6,-mcpu=power7or-mcpu=power8automatically selects-mrecip-precision. The double-precision square root estimate instructions are not generated by default on low-precision machines, since they don't provide an estimate that converges after three steps. no cap ๐ฆ-mveclibabi=typeโ okay so this one tells GCC which ABI to use when it's vectorizing intrinsics with an external library. ๐ Right now the onlytypeit supports ismass, which means "use IBM's Mathematical Acceleration Subsystem (MASS) libraries to vectorize intrinsics via external libraries." When it's generating code forpower7, GCC currently emits calls to:
acosd2, acosf4, acoshd2, acoshf4, asind2, asinf4, asinhd2, asinhf4,
atan2d2, atan2f4, atand2, atanf4, atanhd2, atanhf4, cbrtd2, cbrtf4,
cosd2, cosf4, coshd2, coshf4, erfcd2, erfcf4, erfd2, erff4, exp2d2,
exp2f4, expd2, expf4, expm1d2, expm1f4, hypotd2, hypotf4, lgammad2,
lgammaf4, log10d2, log10f4, log1pd2, log1pf4, log2d2, log2f4, logd2,
logf4, powd2, powf4, sind2, sinf4, sinhd2, sinhf4, sqrtd2, sqrtf4,
tand2, tanf4, tanhd2, tanhf4
Both -ftree-vectorize and -funsafe-math-optimizations have to be enabled too, bestie, and the MASS libraries must be specified at link time. No shortcuts. ๐ซถ
-mfriz,-mno-frizโ these two decide whether to generate (or not generate, respectively) thefrizinstruction when-funsafe-math-optimizationsis being used to optimize rounding of floating-point values to 64-bit integer and back to floating point. โ ๏ธ Heads up though: thefrizinstruction does not return the same value if the floating-point number is too large to fit in an integer. So like, know what you're doing.-mpointers-to-nested-functions,-mno-pointers-to-nested-functionsโ generate (or don't generate) code to load up the static chain register (r11) when you're calling through a pointer on AIX and 64-bit Linux systems, where a function pointer points to a 3-word descriptor giving the function address, the TOC value to be loaded in registerr2, and the static chain value to be loaded in registerr11. โจ-mpointers-to-nested-functionsis on by default. And real talk: you literally 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. It's giving locked door. ๐ช-msave-toc-indirect,-mno-save-toc-indirectโ generate (or don't generate) code to save the TOC value in the reserved stack location in the function prologue, if the function calls through a pointer on AIX and 64-bit Linux systems. If the TOC value isn't saved in the prologue, it gets saved just before the call through the pointer instead.-mno-save-toc-indirectis the default. ๐-mcompat-align-parm,-mno-compat-align-parmโ generate (or don't generate) code that passes 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. That's been corrected in more recent versions. So this option exists so you can generate code that plays nice with functions compiled by the old GCCs. Very "we don't talk about the before times" energy, ngl.
-mno-compat-align-parm is the default.
-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offset,-mstack-protector-guard-symbol=symbolโ generate stack protection code using a canary at guard. Supported locations areglobalfor a global canary, ortlsfor a per-thread canary in the TLS block (which is the default with GNU libc version 2.4 or later). ๐ค
With that tls choice, -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset additionally specify which register to use as the base register for reading the canary, and from what offset off that base register. The default for those is as specified in the relevant ABI. And -mstack-protector-guard-symbol=symbol overrides the offset with a symbol reference to a canary in the TLS block. ๐
๐ RX Options ๐
These command-line options are defined for RX targets, bestie. Let's go. ๐ฆ
-m64bit-doubles,-m32bit-doublesโ make thedoubledata type be 64 bits (-m64bit-doubles) or 32 bits (-m32bit-doubles) in size. The default is-m32bit-doubles. Why, you ask? Because RX floating-point hardware only works on 32-bit values, which is literally 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 though, so the FPU hardware is not used for doubles if you've got -m64bit-doubles on. ๐
Note: if-fpuis enabled then-funsafe-math-optimizationsis also enabled automatically. Why? Because the RX FPU instructions are themselves unsafe. It's giving "the hardware said yolo". ๐ญ
-mcpu=nameโ selects the type of RX CPU to target. Currently three types are supported: the generic RX600 and RX200 series hardware, and the specific RX610 CPU. The default isRX600. โจ
The only difference between RX600 and RX610 is that the RX610 does not support the MVTIPL instruction.
The RX200 series doesn't have a hardware floating-point unit, so -nofpu is enabled by default when this type is selected.
-mbig-endian-data,-mlittle-endian-dataโ store data (but not code, okay? just data) in big-endian format. The default is-mlittle-endian-data, i.e. storing data in the little-endian format. ๐ธ-msmall-data-limit=Nโ specifies the maximum size in bytes of global and static variables that can be placed into the small data area. Using the small data area can lead to smaller and faster code, but the size of the area is limited and it's up to you, the programmer, to make sure the area doesn't overflow. ๐ Also, when the small data area is used, one of the RX's registers (usuallyr13) is reserved for pointing to this area, so it's no longer available for the compiler to use. Which could mean slower and/or larger code if variables get pushed onto the stack instead of chilling in this register. ๐
Note: common variables (variables that haven't been initialized) and constants are not placed into the small data area, because they get assigned to other sections in the output executable.
The default value is zero, which disables this feature. And note that this feature is not enabled by default even with higher optimization levels (-O2 etc.), because of the potentially detrimental effects of reserving a register. It's up to the programmer to experiment and discover whether this feature benefits their program. See the description of the -mpid option for how the actual register to hold the small data area pointer is chosen. ๐
-msim,-mno-simโ use the simulator runtime. The default is to use the libgloss board-specific runtime. ๐-mas100-syntax,-mno-as100-syntaxโ when generating assembler output, use a syntax compatible with Renesas's AS100 assembler. This syntax can also be handled by the GAS assembler, but it has some restrictions, so it's not generated by default. ๐ซถ-mmax-constant-size=Nโ specifies the maximum size, in bytes, of a constant that can be used as an operand in an RX instruction. So like, the RX instruction set does allow constants up to 4 bytes long to be used in instructions, but a longer value equates to a longer instruction. So sometimes it's actually beneficial to restrict the size of constants used in instructions. Constants that are too big get placed into a constant pool instead and referenced via register indirection. โจ
The value N can be between 0 and 4. A value of 0 (the default) or 4 means constants of any size are allowed.
-mrelaxโ enable linker relaxation. Linker relaxation is a process where the linker tries to shrink your program by finding shorter versions of various instructions. Disabled by default. ๐-mint-register=Nโ specify the number of registers to reserve for fast interrupt handler functions. The valueNcan be between0and4. A value of1means registerr13is reserved for the exclusive use of fast interrupt handlers. A value of2reservesr13andr12. A value of3reservesr13,r12andr11, and a value of4reservesr13throughr10. A value of0, the default, reserves no registers. ๐ฅ-msave-acc-in-interruptsโ specifies that interrupt handler functions should preserve the accumulator register. This is only necessary if normal code might use the accumulator register, for example because it performs 64-bit multiplications. The default is to ignore the accumulator, because that makes the interrupt handlers faster. ๐โโ๏ธ-mpid,-mno-pidโ enables the generation of position independent data. When enabled, any access to constant data is done via an offset from a base address held in a register. This lets the location of constant data be determined at run time without requiring the executable to be relocated, which is a benefit to embedded applications with tight memory constraints. Data that can be modified is not affected by this option. โจ
Note: using this feature reserves a register, usually r13, for the constant data base address. This can result in slower and/or larger code, especially in complicated functions. ๐ญ
The actual register chosen to hold the constant data base address depends on whether the -msmall-data-limit and/or the -mint-register command-line options are enabled. Starting with register r13 and proceeding downwards, registers are allocated first to satisfy the requirements of -mint-register, then -mpid, and finally -msmall-data-limit. So it's totally possible for the small data area register to end up being r8 if both -mint-register=4 and -mpid are specified on the command line. ๐คฏ
By default this feature is not enabled. The default can be restored via the -mno-pid command-line option.
-mno-warn-multiple-fast-interrupts,-mwarn-multiple-fast-interruptsโ prevents GCC from issuing a warning message if it finds more than one fast interrupt handler while compiling a file. The default is to issue a warning for each extra fast interrupt handler found, because the RX only supports one such interrupt. One (1) interrupt. Periodt. ๐-mallow-string-insns,-mno-allow-string-insnsโ turns on (or off, bestie) the use of the string manipulation instructionsSMOVF,SCMPU,SMOVB,SMOVU,SUNTIL,SWHILE, plus theRMPAinstruction too. Okay so here's the tea ๐ซ โ these instructions may prefetch data, and that is not safe to do if you're accessing an I/O register. (Go read section 12.2.7 of the RX62N Group User's Manual if you want the whole lore.)
The default is to allow these instructions, but ngl, it is not possible for GCC to reliably detect all circumstances where a string instruction might be used to access an I/O register, so their use cannot be disabled automatically. It is instead reliant upon the programmer to use -mno-allow-string-insns if their program accesses I/O space. This one's on you, bestie. ๐ญ
When the instructions are enabled GCC defines the C preprocessor symbol __RX_ALLOW_STRING_INSNS__, otherwise it defines the symbol __RX_DISALLOW_STRING_INSNS__.
-mjsr,-mno-jsrโ use only (or not only)JSRinstructions to access functions. This option can be used when code size exceeds the range ofBSRinstructions. And pay attention, because this trips people up:-mno-jsrdoes not mean "do not useJSR" โ it instead means that any type of branch may be used. ๐
Note: the generic GCC command-line option-ffixed-reghas special significance to the RX port when used with theinterruptfunction attribute. This attribute indicates a function intended to process fast interrupts. GCC ensures that it only uses the registersr10,r11,r12and/orr13โ and only provided that the normal use of the corresponding registers have been restricted via the-ffixed-regor-mint-registercommand-line options. Lowkey iconic how much it cares. ๐
โจ S/390 and zSeries Options โจ
These are the -m options defined for the S/390 and zSeries architecture. Big mainframe energy fr fr ๐ฅ๏ธ๐
-mhard-float,-msoft-floatโ use (do not use) the hardware floating-point instructions and registers for floating-point operations. When-msoft-floatis specified, functions inlibgcc.aare used to perform floating-point operations. When-mhard-floatis specified, the compiler generates IEEE floating-point instructions. This is the default. โญ-mhard-dfp,-mno-hard-dfpโ use (do not use) the hardware decimal-floating-point instructions for decimal-floating-point operations. When-mno-hard-dfpis specified, functions inlibgcc.aare used to perform decimal-floating-point operations. When-mhard-dfpis specified, 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 makes thelong doubletype equivalent to thedoubletype. This is the default.-mbackchain,-mno-backchainโ store (do not store) the address of the caller's frame as backchain pointer into the callee's stack frame. A backchain may be needed to allow debugging using tools that do not understand DWARF call frame information. When-mno-packed-stackis in effect, the backchain pointer is stored 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.
In general, code compiled with -mbackchain is call-compatible with code compiled with -mmo-backchain; however, use of the backchain for debugging purposes usually requires that the whole binary is built with -mbackchain. Note that the combination of -mbackchain, -mpacked-stack and -mhard-float is not supported. In order to build a linux kernel use -msoft-float. ๐ง
The default is to not maintain the backchain.
-mpacked-stack,-mno-packed-stackโ use (do not use) the packed stack layout. When-mno-packed-stackis specified, the compiler uses the all fields of the 96/160 byte register save area only for their default purpose; unused fields still take up stack space. When-mpacked-stackis specified, register save slots are densely packed at the top of the register save area; unused space is reused for other purposes, allowing for more efficient use of the available stack space. However, when-mbackchainis also in effect, the topmost word of the save area is always used to store the backchain, and the return address register is always saved two words below the backchain. ๐งบ
As long as the stack frame backchain is not used, code generated with -mpacked-stack is call-compatible with code generated with -mno-packed-stack. Note that some non-FSF releases of GCC 2.95 for S/390 or zSeries generated code that uses the stack frame backchain at run time, not just for debugging purposes. Such code is not call-compatible with code compiled with -mpacked-stack. Also, note that the combination of -mbackchain, -mpacked-stack and -mhard-float is not supported. In order to build a linux kernel use -msoft-float.
The default is to not use the packed stack layout.
-msmall-exec,-mno-small-execโ generate (or do not generate) code using thebrasinstruction to do subroutine calls. This only works reliably if the total executable size does not exceed 64k. ๐ The default is to use thebasrinstruction instead, which does not have this limitation.-m64,-m31โ when-m31is specified, generate code compliant to the GNU/Linux for S/390 ABI. When-m64is specified, generate code compliant to the GNU/Linux for zSeries ABI. This allows GCC in particular to generate 64-bit instructions. For the s390 targets, the default is-m31, while the s390x targets default to-m64.-mzarch,-mesaโ when-mzarchis specified, generate code using the instructions available on z/Architecture. When-mesais specified, generate code using the instructions available on ESA/390. Note that-mesais not possible with-m64. When generating code compliant to the GNU/Linux for S/390 ABI, the default is-mesa. When generating code compliant to the GNU/Linux for zSeries ABI, the default is-mzarch.-mhtm,-mno-htmโ the-mhtmoption enables a set of builtins making use of instructions available with the transactional execution facility introduced with the IBM zEnterprise EC12 machine generation S/390 System z Built-in Functions.-mhtmis enabled by default when using-march=zEC12.-mvx,-mno-vxโ when-mvxis specified, generate code using the instructions available with the vector extension facility introduced with the IBM z13 machine generation. This option changes the ABI for some vector type values with regard to alignment and calling conventions. In case vector type values are being used in an ABI-relevant context a GAS.gnu_attributecommand will be added to mark the resulting binary with the ABI used.-mvxis enabled by default when using-march=z13. ๐-mzvector,-mno-zvectorโ the-mzvectoroption enables vector language extensions and builtins using instructions available with the vector extension facility introduced with the IBM z13 machine generation. This option adds support forvectorto be used as a keyword to define vector type variables and arguments.vectoris only available when GNU extensions are enabled. It will not be expanded when requesting strict standard compliance e.g. with-std=c99. In addition to the GCC low-level builtins-mzvectorenables a set of builtins added for compatibility with AltiVec-style implementations like Power and Cell. In order to make use of these builtins the header filevecintrin.hneeds to be included.-mzvectoris disabled by default.-mmvcle,-mno-mvcleโ generate (or do not generate) code using themvcleinstruction to perform block moves. When-mno-mvcleis specified, use amvcloop instead. This is the default unless optimizing for size.-mdebug,-mno-debugโ print (or do not print) additional debug information when compiling. The default is to not print debug information.- *
-march=cpu-type* โ generate code that runs on cpu-type, which is the name of a system representing a certain processor type. Possible values for cpu-type arez900/arch5,z990/arch6,z9-109,z9-ec/arch7,z10/arch8,z196/arch9,zEC12,z13/arch11,z14/arch12, andnative.
The default is -march=z900.
Specifying native as cpu type can be used to select the best architecture option for the host processor. -march=native has no effect if GCC does not recognize the processor. ๐
- *
-mtune=cpu-type* โ tune to cpu-type everything applicable about the generated code, except for the ABI and the set of available instructions. The list of cpu-type values is the same as for-march. The default is the value used for-march. -mtpf-trace,-mno-tpf-traceโ generate code that adds (does not add) in TPF OS specific branches to trace routines in the operating system. This option is off by default, even when compiling for the TPF OS. ๐-mfused-madd,-mno-fused-maddโ generate code that uses (does not use) the floating-point multiply and accumulate instructions. These instructions are generated by default if hardware floating point is used. โโ๏ธ- *
-mwarn-framesize=framesize* โ emit a warning if the current function exceeds the given frame size. Because this is a compile-time check it doesn't need to be a real problem when the program runs. It is intended to identify functions that most probably cause a stack overflow. It is useful to be used in an environment with limited stack size e.g. the linux kernel. ๐จ -mwarn-dynamicstackโ emit a warning if the function callsallocaor uses dynamically-sized arrays. This is generally a bad idea with a limited stack size. Not the vibe, bestie. ๐ฌ-mstack-guard=stack-guard-mstack-size=stack-size โ bestie, if you hand over both of these, the S/390 back end sneaks extra instructions into the function prologue that trap if the stack size ends up being stack-guard bytes above stack-size (and yes, remember the stack on S/390 grows downward ๐ ). If you skip-mstack-guard, it just picks the smallest power of 2 that's bigger than the frame size of the function it's compiling. These two are meant to help you debug stack overflow situations, no cap โ the extra code it emits costs basically nothing in overhead, so you can legit run it in production-like systems without a big performance hit. The values you give have to be exact powers of 2, and stack-size must be greater than stack-guard while not exceeding64k. Also for efficiency the extra code assumes the stack starts at an address aligned to whatever stack-size says. Oh and-mstack-guardcan only be used together with-mstack-size, periodt.-mhotpatch=pre-halfwords,post-halfwords โ turn this on and a "hot-patching" function prologue gets generated for every single function in the compilation unit ๐ซถ. The function label gets prepended with the given number of two-byteNOPinstructions (pre-halfwords, max1000000). After the label,2 * post-halfwordsbytes get appended, using the largest NOP-like instructions the architecture allows (post-halfwords, max1000000).
If both arguments are zero, hotpatching is disabled ๐.
This option can be overridden for individual functions with the "hotpatch" attribute.
๐ฎ Score Options ๐ฎ
These options are defined for Score implementations:
-mebโ compile code for big-endian mode. This is the default. ๐-melโ compile code for little-endian mode.-mnhwloopโ disable generation of"bcnz"instructions.-mulsโ enable generation of unaligned load and store instructions.-mmacโ enable the use of multiply-accumulate instructions. Disabled by default.-mscore5โ specify theSCORE5as the target architecture.-mscore5uโ specify theSCORE5Uof the target architecture.-mscore7โ specify theSCORE7as the target architecture. This is the default.-mscore7dโ specify theSCORE7Das the target architecture.
๐ธ SH Options ๐ธ
These -m options are defined for the SH implementations:
-m1โ generate code for the SH1.-m2โ generate code for the SH2.-m2eโ generate code for the SH2e.-m2a-nofpuโ generate code for the SH2a without FPU, or for a SH2a-FPU in such a way that the floating-point unit is not used.-m2a-single-onlyโ generate code for the SH2a-FPU, in such a way that no double-precision floating-point operations are used.-m2a-singleโ generate code for the SH2a-FPU assuming the floating-point unit is in single-precision mode by default.-m2aโ generate code for the SH2a-FPU assuming the floating-point unit is in double-precision mode by default.-m3โ generate code for the SH3.-m3eโ generate code for the SH3e.-m4-nofpuโ generate code for the SH4 without a floating-point unit.-m4-single-onlyโ generate code for the SH4 with a floating-point unit that only supports single-precision arithmetic.-m4-singleโ generate code for the SH4 assuming the floating-point unit is in single-precision mode by default.-m4โ generate code for the SH4.-m4-100โ generate code for SH4-100.-m4-100-nofpuโ generate code for SH4-100 in such a way that the floating-point unit is not used.-m4-100-singleโ generate code for SH4-100 assuming the floating-point unit is in single-precision mode by default.-m4-100-single-onlyโ generate code for SH4-100 in such a way that no double-precision floating-point operations are used.-m4-200โ generate code for SH4-200.-m4-200-nofpuโ generate code for SH4-200 without in such a way that the floating-point unit is not used.-m4-200-singleโ generate code for SH4-200 assuming the floating-point unit is in single-precision mode by default.-m4-200-single-onlyโ generate code for SH4-200 in such a way that no double-precision floating-point operations are used.-m4-300โ generate code for SH4-300.-m4-300-nofpuโ generate code for SH4-300 without in such a way that the floating-point unit is not used.-m4-300-singleโ generate code for SH4-300 in such a way that no double-precision floating-point operations are used.-m4-300-single-onlyโ generate code for SH4-300 in such a way that no double-precision floating-point operations are used.-m4-340โ generate code for SH4-340 (no MMU, no FPU).-m4-500โ generate code for SH4-500 (no FPU). Passes-isa=sh4-nofputo the assembler.-m4a-nofpuโ generate code for the SH4al-dsp, or for a SH4a in such a way that the floating-point unit is not used.-m4a-single-onlyโ generate code for the SH4a, in such a way that no double-precision floating-point operations are used.-m4a-singleโ generate code for the SH4a assuming the floating-point unit is in single-precision mode by default.-m4aโ generate code for the SH4a.-m4alโ same as-m4a-nofpu, except that it implicitly passes-dspto the assembler. 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. Heads up bestie, this changes the calling conventions, so some functions from the standard C library won't work unless you recompile it first with-mdalign๐ญ.-mrelaxโ shorten some address references at link time, when possible; uses the linker option-relax.-mbigtableโ use 32-bit offsets in"switch"tables. The default is to use 16-bit offsets.-mbitopsโ enable the use of bit manipulation instructions on SH2A.-mfmovdโ enable the use of the instruction"fmovd". Check-mdalignfor alignment constraints.-mrenesasโ comply with the calling conventions defined by Renesas.-mno-renesasโ comply with the calling conventions defined for GCC before the Renesas conventions were available. This option is the default for all targets of the SH toolchain.-mnomacsaveโ mark the"MAC"register as call-clobbered, even if-mrenesasis given.-mieee-mno-ieeeโ control the IEEE compliance of floating-point comparisons, which affects how cases get handled where the result of a comparison is unordered. By default-mieeeis implicitly enabled. If-ffinite-math-onlyis enabled,-mno-ieeeis implicitly set, which gives you faster floating-point greater-equal and less-equal comparisons. You can override those implicit settings by specifying either-mieeeor-mno-ieee. โจ-minline-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 the"icbi"instruction. If the selected code generation option does not allow the use of the"icbi"instruction, and-musermodeis not in effect, the inlined code manipulates the instruction cache address array directly with an associative write. This not only requires privileged mode at run time, 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.-mpadstructโ this option is deprecated. It pads structures to multiple of 4 bytes, which is incompatible with the SH ABI.-matomic-model=model โ sets the model of atomic operations and additional parameters as a comma separated list. For details on the atomic built-in functions see__atomic Builtins. The following models and parameters are supported:noneโ disable compiler generated atomic sequences and emit library calls for atomic operations. This is the default if the target is not"sh*-*-linux*".soft-gusaโ generate GNU/Linux compatible gUSA software atomic sequences for the atomic built-in functions. The generated atomic sequences require additional support from the interrupt/exception handling code of the system and are only suitable for SH3* and SH4* single-core systems. This option is enabled by default when the target is"sh*-*-linux*"and SH3* or SH4*. When the target is SH4A, this option also partially utilizes the hardware atomic instructions"movli.l"and"movco.l"to create more efficient code, unless strict is specified.soft-tcbโ generate software atomic sequences that use a variable in the thread control block. This is a variation of the gUSA sequences which can also be used on SH1* and SH2* targets. The generated atomic sequences require additional support from the interrupt/exception handling code of the system and are only suitable for single-core systems. When using this model, thegbr-offset=parameter has to be specified as well.soft-imaskโ generate software atomic sequences that temporarily disable interrupts by setting"SR.IMASK = 1111". This model works only when the program runs in privileged mode and is only suitable for single-core systems. Additional support from the interrupt/exception handling code of the system is not required. This model is enabled by default when the target is"sh*-*-linux*"and SH1* or SH2*.hard-llcsโ generate hardware atomic sequences using the"movli.l"and"movco.l"instructions only. This is only available on SH4A and is suitable for multi-core systems. Since the hardware instructions support only 32 bit atomic variables, access to 8 or 16 bit variables is emulated with 32 bit accesses. Code compiled with this option is also compatible with other software atomic model interrupt/exception handling systems if executed on an SH4A system. Additional support from the interrupt/exception handling code of the system is not required for this model.
gbr-offset=โ this one tells the compiler the offset, in bytes, of the variable inside the thread control block structure that the generated atomic sequences should use โ but only when the soft-tcb model has been picked. Any other model? It literally ignores this. And the value you give has to be an integer multiple of four, sitting somewhere in the range0-1020. No exceptions bestie, the compiler will side-eye you.strictโ this one says no mixing!! Even if the atomic models are compatible,strictblocks you from combining them, and forces the compiler to generate atomic sequences of the specified model only. One model, one vibe, periodt. ๐
-mtasโ generates the"tas.b"opcode for"__atomic_test_and_set". But heads up: depending on the exact hardware and software configuration, this can tank your overall performance, because of the operand cache line flushes that the"tas.b"instruction implies. And on multi-core SH4A processors you gotta be careful with"tas.b"โ it can cause actual data corruption for certain cache configurations. ๐ญ So like, know your machine.-mprefergotโ when you're generating position-independent code, this makes function calls go through the Global Offset Table instead of the Procedure Linkage Table. GOT > PLT, apparently.-musermode,-mno-usermodeโ don't allow / allow the compiler to generate privileged mode code. Specifying-musermodealso implies-mno-inline-ic_invalidateif the inlined code wouldn't work in user mode.-musermodeis the default when the target is"sh*-*-linux*". But if the target is SH1* or SH2*,-musermodedoes nothing at all, since there's no user mode to speak of. ๐-multcost=numberโ sets the cost to assume for a multiply instruction.-mdiv=strategyโ sets the division strategy used for integer division operations. strategy can be one of these three:call-div1โ calls a library function that uses the single-step division instruction"div1"to do the thing. 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 here causes a floating-point exception. This is the default for SHcompact with FPU. If you specify this for targets that don't have a double precision FPU, it defaults to"call-div1".call-tableโ calls a library function that uses a lookup table for small divisors, and the"div1"instruction with case distinction for bigger divisors. Division by zero calculates an unspecified result and does not trap. This is the default for SH4. Specifying this for targets that don't have dynamic shift instructions defaults to"call-div1".
When you haven't specified a division strategy, the default is picked 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โ reserve space once for outgoing arguments in the function prologue, instead of doing it around every single call. Generally a glow-up for performance and size. Also needed for unwinding, so you don't go changing the stack frame around conditional code.-mdivsi3_libfunc=nameโ sets the name of the library function used for 32-bit signed division to name. This only affects the name used in the call division strategies โ the compiler still expects the same sets of input/output/clobbered registers as if this option weren't there at all. No take-backs.-mfixed-range=register-rangeโ generates code treating the given register range as fixed registers. A fixed register is one the register allocator can't touch. Super useful when you're compiling kernel code. A register range is written as two registers separated by a dash. And yes, you can specify multiple register ranges, separated by commas.-mbranch-cost=numโ assume num is the cost for a branch instruction. Higher numbers make the compiler try harder to generate branch-free code where it can. If you don't specify it, the value gets picked based on the processor type you're compiling for.-mzdcbranch,-mno-zdcbranchโ assume (or don't assume) that the zero displacement conditional branch instructions"bt"and"bf"are fast. With-mzdcbranch, the compiler prefers zero displacement branch code sequences. Enabled by default when generating code for SH4 and SH4A. You can explicitly turn it off with-mno-zdcbranch.-mcbranch-force-delay-slotโ forces the usage of delay slots for conditional branches, which stuffs the delay slot with a"nop"if no suitable instruction can be found. Disabled by default. You can enable it to work around hardware bugs, like the ones found in the original SH7055.-mfused-madd,-mno-fused-maddโ generate code that uses (or doesn't use) the floating-point multiply and accumulate instructions. These get generated by default if hardware floating point is in use. The machine-dependent-mfused-maddoption is now mapped to the machine-independent-ffp-contract=fastoption, and-mno-fused-maddmaps to-ffp-contract=off.-mfsca,-mno-fscaโ allow or disallow the compiler from emitting the"fsca"instruction for sine and cosine approximations.-mfscamust be used together with-funsafe-math-optimizations. Enabled by default when generating code for SH4A. Using-mno-fscadisables the sine and cosine approximations even if-funsafe-math-optimizationsis in effect.-mfsrra,-mno-fsrraโ allow or disallow the compiler from emitting the"fsrra"instruction for reciprocal square root approximations.-mfsrramust be used together with-funsafe-math-optimizationsand-ffinite-math-only. Enabled by default when generating code for SH4A. Using-mno-fsrradisables the reciprocal square root approximations even if-funsafe-math-optimizationsand-ffinite-math-onlyare both in effect.-mpretend-cmoveโ prefer zero-displacement conditional branches for conditional move instruction patterns. This can give you faster code on the SH4 processor. ๐ฅ-mfdpicโ generate code using the FDPIC ABI.
๐ Solaris 2 Options ๐
These -m options are supported on Solaris 2:
-mclear-hwcapโ-mclear-hwcaptells the compiler to remove the hardware capabilities generated by the Solaris assembler. You only need this when object files use ISA extensions that the current machine doesn't support, but check at runtime whether or not to use them.-mimpure-textโ-mimpure-text, used in addition to-shared, tells the compiler not to 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 isn't actually shared across processes. So instead of using -mimpure-text, you should compile all source code with -fpic or -fPIC. Do that. Bestie, please.
These switches are supported in addition to the above on Solaris 2:
-pthreadsโ this is a synonym for-pthread.
๐ SPARC Options ๐
These -m options are supported on the SPARC:
-mno-app-regs,-mapp-regsโ specify-mapp-regsto generate output using the global registers 2 through 4, which the SPARC SVR4 ABI reserves for applications. Just like global register 1, each global register 2 through 4 then gets 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 doesn't generate save/restore instructions and instead 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 can't be done directly in cross-compilation. You have to make your own arrangements to provide suitable library functions for cross-compilation. The embedded targetssparc-*-aoutandsparclite-*-*do provide software floating-point support.
-msoft-float changes the calling convention in the output file, so it's only useful if you compile all of a program with this option. In particular, you need to compile libgcc.a, the library that comes with GCC, with -msoft-float for this to work.
-mhard-quad-floatโ generate output containing quad-word (long double) floating-point instructions.-msoft-quad-floatโ generate output containing library calls for quad-word (long double) floating-point instructions. The functions called are those specified in the SPARC ABI. This is the default.
As of this writing, there are no SPARC implementations that have hardware support for the quad-word floating-point instructions. They all invoke a trap handler for one of these instructions, and then the trap handler emulates the effect of the instruction. Because of the trap handler overhead, this is much slower than calling the ABI library routines. Thus the -msoft-quad-float option is the default.
-mno-unaligned-doubles,-munaligned-doublesโ assume that doubles have 8-byte alignment. This is the default.-munaligned-doublesโ with this one, GCC is like "okay so doubles only have 8-byte alignment if they're chillin' inside another type, or if they have an absolute address". Otherwise bestie gets 4-byte alignment. Why would you want this? It dodges some rare compatibility drama with code that other compilers made. Why is it not the default? Because it costs you performance, especially for floating-point code. It's giving "works but slow" ๐-muser-mode-mno-user-modeโ don't generate code that can only run in supervisor mode. This only matters for thecasainstruction emitted for the LEON3 processor. This is the default. โจ-mfaster-structs-mno-faster-structsโ with-mfaster-structs, the compiler assumes structs should have 8-byte alignment. That unlocks pairs oflddandstdinstructions for copies in struct assignment, instead of literally twice as manyldandstpairs. slay BUT โ and this is a big but โ that changed alignment directly violates the SPARC ABI. So it's intended only for targets where the dev fully acknowledges that their resulting code is not in line with the rules of the ABI. No cap, read that twice. ๐ญ-mstd-struct-return-mno-std-struct-returnโ with-mstd-struct-return, the compiler generates checking code in functions returning structs or unions, to detect size mismatches between the two sides of function calls, as per the 32-bit ABI.
The default is -mno-std-struct-return. This option has no effect in 64-bit mode. ๐
-mlra-mno-lraโ enable Local Register Allocation. This is the default for SPARC since GCC 7, so you'd have to pass-mno-lrato get old Reload back. throwback era ๐ฆ- *
-mcpu=cpu_type* โ set the instruction set, register set, and instruction scheduling parameters for machine type cpu_type. The supported values for cpu_type arev7,cypress,v8,supersparc,hypersparc,leon,leon3,leon3v7,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. it literally just gives up, respectfully ๐
Default instruction scheduling parameters are used for values that select an architecture and not an implementation. Those are v7, v8, sparclite, sparclet, v9.
Here is a list of each supported architecture and their supported implementations:
v7โcypress,leon3v7v8โsupersparc,hypersparc,leon,leon3sparcliteโf930,f934,sparclite86xsparcletโtsc701v9โultrasparc,ultrasparc3,niagara,niagara2,niagara3,niagara4,niagara7,m8
By default (unless configured otherwise), GCC generates code for the V7 variant of the SPARC architecture. With -mcpu=cypress, the compiler additionally optimizes it for the Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series. This is also appropriate for the older SPARCStation 1, 2, IPX etc.
With -mcpu=v8, GCC generates code for the V8 variant of the SPARC architecture. The only difference from V7 code is that the compiler emits the integer multiply and integer divide instructions which exist in SPARC-V8 but not in SPARC-V7. With -mcpu=supersparc, the compiler additionally optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and 2000 series. โจ
With -mcpu=sparclite, GCC generates code for the SPARClite variant of the SPARC architecture. This adds the integer multiply, integer divide step and scan (ffs) instructions which exist in SPARClite but not in SPARC-V7. With -mcpu=f930, the compiler additionally optimizes it for the Fujitsu MB86930 chip, which is the original SPARClite, with no FPU. With -mcpu=f934, the compiler additionally optimizes it for the Fujitsu MB86934 chip, which is the more recent SPARClite with FPU.
With -mcpu=sparclet, GCC generates code for the SPARClet variant of the SPARC architecture. This adds the integer multiply, multiply/accumulate, integer divide step and scan (ffs) instructions which exist in SPARClet but not in SPARC-V7. With -mcpu=tsc701, the compiler additionally optimizes it for the TEMIC SPARClet chip.
With -mcpu=v9, GCC generates code for the V9 variant of the SPARC architecture. This adds 64-bit integer and floating-point move instructions, 3 additional floating-point condition code registers and conditional move instructions. With -mcpu=ultrasparc, the compiler additionally optimizes it for the Sun UltraSPARC I/II/IIi chips. With -mcpu=ultrasparc3, the compiler additionally optimizes it for the Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips. With -mcpu=niagara, the compiler additionally optimizes it for Sun UltraSPARC T1 chips. With -mcpu=niagara2, the compiler additionally optimizes it for Sun UltraSPARC T2 chips. With -mcpu=niagara3, the compiler additionally optimizes it for Sun UltraSPARC T3 chips. With -mcpu=niagara4, the compiler additionally optimizes it for Sun UltraSPARC T4 chips. With -mcpu=niagara7, the compiler additionally optimizes it for Oracle SPARC M7 chips. With -mcpu=m8, the compiler additionally optimizes it for Oracle M8 chips. the way this list just keeps GOING ๐ญ๐
-mtune=cpu_type โ set the instruction scheduling parameters for machine type cpu_type, but do *not set the instruction set or register set that the option-mcpu=cpu_type* does. subtle queen behavior ๐
The same values for -mcpu=cpu_type can be used for -mtune=cpu_type, but the only useful values are those that select a particular CPU implementation. Those are cypress, supersparc, hypersparc, leon, leon3, leon3v7, 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. ๐ฆ-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-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 asm8and later. Setting-mvis4balso sets-mvis4,-mvis3,-mvis2and-mvis. the stacking is immaculate ๐-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: ๐
-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. โจ- *
-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. very specific, very demure ๐
medanyโ the Medium/Anywhere code model, bestie: 64-bit addresses, programs can be linked anywhere in memory, but the text and data segments have to be less than 2GB in size, and the data segment must sit within 2GB of the text segment. ๐embmedanyโ Medium/Anywhere but for embedded systems ๐ฆ: 64-bit addresses, text and data segments must be less than 2GB in size, and both start anywhere in memory (decided at link time, no cap). The global register%g4points to the base of the data segment. Programs are statically linked and PIC is not supported, periodt.
โจ -mmemory-model=mem-model โจ
Set the memory model in force on the processor to one of these ๐
defaultโ the default memory model for the processor and operating system. The safe lil' no-thoughts choice.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. iykyk ๐
๐ธ -mstack-bias / -mno-stack-bias ๐ธ
With -mstack-bias, GCC assumes that the stack pointer โ and the frame pointer if there is one โ are offset by -2047, which must be added back when making stack frame references. This is the default in 64-bit mode. Otherwise, assume no such offset is present.
๐ SPU Options ๐
These -m options are supported on the SPU:
๐ -mwarn-reloc / -merror-reloc ๐
The loader for SPU does not handle dynamic relocations, and that is simply not the vibe. By default, GCC gives an error when it generates code that requires a dynamic relocation. -mno-error-reloc disables the error, and -mwarn-reloc generates a warning instead.
๐ง -msafe-dma / -munsafe-dma ๐ง
Instructions that initiate or test completion of DMA must not be reordered with respect to loads and stores of the memory that is being accessed. With -munsafe-dma you must use the volatile keyword to protect memory accesses โ but that can lead to inefficient code in places where the memory is known to not change. Rather than mark the memory as volatile, you can use -msafe-dma to tell the compiler to treat the DMA instructions as potentially affecting all memory.
๐ -mbranch-hints ๐
By default, GCC generates a branch hint instruction to avoid pipeline stalls for always-taken or probably-taken branches. A hint is not generated closer than 8 instructions away from its branch. There is little reason to disable them, except for debugging purposes, or to make an object a little bit smaller.
๐ -msmall-mem / -mlarge-mem ๐
By default, GCC generates code assuming that addresses are never larger than 18 bits. With -mlarge-mem, code is generated that assumes a full 32-bit address.
โจ -mstdmain โจ
By default, GCC links against startup code that assumes the SPU-style main function interface (which has an unconventional parameter list, no shade). With -mstdmain, GCC links your program against startup code that assumes a C99-style interface to main, including a local copy of argv strings.
๐ -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.
๐ -mea32 / -mea64 ๐
Compile code assuming that pointers to the PPU address space accessed via the __ea named address space qualifier are either 32 or 64 bits wide. The default is 32 bits. As this is an ABI-changing option, all object code in an executable must be compiled with the same setting. No mixing, bestie.
๐ฆ -maddress-space-conversion / -mno-address-space-conversion ๐ฆ
Allow/disallow treating the __ea address space as a superset of the generic address space. This enables explicit type casts between __ea and generic pointer, as well as implicit conversions of generic pointers to __ea pointers. The default is to allow address space pointer conversions.
๐ธ -mcache-size=cache-size ๐ธ
This option controls the version of libgcc that the compiler links to an executable and selects a software-managed cache for accessing variables in the __ea address space with a particular cache size. Possible options for cache-size are 8, 16, 32, 64 and 128. The default cache size is 64KB.
๐ -matomic-updates / -mno-atomic-updates ๐
This option controls the version of libgcc that the compiler links to an executable and selects whether atomic updates to the software-managed cache of PPU-side variables are used. If you use atomic updates, changes to a PPU variable from SPU code using the __ea named address space qualifier do not interfere with changes to other PPU variables residing in the same cache line from PPU code. If you do not use atomic updates, such interference may occur โ however, writing back cache lines is more efficient. The default behavior is to use atomic updates.
๐ -mdual-nops / -mdual-nops=n ๐
By default, GCC inserts NOPs to increase dual issue when it expects it to increase performance. n can be a value from 0 to 10. A smaller n inserts fewer NOPs. 10 is the default, 0 is the same as -mno-dual-nops. Disabled with -Os.
๐ -mhint-max-nops=n ๐
Maximum number of NOPs to insert for a branch hint. A branch hint must be at least 8 instructions away from the branch it is affecting. GCC inserts up to n NOPs to enforce this, otherwise it does not generate the branch hint.
๐ง -mhint-max-distance=n ๐ง
The encoding of the branch hint instruction limits the hint to be within 256 instructions of the branch it is affecting. By default, GCC makes sure it is within 125.
๐ฅ -msafe-hints ๐ฅ
Work around a hardware bug that causes the SPU to stall indefinitely. By default, GCC inserts the hbrp instruction to make sure this stall won't happen.
๐ 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. (So likeโฆ it works, but it's giving deprecated energy, fr.)-Qyโ Identify the versions of each tool used by the compiler, in a.identassembler directive in the output.-Qnโ Refrain from adding.identdirectives to the output file (this is the default).-YP,dirsโ Search the directories dirs, and no others, for libraries specified with-l.-Ym,dirโ Look in the directory dir to find the M4 preprocessor. The assembler uses this option.
๐ TILE-Gx Options ๐
These -m options are supported on the TILE-Gx:
โญ -mcmodel=small โญ
Generate code for the small model. The distance for direct calls is limited to 500M in either direction. PC-relative addresses are 32 bits. Absolute addresses support the full address range.
โญ -mcmodel=large โญ
Generate code for the large model. There is no limitation on call distance, pc-relative addresses, or absolute addresses.
โญ -mcpu=name โญ
Selects the type of CPU to be targeted. Currently the only supported type is tilegx.
โญ -m32 / -m64 โญ
Generate code for a 32-bit or 64-bit environment. The 32-bit environment sets int, long, and pointer to 32 bits. The 64-bit environment sets int to 32 bits and long and pointer to 64 bits.
โญ -mbig-endian / -mlittle-endian โญ
Generate code in big/little endian mode, respectively.
๐ฆ TILEPro Options ๐ฆ
These -m options are supported on the TILEPro:
๐ -mcpu=name ๐
Selects the type of CPU to be targeted. Currently the only supported type is tilepro.
๐ -m32 ๐
Generate code for a 32-bit environment, which sets int, long, and pointer to 32 bits. This is the only supported behavior so the flag is essentially ignored. (Iconic honestly โ it's there, it's just not doing much ๐)
๐ V850 Options ๐
These -m options are defined for V850 implementations:
-mlong-calls/-mno-long-callsโ Treat all calls as being far away (near). If calls are assumed to be far away, the compiler always loads the function's address into a register, and calls indirect through the pointer.-mno-ep/-mepโ Do not optimize (do optimize) basic blocks that use the same index pointer4or more times to copy pointer into theepregister, and use the shortersldandsstinstructions. The-mepoption is on by default if you optimize.-mno-prolog-function/-mprolog-functionโ Do not use (do use) external functions to save and restore registers at the prologue and epilogue of a function. The external functions are slower, but use less code space if more than one function saves the same number of registers. The-mprolog-functionoption is on by default if you optimize.-mspaceโ Try to make the code as small as possible. At present, this just turns on the-mepand-mprolog-functionoptions.-mtda=nโ Put static or global variables whose size isnbytes or less into the tiny data area that registereppoints to. The tiny data area can hold up to256bytes in total (128bytes for byte references).-msda=nโ Put static or global variables whose size isnbytes or less into the small data area that registergppoints to. The small data area can hold up to64kilobytes.-mzda=nโ Put static or global variables whose size isnbytes or less into the first32kilobytes of memory.-mv850โ Specify that the target processor is the V850.-mv850e3v5โ Specify that the target processor is the V850E3V5. The preprocessor constant__v850e3v5__is defined if this option is used.-mv850e2v4โ Specify that the target processor is the V850E3V5. This is an alias for the-mv850e3v5option.-mv850e2v3โ Specify that the target processor is the V850E2V3. The preprocessor constant__v850e2v3__is defined if this option is used.-mv850e2โ Specify that the target processor is the V850E2. The preprocessor constant__v850e2__is defined if this option is used.-mv850e1โ Specify that the target processor is the V850E1. The preprocessor constants__v850e1__and__v850e__are defined if this option is used.-mv850esโ Specify that the target processor is the V850ES. This is an alias for the-mv850e1option.-mv850eโ tells GCC the target processor is the V850E. If you use this, the preprocessor constant__v850e__gets defined, slay.
Okay so if literally none of -mv850, -mv850e, -mv850e1, -mv850e2, -mv850e2v3, -mv850e3v5 are defined, then a default target processor is chosen for you and the relevant __v850*__ preprocessor constant gets defined. And bestie, __v850 and __v851__ are always defined, no matter which processor variant is the target. Always. Periodt.
-mdisable-callt,-mno-disable-calltโ this one suppresses generation of theCALLTinstruction 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 (peep -mrh850-abi), and disabled by default when the GCC ABI is in use. And if CALLT instructions are being generated, the C preprocessor symbol __V850_CALLT__ gets defined. iykyk.
-mrelax,-mno-relaxโ passes on (or does not pass on) the-mrelaxcommand-line option to the assembler. Passing the vibe along, fr fr.-mlong-jumps,-mno-long-jumpsโ disables (or re-enables) the generation of PC-relative jump instructions. Yes the double negative is giving chaos but it's not my fault.-msoft-float,-mhard-floatโ disables (or re-enables) the generation of hardware floating point instructions. This one only matters when the target architecture is V850E2V3 or higher. If hardware floating point instructions are being generated then the C preprocessor symbol__FPU_OK__is defined, otherwise the symbol__NO_FPU__is defined. ๐ซถ-mloopโ enables the use of the e3v5LOOPinstruction. It is not enabled by default when the e3v5 architecture is selected, because its use is still experimental. Lowkey iconic but proceed with caution.-mrh850-abi,-mghsโ enables support for the RH850 version of the V850 ABI. This is the default. With this version of the ABI the following rules apply:- Integer sized structures and unions are returned via a memory pointer rather than a register.
- Large structures and unions (more than 8 bytes in size) are passed by value.
- Functions are aligned to 16-bit boundaries.
- The
-m8byte-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 of the ABI the following rules apply:- Integer sized structures and unions are returned in register
r10. - Large structures and unions (more than 8 bytes in size) are passed by reference.
- Functions are aligned to 32-bit boundaries, unless optimizing for size.
- The
-m8byte-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 fordoubleandlong longtypes 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โ generates code suitable for big switch tables. Use this option only if the assembler/linker complain about out of range branches within a switch table. Like, only if they're literally yelling at you.-mapp-regsโ this option causesr2andr5to be used in the code generated by the compiler. This setting is the default.-mno-app-regsโ this option causesr2andr5to be treated as fixed registers.
๐ VAX Options ๐
These -m options are defined for the VAX:
-munixโ do not output certain jump instructions (aobleqand so on) that the Unix assembler for the VAX cannot handle across long ranges.-mgnuโ do output those jump instructions, on the assumption that the GNU assembler is being used.-mgโ output code for G-format floating-point numbers instead of D-format.
๐ฆ Visium Options ๐ฆ
-mdebugโ a program which performs file I/O and is destined to run on an MCM target should be linked with this option. It causes the librarieslibc.aandlibdebug.ato be linked. The program should be run on the target under the control of the GDB remote debugging stub.-msimโ a program which performs file I/O and is destined to run on the simulator should be linked with option. This causes librarieslibc.aandlibsim.ato be linked. (Yes, the original just says "with option" โ I'm as confused as you bestie, but I'm not touching it. ๐)-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.
Heads up:-msoft-floatchanges 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 compilelibgcc.a, the library that comes with GCC, with-msoft-floatin order for this to work. Compile it all or suffer, no cap.
-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. A little throwback, we love that for it.
By default (unless configured otherwise), GCC generates code for the GR5 variant of the Visium architecture.
With -mcpu=gr6, GCC generates code for the GR6 variant of the Visium architecture. The only difference from GR5 code is that the compiler will generate block move instructions.
-mtune=cpu_typeโ set the instruction scheduling parameters for machine type cpu_type, but do not set the instruction set or register set that the option-mcpu=cpu_typewould. Scheduling glow-up only, no instruction-set makeover.-msv-modeโ generate code for the supervisor mode, where there are no restrictions on the access to general registers. This is the default.-muser-modeโ generate code for the user mode, where the access to some general registers is forbidden: on the GR5, registersr24tor31cannot be accessed in this mode; on the GR6, only registersr29tor31are affected.
๐ VMS Options ๐
These -m options are defined for the VMS implementations:
-mvms-return-codesโ return VMS condition codes frommain. 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. The later option disablespragma pointer_size.
๐ธ VxWorks Options ๐ธ
The options in this section are defined for all VxWorks targets. Options specific to the target hardware are listed with the other options for that target.
-mrtpโ GCC can generate code for both VxWorks kernels and real time processes (RTPs). This option switches from the former to the latter. It also defines the preprocessor macro__RTP__.-non-staticโ link an RTP executable against shared libraries rather than static libraries. The options-staticand-sharedcan also be used for RTPs;-staticis the default.-Bstatic,-Bdynamicโ these options are passed down to the linker. They are defined for compatibility with Diab.-Xbind-lazyโ enable lazy binding of function calls. This option is equivalent to-Wl,-z,nowand is defined for compatibility with Diab.-Xbind-nowโ disable lazy binding of function calls. This option is the default and is defined for compatibility with Diab.
๐ x86 Options ๐
These -m options are defined for the x86 family of computers. Buckle up bestie, this list is long.
-march=cpu-typeโ generate instructions for the machine type cpu-type. In contrast to-mtune=cpu-type, which merely tunes the generated code for the specified cpu-type,-march=cpu-typeallows GCC to generate code that may not run at all on processors other than the one indicated. Specifying-march=cpu-typeimplies-mtune=cpu-type.
Not me warning you again: this is the "this binary only vibes with your exact CPU" option. Choose wisely. ๐
The choices for cpu-type are:
nativeโ this selects the CPU to generate code for at compilation time by determining the processor type of the compiling machine. Using-march=nativeenables all instruction subsets supported by the local machine (hence the result might not run on different machines). 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.i386โ original Intel i386 CPU.i486โ Intel i486 CPU. (No scheduling is implemented for this chip.)i586,pentiumโ Intel Pentium CPU with no MMX support.lakemontโ Intel Lakemont MCU, based on Intel Pentium CPU.pentium-mmxโ Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.pentiumproโ Intel Pentium Pro CPU.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 instruction set support.pentium3,pentium3mโ Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction set support.pentium-mโ Intel Pentium M; low-power version of Intel Pentium III CPU with MMX, SSE and SSE2 instruction set support. Used by Centrino notebooks.pentium4,pentium4mโ Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.prescottโ improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction set support.noconaโ improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE, SSE2 and SSE3 instruction set support.
core2โ Intel Core 2 CPU, 64-bit extensions, and MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support. the little engine that could ๐nehalemโ Intel Nehalem CPU, 64-bit extensions, and MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2 and POPCNT instruction set support.westmereโ Intel Westmere CPU, 64-bit extensions, and MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.sandybridgeโ Intel Sandy Bridge CPU, 64-bit extensions, and MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support. bridge era, we love her ๐ivybridgeโ Intel Ivy Bridge CPU, 64-bit extensions, and MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction set support.haswellโ Intel Haswell CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2 and F16C instruction set support. the icon the legend ๐broadwellโ Intel Broadwell CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED ADCX and PREFETCHW instruction set support.skylakeโ Intel Skylake CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and XSAVES instruction set support.bonnellโ Intel Bonnell CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support. tiny but mighty โจsilvermontโ Intel Silvermont CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PREFETCHW, PCLMUL and RDRND instruction set support.goldmontโ Intel Goldmont CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT and FSGSBASE instruction set support. gold in the name, gold in the vibe ๐goldmont-plusโ Intel Goldmont Plus CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX and UMIP instruction set support.tremontโ Intel Tremont CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, UMIP, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, CLDEMOTE and WAITPKG instruction set support. that list is LONG, she ate ๐knlโ Intel Knight's Landing CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, PREFETCHWT1, AVX512F, AVX512PF, AVX512ER and AVX512CD instruction set support.knmโ Intel Knights Mill CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, PREFETCHWT1, AVX512F, AVX512PF, AVX512ER, AVX512CD, AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.skylake-avx512โ Intel Skylake Server CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.cannonlakeโ Intel Cannonlake Server CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI, AVX512IFMA, SHA and UMIP instruction set support.icelake-clientโ Intel Icelake Client CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI, AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ, AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support. ice cold but make it warm ๐งicelake-serverโ Intel Icelake Server CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI, AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ, AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction set support.cascadelakeโ Intel Cascadelake CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, CLWB, AVX512VL, AVX512BW, AVX512DQ, AVX512CD and AVX512VNNI instruction set support.tigerlakeโ Intel Tigerlake CPU, 64-bit extensions, and MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI, AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ, AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG, WBNOINVD, MOVDIRI, MOVDIR64B and CLWB instruction set support. rawr ๐ฏk6โ AMD K6 CPU with MMX instruction set support.k6-2k6-3โ Improved versions of AMD K6 CPU with MMX and 3DNow! instruction set support. twins fr fr ๐ฏathlonathlon-tbirdโ AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow! and SSE prefetch instructions support.athlon-4athlon-xpathlon-mpโ Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow! and full SSE instruction set support.k8opteronathlon64athlon-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-sse3opteron-sse3athlon64-sse3โ Improved versions of AMD K8 cores with SSE3 instruction set support.amdfam10barcelonaโ CPUs based on AMD Family 10h cores with x86-64 instruction set support. (This supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit instruction set extensions.)bdver1โ CPUs based on AMD Family 15h cores with x86-64 instruction set support. (This supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)bdver2โ AMD Family 15h core based CPUs with x86-64 instruction set support. (This supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)bdver3โ AMD Family 15h core based CPUs with x86-64 instruction set support. (This supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.bdver4โ AMD Family 15h core based CPUs with x86-64 instruction set support. (This supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.znver1โ AMD Family 17h core based CPUs with x86-64 instruction set support. (This supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit instruction set extensions. โจznver2โ AMD Family 17h core based CPUs with x86-64 instruction set support. (This supersets BMI, BMI2, ,CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit instruction set extensions.)btver1โ CPUs based on AMD Family 14h cores with x86-64 instruction set support. (This supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit instruction set extensions.)btver2โ CPUs based on AMD Family 16h cores with x86-64 instruction set support. This includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM, SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.winchip-c6โ IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction set support. throwback era ๐ฐ๏ธwinchip2โ IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow! instruction set support.c3โ VIA C3 CPU with MMX and 3DNow! instruction set support. (No scheduling is implemented for this chip.)c3-2โ VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support. (No scheduling is implemented for this chip.)c7โ VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support. (No scheduling is implemented for this chip.)samuel-2โ VIA Eden Samuel 2 CPU, slinging MMX and 3DNow! instruction set support. (fr no scheduling is implemented for this chip, she just vibes)nehemiahโ VIA Eden Nehemiah CPU, MMX and SSE instruction set support energy. (again: no scheduling implemented for this chip, bestie)estherโ VIA Eden Esther CPU, holding MMX, SSE, SSE2 and SSE3 instruction set support. (no scheduling implemented for this chip either, we stay consistent โจ)eden-x2โ VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support. (no scheduling implemented for this chip, iykyk)eden-x4โ VIA Eden X4 CPU, serving x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and AVX2 instruction set support. (and yes โ 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 implemented for this chip, iconic of her honestly)nano-1000โ VIA Nano 1xxx CPU, x86-64, MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support. (no scheduling implemented for this chip)nano-2000โ VIA Nano 2xxx CPU, x86-64, MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support. (no scheduling implemented for this chip)nano-3000โ VIA Nano 3xxx CPU, x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 instruction set support. (no scheduling implemented for this chip)nano-x2โ VIA Nano Dual Core CPU, x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 instruction set support. (no scheduling implemented for this chip)nano-x4โ VIA Nano Quad Core CPU, x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 instruction set support. (no scheduling implemented for this chip)geodeโ AMD Geode embedded processor with MMX and 3DNow! instruction set support. (no scheduling disclaimer on this one, she's built different)
๐ -mtune=cpu-type ๐
Okay so this one tunes everything applicable about the generated code to cpu-type โ and by everything we mean everything except the ABI and the set of available instructions. Like, she's adjusting the fit, not swapping out the whole wardrobe.
Picking a specific cpu-type schedules things appropriately for that particular chip, but โ important โ the compiler does not generate any code that cannot run on the default machine type unless you go ahead and use a -march=cpu-type option. So for example, if GCC is configured for i686-pc-linux-gnu, then -mtune=pentium4 generates code that is tuned for Pentium 4 but still runs on i686 machines. bestie stays compatible ๐
The choices for cpu-type are the same as for -march. Plus, -mtune supports 2 extra choices for cpu-type:
genericโ Produce code optimized for the most common IA32/AMD64/EM64T processors. If you know the CPU on which your code will run, then you should use the corresponding-mtuneor-marchoption instead of-mtune=generic. But if you do not know exactly what CPU users of your application will have, then this is the one for you.
As new processors are deployed in the marketplace, the behavior of this option will change. So if you upgrade to a newer version of GCC, code generation controlled by this option will change to reflect the processors that are most common at the time that version of GCC is released. it's giving "always evolving" ๐ฆ
There is no -march=generic option, because -march indicates the instruction set the compiler can use, and there is no generic instruction set applicable to all processors. In contrast, -mtune indicates the processor (or, in this case, collection of processors) for which the code is optimized. periodt.
intelโ Produce code optimized for the most current Intel processors, which are Haswell and Silvermont for this version of GCC. If you know the CPU on which your code will run, then you should use the corresponding-mtuneor-marchoption instead of-mtune=intel. But if you want your application to perform better on both Haswell and Silvermont, then you should use this option. main character energy fr ๐
As new Intel processors are deployed in the marketplace, the behavior of this option will change. So if you upgrade to a newer version of GCC, code generation controlled by this option will change to reflect the most current Intel processors at the time that version of GCC is released.
There is no -march=intel option, because -march indicates the instruction set the compiler can use, and there is no common instruction set applicable to all processors. In contrast, -mtune indicates the processor (or, in this case, collection of processors) for which the code is optimized. same energy, same rule ๐ธ
๐ -mcpu=cpu-type ๐
A deprecated synonym for -mtune. that's it. that's the whole thing. she's old, she's retired, pls use -mtune ๐
โจ -mfpmath=unit โจ
Generate floating-point arithmetic for selected unit โ you literally pick which unit does your float math. The choices for unit are:
387โ Use the standard 387 floating-point coprocessor present on the majority of chips and emulated otherwise. Code compiled with this option runs almost everywhere. The temporary results are computed in 80-bit precision instead of the precision specified by the type, resulting in slightly different results compared to most of other chips. See-ffloat-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 in the AMD line by Athlon-4, Athlon XP and Athlon MP chips. The earlier version of the SSE instruction set supports only single-precision arithmetic, thus the double and extended-precision arithmetic are still done using387. A later version, present only in Pentium 4 and AMD x86-64 chips, supports double-precision arithmetic too. glow up ๐
For the x86-32 compiler, you must use -march=cpu-type, -msse or -msse2 switches to enable SSE extensions and make this option effective. For the x86-64 compiler, these extensions are enabled by default. no extra work needed, she's ready ๐
The resulting code should be considerably faster in the majority of cases and avoid the numerical instability problems of 387 code, but may break some existing code that expects temporaries to be 80 bits. โ ๏ธ
This is the default choice for the x86-64 compiler, Darwin x86-32 targets, and the default choice for x86-32 targets with the SSE2 instruction set when -ffast-math is enabled.
sse,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, as it is still experimental, because the GCC register allocator does not model separate functional units well, resulting in unstable performance. it's giving chaotic genius ๐ญ
๐ฆ -masm=dialect ๐ฆ
Output assembly instructions using the selected dialect. Also affects which dialect is used for basic "asm" and extended "asm". Supported choices (in dialect order) are att or intel. The default is att. Darwin does not support intel. noted bestie ๐ซถ
๐ -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. no chaos, just correctness โจ
๐ -m80387 / -mhard-float ๐
Generate output containing 80387 instructions for floating point. she's doing it in hardware, periodt ๐
๐ -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. bestie you are on your own for this one ๐ญ
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. sneaky but true ๐
๐ -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. cute concept ngl ๐
The option -mno-fp-ret-in-387 causes such values to be returned in ordinary CPU registers instead. plot twist.
๐ธ -mno-fancy-math-387 ๐ธ
Some 387 emulators do not support the "sin", "cos" and "sqrt" instructions for the 387. Specify this option to avoid generating those instructions. This option is overridden when -march indicates that the target CPU always has an FPU and so the instruction does not need emulation. These instructions are not generated unless you also use the -funsafe-math-optimizations switch. so like, double opt-in, very consent-forward of her ๐ซถ
โญ -malign-double / -mno-align-double โญ
Control whether GCC aligns "double", "long double", and "long long" variables on a two-word boundary or a one-word boundary. Aligning "double" variables on a two-word boundary produces code that runs somewhat faster on a Pentium at the expense of more memory. speed vs. memory, the eternal struggle ๐
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. do not do this casually bestie, she will break things ๐ญ
๐
-m96bit-long-double / -m128bit-long-double ๐
These switches control the size of the "long double" type. The x86-32 application binary interface specifies the size to be 96 bits, so -m96bit-long-double is the default in 32-bit mode.
Modern architectures (Pentium and newer) prefer "long double" to be aligned to an 8- or 16-byte boundary. 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. padding queen โจ
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". so don't get it twisted, they're alignment-only, no bonus precision ๐
โ ๏ธ 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โ bestie these three switches control the size of thelong 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. ๐ not compatible, no cap.
-malign-data=type โ controls how GCC aligns variables. Supported values for type are:compatuses increased alignment value compatible uses 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=mediumis specified, data objects larger than threshold are placed in the large data section. This value must be the same across all objects linked into the binary, and defaults to65535. ๐-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. slay, efficiency ๐
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 cannot use it if you need to call libraries compiled with the Unix compiler. literally cannot. ๐ซ
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.) ๐
-mregparm=num โ control how many registers are used to pass integer arguments. By default, no registers are used to pass arguments, and at most 3 registers can be used. You can control this behavior for a specific function by using the function 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. fr fr, ALL of them.
-msseregparmโ use SSE register passing conventions for float and double arguments and return values. You can control this behavior for a specific function by using the function 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. ๐ consistency is key bestie
-mvect8-ret-in-memโ return 8-byte vectors in memory instead of MMX registers. This is the default on Solaris 8 and 9 and VxWorks to match the ABI of the Sun Studio compilers until version 12. Later compiler versions (starting with Studio 12 Update 1) follow the ABI used by other x86 targets, which is the default on Solaris 10 and later. Only use this option if you need to remain compatible with existing code produced by those previous compiler versions or older versions of GCC. ๐ซถ legacy vibes only-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. ๐ catastrophic?? the drama is real
-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. ๐ง so versatile-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 x87 long double and __int128), leading to wrong results. You must build all modules with-mpreferred-stack-boundary=3, including any libraries. This includes the system libraries and startup modules. ๐ this one is giving danger, bestie, read it twice.
-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. ๐ trust the default
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. ๐ฆ
-mmmx-msse-msse2-msse3-mssse3-msse4-msse4a-msse4.1-msse4.2-mavx-mavx2-mavx512f-mavx512pf-mavx512er-mavx512cd-mavx512vl-mavx512bw-mavx512dq-mavx512ifma-mavx512vbmi-msha-maes-mpclmul-mclflushopt-mclwb-mfsgsbase-mptwrite-mrdrnd-mf16c-mfma-mpconfig-mwbnoinvd-mfma4-mprfchw-mrdpid-mprefetchwt1-mrdseed-msgx-mxop-mlwp-m3dnow-m3dnowa-mpopcnt-mabm-madx-mbmi-mbmi2-mlzcnt-mfxsr-mxsave-mxsaveopt-mxsavec-mxsaves-mrtm-mhle-mtbm-mmwaitx-mclzero-mpku-mavx512vbmi2-mgfni-mvaes-mwaitpkg-mvpclmulqdq-mavx512bitalg-mmovdiri-mmovdir64b-mavx512vpopcntdq-mavx5124fmaps-mavx512vnni-mavx5124vnniw-mcldemoteโ these switches enable the use of instructions in the MMX, SSE, SSE2, SSE3, SSSE3, SSE4, SSE4A, SSE4.1, SSE4.2, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD, AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, SHA, AES, PCLMUL, CLFLUSHOPT, CLWB, FSGSBASE, PTWRITE, RDRND, F16C, FMA, PCONFIG, WBNOINVD, FMA4, PREFETCHW, RDPID, PREFETCHWT1, RDSEED, SGX, XOP, LWP, 3DNow!, enhanced 3DNow!, POPCNT, ABM, ADX, BMI, BMI2, LZCNT, FXSR, XSAVE, XSAVEOPT, XSAVEC, XSAVES, RTM, HLE, TBM, MWAITX, CLZERO, PKU, AVX512VBMI2, GFNI, VAES, WAITPKG, VPCLMULQDQ, AVX512BITALG, MOVDIRI, MOVDIR64B, AVX512VPOPCNTDQ, AVX5124FMAPS, AVX512VNNI, AVX5124VNNIW, or CLDEMOTE extended instruction sets. Each has a corresponding-mno-option to disable use of these instructions. ๐ฅ ok that's a LOT of instructions, and yes bestie, you get the-mno-version of literally every single one of them.
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. โจ
To generate SSE/SSE2 instructions automatically from floating-point code (as opposed to 387 instructions), see -mfpmath=sse.
GCC depresses SSEx instructions when -mavx is used. Instead, it generates new AVX instructions or AVX equivalence for all SSEx instructions when needed. ๐ she upgrades herself, we love that for her.
These options let GCC flex those extended instructions in the code it generates, even when you haven't passed -mfpmath=sse. ๐ช But heads up bestie: apps that do run-time CPU detection have to compile separate files for each architecture they support, each one using the right flags. And like โ specifically โ the file holding the CPU detection code itself should be compiled without these options. No cap.
-mdump-tune-featuresโ tells GCC to spill the tea on the names of all the x86 performance tuning features and their default settings ๐ซ. Those names are exactly what you plug into-mtune-ctrl=feature-list.-mtune-ctrl=feature-listโ the fine-grain control knob for x86 code generation features โจ.feature-listis a comma-separated list of feature names. Peep-mdump-tune-featuresfor the names. When a feature shows up without a^in front, it gets turned on; with a^in front, it gets turned off. Real talk:-mtune-ctrl=feature-listis meant for GCC developers. Using it can send you down code paths nobody tested, and it can potentially cause compiler ICEs or runtime errors. ๐ญ๐-mno-defaultโ instructs GCC to turn all the tunable features off. See also-mtune-ctrl=feature-listand-mdump-tune-features.-mcldโ makes GCC emit a"cld"instruction in the prologue of functions that use string instructions ๐งน. Here's the lore: string instructions lean on the DF flag to pick between autoincrement and autodecrement mode. The ABI says the DF flag is supposed to be cleared on function entry, but some operating systems straight up violate that spec by not clearing DF in their exception dispatchers ๐. So the exception handler can get invoked with DF still set, and then string instructions go in the wrong direction. You can make this default on 32-bit x86 targets by configuring GCC with the--enable-cldconfigure option. And if you do that, you can suppress the"cld"generation with the-mno-cldcompiler option. ๐-mvzeroupperโ tells GCC to emit a"vzeroupper"instruction before control flow transfers out of the function, which minimizes the AVX to SSE transition penalty ๐ฎโ๐จ and also removes unnecessary"zeroupper"intrinsics. Slay.-mprefer-avx128โ tells GCC to use 128-bit AVX instructions instead of 256-bit AVX instructions in the auto-vectorizer. ๐ฆ-mprefer-vector-width=optโ tells GCC to use an opt-bit vector width in instructions instead of whatever the default is on the selected platform.noneโ no extra limitations applied to GCC beyond what the selected platform already defines.128โ prefer 128-bit vector width for instructions.256โ prefer 256-bit vector width for instructions.512โ prefer 512-bit vector width for instructions.
-mcx16โ lets GCC generate"CMPXCHG16B"instructions in 64-bit code to implement compare-and-exchange operations on 16-byte aligned 128-bit objects ๐ฅ. Super useful for atomic updates of data structures bigger than one machine word. The compiler uses this instruction to implement__syncBuiltins. But โ for__atomicBuiltins operating on 128-bit integers, a library call is always used. Periodt.-msahfโ enables generation of"SAHF"instructions in 64-bit code โจ. The lore: early Intel Pentium 4 CPUs with Intel 64 support, before the Pentium 4 G1 step dropped in December 2005, were missing the"LAHF"and"SAHF"instructions that AMD64 supports. Those are load and store instructions, respectively, for certain status flags. In 64-bit mode,"SAHF"is used to optimize the"fmod","drem", and"remainder"built-in functions; see Other Builtins for the details.-mmovbeโ enables use of the"movbe"instruction to implement__builtin_bswap32and__builtin_bswap64. ๐-mshstkโ the-mshstkoption enables shadow stack built-in functions from x86 Control-flow Enforcement Technology (CET). ๐ก๏ธ-mcrc32โ enables the built-in functions__builtin_ia32_crc32qi,__builtin_ia32_crc32hi,__builtin_ia32_crc32siand__builtin_ia32_crc32diso they generate the"crc32"machine instruction. ๐-mrecipโ enables use of"RCPSS"and"RSQRTSS"instructions (and their vectorized variants"RCPPS"and"RSQRTPS") with an extra Newton-Raphson step to boost precision, instead of"DIVSS"and"SQRTSS"(and their vectorized variants) for single-precision floating-point arguments. ๐งฎ These instructions only get generated when-funsafe-math-optimizationsis enabled together with-ffinite-math-onlyand-fno-trapping-math. Now โ while the throughput of the sequence beats the throughput of the non-reciprocal instruction, the precision can drop by up to 2 ulp (i.e. the inverse of1.0equals0.99999994). ๐ฌ
Also note: GCC already implements 1.0f/sqrtf(x) in terms of "RSQRTSS" (or "RSQRTPS") with -ffast-math (or the option combo above), and doesn't need -mrecip.
And also also: GCC emits that sequence with the additional Newton-Raphson step for vectorized single-float division and vectorized sqrtf(x) already with -ffast-math (or the option combo above), and doesn't need -mrecip. ๐
-mrecip=optโ controls which reciprocal estimate instructions are allowed to show up.optis a comma-separated list of options, and any of them may be preceded by a!to invert it:allโ enable all estimate instructions.defaultโ enable the default instructions, equivalent to-mrecip.noneโ disable all estimate instructions, equivalent to-mno-recip.divโ enable the approximation for scalar division.vec-divโ enable the approximation for vectorized division.sqrtโ enable the approximation for scalar square root.vec-sqrtโ enable the approximation for vectorized square root.
So for example, -mrecip=all,!sqrt enables all of the reciprocal approximations except for square root. ๐ธ
-mveclibabi=typeโ specifies the ABI type to use for vectorizing intrinsics using an external library. Supported values for type aresvmlfor the Intel short vector math library andacmlfor the AMD math core library. 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. ๐
Right now GCC emits calls to "vmldExp2", "vmldLn2", "vmldLog102", "vmldPow2", "vmldTanh2", "vmldTan2", "vmldAtan2", "vmldAtanh2", "vmldCbrt2", "vmldSinh2", "vmldSin2", "vmldAsinh2", "vmldAsin2", "vmldCosh2", "vmldCos2", "vmldAcosh2", "vmldAcos2", "vmlsExp4", "vmlsLn4", "vmlsLog104", "vmlsPow4", "vmlsTanh4", "vmlsTan4", "vmlsAtan4", "vmlsAtanh4", "vmlsCbrt4", "vmlsSinh4", "vmlsSin4", "vmlsAsinh4", "vmlsAsin4", "vmlsCosh4", "vmlsCos4", "vmlsAcosh4" and "vmlsAcos4" for the corresponding function type when -mveclibabi=svml is used, and "__vrd2_sin", "__vrd2_cos", "__vrd2_exp", "__vrd2_log", "__vrd2_log2", "__vrd2_log10", "__vrs4_sinf", "__vrs4_cosf", "__vrs4_expf", "__vrs4_logf", "__vrs4_log2f", "__vrs4_log10f" and "__vrs4_powf" for the corresponding function type when -mveclibabi=acml is used. ๐
-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 attributes"ms_abi"and"sysv_abi". ๐-mforce-indirect-callโ forces 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โ inserts an ENDBR instruction at function entry only via the"cf_check"function attribute. This is useful when used with the option-fcf-protection=branchto control ENDBR insertion at the function entry. ๐-mcall-ms2sysv-xloguesโ okay so because of differences in 64-bit ABIs, any Microsoft ABI function that calls a System V ABI function has to consider RSI, RDI and XMM6-15 as clobbered ๐ญ. By default, the code for saving and restoring those registers is emitted inline, which gives you fairly lengthy prologues and epilogues. Using-mcall-ms2sysv-xloguesemits prologues and epilogues that use stubs in the static portion oflibgccto do those saves and restores, cutting down function size at the cost of a few extra instructions. Trade-offs, bestie. ๐-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 can't 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 the method using SUB/MOV operations, and it's 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, thanks to reduced dependencies, improved scheduling and reduced stack usage when the preferred stack boundary isn't equal to2. The drawback? A notable increase in code size. ๐ญ This switch implies-mno-push-args.-mthreadsโ support thread-safe exception handling on MinGW. ๐งต Programs that rely on thread-safe exception handling must compile and link all their 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. โจ-mms-bitfields-mno-ms-bitfieldsโ enable/disable bit-field layout compatible with the native Microsoft Windows compiler. ๐ช
Heads up bestie: this chunk is a direct continuation of the Microsoft structure layout rules, so no new heading here โ we're picking up mid-thought like a group chat at 2am. ๐
If packed gets used on a structure, or if bit-fields are in play, the Microsoft ABI might lay that structure out differently than GCC normally does. Especially when you're moving packed data between functions compiled with GCC and the native Microsoft compiler โ whether that's via a function call or as data sitting in a file โ you might genuinely need to access either format. ๐
This option is enabled by default for Microsoft Windows targets. You can also control this behavior locally using variable or type attributes. Want the details? Go see x86 Variable Attributes and x86 Type Attributes. โจ
The Microsoft structure layout algorithm is pretty simple, except for the bit-field packing part. The padding and alignment of structure members, plus 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 gets the lowest memory address and the last member gets 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
alignedattribute or thepackpragma), 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, bestie, listen up:
- 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. The way that one little : 0 doubles your struct... not me being shook. ๐ญ
- 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, thenbaris 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.
โจ OPTIONS โจ (still going, we're so back) ๐ซถ
-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. Classic GCC not knowing. ๐-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 it may improve performance of code that depends on fastmemcpy,strlen, andmemsetfor short lengths. ๐-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. Small = inline, big = libcall, we love a dynamic queen. ๐-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_byterep_4byterep_8byte- Expand using i386
repprefix of the specified size.
- Expand using i386
byte_looploopunrolled_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__builtin_memsetexpansion instead. ๐ธ-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-fomit-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 attributems_hook_prologueisn't possible at the moment for-mfentryand-pg. ๐ญ-mrecord-mcount-mno-record-mcountโ If profiling is active (-pg), generate a__mcount_locsection that contains pointers to each profiling call. This is useful for automatically patching and out calls. ๐-mnop-mcount-mno-nop-mcountโ If profiling is active (-pg), generate the calls to the profiling functions as NOPs. This is useful when they should be patched in later dynamically. This is likely only useful together with-mrecord-mcount. ๐ง-minstrument-return=typeโ Instrument function exit in-pg-mfentryinstrumented functions with a call to the specified function. This only instruments true returns ending withret, but not sibling calls ending withjump. Valid types arenoneto not instrument,callto generate a call to__return__, ornop5to generate a 5 byte nop. ๐ซ-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 (default__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 the RAX register when there are no variable arguments passed in vector registers.
Warning: Since the RAX register is used to avoid unnecessarily saving vector registers on stack when passing variable arguments, the impacts of this option are that callees may waste some stack space, misbehave, or jump to a random location. GCC 4.4 or newer don't have those issues, regardless of the RAX register value. ๐
-m8bit-idiv-mno-8bit-idivโ On some processors, like Intel Atom, 8-bit unsigned integer divide is much faster than 32-bit/64-bit integer divide. This option generates a run-time check. If both dividend and divisor are within range of 0 to 255, 8-bit unsigned integer divide is used instead of 32-bit/64-bit integer divide. ๐-mavx256-split-unaligned-load-mavx256-split-unaligned-storeโ Split 32-byte AVX unaligned load and store. ๐ฆ-mstack-protector-guard=guard-mstack-protector-guard-reg=reg-mstack-protector-guard-offset=offsetโ Generate stack protection code using a 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. ๐
-mgeneral-regs-onlyโ okay so this one makes GCC generate code that uses only the general-purpose registers. It literally prevents the compiler from using floating-point, vector, mask and bound registers. ๐-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=largeis incompatible with-mindirect-branch=thunkand-mindirect-branch=thunk-externsince the thunk function may not be reachable in the large code model. ๐ญ
๐ Note that-mindirect-branch=thunk-externis compatible with-fcf-protection=branchsince 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-externis compatible with-fcf-protection=branchsince the external thunk can be made to enable control-flow check. ๐
๐ญ Note that-mcmodel=largeis incompatible with-mfunction-return=thunkand-mfunction-return=thunk-externsince the thunk function may not be reachable in the large code model. ๐ธ
-mindirect-branch-registerโ Force indirect call and jump via register. ๐
These -m switches are supported in addition to the above on x86-64 processors in 64-bit environments. ๐
Generate code for a 16-bit, 32-bit or 64-bit environment. ๐งฌ
-m32โ setsint,long, and pointer types to 32 bits, and generates code that runs on any i386 system. ๐งธ-m64โ 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โ setsint,long, and pointer types to 32 bits, and generates code for the x86-64 architecture. ๐-m16โ 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โ generates code which 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 into large data or BSS sections and can be located above 2GB. Programs can be statically or dynamically linked. ๐งฑ-mcmodel=largeโ Generate code for the large model. This model makes no assumptions about addresses and sizes of sections. ๐-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. ๐
๐ช x86 Windows 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. ๐ฅ๏ธ-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. ๐-mthreadโ This option is available for MinGW targets. It specifies that MinGW-specific thread support is to be used. ๐งต-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 a 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. ๐งฉ
See also under x86 Options for standard options. ๐
๐ช๏ธ Xstormy16 Options ๐ช๏ธ
These options are defined for Xstormy16: ๐ฌ๏ธ
-msimโ Choose startup files and linker script suitable for the simulator. ๐น๏ธ
๐ Xtensa Options ๐
These options are supported for Xtensa targets: โจ
-mconst16,-mno-const16โ Enable or disable use ofCONST16instructions for loading constant values. TheCONST16instruction is currently not a standard option from Tensilica. When enabled,CONST16instructions are always used in place of the standardL32Rinstructions. The use ofCONST16is enabled by default only if theL32Rinstruction is not available. ๐ข-mfused-madd,-mno-fused-maddโ Enable or disable use of fused multiply/add and multiply/subtract instructions in the floating-point option. This has no effect if the floating-point option is not also enabled. Disabling fused multiply/add and multiply/subtract instructions forces the compiler to use separate instructions for the multiply and add/subtract operations. This may be desirable in some cases where strict IEEE 754-compliant results are required: the fused multiply add/subtract instructions do not round the intermediate result, thereby producing results with more bits of precision than specified by the IEEE standard. Disabling fused multiply add/subtract instructions also ensures that the program output is not sensitive to the compiler's ability to combine multiply and add/subtract operations. โ-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โ 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โ okay so these two are the literal-pool babysitters ๐ The default is-mno-auto-litpools, which drops literals in their own separate section in the output file unless you also pass-mtext-section-literals. But with-mauto-litpools, the assembler just sprinkles those literals right into the text section ๐ฆ The compiler stops emitting explicit.literaldirectives and loads literals into registers withMOVIinstead ofL32R, so the assembler can do its relaxation thing and place literals wherever it needs. Why do you care? Because this option lets the assembler create several literal pools per function and assemble absolutely massive functions, which lowkey just isn't possible with-mtext-section-literals. slay for big functions ๐-mtarget-align-mno-target-alignโ turn this on and GCC tells the assembler to auto-align instructions, trading a lil bit of code density to cut down branch penalties. The assembler tries to widen density instructions to line up branch targets and whatever comes right after call instructions. If there aren't enough safe density instructions before a target to align it? No widening, we're not forcing it bestie. The default is-mtarget-align. Heads up tho: these options don't touch auto-aligned instructions likeLOOPโ the assembler always aligns those, either by widening density instructions or by inserting NOP instructions. no cap โจ-mlongcalls-mno-longcallsโ enable this and GCC tells the assembler to flip direct calls into indirect calls, unless it can prove the call target is inside the range the call instruction allows. This usually kicks in for calls to functions in other source files. Specifically, the assembler rewrites a directCALLinstruction into anL32Rfollowed by aCALLXinstruction. Default is-mno-longcalls. Use this when your call target could possibly be out of range ๐ฅ Big important thing: this is implemented in the assembler, not the compiler, so the assembly GCC spits out still shows direct call instructions โ go peek at the disassembled object code to see what's actually happening ๐ Also note the assembler uses an indirect call for every cross-file call, not just the ones that are actually out of range. periodt.
zSeries Options
These are listed under
๐ ENVIRONMENT ๐
Okay bestie, this section is all about the environment variables that mess with how GCC does its thing ๐ Some of them work by giving directories or prefixes to search for different kinds of files, and some just specify other aspects of the compilation environment.
Not me reminding you that you can also specify search places with options like -B, -I and -L โ and those take precedence over places set by environment variables, which in turn take precedence over whatever GCC's configuration specifies. hierarchy is real ๐
LANG
LC_CTYPE
LC_MESSAGES
LC_ALL
These four control how GCC uses localization info, so it can vibe with different national conventions ๐ GCC checks the locale categories LC_CTYPE and LC_MESSAGES if it was configured to do so. Those categories can be set to anything your installation supports โ a typical value is en_GB.UTF-8 for English in the United Kingdom encoded in UTF-8.
LC_CTYPE specifies character classification. GCC uses it to figure out character boundaries in a string โ needed for some multibyte encodings that contain quote and escape characters which would otherwise get read as a string end or an escape ๐ญ
LC_MESSAGES specifies the language to use in diagnostic messages.
If LC_ALL is set, it overrides the values of LC_CTYPE and LC_MESSAGES. Otherwise, LC_CTYPE and LC_MESSAGES default to the value of the LANG environment variable. And if none of these are set? GCC just defaults to traditional C English behavior. classic ๐
TMPDIR
If TMPDIR is set, it tells GCC which directory to use for temporary files. GCC uses temp files to hold the output of one stage of compilation that's about to become the input of the next stage โ for example, the output of the preprocessor, which is the input to the compiler proper. the pipeline is giving teamwork fr fr ๐
GCC_COMPARE_DEBUG
Setting GCC_COMPARE_DEBUG is nearly equivalent to passing -fcompare-debug to the compiler driver. See the documentation of that option for the deets โจ
GCC_EXEC_PREFIX
If GCC_EXEC_PREFIX is set, it specifies a prefix to use in the names of the subprograms the compiler executes. No slash gets added when this prefix is combined with a subprogram name โ but you can specify a prefix that ends with a slash if you want to, you do you ๐ซถ
If GCC_EXEC_PREFIX is not set, GCC tries to figure out an appropriate prefix from the pathname it was invoked with.
If GCC can't find the subprogram using the specified prefix, it goes looking in the usual places instead.
The default value of GCC_EXEC_PREFIX is prefix/lib/gcc/ where prefix is the prefix to the installed compiler. In many cases prefix is the value of prefix when you ran the configure script. Other prefixes specified with -B take precedence over this one.
This prefix is also used for finding files such as crt0.o that are used for linking.
And it gets used in a kinda unusual way for finding directories to search for header files too ๐ 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 make 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. iykyk ๐ธ
COMPILER_PATH
The value of COMPILER_PATH is a colon-separated list of directories, much like PATH. GCC tries the directories you list here when searching for subprograms, if it can't find them 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 you list here when searching for special linker files, if it can't find them using GCC_EXEC_PREFIX. Linking with GCC also uses these directories when searching for ordinary libraries for the -l option (but directories specified with -L come first ๐).
LANG
This variable passes locale info to the compiler. One way it's used is to determine the character set for parsing character literals, string literals and comments in C and C++. When the compiler is configured to allow multibyte characters, these values for LANG are recognized:
C-JISโ Recognize JIS characters. ๐ฆC-SJISโ Recognize SJIS characters. ๐ฆC-EUCJPโ Recognize EUCJP characters. ๐ฆ
If LANG isn't defined, or it has some other value, then the compiler uses mblen and mbtowc as defined by the default locale to recognize and translate multibyte characters.
Some additional environment variables affect the behavior of the preprocessor. ok here we go ๐
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 decided 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 they were specified with -I, but after any paths given with -I options on the command line. This environment variable is used no matter which language is being preprocessed.
The remaining environment variables only apply when preprocessing the particular language indicated. Each one 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 of 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. sneaky but iconic ๐
DEPENDENCIES_OUTPUT
If this variable is set, its value specifies how to output dependencies for Make based on the non-system header files the compiler processed. System header files get ignored in the dependency output ๐ซ
The value of DEPENDENCIES_OUTPUT can be just a file name, in which case the Make rules get written to that file and the target name is guessed from the source file name. Or the value can have the form file target, in which case the rules get 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 meal energy โจ
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 place of the current date and time in the __DATE__ and __TIME__ macros, so that the embedded timestamps become reproducible. reproducible builds bestie, we love to see it ๐
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 @command{date +%s} on GNU/Linux and other systems that support the %s extension in the date command.
The value should be a known timestamp such as the last modification time of the source or package, and it should be set by the build process.
๐ BUGS ๐
For instructions on reporting bugs, see <https://gcc.gnu.org/bugs/>.
๐ฆ FOOTNOTES ๐ฆ
- So like, on some systems
gcc -sharedhas to build supplementary stub code so constructors actually work, okay? ๐ And on multi-libbed systems,gcc -sharedhas to pick the correct support libraries to link against. Not supplying the correct flags can lead to subtle defects, which is giving chaos honestly ๐ญ. But supplying them when they're not necessary? Totally innocuous. No harm, no foul. ๐ซถ
๐ธ SEE ALSO ๐ธ
Go read these besties too, they're all in the friend group:
...and the Info entries for gcc, cpp, as, ld, binutils and gdb. ๐
๐ AUTHOR ๐
Wanna know who actually made this? Check the Info entry for gcc, or hit up <http://gcc.gnu.org/onlinedocs/gcc/Contributors.html> โ that's where the contributors to GCC live. Iconic behavior from every single one of them, fr fr. ๐
๐ COPYRIGHT ๐
Copyright (c) 1988-2019 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 bestie that's literally the whole entire manpage. You read all 102 parts. Main character energy, no cap. ๐๐
And that's a wrap on gcc-9, dated 2022-05-27, from the GCC(1) page. Thanks for reading the whole thing, you absolute legend โ go compile something beautiful. ๐
๐ฆ๐ธโจ
๐ฆ where this page comes from
- ubuntu noble: gcc-9-offload-nvptx 9.5.0-6ubuntu2
- ubuntu noble: gcc-9-offload-nvptx 9.5.0-6ubuntu2.1
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms