GCC(1)
๐ NAME ๐
okay so like, gcc is the GNU project's C and C++ compiler, bestie. periodt. ๐
โจ SYNOPSIS โจ
gcc [-c|-S|-E] [-std=standard]
[-g] [-pg] [-Olevel]
[-Wwarn...] [-Wpedantic]
[-Idir...] [-Ldir...]
[-Dmacro[=defn]...] [-Umacro]
[-foption...] [-mmachine-option...]
[-o outfile] [@file] infile...
only the most useful options are listed here, bestie โ see below for the remainder, no cap. g++ accepts mostly the same options as gcc too. ๐
๐ธ DESCRIPTION ๐ธ
so when you invoke GCC, it normally does the whole glow-up: preprocessing, compilation, assembly, and linking. but the "overall options" let you stop this process at an intermediate stage, like hitting pause. for example, the -c option says not to run the linker, so then the output is just object files output by the assembler. it's giving intermediate stage realness. ๐
other options get passed on to one or more stages of processing. some options control the preprocessor, others the compiler itself. and yet other options control the assembler and linker โ but most of those are not documented here because you rarely need to use any of them, lowkey. ๐
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 will say so explicitly, bestie. and if the description for a particular option does not mention a source language, you can use that option with all supported languages. periodt.
the usual way to run GCC is to run the executable called gcc, or machine-gcc when cross-compiling, or machine-gcc-version to run a specific version of GCC. when you compile C++ programs, you should invoke GCC as g++ instead. it's giving C++ main character energy. ๐
the gcc program accepts options and file names as operands. many options have multi-letter names, so multiple single-letter options may not be grouped: -dv is very different from -d -v. no cap, do not group them. ๐
you can mix options and other arguments, bestie. for the most part, the order you use doesn't matter. but order does matter when you use several options of the same kind. for example, if you specify -L more than once, the directories are searched in the order specified. also, the placement of the -l option is significant. so like, pay attention. ๐
many options have long names starting with -f or with -W---for example, -fmove-loop-invariants, -Wformat and so on. most of these have both positive and negative forms; the negative form of -ffoo is -fno-foo. this manual documents only one of these two forms, whichever one is not the default. iykyk. โจ
some options take one or more arguments, typically separated either by a space or by the equals sign (=) from the option name. unless documented otherwise, an argument can be either numeric or a string. numeric arguments must typically be small unsigned decimal or hexadecimal integers. hexadecimal arguments must begin with the 0x prefix. arguments to options that specify a size threshold of some sort may be arbitrarily large decimal or hexadecimal integers followed by a byte size suffix designating a multiple of bytes, such as "kB" and "KiB" for kilobyte and kibibyte, respectively, "MB" and "MiB" for megabyte and mebibyte, "GB" and "GiB" for gigabyte and gigibyte, and so on. such arguments are designated by byte-size in the following text. refer to the NIST, IEC, and other relevant national and international standards for the full listing and explanation of the binary and decimal byte size prefixes. that's the tea. ๐
๐ OPTIONS ๐
๐ Option Summary ๐
here's a summary of all the options, grouped by type, bestie. explanations are in the following sections. get ready. ๐
Overall Options
-c-S-E-o file-dumpbase dumpbase-dumpbase-ext auxdropsuf-dumpdir dumppfx-x language-v-###--help[=class[,...]]--target-help--version-pass-exit-codes-pipe-wrapper @file-ffile-prefix-map=old=new-fcanon-prefix-map-fplugin=file-fplugin-arg-name=arg-fdump-ada-spec[-slim]-fada-spec-parent=unit-fdump-go-spec=file--assemble--compile--dumpbase dumpbase--dumpbase-ext auxdropsuf--dumpdir dumppfx--language=language--output=file--pass-exit-codes--pipe--preprocess--verbose
C Language Options
-ansi-std=standard-aux-info filename-fno-asm-fno-builtin-fno-builtin-function-fcond-mismatch-ffreestanding-fgimple-fgnu-tm-fgnu89-inline-fhosted-flax-vector-conversions-fms-extensions-fpermitted-flt-eval-methods=standard-fplan9-extensions-fsigned-bitfields-funsigned-bitfields-fsigned-char-funsigned-char-fstrict-flex-arrays[=n]-fsso-struct=endianness--ansi
C++ Language Options
--compile-std-module-fabi-compat-version=n-fabi-version=n-fno-access-control-faligned-new=[n]-fno-assume-sane-operators-new-delete-fchar8_t-fcheck-new-fconcepts-fconcepts-diagnostics-depth=n-fconstexpr-depth=n-fconstexpr-cache-depth=n-fconstexpr-loop-limit=n-fconstexpr-ops-limit=n-fcontracts-fcontract-evaluation-semantic=[ignore|observe|enforce|quick_enforce]-fcontracts-conservative-ipa-fcontract-checks-outlined-fcontract-disable-optimized-checks-fcontracts-client-check=[none|pre|all]-fcontracts-definition-check=[on|off]-fcoroutines-fdiagnostics-all-candidates-fno-elide-constructors-fno-enforce-eh-specs-fext-numeric-literals-fno-gnu-keywords-fno-immediate-escalation-fno-implement-inlines-fimplicit-constexpr-fno-implicit-inline-templates-fno-implicit-templates-fmodule-header[=kind]-fmodule-implicit-inline-fno-module-lazy-fmodule-mapper=specification-fmodule-only-fmodules-fms-extensions-fnew-inheriting-ctors-fnew-ttp-matching-fno-nonansi-builtins-fnothrow-opt-fno-operator-names-fno-optional-diags-fno-pretty-templates-frange-for-ext-temps-freflection-fno-rtti-fsized-deallocation-fstrict-enums-fstrong-eval-order[=kind]-ftemplate-backtrace-limit=n-ftemplate-depth=n-fno-threadsafe-statics-fuse-cxa-atexit-fno-use-cxa-get-exception-ptr-fno-weak-nostdinc++-fvisibility-inlines-hidden-fvisibility-ms-compat-flang-info-include-translate[=header]-flang-info-include-translate-not-flang-info-module-cmi[=module]-stdlib=libstdc++,libc++-Wabbreviated-auto-in-template-arg-Wabi-tag-Waligned-new[=kind]-Wcatch-value-Wcatch-value=n-Wno-class-conversion-Wclass-memaccess-Wcomma-subscript-Wconditionally-supported-Wno-conversion-null-Wctad-maybe-unsupported-Wctor-dtor-privacy-Wdangling-reference-Wno-defaulted-function-deleted-Wno-delete-incomplete-Wdelete-non-virtual-dtor-Wno-deprecated-array-compare-Wdeprecated-copy-Wdeprecated-copy-dtor-Wno-deprecated-enum-enum-conversion-Wno-deprecated-enum-float-conversion-Wno-deprecated-literal-operator-Wdeprecated-variadic-comma-omission-Weffc++-Wno-elaborated-enum-base-Wno-exceptions-Wno-expose-global-module-tu-local-Wno-external-tu-local-Wextra-semi-Wno-global-module-Wno-inaccessible-base-Wno-inherited-variadic-ctor-Wno-init-list-lifetime-Winvalid-constexpr-Winvalid-imported-macros-Wno-invalid-offsetof-Wno-literal-suffix-Wmismatched-new-delete-Wmismatched-tags-Wmultiple-inheritance-Wnamespaces-Wnarrowing-Wnoexcept-Wnoexcept-type-Wnon-virtual-dtor-Wpessimizing-move-Wno-placement-new-Wplacement-new=n-Wrange-loop-construct-Wredundant-move-Wredundant-tags-Wreorder-Wregister-Wno-sfinae-incomplete-Wstrict-null-sentinel-Wno-subobject-linkage-Wtemplates-Wno-non-c-typedef-for-linkage-Wno-non-template-friend-Wold-style-cast-Woverloaded-virtual-Wno-pmf-conversions-Wself-move-Wsign-promo-Wsized-deallocation-Wsuggest-final-methods-Wsuggest-final-types-Wsuggest-override-Wno-template-body-Wno-template-id-cdtor-Wtemplate-names-tu-local-Wno-terminate-Wno-vexing-parse-Wvirtual-inheritance-Wno-virtual-move-assign-Wvolatile
Objective-C and Objective-C++ Language Options
-fconstant-string-class=class-name-fgnu-runtime-fnext-runtime-fno-nil-receivers-fobjc-abi-version=n-fobjc-call-cxx-cdtors-fobjc-direct-dispatch-fobjc-exceptions-fobjc-gc-fobjc-nilcheck-fobjc-std=objc1-fno-local-ivars-fivar-visibility=[public|protected|private|package]-freplace-objc-classes-fzero-link-gen-decls-Wassign-intercept-Wno-property-assign-default-Wno-protocol-Wobjc-root-class-Wselector-Wstrict-selector-match-Wundeclared-selector
OpenMP and OpenACC Options
-foffload=arg-foffload-options=arg-fopenacc-fopenacc-dim=geom-fopenmp-fopenmp-simd-fopenmp-target-simd-clone[=device-type]
Diagnostic Message Formatting Options
-fmessage-length=n-fdiagnostics-plain-output-fdiagnostics-show-location=[once|every-line]-fdiagnostics-color=[auto|never|always]-fdiagnostics-urls=[auto|never|always]-fdiagnostics-format=[text|sarif-stderr|sarif-file]-fdiagnostics-add-output=DIAGNOSTICS-OUTPUT-SPEC-fdiagnostics-set-output=DIAGNOSTICS-OUTPUT-SPEC-fno-diagnostics-json-formatting-fno-diagnostics-show-option-fno-diagnostics-show-caret-fno-diagnostics-show-event-links-fno-diagnostics-show-labels-fno-diagnostics-show-line-numbers-fno-diagnostics-show-cwe-fno-diagnostics-show-rules-fno-diagnostics-show-highlight-colors-fno-diagnostics-show-nesting-fno-diagnostics-show-nesting-locations-fdiagnostics-show-nesting-levels-fdiagnostics-minimum-margin-width=width-fdiagnostics-parseable-fixits-fdiagnostics-generate-patch-fdiagnostics-show-template-tree-fno-elide-type-fdiagnostics-path-format=[none|separate-events|inline-events]-fdiagnostics-show-path-depths-fno-show-column-fdiagnostics-column-unit=[display|byte]-fdiagnostics-column-origin=origin-fdiagnostics-escape-format=[unicode|bytes]-fdiagnostics-text-art-charset=[none|ascii|unicode|emoji]-fdiagnostics-show-context[=depth]
๐จ Warning Options ๐จ
okay bestie, pull up a chair, hydrate, and put your phone on Do Not Disturb, because this is the list. This is where GCC keeps every single thing it might yell at you about. Some of these are your best friend, some of these will humble you at 3am, and some of them are the reason your teammate keeps pushing "fix warning" commits. It's giving โจ accountability โจ. Every single one is right here, exactly as written, no cap.
-fsyntax-onlyโ bestie just wants the vibes checked, no output file, no drama ๐-fmax-errors=nโ "n mistakes and then we're DONE" energy-Wpedanticโ pedantic, as advertised, on purpose, iconic-pedantic-errorsโ pedantic but make it fatal ๐ค-fpermissiveโ permission granted... allegedly ๐-wโ the lowercase one. silent. mysterious. ๐-Wextraโ extra. we love extra. extra is the moment.-Wallโ mother. the blueprint. the blueprint mother. ๐-Wabi=nโ abi drama, but numbered-Waddressโ address tea, freshly brewed โ-Wno-address-of-packed-memberโ no. address of packed member. that's the whole note ๐ซถ-Waggregate-returnโ aggregate? returning? the way that sounds so serious-Walloc-sizeโ alloc size, she's got opinions-Walloc-size-larger-than=byte-sizeโ alloc size but make it bigger than byte-size ๐-Walloc-zeroโ zero allocation, zero chill-Wallocaโ alloca!!! say her name!!! ๐ฃ-Walloca-larger-than=byte-sizeโ alloca, but with a byte-size limit attached-Wauto-profileโ auto profile, she's automated, she's profiling, she's booked โจ-Wno-aggressive-loop-optimizationsโ no aggressive loop optimizations. the loop wants peace ๐ธ-Warith-conversionโ arith conversion nation rise up ๐งฎ-Warray-boundsโ array bounds, stay in your lane challenge-Warray-bounds=nโ same but with an n, because numbers make it real-Warray-compareโ comparing arrays, oh she's comparing ๐-Warray-parameterโ array parameter, parameter array, we contain multitudes-Warray-parameter=nโ array parameter but specified-Wno-attributesโ no attributes, no notes-Wattribute-alias=nโ attribute alias, numbered, iconic-Wno-attribute-aliasโ the alias says no thanks ๐-Wno-attribute-warningโ no attribute warning, we're not warning about attributes today bestie-Wbidi-chars=[none|unpaired|any|ucn]โ bidi chars, and you get to pick:none,unpaired,any, orucn. pick your fighter ๐ฅ-Wbool-compareโ bool compare, so true/true of her-Wbool-operationโ bool operation, she's operating ๐ฆ-Wno-builtin-declaration-mismatchโ no builtin declaration mismatch, the builtin is fine, leave her alone-Wno-builtin-macro-redefinedโ no builtin macro redefined, the macro is redefining herself and that's her journey-Wc90-c99-compatโ c90 meeting c99, a crossover event ๐-Wc99-c11-compatโ c99 meeting c11, the sequel-Wc11-c23-compatโ c11 meeting c23, they're chatting-Wc23-c2y-compatโ c23 meeting c2y, the future is now-Wc++-compatโ c++ compat, the whole vibe-Wc++11-compatโ c++11 compat, throwback era-Wc++14-compatโ c++14 compat, mid-decade moment-Wc++17-compatโ c++17 compat, she's back-Wc++20-compatโ c++20 compat, recent queen-Wc++26-compatโ c++26 compat, from the future, lowkey terrifying ๐-Wno-c++11-extensionsโ no c++11 extensions, sorry to that era-Wno-c++14-extensionsโ no c++14 extensions, respectfully-Wno-c++17-extensionsโ no c++17 extensions, we're moving on-Wno-c++20-extensionsโ no c++20 extensions, closing that chapter-Wno-c++23-extensionsโ no c++23 extensions, the chapter is closed fr fr-Wcalloc-transposed-argsโ calloc transposed args, she flipped them and we all saw ๐-Wcannot-profileโ cannot profile. devastating. rip to the profiling ๐ฅ-Wcast-alignโ cast align, she's aligned and she knows it โจ-Wcast-align=strictโ cast align but strict, no negotiation-Wcast-function-typeโ cast function type, typing as a function, slay-Wcast-qualโ cast qual, qualifier tea-Wchar-subscriptsโ char subscripts, tiny but mighty-Wclobberedโ clobbered ๐ญ the name alone-Wcommentโ comment. that's it. that's the note. ๐-Wcompare-distinct-pointer-typesโ comparing distinct pointer types, messy but valid gossip-Wno-complain-wrong-langโ no complaining about the wrong lang, we're being polite ๐-Wconversionโ conversion. the big one. the one that humbles everybody-Wno-coverage-mismatchโ no coverage mismatch, coverage is covered-Wno-cppโ no cpp, we're not doing cpp today-Wdangling-elseโ dangling else, dangling like her earrings ๐ธ-Wdangling-pointerโ dangling pointer, dangling again, she's consistent-Wdangling-pointer=nโ dangling pointer but with a level, because why not-Wdate-timeโ date time, she knows what time it is โฐ-Wno-deprecatedโ no deprecated, we're not doing deprecation discourse-Wno-deprecated-declarationsโ no deprecated declarations, the declarations are deprecated but we're not discussing it-Wno-designated-initโ no designated init, the init remains undesignated ๐-Wno-deprecated-openmpโ no deprecated openmp, openmp is thriving actually-Wdisabled-optimizationโ disabled optimization, the optimization is on a break-Wno-discarded-array-qualifiersโ no discarded array qualifiers, the qualifiers were not discarded and we will not be discussing it-Wno-discarded-qualifiersโ no discarded qualifiers, periodt-Wno-div-by-zeroโ no div by zero, we're being responsible today ๐ซถ-Wdouble-promotionโ double promotion, she got promoted twice, good for her-Wduplicated-branchesโ duplicated branches, the branches are twinning ๐ง-Wduplicated-condโ duplicated cond, cond twinning-Wempty-bodyโ empty body, nothing in there, echoing ๐ณ๏ธ-Wno-endif-labelsโ no endif labels, the endif is unlabeled and free-Wenum-compareโ enum compare, enum on enum action-Wenum-conversionโ enum conversion, converting, evolving-Wenum-int-mismatchโ enum int mismatch, they don't match, it's giving tension-Werrorโ-Werror!!! the final boss. warnings become errors. no mercy. ๐-Werror=*โ-Werror=*, the wildcard version, she does ALL of them-Wexpansion-to-definedโ expansion to defined, she expanded-Wfatal-errorsโ fatal errors, dramatic and correct ๐-Wflex-array-member-not-at-endโ flex array member not at end, she's flexing but in the wrong spot-Wfloat-conversionโ float conversion, floating, converting, ethereal ๐-Wfloat-equalโ float equal, comparing floats for equality, living dangerously fr-Wformatโ format, the original format girlie-Wformat=2โ format but level 2, format with a sequel-Wno-format-contains-nulโ no format contains nul, the format is nul-free and thriving-Wno-format-diagโ no format diag, no diagnostics about formats today-Wno-format-extra-argsโ no format extra args, the extra args are staying, they're guests ๐-Wformat-nonliteralโ format nonliteral, not literal, mysterious-Wformat-overflow=nโ format overflow, level n, overflowing with style-Wformat-securityโ format security, she's the bouncer of formats ๐ก๏ธ-Wformat-signednessโ format signedness, signed or not, she'll know-Wformat-truncation=nโ format truncation, level n, cut off but make it numbered-Wformat-y2kโ format y2k, the y2k of formats, nostalgic ๐ฆ-Wframe-addressโ frame address, address of the frame-Wframe-larger-than=byte-sizeโ frame larger than byte-size, set your limit bestie-Wno-free-nonheap-objectโ no free nonheap object, the object isn't on the heap and we're not freeing it, respectfully-Wheader-guardโ header guard, protecting the header like a bodyguard ๐-Wno-if-not-alignedโ no if not aligned, alignment discourse is cancelled-Wno-ignored-attributesโ no ignored attributes, the attributes are not being ignored and we will not elaborate-Wignored-qualifiersโ ignored qualifiers, the qualifiers got ignored ๐-Wno-incompatible-pointer-typesโ no incompatible pointer types, the pointers are compatible enough-Whardenedโ hardened, she's been through things and came out stronger ๐ฅ-Wimplicitโ implicit, unspoken, implied, iconic-Wimplicit-fallthroughโ implicit fallthrough, she fell through, no comment-Wimplicit-fallthrough=nโ same fall, but leveled-Wno-implicit-function-declarationโ no implicit function declaration, declare your functions bestie, that's all I'm saying-Wno-implicit-intโ no implicit int, ints must be explicit-Winfinite-recursionโ infinite recursion... infinite recursion... infinite recursion... ๐ญ-Winit-selfโ init self, she initialized herself, main character energy ๐-Winlineโ inline, she's inline, she's in line, she's always been in line-Wno-int-conversionโ no int conversion, the int stays as she is-Wint-in-bool-contextโ int in bool context, an int in a bool's world ๐ฆ-Wno-int-to-pointer-castโ no int to pointer cast, that cast is not happening on our watch-Wno-invalid-memory-modelโ no invalid memory model, the memory model is valid and happy-Winvalid-pchโ invalid pch, the pch said no-Winvalid-utf8โ invalid utf8, the utf8 is not utf8ing ๐-Wno-unicodeโ no unicode, we're keeping it ascii-coded-Wjump-misses-initโ jump misses init, the jump ghosted the init ๐-Wkeyword-macroโ keyword macro, macro with a keyword, crossover-Wlarger-than=byte-sizeโ larger than byte-size, size limits are self care ๐-Wleading-whitespace=kindโ leading whitespace of a given kind, specify your kind-Wlogical-not-parenthesesโ logical not parentheses, the parentheses of it all-Wlogical-opโ logical op, logic operation, she's thinking-Wlong-longโ long long. two longs. twice the long. โจ-Wno-lto-type-mismatchโ no lto type mismatch, lto is fine actually-Wmainโ main. the main one. she's main. ๐-Wmaybe-uninitializedโ maybe uninitialized, maybe not, she's keeping it ambiguous-Wmemset-elt-sizeโ memset elt size, elt size matters-Wmemset-transposed-argsโ memset transposed args, the args got transposed, oops-Wmisleading-indentationโ misleading indentation, the indentation is lying to you, do not trust her ๐ญ-Wmissing-attributesโ missing attributes, where did the attributes go-Wmissing-bracesโ missing braces, the braces are missing, someone find them-Wmissing-field-initializersโ missing field initializers, the fields weren't initialized, they're just out there-Wmissing-format-attributeโ missing format attribute, the format attribute is missing-Wmissing-include-dirsโ missing include dirs, the include dirs are missing, sad-Wmissing-noreturnโ missing noreturn, she never returns but nobody marked her as such ๐-Wmusttail-local-addrโ musttail local addr, must tail, must addr-Wmaybe-musttail-local-addrโ maybe musttail local addr, the tentative version, she's thinking about it-Wno-missing-profileโ no missing profile, the profile is present-Wno-multicharโ no multichar, one char only bestie-Wmultistatement-macrosโ multistatement macros, the macro does many things, she's multitasking-Wnonnullโ nonnull, she's not null and she'd like you to know-Wnonnull-compareโ nonnull compare, comparing something that's not null-Wnormalized=[none|id|nfc|nfkc]โ normalized, and you choose:none,id,nfc, ornfkc. pick your normalization bestie ๐-Wnull-dereferenceโ null dereference, dereferencing null, the classic ๐-Wno-odrโ no odr, odr discourse declined-Wopenacc-parallelismโ openacc parallelism, she's parallel and she's acc-Wopenmpโ openmp, the mp is open-Wopenmp-simdโ openmp simd, openmp but simd, the collab ๐ซถ-Wno-overflowโ no overflow, nothing overflows here, everything fits-Woverlength-stringsโ overlength strings, the strings are too long, they're doing their best-Wno-override-init-side-effectsโ no override init side effects, no side effects were had-Wpackedโ packed, she's packed, she's ready to go โ๏ธ-Wno-packed-bitfield-compatโ no packed bitfield compat, packed bitfields are compatible, moving on-Wpacked-not-alignedโ packed not aligned, packed AND unaligned, double trouble-Wpaddedโ padded, she's got padding, she's comfortable-Wparenthesesโ parentheses, the parentheses!!! use them!!! ๐-Wno-pedantic-ms-formatโ no pedantic ms format, being chill about the ms format today-Wpointer-arithโ pointer arith, pointer doing math, she's a scholar ๐งฎ-Wno-pointer-compareโ no pointer compare, the pointers are not being compared-Wno-pointer-to-int-castโ no pointer to int cast, that cast is not on the schedule-Wno-pragmasโ no pragmas, no pragma talk, we're done-Wno-pragma-once-outside-headerโ no pragma once outside header, the pragma once is where she shouldn't be and we're being cool about it-Wno-prio-ctor-dtorโ no prio ctor dtor, the ctor and dtor priorities are unbothered-Wno-psabiโ no psabi, psabi has been excused-Wredundant-declsโ redundant decls, the decls are redundant, we heard you the first time ๐ญ-Wrestrictโ restrict, she's restricted, she's got boundaries ๐ซถ-Wno-return-local-addrโ no return local addr, we're not returning local addresses, we PROMISE-Wreturn-typeโ return type, what type does she return? find out-Wno-scalar-storage-orderโ no scalar storage order, the order is private-Wsequence-pointโ sequence point, the point of the sequence, the sequence of the point-Wshadowโ shadow ๐ป she's shadowing, she's behind you, she's your variable now-Wshadow=globalโ shadow but global, worldwide shadowing ๐-Wshadow=localโ shadow but local, neighborhood shadowing ๐๏ธ-Wshadow=compatible-localโ shadow but compatible-local, the chill local shadowing-Wno-shadow-ivarโ no shadow ivar, the ivar is not shadowed, the ivar is free-Wno-shift-count-negativeโ no shift count negative, the shift count is positive and thriving-Wno-shift-count-overflowโ no shift count overflow, the shift count is contained-Wshift-negative-valueโ shift negative value, she shifted and it went negative ๐-Wno-shift-overflowโ no shift overflow, nothing overflowed during that shift-Wshift-overflow=nโ shift overflow at level n, overflowing but numbered-Wsign-compareโ sign compare, comparing signs, astrology for integers ๐ฎ-Wsign-conversionโ sign conversion, the sign changed, character development-Wno-sizeof-array-argumentโ no sizeof array argument, the sizeof array argument is not happening-Wsizeof-array-divโ sizeof array div, sizeof doing division, she's multifaceted-Wsizeof-pointer-divโ sizeof pointer div, sizeof pointer division, the other one-Wsizeof-pointer-memaccessโ sizeof pointer memaccess, sizeof pointer plus memaccess, the combo-Wstack-protectorโ stack protector, protecting the stack, she's got a bodyguard ๐ก๏ธ-Wstack-usage=byte-sizeโ stack usage over byte-size, know your limits-Wstrict-aliasingโ strict aliasing, strict about the aliases, she has standards ๐-Wstrict-aliasing=nโ strict aliasing level n, standards but numbered-Wstrict-overflowโ strict overflow, strict about overflowing-Wstrict-overflow=nโ strict overflow level n, strict and specified-Wstring-compareโ string compare, comparing strings, gossip in text form-Wno-stringop-overflowโ no stringop overflow, the string op is not overflowing, she's contained-Wno-stringop-overreadโ no stringop overread, she's reading exactly the right amount ๐-Wno-stringop-truncationโ no stringop truncation, nothing was truncated, the string is whole-Wstrict-flex-arraysโ strict flex arrays, strict about flexing-Wsuggest-attribute=attribute-nameโ suggest an attribute, and you name it: attribute-name ๐-Wswitchโ switch, she switches, she's decisive-Wno-switch-boolโ no switch bool, bool switching is off the table-Wswitch-defaultโ switch default, the default case, the fallback friend ๐ซถ-Wswitch-enumโ switch enum, switching on enums, enum girlie-Wno-switch-outside-rangeโ no switch outside range, the switch is staying in range-Wno-switch-unreachableโ no switch unreachable, everything is reachable, we believe in her-Wsync-nandโ sync nand, nand but synced, the nand is in sync-Wsystem-headersโ system headers, the headers of the system, she's systemic-Wtautological-compareโ tautological compare, comparing something to itself, the most self-referential ๐-Wtrailing-whitespaceโ trailing whitespace, the whitespace is trailing, she's following you ๐-Wtrailing-whitespace=kindโ trailing whitespace of a specific kind, specify bestie-Wtrampolinesโ trampolines!!! she's bouncing, she's fun ๐-Wtrigraphsโ trigraphs, three graphs, the trio-Wtrivial-auto-var-initโ trivial auto var init, the init is trivial, we're not being dramatic about it-Wno-tsanโ no tsan, tsan is excused-Wtype-limitsโ type limits, respecting the type's boundaries-Wundefโ undef, she's undefined, she's a mystery-Wuninitializedโ uninitialized, not initialized, out there raw and unfiltered-Wunknown-pragmasโ unknown pragmas, the pragmas are unknown, they came from nowhere-Wunsuffixed-float-constantsโ unsuffixed float constants, the floats have no suffix, they're going commando ๐-Wunterminated-string-initializationโ unterminated string initialization, the string never ended, she's still going ๐-Wunusedโ unused, nobody's using her, she's unemployed and unbothered-Wunused-but-set-parameterโ unused but set parameter, she's set but not used, she's decorative-Wunused-but-set-parameter=nโ same parameter situation, level n-Wunused-but-set-variableโ unused but set variable, the variable is set and unused, we've all been there-Wunused-but-set-variable=nโ same vibe, numbered-Wunused-const-variableโ unused const variable, const and unused, stable and ignored-Wunused-const-variable=nโ const, unused, level n-Wunused-functionโ unused function, the function is not being called, she's on read ๐-Wunused-labelโ unused label, the label is unlabeled by usage-Wunused-local-typedefsโ unused local typedefs, the typedefs are local and unbothered-Wunused-macrosโ unused macros, macros sitting there, waiting, unused-Wunused-parameterโ unused parameter, the parameter is right there and nobody's using her-Wno-unused-resultโ no unused result, the result was unused and that's fine, no notes-Wunused-valueโ unused value, value without usage, tragic ๐ฅ-Wunused-variableโ unused variable, she's declared and abandoned-Wuse-after-freeโ use after free!!! the horror!!! the DRAMA ๐-Wuse-after-free=nโ use after free, level n, still horrifying-Wuseless-castโ useless cast, the cast does nothing, she's just there for the fit-Wno-varargsโ no varargs, the varargs are excused-Wvariadic-macrosโ variadic macros, macros with variable energy-Wvector-operation-performanceโ vector operation performance, she's performing, she's vectorized, she's booked-Wvlaโ vla, variable length array, she's variable and she's long-Wvla-larger-than=byte-sizeโ vla larger than byte-size, limits for the variable ones-Wno-vla-larger-thanโ no vla larger than, that limit discussion is over-Wvolatile-register-varโ volatile register var, volatile AND register AND var, she contains multitudes โจ-Wwrite-stringsโ write strings, she writes strings, she's a poet-Wno-xor-used-as-powโ no xor used as pow, we're not using xor as pow, and honestly fair-Wzero-as-null-pointer-constantโ zero as null pointer constant, zero pretending to be null, identity crisis ๐-Wzero-length-boundsโ zero length bounds, the bounds have zero length, they're minimal--all-warningsโ all warnings, the whole entire set, she has everything ๐--extra-warningsโ extra warnings, more warnings, we're being generous--no-warningsโ no warnings, silence, peace, a dream ๐--pedanticโ pedantic, the long-form one--pedantic-errorsโ pedantic errors, the long-form fatal one
๐ Static Analyzer Options ๐
okay so this is the part where GCC gets observant. She's watching your code like a group chat that screenshots everything. She finds the leaks, the double frees, the null derefs, the whole saga. Bestie, this is the detective arc. ๐ต๏ธโโ๏ธ
-fanalyzerโ the analyzer herself. she's here. she's analyzing. she's taking notes ๐-fanalyzer-assume-nothrowโ assume nothing throws, live in the fantasy-fanalyzer-call-summariesโ call summaries, she summarized the calls, efficient queen-fanalyzer-checker=nameโ pick a checker by name, choose your fighter-fno-analyzer-feasibilityโ no analyzer feasibility, feasibility discourse: declined-fanalyzer-show-events-in-system-headersโ show events in system headers, she's showing you the receipts in the system headers-fno-analyzer-state-mergeโ no analyzer state merge, the states remain separate, they're not merging-fno-analyzer-state-purgeโ no analyzer state purge, nothing gets purged on her watch-fno-analyzer-suppress-followupsโ no analyzer suppress followups, the followups are coming, brace yourself-fanalyzer-transitivityโ analyzer transitivity, transitive analysis, she's connecting the dots ๐-fno-analyzer-undo-inliningโ no analyzer undo inlining, the inlining stands-fanalyzer-verbose-edgesโ analyzer verbose edges, the edges are verbose and they have a lot to say-fanalyzer-verbose-state-changesโ analyzer verbose state changes, the state changed and she will be detailing it-fanalyzer-verbosity=levelโ analyzer verbosity at level, set your yapping level ๐ฃ๏ธ-fdump-analyzerโ dump analyzer, she's dumping, she's sharing everything-fdump-analyzer-callgraphโ dump analyzer callgraph, the callgraph gets dumped too-fdump-analyzer-exploded-graphโ dump analyzer exploded graph, EXPLODED graph ๐ฅ-fdump-analyzer-exploded-nodesโ dump analyzer exploded nodes, the nodes exploded too-fdump-analyzer-exploded-nodes-2โ exploded nodes, the sequel-fdump-analyzer-exploded-nodes-3โ exploded nodes, the threequel ๐ฌ-fdump-analyzer-exploded-pathsโ dump analyzer exploded paths, the paths are exploded-fdump-analyzer-feasibilityโ dump analyzer feasibility, feasibility gets dumped-fdump-analyzer-infinite-loopโ dump analyzer infinite loop, dump analyzer infinite loop, dump analyzer infinite loop... ๐ญ-fdump-analyzer-jsonโ dump analyzer json, json format, she's structured-fdump-analyzer-state-purgeโ dump analyzer state purge, the purge gets dumped-fdump-analyzer-stderrโ dump analyzer to stderr, going straight to stderr with it-fdump-analyzer-supergraphโ dump analyzer supergraph, SUPER graph, she's super ๐ฅ-fdump-analyzer-untrackedโ dump analyzer untracked, the untracked get dumped
and then the analyzer warnings, all of them, in order, because we do not skip:
-Wno-analyzer-double-fcloseโ no analyzer double fclose, the fclose was doubled and we're being chill-Wno-analyzer-double-freeโ no analyzer double free, freeing twice is cancelled-Wno-analyzer-exposure-through-output-fileโ no analyzer exposure through output file, the output file is not snitching-Wno-analyzer-exposure-through-uninit-copyโ no analyzer exposure through uninit copy, the uninit copy is keeping secrets-Wno-analyzer-fd-access-mode-mismatchโ no analyzer fd access mode mismatch, the fd access mode matches actually-Wno-analyzer-fd-double-closeโ no analyzer fd double close, closing the fd twice, no thanks-Wno-analyzer-fd-leakโ no analyzer fd leak, the fd is contained-Wno-analyzer-fd-phase-mismatchโ no analyzer fd phase mismatch, the phases are in sync-Wno-analyzer-fd-type-mismatchโ no analyzer fd type mismatch, the fd types match-Wno-analyzer-fd-use-after-closeโ no analyzer fd use after close, we're not using fds after closing them ๐ซถ-Wno-analyzer-fd-use-without-checkโ no analyzer fd use without check, we checked, promise-Wno-analyzer-file-leakโ no analyzer file leak, the files are held tightly-Wno-analyzer-free-of-non-heapโ no analyzer free of non heap, we're not freeing non-heap things-Wno-analyzer-imprecise-fp-arithmeticโ no analyzer imprecise fp arithmetic, the floating point math is precise, she's exact ๐-Wno-analyzer-infinite-loopโ no analyzer infinite loop, the loop ends, we promise-Wno-analyzer-infinite-recursionโ no analyzer infinite recursion, no analyzer infinite recursion, no analyzer infinite recursion... ๐ญ-Wno-analyzer-jump-through-nullโ no analyzer jump through null, we're not jumping through nulls-Wno-analyzer-malloc-leakโ no analyzer malloc leak, the malloc is accounted for-Wno-analyzer-mismatching-deallocationโ no analyzer mismatching deallocation, the deallocation matches-Wno-analyzer-null-argumentโ no analyzer null argument, the argument is not null-Wno-analyzer-null-dereferenceโ no analyzer null dereference, no nulls were dereferenced-Wno-analyzer-out-of-boundsโ no analyzer out of bounds, we're in bounds, we're behaving-Wno-analyzer-overlapping-buffersโ no analyzer overlapping buffers, the buffers are respecting each other's space-Wno-analyzer-possible-null-argumentโ no analyzer possible null argument, maybe null, maybe not-Wno-analyzer-possible-null-dereferenceโ no analyzer possible null dereference, possibly dereferencing possibly null, possibly fine-Wno-analyzer-putenv-of-auto-varโ no analyzer putenv of auto var, the auto var is not being putenv'd-Wno-analyzer-shift-count-negativeโ no analyzer shift count negative, the shift count is positive-Wno-analyzer-shift-count-overflowโ no analyzer shift count overflow, the shift count is contained-Wno-analyzer-stale-setjmp-bufferโ no analyzer stale setjmp buffer, the setjmp buffer is fresh โจ-Wno-analyzer-tainted-allocation-sizeโ no analyzer tainted allocation size, the allocation size is untainted-Wno-analyzer-tainted-assertionโ no analyzer tainted assertion, the assertion is clean-Wno-analyzer-tainted-array-indexโ no analyzer tainted array index, the array index is pure-Wno-analyzer-tainted-divisorโ no analyzer tainted divisor, the divisor is innocent-Wno-analyzer-tainted-offsetโ no analyzer tainted offset, the offset is unbothered-Wno-analyzer-tainted-sizeโ no analyzer tainted size, the size is trustworthy-Wno-analyzer-throw-of-unexpected-typeโ no analyzer throw of unexpected type, the throw was expected actually-Wanalyzer-symbol-too-complexโ analyzer symbol too complex, the symbol is complex and she's saying so-Wanalyzer-too-complexโ analyzer too complex, the whole thing is complex, she's overwhelmed ๐ต-Wno-analyzer-undefined-behavior-ptrdiffโ no analyzer undefined behavior ptrdiff, the ptrdiff is defined-Wno-analyzer-undefined-behavior-strtokโ no analyzer undefined behavior strtok, the strtok is defined and fine-Wno-analyzer-unsafe-call-within-signal-handlerโ no analyzer unsafe call within signal handler, the signal handler is being safe-Wno-analyzer-use-after-freeโ no analyzer use after free, using after freeing is not on the agenda-Wno-analyzer-use-of-pointer-in-stale-stack-frameโ no analyzer use of pointer in stale stack frame, the stack frame is fresh-Wno-analyzer-use-of-uninitialized-valueโ no analyzer use of uninitialized value, everything is initialized-Wno-analyzer-va-arg-type-mismatchโ no analyzer va arg type mismatch, the va args match-Wno-analyzer-va-list-exhaustedโ no analyzer va list exhausted, the va list is full of energy-Wno-analyzer-va-list-leakโ no analyzer va list leak, the va list is held-Wno-analyzer-va-list-use-after-va-endโ no analyzer va list use after va end, we ended it and moved on-Wno-analyzer-write-to-constโ no analyzer write to const, we're not writing to const, we're not monsters-Wno-analyzer-write-to-string-literalโ no analyzer write to string literal, the string literal stays untouched ๐
๐ C and Objective-C-only Warning Options ๐
these ones are for the C and Objective-C girlies specifically. everyone else can scroll, but honestly stay, it's fun here ๐ฆ
-Wbad-function-castโ bad function cast, the cast is bad, she's been called out-Wdeprecated-non-prototypeโ deprecated non prototype, deprecated AND non-prototype, double legacy-Wfree-labelsโ free labels, the labels are free, liberation ๐๏ธ-Wmissing-declarationsโ missing declarations, the declarations went missing-Wmissing-parameter-nameโ missing parameter name, the parameter has no name, she's anonymous-Wmissing-parameter-typeโ missing parameter type, the parameter has no type either-Wdeclaration-missing-parameter-typeโ declaration missing parameter type, the declaration is missing the parameter type, same energy-Wmissing-prototypesโ missing prototypes, where are the prototypes ๐ญ-Wmissing-variable-declarationsโ missing variable declarations, the variables weren't declared, they just showed up-Wmultiple-parameter-fwd-decl-listsโ multiple parameter fwd decl lists, multiple lists, multiple forward declarations, chaotic-Wnested-externsโ nested externs, externs inside externs, it's giving inception ๐-Wold-style-declarationโ old style declaration, vintage, retro, nostalgic ๐-Wold-style-definitionโ old style definition, the definition is vintage too-Wstrict-prototypesโ strict prototypes, strict about the prototypes, she has standards-Wtraditionalโ traditional, classic, timeless-Wtraditional-conversionโ traditional conversion, converting the old school way-Wdeclaration-after-statementโ declaration after statement, the declaration came late to the party ๐-Wpointer-signโ pointer sign, the sign of the pointer, astrological again ๐ฎ
๐ Debugging Options ๐
and NOW, bestie, the debugging arc. This is where you tell GCC to keep the receipts so your future self can figure out what past you was thinking. It's giving time capsule. ๐
-gโ-g. the icon. the classic. the one everybody types. ๐-glevelโ-gbut with a level, because more is more-gdwarfโ gdwarf, dwarf format, small name, big energy-gdwarf-versionโ gdwarf but you pick the version, choose your era-gbtfโ gbtf, btf format, she's got letters-gctfโ gctf, ctf format, another set of letters-gctflevelโ gctf but with a level, leveled ctf-gno-prune-btfโ gno prune btf, nothing is being pruned, the btf stays-ggdbโ ggdb, gdb-coded, she's ready for gdb specifically ๐-gno-record-gcc-switchesโ gno record gcc switches, the gcc switches are not being recorded, they're private-gstrict-dwarfโ gstrict dwarf, strict dwarf, no shortcuts-gas-loc-supportโ gas loc support, supporting gas loc, supportive queen-gas-locview-supportโ gas locview support, supporting the gas locview too, she supports everything ๐ซถ-gcodeviewโ gcodeview, codeview format, she's viewing the code-gcolumn-infoโ gcolumn info, column info included, extra detail for the girlies who want it-gdwarf32โ gdwarf32, dwarf but 32, the thirty-two of it-gdwarf64โ gdwarf64, dwarf but 64, the sixty-four of it-gno-statement-frontiersโ gno statement frontiers, the statement frontiers are not happening-gno-variable-location-viewsโ gno variable location views, the variable location views are off the table-gvariable-location-views=incompat5โ gvariable location views set toincompat5, a very specific vibe-ginternal-reset-location-viewsโ ginternal reset location views, internally resetting the location views, she's got it handled-ginline-pointsโ ginline points, inline points, points about inlining-gvmsโ gvms, vms format, old school cool-gz[=type]โ-gzwith an optional =type, compressed debug info, she's zipped ๐ธ-gsplit-dwarfโ gsplit dwarf, splitting the dwarf, she's divided but thriving-gdescribe-diesโ gdescribe dies, describing the dies, she's narrating-fdebug-prefix-map=old=newโ map old to new for debug prefixes, remapping the whole path situation-fdebug-types-sectionโ debug types section, a whole section for debug types-fno-eliminate-unused-debug-typesโ no eliminating unused debug types, the unused debug types are staying, they're guests here-femit-struct-debug-baseonlyโ emit struct debug, base only, just the base bestie-femit-struct-debug-reducedโ emit struct debug but reduced, the diet version-femit-struct-debug-detailed[=spec-list]โ emit struct debug but detailed, with an optional =spec-list, the full course meal ๐ฝ๏ธ-fno-eliminate-unused-debug-symbolsโ no eliminating unused debug symbols, the unused debug symbols stay, no evictions-femit-class-debug-alwaysโ emit class debug always, always, she said ALWAYS-fno-merge-debug-stringsโ no merging debug strings, the debug strings stay separate, they're individuals ๐-fno-dwarf2-cfi-asmโ no dwarf2 cfi asm, that one's off-fvar-trackingโ var tracking, she's tracking the vars, she knows where they've been ๐-fvar-tracking-assignmentsโ var tracking assignments, tracking the assignments too, thorough-fvar-tracking-uninitโ var tracking uninit, tracking the uninitialized ones as well, she leaves no var behind--debugโ the long-form debug one, extra letters, same iconic energy โจ
and there's still more where that came from, bestie โ keep scrolling, we are NOT done ๐
๐ฅ Optimization Options ๐ฅ
Bestie. Sit down. Hydrate. Because this is the list โ the one everyone opens the manpage for and then immediately closes in fear. It's giving wall of flags, it's giving main character energy, and every single one of them is below, untouched, unmangled, exactly as printed. ๐
I'm not gonna lie to you and pretend I can summarise this in a sentence. Nobody can. This is the vibe check list. Scroll it, ctrl-F it, screenshot it for later. ๐ฆ
-faggressive-loop-optimizations -falign-functions[=n[:m:[n2[:m2]]]]
-falign-jumps[=n[:m:[n2[:m2]]]] -falign-labels[=n[:m:[n2[:m2]]]]
-falign-loops[=n[:m:[n2[:m2]]]] -fmin-function-alignment=[n]
-fno-allocation-dce -fallow-store-data-races -fassociative-math
-fauto-profile -fauto-profile[=path] -fauto-profile-inlining
-fauto-inc-dec -fbranch-probabilities -fcaller-saves
-fcombine-stack-adjustments -fconserve-stack -ffold-mem-offsets
-fcompare-elim -fcprop-registers -fcrossjumping -fcse-follow-jumps
-fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range -fcx-method
-fdata-sections -fdce -fdelayed-branch
-fdelete-null-pointer-checks -fdep-fusion -fdevirtualize
-fdevirtualize-speculatively -fdevirtualize-at-ltrans -fdse
-fearly-inlining -fexcess-precision=style -fexpensive-optimizations
-fext-dce -ffast-math -ffat-lto-objects -ffinite-loops
-ffinite-math-only -ffloat-store -fforward-propagate
-ffp-contract=style -ffp-int-builtin-inexact -ffunction-sections
-ffuse-ops-with-volatile-access -fgcse -fgcse-after-reload
-fgcse-las -fgcse-lm -fgraphite-identity -fgcse-sm
-fhoist-adjacent-loads -fif-conversion -fif-conversion2
-findirect-inlining -finline-atomics -finline-functions
-finline-functions-called-once -finline-limit=n
-finline-small-functions -finline-stringops[=fn] -fipa-modref
-fipa-cp -fipa-cp-clone -fipa-bit-cp -fipa-vrp -fipa-pta
-fipa-profile -fipa-pure-const -fipa-reference
-fipa-reference-addressable -fipa-reorder-for-locality -fipa-sra
-fipa-stack-alignment -fipa-icf -fipa-icf-functions
-fipa-icf-variables -fira-algorithm=algorithm
-flate-combine-instructions -flifetime-dse -flive-patching=level
-fira-region=region -fira-hoist-pressure -fira-loop-pressure
-fno-ira-share-save-slots -fno-ira-share-spill-slots
-fisolate-erroneous-paths-dereference
-fisolate-erroneous-paths-attribute -fivopts
-fkeep-inline-functions -fkeep-static-functions
-fkeep-static-consts -flimit-function-alignment
-flive-range-shrinkage -floop-block -floop-interchange
-floop-strip-mine -floop-unroll-and-jam -floop-nest-optimize
-floop-parallelize-all -flra-remat -flto
-flto-compression-level=n -flto-toplevel-asm-heuristics
-flto-partition=alg -flto-incremental=path
-flto-incremental-cache-size=n -fmalloc-dce -fmerge-all-constants
-fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves
-fmove-loop-invariants -fmove-loop-stores -fno-branch-count-reg
-fno-defer-pop -fno-function-cse -fno-guess-branch-probability
-fno-inline -fno-math-errno -fno-peephole -fno-peephole2
-fno-printf-return-value -fno-sched-interblock -fno-sched-spec
-fno-signed-zeros -fno-toplevel-reorder -fno-trapping-math
-fno-zero-initialized-in-bss -fomit-frame-pointer -foptimize-crc
-foptimize-sibling-calls -fpartial-inlining -fpeel-loops
-fpredictive-commoning -fprefetch-loop-arrays -fprofile-correction
-fprofile-use -fprofile-use=path -fprofile-partial-training
-fprofile-values -fprofile-reorder-functions -freciprocal-math
-free -frename-registers -freorder-blocks
-freorder-blocks-algorithm=algorithm -freorder-blocks-and-partition
-freorder-functions -frerun-cse-after-loop
-freschedule-modulo-scheduled-loops -frounding-math
-fsave-optimization-record -fsched2-use-superblocks
-fsched-pressure -fsched-spec-load -fsched-spec-load-dangerous
-fsched-stalled-insns-dep[=n] -fsched-stalled-insns[=n]
-fsched-group-heuristic -fsched-critical-path-heuristic
-fsched-spec-insn-heuristic -fsched-rank-heuristic
-fsched-last-insn-heuristic -fsched-dep-count-heuristic
-fschedule-fusion -fschedule-insns -fschedule-insns2
-fsection-anchors -fselective-scheduling -fselective-scheduling2
-fsel-sched-pipelining -fsel-sched-pipelining-outer-loops
-fsemantic-interposition -fshrink-wrap -fshrink-wrap-separate
-fsignaling-nans -fsingle-precision-constant
-fsplit-ivs-in-unroller -fsplit-loops
-fspeculatively-call-stored-functions -fsplit-paths
-fsplit-wide-types -fsplit-wide-types-early -fssa-backprop
-fssa-phiopt -fstdarg-opt -fstore-merging -fstrict-aliasing
-fipa-strict-aliasing -fthread-jumps -ftracer -ftree-bit-ccp
-ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-coalesce-vars
-ftree-copy-prop -ftree-cselim -ftree-dce -ftree-dominator-opts
-ftree-dse -ftree-forwprop -ftree-fre -fcode-hoisting
-ftree-loop-if-convert -ftree-loop-im -ftree-phiprop
-ftree-loop-distribution -ftree-loop-distribute-patterns
-ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize
-ftree-loop-vectorize -ftree-parallelize-loops[=n] -ftree-pre
-ftree-partial-pre -ftree-pta -ftree-reassoc -ftree-scev-cprop
-ftree-sink -ftree-slsr -ftree-sra -ftree-switch-conversion
-ftree-tail-merge -ftree-ter -ftree-vectorize -ftree-vrp
-ftrivial-auto-var-init -funconstrained-commons -funit-at-a-time
-funroll-all-loops -funroll-loops -funsafe-math-optimizations
-funswitch-loops -fipa-ra -fvariable-expansion-in-unroller
-fvect-cost-model -fvpt -fweb -fwhole-program -fwpa
-fuse-linker-plugin -fzero-call-used-regs -O -O0 -O1 -O2 -O3
-Os -Ofast -Og -Oz --optimize
And then, at the very bottom of that pile, the celebrities themselves โ the ones you've actually typed in your life:
-O-O0-O1-O2-O3-Os-Ofast-Og-Oz--optimize
They're in the list, bestie. Right where they belong. ๐
๐งช Program Instrumentation Options ๐งช
Oh we're in our lab coat era now. ๐ฅผโจ Instrumentation options, coverage options, sanitizer-adjacent girlies, the hardening squad โ this is the whole roster:
-p -pg -fprofile-arcs -coverage -ftest-coverage
-fcondition-coverage -fpath-coverage -fprofile -fprofile-abs-path
-fprofile-dir=path -fprofile-generate -fprofile-generate=path
-fprofile-info-section -fprofile-info-section=name
-fprofile-note=path -fprofile-prefix-path=path
-fprofile-update=method -fprofile-filter-files=regex
-fprofile-exclude-files=regex
-fprofile-reproducible=[multithreaded|parallel-runs|serial]
-fsanitize=style -fsanitize-recover -fsanitize-recover=style
-fsanitize-trap -fsanitize-trap=style -fasan-shadow-offset=number
-fsanitize-sections=s1,s2,... -fsanitize-undefined-trap-on-error
-fcf-protection -fcf-protection=[full|branch|return|none|check]
-fharden-compares -fharden-conditional-branches -fhardened
-fharden-control-flow-redundancy -fhardcfr-skip-leaf
-fhardcfr-check-exceptions -fhardcfr-check-returning-calls
-fhardcfr-check-noreturn-calls=[always|no-xthrow|nothrow|never]
-fstack-protector -fstack-protector-all -fstack-protector-strong
-fstack-protector-explicit -fstack-check -fstack-limit-register=reg
-fstack-limit-symbol=sym -fno-stack-limit -fsplit-stack
-fstrub=disable -fstrub=strict -fstrub=relaxed -fstrub=all
-fstrub=at-calls -fstrub=internal
-fvtable-verify=[std|preinit|none] -fvtv-counts -fvtv-debug
-finstrument-functions -finstrument-functions-once
-finstrument-functions-exclude-function-list=sym,sym,...
-finstrument-functions-exclude-file-list=file,file,...
-fprofile-prefix-map=old=new -fpatchable-function-entry=N[,M]
--coverage --profile
Note the double-dash girlies at the bottom โ --coverage and --profile โ they're long-form icons and they get the same respect. ๐
๐ Preprocessor Options ๐
The macro-manipulation corner of the group chat. Define things, undefine things, dump things, keep comments, lose comments, and just generally โจpreprocessโจ your little heart out:
-C -CC -Dmacro[=defn] -dD -dI -dM -dN -dU -fdebug-cpp
-fdirectives-only -fdollars-in-identifiers -fexec-charset=charset
-fextended-identifiers -finput-charset=charset
-fmacro-prefix-map=old=new -fmax-include-depth=depth
-fno-canonical-system-headers -fpch-deps -fpch-preprocess
-fpreprocessed -ftabstop=width -ftrack-macro-expansion
-fwide-exec-charset=charset -fworking-directory -H -imacros file
-include file -M -MD -MF -MG -MM -MMD -MP -MQ -MT
-Mno-modules -no-integrated-cpp -P -pthread -remap -traditional
-traditional-cpp -trigraphs -Umacro -undef -Wp,option
-Xpreprocessor option --comments --comments-in-macros
--define-macro=macro[=defn] --dependencies --dump=letters
--imacros=file --include=file --no-integrated-cpp
--no-line-commands --print-missing-file-dependencies --traditional
--traditional-cpp --trigraphs --trace-includes
--undefine-macro=macro --user-dependencies --write-dependencies
--write-user-dependencies
Lowkey the -M family alone could fill a whole afternoon. ๐ซถ
๐ง Assembler Options ๐ง
Tiny section. Three options. They're all about handing stuff off to the assembler, and they're all here, no cap:
-Wa,option-Xassembler option--for-assembler=option
Short but mighty. Periodt. ๐
๐ Linker Options ๐
Now we're in the link it all together part of the story. Object files, libraries, static vs shared, entry points, scripts, and a whole alphabet soup of -T flags. Behold:
object-file-name -flink-libatomic -fuse-ld=linker -llibrary
-nostartfiles -nodefaultlibs -nolibc -nostdlib -nostdlib++ -e
entry -pie -pthread -r -rdynamic -s -static -static-pie
-static-libgcc -static-libstdc++ -static-libasan -static-libhwasan
-static-liblsan -static-libtsan -static-libubsan -shared
-shared-libgcc -symbolic -T script -Wl,option -Xlinker option -u
symbol -Tbss=addr -Tdata=addr -Ttext=addr -N -n -t -Z -z
keyword --entry=entry --for-linker=option --force-link=symbol
--no-standard-library --pie --static --static-pie --symbolic
Heads up bestie, the very first entry there โ object-file-name โ is a placeholder, not a flag. That's just how it's written. Don't come for me, I'm reporting faithfully. ๐
๐ Directory Options ๐
The "where do I even look for things" section. Include paths, library paths, prefixes, sysroots, and the absolute legend that is -I-:
-Bprefix -Idir -I- -idirafter dir -imacros file -imultilib dir
-imultiarch dir -iplugindir=dir -iprefix file -iquote dir
-isysroot dir -isystem dir -iwithprefix dir -iwithprefixbefore dir
-Ldir -no-canonical-prefixes --no-sysroot-suffix -nostdinc
-nostdinc++ --embed-dir=dir --embed-directory=dir --include-barrier
--include-directory=dir --include-directory-after=dir
--include-prefix=prefix --include-with-prefix=prefix
--include-with-prefix-after=prefix
--include-with-prefix-before=prefix --no-canonical-prefixes
--no-standard-includes --prefix=prefix --sysroot=dir
Yes, --no-canonical-prefixes really does show up twice in that list. I'm not touching it. That's between the manpage and itself. ๐ญ
โ๏ธ Code Generation Options โ๏ธ
Last one in this batch, and it's the how do I actually emit the code section โ registers, exceptions, PIC/PIE, struct returns, trampolines, visibility, and the lil -Q duo at the very end:
-fcall-saved-reg -fcall-used-reg -ffixed-reg -fexceptions
-fnon-call-exceptions -fdelete-dead-exceptions -funwind-tables
-fasynchronous-unwind-tables -fno-gnu-unique
-finhibit-size-directive -fcommon -fno-ident -fpcc-struct-return
-fpic -fPIC -fpie -fPIE -fno-plt -fno-jump-tables
-fno-bit-tests -frecord-gcc-switches -freg-struct-return
-fshort-enums -fshort-wchar -fverbose-asm -fpack-struct[=n]
-fleading-underscore -ftls-model=model -fstack-reuse=reuse_level
-ftrampolines -ftrampoline-impl=[stack|heap] -ftrapv -fwrapv
-fwrapv-pointer -fvisibility=[default|internal|hidden|protected]
-fstrict-volatile-bitfields -fsync-libcalls
-fzero-init-padding-bits=value -Qy -Qn
And that's where this part lands. There's so much more coming, so don't go anywhere. ๐ฆ๐
Developer Options ๐ ๏ธโจ
okay bestie, these are the developer options. every single one is below, no cap. don't skip a single flag or the compiler will know. ๐
-dletters-dumpspecs-dumpmachine-dumpversion-dumpfullversion-fcallgraph-info[=su,da]-fchecking-fchecking=n-fdbg-cnt-list-fdbg-cnt=counter-value-list-fdisable-ipa-pass_name-fdisable-rtl-pass_name-fdisable-rtl-pass-name=range-list-fdisable-tree-pass_name-fdisable-tree-pass-name=range-list-fdump-debug-fdump-earlydebug-fdump-noaddr-fdump-unnumbered-fdump-unnumbered-links-fdump-final-insns[=file]-fdump-internal-locations-fdump-ipa-all-fdump-ipa-cgraph-fdump-ipa-inline-fdump-lang-all-fdump-lang-switch-fdump-lang-switch-options-fdump-lang-switch-options=filename-fdump-passes-fdump-rtl-pass-fdump-rtl-pass=filename-fdump-statistics-fdump-tree-all-fdump-tree-switch-fdump-tree-switch-options-fdump-tree-switch-options=filename-fcompare-debug[=opts]-fcompare-debug-second-fenable-kind-pass-fenable-kind-pass=range-list-fira-verbose=n-flto-report-flto-report-wpa-fmem-report-wpa-fmem-report-fpre-ipa-mem-report-fpost-ipa-mem-report-fopt-info-fopt-info-options[=file]-fmultiflags-fprofile-report-frandom-seed=string-fsched-verbose=n-fsel-sched-verbose-fsel-sched-dump-cfg-fsel-sched-pipelining-verbose-fstats-fstack-usage-ftime-report-ftime-report-details-fvar-tracking-assignments-toggle-gtoggle-print-autofdo-gcov-version-print-file-name=library-print-libgcc-file-name-print-multi-directory-print-multi-lib-print-multi-os-directory-print-multiarch-print-prog-name=program-print-search-dirs-Q-print-sysroot-print-sysroot-headers-suffix-save-temps-save-temps=cwd-save-temps=obj-specs=file-time[=file]--dump=letters--print-autofdo-gcov-version--print-file-name=library--print-libgcc-file-file-name--print-multi-directory--print-multi-lib--print-multi-os-directory--print-multiarch--print-prog-name=program--print-search-dirs--print-sysroot--print-sysroot-headers-suffix--save-temps--specs=file--param name=value
Target-Specific Options ๐๐
and now for the target-specific options, because not every CPU speaks the same language, and honestly? slay. ๐ฆ
AArch64 Options (AArch64 Options) ๐
-mabi=name-mbig-endian-mlittle-endian-menable-sysreg-checking-mgeneral-regs-only-mcmodel=tiny-mcmodel=small-mcmodel=large-mstrict-align-momit-leaf-frame-pointer-mtls-dialect=desc-mtls-dialect=traditional-mtls-size=size-mtp=name-mfix-cortex-a53-835769-mfix-cortex-a53-843419-mlow-precision-recip-sqrt-mlow-precision-sqrt-mlow-precision-div-mmax-vectorization-mautovec-preference=name-mpc-relative-literal-loads-msign-return-address=scope-mbranch-protection=features-mharden-sls=opts-march=name-mcpu=name-mtune=name-moverride=string-mstack-protector-guard=guard-mstack-protector-guard-reg=sysreg-mstack-protector-guard-offset=offset-mtrack-speculation-moutline-atomics-mearly-ra-mearly-ldp-fusion-mlate-ldp-fusion-mnarrow-gp-writes-msve-vector-bits=bits
Adapteva Epiphany Options (Adapteva Epiphany Options) ๐
-mhalf-reg-file-mprefer-short-insn-regs-mbranch-cost=num-mcmove-mnops=num-msoft-cmpsf-msplit-lohi-mpost-inc-mpost-modify-mstack-offset=num-mround-nearest-mlong-calls-mshort-calls-msmall16-mfp-mode=mode-mmay-round-for-trunc-mfp-iarith-mvect-double-max-vect-align=num-msplit-vecmove-early-m1reg-reg
AMD GCN Options (AMD GCN Options) ๐ฅ
-march=gpu-mtune=gpu-mgang-private-size=bytes-msram-ecc=[on|off|any]-mxnack=[on|off|any]-Wopenacc-dims
ARC Options (ARC Options) ๐
-mbarrel-shifter-mjli-always-mcpu=cpu-mA6-mARC600-mA7-mARC700-mdpfp-mdpfp-compact-mdpfp-fast-mno-dpfp-lrsr-mea-mmul32x16-mmul64-matomic-mnorm-mspfp-mspfp-compact-mspfp-fast-msimd-msoft-float-mswap-mlock-mswape-mxy-misize-marclinux-marclinux_prof-mlong-calls-mmedium-calls-msdata-mirq-ctrl-saved-mrgf-banked-regs-mlpc-width=width-G num-mvolatile-cache-mtp-regno=regno-mbitops-mcmem-munaligned-access-mauto-modify-reg-mno-brcc-mcase-vector-pcrel-mno-cond-exec-mearly-cbranchsi-mindexed-loads-mlra-priority-none-mlra-priority-compact-mlra-priority-noncompact-mmillicode-msize-level=level-mtune=cpu-mmultcost=num-mcode-density-frame-mmpy-option=multo-mdiv-rem-mcode-density-mll64-mfpu=fpu-mrf16-mbranch-index
ARM Options (ARM Options) ๐ฆ
-mapcs-frame-mapcs-mabi=name-mgeneral-regs-only-mno-sched-prolog-mlittle-endian-mbig-endian-mbe8-mbe32-mfloat-abi=name-mfp16-format=name-mthumb-interwork-mcpu=name-march=name-mfpu=name-mtune=name-mstructure-size-boundary=n-mabort-on-noreturn-mlong-calls-msingle-pic-base-mpic-register=reg-mpic-data-is-text-relative-mnop-fun-dllimport-mpoke-function-name-mthumb-marm-mtpcs-frame-mtpcs-leaf-frame-mcaller-super-interworking-mcallee-super-interworking-mtp=name-mtls-dialect=dialect-mword-relocations-mfix-cortex-m3-ldrd-mfix-cortex-a57-aes-1742098-mfix-cortex-a72-aes-1655431-munaligned-access-mslow-flash-data-masm-syntax-unified-mrestrict-it-mpure-code-mcmse-mfix-cmse-cve-2021-35465-mstack-protector-guard=guard-mstack-protector-guard-offset=offset-mfdpic-mbranch-protection=features-mvectorize-with-neon-quad-mvectorize-with-neon-double
AVR Options (AVR Options) ๐
-mmcu=mcu-mabsdata-maccumulate-args-mcvt-mbranch-cost=cost-mfuse-add=level-mfuse-move=level-mfuse-move2-mcall-prologues-mgas-isr-prologues-mint8-mflmap-mdouble=bits-mlong-double=bits-mno-call-main-mn_flash=size-mfract-convert-truncate-mno-interrupts-mmain-is-OS_task-mrelax-mpmem-wrap-around-mrmw-mstrict-X-mtiny-stack-mrodata-in-ram-msplit-bit-shift-msplit-ldst-mshort-calls-mskip-bug-muse-nonzero-bits-nodevicelib-nodevicespecs-Waddr-space-convert-Wmisspelled-isr
Blackfin Options (Blackfin Options) ๐ค
-mcpu=cpu[-sirevision]-msim-momit-leaf-frame-pointer-mspecld-anomaly-mcsync-anomaly-mlow-64k-mstack-check-l1-mid-shared-library-mleaf-id-shared-library-mshared-library-id=n-msep-data-mlong-calls-mfast-fp-minline-plt-mmulticore-mcorea-mcoreb-msdram-micplb
C6X Options (C6X Options) โญ
-mbig-endian-mlittle-endian-march=cpu-msim-msdata=sdata-type-mdsbt-mlong-calls
CRIS Options (CRIS Options) ๐ธ
-mcpu=cpu-march=cpu-mtune=cpu-mmax-stackframe=n-metrax4-metrax100-mpdebug-mcc-init-mno-side-effects-mstack-align-mdata-align-mconst-align-m32-bit-m16-bit-m8-bit-mno-prologue-epilogue-mbest-lib-options-moverride-best-lib-options-mtrap-using-break8-mtrap-unaligned-atomic-munaligned-atomic-may-use-library-sim-sim2-mmul-bug-workaround
C-SKY Options (C-SKY Options) ๐
-march=arch-mcpu=cpu-mbig-endian-mlittle-endian-mfpu=fpu-mdouble-float-mfdivdu-mfloat-abi=name-melrw-mistack-mmp-mcp-mcache-msecurity-mtrust-mdsp-medsp-mvdsp-mdiv-msmart-mhigh-registers-manchor-mpushpop-mmultiple-stld-mconstpool-mstack-size-mccrt-mbranch-cost=n-msched-prolog-msim
Cygwin and MinGW Options (Cygwin and MinGW Options) ๐ช
-mconsole-mcrtdll=library-mdll-mnop-fun-dllimport-mthreads-municode-mwin32-mwindows-fno-set-stack-executable-fwritable-relocated-rdata-mpe-aligned-commons-muse-libstdc-wrappers
Darwin Options (Darwin Options) ๐
-all_load-allowable_client-arch name-arch_errors_fatal-asm_macosx_version_min=version-bind_at_load-bundle-bundle_loader-client_name-compatibility_version-current_version-dead_strip-dependency-file-dylib_file-dylinker-dylinker_install_name-dynamic-dynamiclib-exported_symbols_list-fapple-kext-fconstant-cfstrings-ffix-and-continue-filelist-findirect-data-flat_namespace-force_cpusubtype_ALL-force_flat_namespace-framework name-gfull-gused-headerpad_max_install_names-iframework-image_base-init symbol-name-install_name-keep_private_externs-matt-stubs-mconstant-cfstrings-mdynamic-no-pic-mfix-and-continue-mkernel-mmacosx-version-min=version-mone-byte-bool-msymbol-stubs-mtarget-linker[=]version-nodefaultexport-nodefaultrpaths-pagezero_size-preload-read_only_relocs-sectalign-sectcreate-seg_addr_table-seg1addr-segaddr-segprot-segs_read_only_addr-segs_read_write_addr-sub_library-sub_umbrella-twolevel_namespace-twolevel_namespace_hints-umbrella-undefined-unexported_symbols_list-weak_framework name-weak_reference_mismatches-whatsloaded-whyload-F-ObjC-ObjC++-Wnonportable-cfstrings
DEC Alpha Options (DEC Alpha Options) ๐ซ
-mno-fp-regs-msoft-float-mieee-mieee-with-inexact-mieee-conformant-mfp-trap-mode=mode-mfp-rounding-mode=mode-mtrap-precision=mode-mbuild-constants-mcpu=cpu-type-mtune=cpu-type-mbwx-mmax-mfix-mcix-msafe-bwa-msafe-partial-mfloat-vax-mfloat-ieee-mexplicit-relocs-msmall-data-mlarge-data-msmall-text-mlarge-text-mmemory-latency=time-mtls-kernel-mtls-size=bitsize-mlong-double-128-mlong-double-64
eBPF Options (eBPF Options) ๐
-mbig-endian-mlittle-endian-mframe-limit=bytes-mxbpf-mco-re-mjmpext-mjmp32-malu32-mv3-atomics-mbswap-msdiv-msmov-mcpu=version-masm=dialect-minline-memops-threshold=bytes-Wco-re
FR30 Options (FR30 Options) ๐
-msmall-model-mno-lsim
FRV Options (FRV Options) ๐ฆ
-mgpr-32-mgpr-64-mfpr-32-mfpr-64-mhard-float-msoft-float-malloc-cc-mfixed-cc-mdword-mdouble-mmedia-mmuladd-mfdpic-minline-plt-mgprel-ro-multilib-library-pic-mlinked-fp-mlong-calls-malign-labels-mlibrary-pic-macc-4-macc-8-mpack-mno-eflags-mno-cond-move-mno-optimize-membar-mno-scc-mno-cond-exec-mno-vliw-branch-mno-multi-cond-exec-mno-nested-cond-exec-mtomcat-stats-mTLS-mtls-mcpu=cpu
FT32 Options (FT32 Options) ๐
-msim-mnodiv-mft32b-mcompress-mnopm
GNU/Linux Options (GNU/Linux Options) ๐ง
-mglibc-muclibc-mmusl-mbionic-mandroid-tno-android-cc-tno-android-ld
H8/300 Options (H8/300 Options) ๐
-mrelax-mh-ms-mn-msx-ms2600-mquickcall-mslowbyte-mexr-mint32-malign-300
โจ HPPA Options (HPPA Options) โจ
bestie, HPPA really said โlet me have a whole tray of tiny switchesโ and we respect it ๐ hereโs every single one, no cap:
-march=architecture-type-mno-atomic-libcalls-mcaller-copies-mdisable-fpregs-mdisable-indexing-mordered-mfast-indirect-calls-mgas-mgnu-ld-mhp-ld-mfixed-range=register-range-mcoherent-ldcw-mlinker-opt-mlong-calls-mlong-load-store-mno-space-regs-msoft-float-mpa-risc-1-0-mpa-risc-1-1-mpa-risc-2-0-mportable-runtime-mschedule=cpu-type-msoft-mult-msio-mwsio-munix=unix-std-nolibdld-static-threads
โจ IA-64 Options (IA-64 Options) โจ
IA-64 said โI contain multitudesโ and honestly? same ๐ฆ hereโs the full menu:
-mbig-endian-mlittle-endian-mgnu-as-mgnu-ld-mno-pic-mvolatile-asm-stop-mregister-names-msdata-mconstant-gp-mauto-pic-minline-float-divide-min-latency-minline-float-divide-max-throughput-mno-inline-float-divide-minline-int-divide-min-latency-minline-int-divide-max-throughput-mno-inline-int-divide-minline-sqrt-min-latency-minline-sqrt-max-throughput-mno-inline-sqrt-mdwarf2-asm-mearly-stop-bits-mfixed-range=register-range-mtls-size=tls-size-mtune=cpu-type-milp32-mlp64-msched-br-data-spec-msched-ar-data-spec-msched-control-spec-msched-br-in-data-spec-msched-ar-in-data-spec-msched-in-control-spec-msched-spec-ldc-msched-spec-control-ldc-msched-stop-bits-after-every-cycle-msched-count-spec-in-critical-path-msel-sched-dont-check-control-spec-msched-fp-mem-deps-zero-cost-msched-max-memory-insns-hard-limit-msched-max-memory-insns=max-insns
โจ LM32 Options (LM32 Options) โจ
LM32 is giving compact and cute, but still got options ๐ธ:
-mbarrel-shift-enabled-mdivide-enabled-mmultiply-enabled-msign-extend-enabled-muser-enabled
โจ LoongArch Options (LoongArch Options) โจ
LoongArch walked in with a whole aesthetic and a million flags ๐:
-march=arch-type-mtune=tune-type-mabi=base-abi-type-mfpu=fpu-type-msimd=simd-type-msoft-float-msingle-float-mdouble-float-mlsx-mlasx-mbranch-cost=n-maddr-reg-reg-cost=n-mcheck-zero-division-mbreak-code=code-mcond-move-int-mcond-move-float-memcpy-mstrict-align-G num-mmax-inline-memcpy-size=n-mexplicit-relocs=style-mexplicit-relocs-mno-explicit-relocs-mdirect-extern-access-mcmodel=code-model-mrelax-mpass-mrelax-to-as-mrecip-mrecip=opt-mfrecipe-mdiv32-mlam-bh-mlamcas-mld-seq-sa-mscq-mtls-dialect=opt-mannotate-tablejump
โจ LynxOS Options (LynxOS Options) โจ
LynxOS keeps it short and sweet ๐:
-mshared-mthreads-mlegacy-threads
โจ M32C Options (M32C Options) โจ
M32C said โsmall but mightyโ and I felt that โจ:
-mcpu=cpu-msim-memregs=number
โจ M32R/D Options (M32R/D Options) โจ
M32R/D coming through with the classics ๐:
-m32r2-m32rx-m32r-mdebug-malign-loops-missue-rate=number-mbranch-cost=number-mmodel=code-size-model-type-msdata=sdata-type-mno-flush-func-mflush-func=name-mno-flush-trap-mflush-trap=number-G num
โจ M680x0 Options (M680x0 Options) โจ
M680x0 is the retro icon of the group and it knows it ๐:
-march=arch-mcpu=cpu-mtune=tune-m68000-m68020-m68020-40-m68020-60-m68030-m68040-m68060-m68302-m68332-m68851-mcpu32-mfidoa-m5200-m5206e-m528x-m5307-m5407-mcfv4e-mbitfield-mc68000-mc68020-mrtd-mdiv-mshort-mhard-float-m68881-msoft-float-mpcrel-malign-int-mstrict-align-msep-data-mshared-library-id=n-mid-shared-library-mxgot-mxtls-mlong-jump-table-offsets
โจ MCore Options (MCore Options) โจ
MCore is lowkey underrated, fr fr ๐:
-mhardlit-mdiv-mrelax-immediates-mwide-bitfields-m4byte-functions-mcallgraph-data-mslow-bytes-mno-lsim-mlittle-endian-mbig-endian-m210-m340-mstack-increment
โจ MicroBlaze Options (MicroBlaze Options) โจ
MicroBlaze said โIโm babyโ and then handed us this list ๐ญ๐:
-msoft-float-mhard-float-msmall-divides-mcpu=cpu-mmemcpy-mxl-soft-mul-mxl-soft-div-mxl-barrel-shift-mxl-pattern-compare-mxl-gp-opt-mxl-multiply-high-mxl-float-convert-mxl-float-sqrt-mbig-endian-mlittle-endian-mxl-reorder-mxl-mode-app-model-mxl-prefetch-mpic-data-is-text-relative
โจ MIPS Options (MIPS Options) โจ
MIPS really said โI contain multitudes, endianness, and also like 100 flagsโ ๐ this is the whole entire vibe:
-EL-EB-mel-meb-march=arch-mtune=arch-mips1-mips2-mips3-mips4-mips32-mips32r2-mips32r3-mips32r5-mips32r6-mips64-mips64r2-mips64r3-mips64r5-mips64r6-mips16-mmips16e2-mflip-mips16-minterlink-compressed-minterlink-mips16-mabi=abi-mabicalls-mshared-mplt-mxgot-mgp32-mgp64-mfp32-mfpxx-mfp64-mhard-float-msoft-float-mno-float-msingle-float-mdouble-float-modd-spreg-mabs=mode-mnan=encoding-mdsp-mdspr2-mmcu-meva-mvirt-mxpa-mcrc-mginv-mmicromips-mmsa-mloongson-mmi-mloongson-ext-mloongson-ext2-mfpu=fpu-type-msmartmips-mpaired-single-mdmx-mips3d-mmt-mllsc-mlong64-mlong32-msym32-Gnum-mno-local-sdata-mno-extern-sdata-mno-gopt-membedded-data-muninit-const-in-rodata-mcode-readable=setting-mno-data-in-code-mcode-xonly-msplit-addresses-mexplicit-relocs-mexplicit-relocs=release-mno-check-zero-division-mdivide-traps-mdivide-breaks-mno-load-store-pairs-mstrict-align-mno-unaligned-access-mmemcpy-mlong-calls-mmad-mimadd-mno-fused-madd-nocpp-mfix-24k-mfix-r4000-mfix-r4400-mfix-r5900-mfix-r10000-mfix-rm7000-mfix-vr4120-mfix-vr4130-mfix-sb1-mfix4300-mr10k-cache-barrier=setting-mflush-func=func-mno-flush-func-mbranch-cost=num-mbranch-likely-mcompact-branches=policy-mno-fp-exceptions-mvr4130-align-msynci-mno-lxc1-sxc1-mno-madd4-mno-relax-pic-calls-mmcount-ra-address-mframe-header-opt
โจ MMIX Options (MMIX Options) โจ
MMIX is giving academic icon behavior and we love that for it ๐:
-mlibfuncs-mepsilon-mabi=gnu-mabi=mmixware-mzero-extend-mknuthdiv-mtoplevel-symbols-melf-mbranch-predict-mbase-addresses-msingle-exit-mset-data-start=address-mset-program-start=address-mno-set-program-start
โจ MN10300 Options (MN10300 Options) โจ
MN10300 said โIโm here, Iโm ready, hereโs my listโ ๐:
-mmult-bug-mno-mult-bug-mam33-mam33-2-mam34-mtune=cpu-type-mno-return-pointer-on-d0-mno-crt0-mrelax-mno-liw-mno-setlb
โจ Moxie Options (Moxie Options) โจ
Moxie is short, sweet, and full of attitude ๐ฆ:
-meb-mel-mmul.x-mno-crt0
โจ MSP430 Options (MSP430 Options) โจ
MSP430 is the tiny microcontroller with a big heart and a long options list ๐ญ๐:
-msim-masm-hex-mmcu=name-mlarge-msmall-mrelax-mwarn-mcu-mwarn-devices-csv-mcode-region=where-mdata-region=where-muse-lower-region-prefix-msilicon-errata=name[,name...]-msilicon-errata-warn=name[,name...]-mhwmult=type-minrt-mtiny-printf-mmax-inline-shift=n
โจ NDS32 Options (NDS32 Options) โจ
NDS32 really came prepared with the whole binder full of flags ๐โจ:
-mbig-endian-mlittle-endian-EB-EL-mabi=name-mfloat-abi=name-mreduced-regs-mfull-regs-malways-align-malign-functions-mfp-as-gp-mcmov-mhw-abs-mext-perf-mext-perf2-mext-string-mext-dsp-mext-fpu-fma-mext-fpu-sp-mext-fpu-dp-mv3push-m16-bit-mvh-misr-vector-size=num-misr-secure=num-mcache-block-size=num-march=arch-mcpu=cpu-mconfig-fpu=num-mconfig-mul=type-mconfig-register-ports=kind-mcmodel=code-model-mctor-dtor-mrelax-mrelax-hint-msched-prolog-epilog-mno-ret-in-naked-func-malways-save-lp-munaligned-access-minline-asm-r15
โจ Nvidia PTX Options (Nvidia PTX Options) โจ
Nvidia PTX is the GPU bestie and it brought its own set of toggles ๐ฅ:
-m64-march=arch-misa=arch-march-map=arch-mptx=version-mmainkernel-moptimize-msoft-stack-msoft-stack-reserve-local=size-muniform-simt-mgomp
โจ OpenRISC Options (OpenRISC Options) โจ
OpenRISC said โopen source, open optionsโ and honestly? periodt ๐ :
-mboard=name-mhard-mul-mhard-div-msoft-mul-msoft-div-msoft-float-mhard-float-mdouble-float-munordered-float-mcmov-mror-mrori-msext-msfimm-mshftimm-mcmodel=code-model
โจ PDP-11 Options (PDP-11 Options) โจ
PDP-11 is the vintage queen and she has options for days ๐:
-mfpu-msoft-float-mac0-m40-m45-m10-mint32-mint16-msplit-munix-asm-mdec-asm-mgnu-asm-mlra
โจ Picolibc Options (Picolibc Options) โจ
Picolibc keeps it cute with double-dash energy ๐ธ:
--oslib=library--crt0=[none|minimal|hosted|semihost]--printf=[d|f|l|i|m]--scanf=[d|f|l|i|m]
โจ PowerPC Options โจ
See RS/6000 and PowerPC Options.
โจ PRU Options (PRU Options) โจ
PRU is small but it said โI still have flagsโ and we respect the hustle ๐:
-mmcu=mcu-minrt-mno-relax-mloop-mmul-mfillzero-mabi=variant
โจ RISC-V Options (RISC-V Options) โจ
RISC-V really said โIโm the future and I have a flag for everythingโ ๐โจ:
-mbranch-cost=N-instruction-mabi=ABI-string-mfdiv-mdiv-mno-fence-tso-misa-spec=ISA-spec-string-march=[ISA|Profile|Profile_ISA|processor-string]-mcpu=processor-string-mtune=processor-string-mpreferred-stack-boundary=num-msmall-data-limit=N-bytes-msave-restore-mno-shorten-memrefs-mstrict-align-mscalar-strict-align-mno-vector-strict-align-mcmodel=medlow-mcmodel=medany-mcmodel=large-mexplicit-relocs-mrelax-mriscv-attribute-malign-data=type-mbig-endian-mlittle-endian-mstack-protector-guard=guard-mstack-protector-guard-reg=reg-mstack-protector-guard-offset=offset-mcsr-check-momit-leaf-frame-pointer-mmovcc-mno-inline-atomics-mno-inline-strlen-mno-inline-strcmp-mno-inline-strncmp-mstringop-strategy=strategy-mtls-dialect=desc-mtls-dialect=trad-mrvv-vector-bits=value-mrvv-max-lmul=value-madjust-lmul-cost-mmax-vectorization-mno-autovec-segment
โจ RL78 Options (RL78 Options) โจ
RL78 is the tiny legend and it has options for days, no cap ๐:
-msim-mallregs-mrelax-mes0-mmul=none-mmul=g13-mmul=g14-mmul=rl78-mcpu=g10-mcpu=g13-mcpu=g14-mcpu=rl78-mg10-mg13-mg14-mrl78-msave-mduc-in-interrupts
๐ RS/6000 and PowerPC Options ๐
Bestie, this is the PowerPC roster and it is stacked. Buckle up, we're going alphabetical-ish by vibe ๐
- CPU + tuning core:
-mcpu=cpu-type,-mtune=cpu-type,-mcmodel=code-model,-mprofile-kernel - The power/altivec girlies:
-mpowerpc64,-maltivec,-mpowerpc-gpopt,-mpowerpc-gfxopt,-mmfcrf,-mpopcntb,-mpopcntd,-mfprnd,-mcmpb,-mhard-dfp - TOC stuff, very specific, very demure:
-mfull-toc,-mminimal-toc,-mno-fp-in-toc,-mno-sum-in-toc - Word size + ABI flavours:
-maix64,-maix32,-m64,-m32,-mxl-compat,-mpe - Alignment, float, endianness, pic:
-malign-power,-malign-natural,-msoft-float,-mhard-float,-mmultiple,-mupdate,-mavoid-indexed-addresses,-mfused-madd,-mbit-align,-mbit-word,-mstrict-align,-mrelocatable,-mrelocatable-lib,-mlittle,-mlittle-endian,-mbig,-mbig-endian,-mdynamic-no-pic,-msingle-pic-base - Scheduling nerds rise up:
-mprioritize-restricted-insns=priority,-msched-costly-dep=dependence_type,-minsert-sched-nops=scheme - Pick your calling convention, it's giving choose-your-own-adventure:
-mcall-aixdesc,-mcall-eabi,-mcall-freebsd,-mcall-linux,-mcall-netbsd,-mcall-openbsd,-mcall-sysv,-mcall-sysv-eabi,-mcall-sysv-noeabi - Tracebacks, struct returns, abi, plts:
-mtraceback=traceback_type,-maix-struct-return,-msvr4-struct-return,-mabi=abi-type,-msecure-plt,-mbss-plt,-msplit-patch-nops,-mregnames,-mlongcall,-mpltseq,-mtls-markers - Block + string compare inline limits (yes, all of them):
-mblock-move-inline-limit=num,-mblock-compare-inline-limit=num,-mblock-compare-inline-loop-limit=num,-mblock-ops-unaligned-vsx,-mstring-compare-inline-limit=num - Little instruction-set legends:
-misel,-mvsx,-mvrsave,-mmulhw,-mdlmzb - System + board flavours:
-mprototype,-msim,-mmvme,-mads,-myellowknife,-memb,-meabi,-msdata,-msdata=opt,-mreadonly-in-sdata,-mvxworks,-G num - Reciprocal + friends:
-mrecip,-mrecip=opt,-mno-recip,-mrecip-precision,-mveclibabi=type,-mfriz,-mpointers-to-nested-functions,-msave-toc-indirect - Newer-gen goodies:
-mpower8-fusion,-mcrypto,-mhtm,-mquad-memory,-mquad-memory-atomic,-mcompat-align-parm,-mfloat128,-mfloat128-hardware,-mgnu-attribute - Stack protector trio:
-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offset - The fresh drop:
-mprefixed,-mpcrel,-mmma,-mdense-math,-mrop-protect,-mprivileged,-mno-splat-word-constant,-mno-splat-float-constant,-mno-ieee128-constant,-mno-warn-altivec-long
๐ฆ RX Options ๐ฆ
- Float sizes:
-m64bit-doubles,-m32bit-doubles - FPU on or off, periodt:
-fpu,-nofpu - Pick your chip + endianness:
-mcpu=name,-mbig-endian-data,-mlittle-endian-data - Data + sim + syntax:
-msmall-data-limit=N,-msim,-mas100-syntax - Squeeze it:
-mrelax,-mmax-constant-size=N,-mint-register=N,-mpid,-mno-allow-string-insns,-mjsr - Interrupt girlies:
-mno-warn-multiple-fast-interrupts,-msave-acc-in-interrupts - And:
-mlra
๐ธ S/390 and zSeries Options ๐ธ
- Tune + arch:
-mtune=cpu-type,-march=cpu-type - Float situation:
-mhard-float,-msoft-float,-mhard-dfp - Long double size picker:
-mlong-double-64,-mlong-double-128 - Stack business, all of it:
-mbackchain,-mpacked-stack,-msmall-exec,-mmvcle,-m64,-m31,-mdebug,-mesa,-mzarch,-mhtm,-mvx,-mzvector - Tracing:
-mtpf-trace,-mtpf-trace-skip,-mmain - Fused madd, both ways:
-mfused-madd,-mno-fused-madd - Warnings + stack limits:
-mwarn-framesize=framesize,-mwarn-dynamicstack,-mstack-size=stack-size,-mno-stack-size,-mstack-guard=stack-guard,-mno-stack-guard - Guard + hotpatch:
-mstack-protector-guard=guard,-mstack-protector-guard-record,-mhotpatch=pre-halfwords,post-halfwords - PIC + indirect branch control:
-mno-pic-data-is-text-relative,-mindirect-branch=choice,-mindirect-branch-jump=choice,-mindirect-branch-call=choice,-mfunction-return=choice,-mfunction-return-mem=choice,-mfunction-return-reg=choice,-mindirect-branch-table - Instrumentation + misc:
-mfentry,-mrecord-mcount,-mnop-mcount,-mpreserve-args,-munaliged-symbols
Note: yes, -munaliged-symbols is spelled exactly like that. Type it as written, bestie, typos are load-bearing here ๐
๐ SH Options ๐
- The whole chip lineup, in order:
-m1,-m2,-m2e,-m2a,-m2a-nofpu,-m2a-single,-m2a-single-only,-m3,-m3e,-m4,-m4-nofpu,-m4-single,-m4-single-only,-m4-100,-m4-100-nofpu,-m4-100-single,-m4-100-single-only,-m4-200,-m4-200-nofpu,-m4-200-single,-m4-200-single-only,-m4-300,-m4-300-nofpu,-m4-300-single,-m4-300-single-only,-m4-340,-m4-400,-m4-500 - The a-variants:
-m4a,-m4al,-m4a-nofpu,-m4a-single,-m4a-single-only - Endian + misc toggles:
-mb,-ml,-mdalign,-mrelax,-mbigtable,-mbitops,-mfmovd,-mrenesas,-mnomacsave,-mieee,-misize,-minline-ic_invalidate,-mprefergot,-musermode - Numbers you supply:
-multcost=number,-mdiv=strategy,-mdivsi3_libfunc=name,-mfixed-range=register-range,-maccumulate-outgoing-args,-matomic-model=atomic-model,-mbranch-cost=num - Branch + delay slot drama:
-mzdcbranch,-mcbranch-force-delay-slot - The rest of the crew:
-mfsca,-mfsrra,-mpretend-cmove,-mfdpic,-mtas,-mlra
โ๏ธ Solaris 2 Options โ๏ธ
-mclear-hwcap,-mno-clear-hwcap-mimpure-text,-mno-impure-text-gsctf
๐ SPARC Options ๐
- CPU + tune + model:
-mcpu=cpu-type,-mtune=cpu-type,-mcmodel=code-model,-mmemory-model=mem-model - Word + pointer size:
-m32,-m64,-mptr32,-mptr64 - Registers, structs, flat:
-mapp-regs,-mfaster-structs,-mflat - Float everything:
-mfpu,-mhard-float,-msoft-float,-mhard-quad-float,-msoft-quad-float - Stack + struct return + alignment:
-mstack-bias,-mstd-struct-return,-munaligned-doubles,-muser-mode,-mv8plus - VIS family, iconic honestly:
-mvis,-mvis2,-mvis3,-mvis3b,-mvis4,-mvis4b - Instruction niceties:
-mcbcond,-mfmaf,-mfsmuld,-mpopc,-msubxc - Errata fixes (for the specific chips, iykyk):
-mfix-at697f,-mfix-ut699,-mfix-ut700,-mfix-gr712rc
๐ System V Options ๐
-YP,paths-Ym,dir
๐ V850 Options ๐
- Calls + prologues + space:
-mlong-calls,-mep,-mprolog-function,-mspace - Data addressing, pick your letter:
-mtda=n,-msda=n,-mzda=n - The v850 variant parade:
-mv850,-mv850e3v5,-m850e2v4,-mv850e2v3,-mv850e2,-mv850e1,-mv850es,-mv850e - Toggles:
-mdisable-callt,-mrelax,-mlong-jumps,-msoft-float,-mhard-float,-mloop,-mrh850-abi,-mghs,-mgcc-abi,-m8byte-align,-mbig-switch,-mapp-regs,-msmall-sld,-mno-strict-align,-mjump-tables-in-data-section
๐ง VAX Options ๐ง
-munix,-mgnu,-md,-md-float,-mg,-mg-float,-mlra,-mvaxc-alignment,-mqmath
โญ Visium Options โญ
-mdebug,-msim-mfpu,-mhard-float,-msoft-float-mcpu=cpu-type,-mtune=cpu-type-msv-mode,-muser-mode
๐ซถ VMS Options ๐ซถ
-mvms-return-codes-mdebug-main=prefix-mmalloc64-mpointer-size=size
๐ VxWorks Options ๐
-mrtp,-msmp,-mvthreads-non-static,-Bstatic,-Bdynamic-Xbind-lazy,-Xbind-now
๐ฅ x86 Options ๐ฅ
Okay this is the main character of machine-dependent options, no cap. Massive roster, every single one:
- Tune/arch + the meta-controls:
-mtune=cpu-type,-march=cpu-type,-mtune-ctrl=feature-list,-mdump-tune-features,-mno-default - Math + asm + float plumbing:
-mfpmath=unit,-masm=dialect,-mno-fancy-math-387,-mno-fp-ret-in-387,-m80387,-mhard-float,-msoft-float,-mieee-fp,-mrtd,-malign-double,-mpreferred-stack-boundary=num,-mincoming-stack-boundary=num,-mcld,-mcx16,-msahf,-mmovbe,-mcrc32,-mmwait,-mrecip,-mrecip=opt,-mvzeroupper,-mstv,-mprefer-avx128,-mprefer-vector-width=opt,-mpartial-vector-fp-math,-mmove-max=bits,-mstore-max=bits,-mnoreturn-no-callee-saved-registers - The SIMD/ext roster (a whole universe):
-mmmx,-msse,-msse2,-msse3,-mssse3,-msse4.1,-msse4.2,-msse4,-mavx,-mavx2,-mavx512f,-mavx512cd,-mavx512vl,-mavx512bw,-mavx512dq,-mavx512ifma,-mavx512vbmi,-msha,-maes,-mpclmul,-mfsgsbase,-mrdrnd,-mf16c,-mfma,-mpconfig,-mwbnoinvd,-mptwrite,-mclflushopt,-mclwb,-mxsavec,-mxsaves,-msse4a,-m3dnow,-m3dnowa,-mpopcnt,-mabm,-mbmi,-mtbm,-mfma4,-mxop,-madx,-mlzcnt,-mbmi2,-mfxsr,-mxsave,-mxsaveopt,-mrtm,-mhle,-mlwp,-mmwaitx,-mclzero,-mpku,-mgfni,-mvaes,-mwaitpkg,-mshstk,-mmanual-endbr,-mcet-switch,-mforce-indirect-call,-mavx512vbmi2,-mavx512bf16,-menqcmd,-mvpclmulqdq,-mavx512bitalg,-mmovdiri,-mmovdir64b,-mavx512vpopcntdq,-mavx512vnni,-mprfchw,-mrdpid,-mrdseed,-msgx,-mavx512vp2intersect,-mserialize,-mtsxldtrk,-mamx-tile,-mamx-int8,-mamx-bf16,-muintr,-mhreset,-mavxvnni,-mamx-fp8,-mavx512fp16,-mavxifma,-mavxvnniint8,-mavxneconvert,-mcmpccxadd,-mamx-fp16,-mprefetchi,-mraoint,-mamx-complex,-mavxvnniint16,-msm3,-msha512,-msm4,-mapxf,-musermsr,-mavx10.1,-mavx10.2,-mamx-avx512,-mamx-tf32,-mmovrs,-mamx-movrs,-mavx512bmm,-mcldemote - Bitfields, stringops, mem strategies:
-mms-bitfields,-mno-align-stringops,-minline-all-stringops,-minline-stringops-dynamically,-mstringop-strategy=alg,-mkl,-mwidekl,-mmemcpy-strategy=strategy,-mmemset-strategy=strategy - Args + long double + regparm + vec ABI:
-mpush-args,-maccumulate-outgoing-args,-m128bit-long-double,-m96bit-long-double,-mlong-double-64,-mlong-double-80,-mlong-double-128,-mregparm=num,-msseregparm,-mveclibabi=type,-mvect8-ret-in-mem,-mpc32,-mpc64,-mpc80,-mdaz-ftz,-mstackrealign,-mstack-arg-probe,-momit-leaf-frame-pointer,-mno-red-zone,-mno-tls-direct-seg-refs - Models, ABIs, address modes, word sizes:
-mcmodel=code-model,-mabi=name,-maddress-mode=mode,-m32,-m64,-mx32,-m16,-miamcu,-mlarge-data-threshold=num,-msse2avx - Instrumentation + entry/return hooks:
-mfentry,-mrecord-mcount,-mnop-mcount,-m8bit-idiv,-minstrument-return=type,-mrecord-return,-mfentry-name=name,-mfentry-section=name,-mskip-rax-setup - Split loads/stores + data alignment:
-mavx256-split-unaligned-load,-mavx256-split-unaligned-store,-malign-data=type - Stack protector quartet:
-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offset,-mstack-protector-guard-symbol=symbol - Registers + xlogues + TLS:
-mgeneral-regs-only,-mcall-ms2sysv-xlogues,-mtls-dialect=type,-mrelax-cmpxchg-loop - Security/hardening crew:
-mindirect-branch=choice,-mfunction-return=choice,-mindirect-branch-register,-mharden-sls=choice,-mindirect-branch-cs-prefix,-mapx-inline-asm-use-gpr32 - Gather/scatter + linking + loop tuning:
-mgather,-mscatter,-mneeded,-mno-direct-extern-access,-munroll-only-small-loops,-mdispatch-scheduler,-mlam=choice
๐ x86 Windows Options ๐
See Cygwin and MinGW Options.
๐ Xstormy16 Options ๐
-msim
๐ฆ Xtensa Options ๐ฆ
-mconst16-mforce-no-pic-mno-serialize-volatile-mtext-section-literals-mauto-litpools-mno-target-align-mlongcalls-mabi=abi-type-mextra-l32r-costs=cycles-mstrict-align
โจ zSeries Options โจ
See S/390 and zSeries Options.
โจ Options Controlling the Kind of Output โจ
Okay so compiling is not one thing, it's a whole journey, bestie. It can involve up to four stages: preprocessing, compilation proper, assembly and linking โ and it's always in that order, no skipping the queue ๐
GCC can preprocess and compile several files either into several assembler input files, or into one assembler input file. Then each assembler input file produces an object file, and linking combines all the object files โ the ones it just freshly compiled and the ones you handed it as input โ into one executable file. Iconic behaviour honestly.
For any given input file, the file name suffix is what decides which kind of compilation happens. The vibe check is in the extension:
file.cโ C source code that must be preprocessed.file.iโ C source code that should not be preprocessed.file.iiโ C++ source code that should not be preprocessed.file.mโ Objective-C source code. Note that you must link with thelibobjclibrary to make an Objective-C program work.file.miโ Objective-C source code that should not be preprocessed.file.mm,file.Mโ Objective-C++ source code. Note that you must link with thelibobjclibrary to make an Objective-C++ program work. Note that.Mrefers to a literal capitalM.file.miiโ Objective-C++ source code that should not be preprocessed.file.hโ C, C++, Objective-C or Objective-C++ header file to be turned into a precompiled header (default), or C, C++ header file to be turned into an Ada spec (via the-fdump-ada-specswitch).
okay bestie, gcc is literally out here playing detective with your file endings ๐โจ โ it peeks at the suffix and goes โoh bet, I know what to do with this.โ Hereโs the whole tea:
file.cc,file.cp,file.cxx,file.cpp,file.CPP,file.c++,file.Cโ C++ source code that must be preprocessed. Note that in.cxx, the last two letters must both be literallyx. Likewise,.Crefers to a literal capitalC. ๐file.mm,file.Mโ Objective-C++ source code that must be preprocessed. ๐ธfile.miiโ Objective-C++ source code that should not be preprocessed. ๐file.hh,file.H,file.hp,file.hxx,file.hpp,file.HPP,file.h++,file.tccโ C++ header file to be turned into a precompiled header or Ada spec. ๐file.f,file.for,file.ftn,file.fiโ Fixed form Fortran source code that should not be preprocessed. ๐file.F,file.FOR,file.fpp,file.FPP,file.FTNโ Fixed form Fortran source code that must be preprocessed (with the traditional preprocessor). ๐ฅfile.f90,file.f95,file.f03,file.f08,file.fiiโ Free form Fortran source code that should not be preprocessed. ๐ฆfile.F90,file.F95,file.F03,file.F08โ Free form Fortran source code that must be preprocessed (with the traditional preprocessor). โญfile.cob,file.COB,file.cbl,file.CBLโ COBOL source code. ๐file.goโ Go source code. ๐file.dโ D source code. ๐file.diโ D interface file. ๐งฉfile.ddโ D documentation code (Ddoc). ๐file.adsโ Ada source code file that contains a library unit declaration (a declaration of a package, subprogram, or generic, or a generic instantiation), or a library unit renaming declaration (a package, generic, or subprogram renaming declaration). Such files are also called specs. ๐ฆfile.adbโ Ada source code file containing a library unit body (a subprogram or package body). Such files are also called bodies. ๐ซfile.sโ Assembler code. โ๏ธfile.S,file.sxโ Assembler code that must be preprocessed. ๐งotherโ An object file to be fed straight into linking. Any file name with no recognized suffix is treated this way. ๐๏ธ
You can specify the input language explicitly with the -x option:
-x language,--language=language,--language languageโ Specify explicitly the language for the following input files (rather than letting the compiler choose a default based on the file name suffix). This option applies to all following input files until the next-xoption. Possible values for language are:
c c-header cpp-output
c++ c++-header c++-system-header c++-user-header c++-cpp-output
c++-system-module
objective-c objective-c-header objective-c-cpp-output objc-cpp-output
objective-c++ objective-c++-header objective-c++-cpp-output
objc++-cpp-output
assembler assembler-with-cpp
ada adascil adawhy
cobol
d
f77 f77-cpp-input f95 f95-cpp-input
go
modula-2 modula-2-cpp-output
rust
algol68
lto
Note that -x does not imply a particular language standard. For example -x f77 may also require -std=legacy for some older source codes. ๐
-x noneโ Turn off any specification of a language, so that subsequent files are handled according to their file name suffixes (as if-xhas not been used at all).
If you only want some of the stages of compilation, you can use -x (or filename suffixes) to tell gcc where to start, and one of the options -c, -S, or -E to say where gcc is to stop. Note that some combinations (for example, -x cpp-output -E) instruct gcc to do nothing at all. ๐ญ
-c,--compileโ Compile or assemble the source files, but do not link. The linking stage simply is not done. The ultimate output is in the form of an object file for each source file.
By default, the object file name for a source file is made by replacing the suffix .c, .i, .s, etc., with .o.
Unrecognized input files, not requiring compilation or assembly, are ignored.
-S,--assembleโ Stop after the stage of compilation proper; do not assemble. The output is in the form of an assembler code file for each non-assembler input file specified.
By default, the assembler file name for a source file is made by replacing the suffix .c, .i, etc., with .s.
Input files that don't require compilation are ignored.
-E,--preprocessโ Stop after the preprocessing stage; do not run the compiler proper. The output is in the form of preprocessed source code, which is sent to the standard output.
Input files that don't require preprocessing are ignored.
-o file,--output=file,--output fileโ Place the primary output in file. This applies to whatever sort of output is being produced, whether it be an executable file, an object file, an assembler file or preprocessed C code.
If -o is not specified, the default is to put an executable file in a.out, the object file for source.suffix in source.o, its assembler file in source.s, a precompiled header file in source.suffix.gch, and all preprocessed C source on standard output.
Though -o names only the primary output, it also affects the naming of auxiliary and dump outputs. See the examples below. Unless overridden, both auxiliary outputs and dump outputs are placed in the same directory as the primary output. In auxiliary outputs, the suffix of the input file is replaced with that of the auxiliary output file type; in dump outputs, the suffix of the dump file is appended to the input file suffix. In compilation commands, the base name of both auxiliary and dump outputs is that of the primary output; in compile and link commands, the primary output name, minus the executable suffix, is combined with the input file name. If both share the same base name, disregarding the suffix, the result of the combination is that base name, otherwise, they are concatenated, separated by a dash.
gcc -c foo.c ...
will use foo.o as the primary output, and place aux outputs and dumps next to it, e.g., aux file foo.dwo for -gsplit-dwarf, and dump file foo.c.???r.final for -fdump-rtl-final.
If a non-linker output file is explicitly specified, aux and dump files by default take the same base name:
gcc -c foo.c -o dir/foobar.o ...
will name aux outputs dir/foobar.* and dump outputs dir/foobar.c.*.
A linker output will instead prefix aux and dump outputs:
gcc foo.c bar.c -o dir/foobar ...
will generally name aux outputs dir/foobar-foo.* and dir/foobar-bar.*, and dump outputs dir/foobar-foo.c.* and dir/foobar-bar.c.*.
The one exception to the above is when the executable shares the base name with the single input:
gcc foo.c -o dir/foo ...
in which case aux outputs are named dir/foo.* and dump outputs named dir/foo.c.*.
The location and the names of auxiliary and dump outputs can be adjusted by the options -dumpbase, -dumpbase-ext, -dumpdir, -save-temps=cwd, and -save-temps=obj.
-dumpbase dumpbase,--dumpbase dumpbaseโ This option sets the base name for auxiliary and dump output files. It does not affect the name of the primary output file. Intermediate outputs, when preserved, are not regarded as primary outputs, but as auxiliary outputs:
gcc -save-temps -S foo.c
saves the (no longer) temporary preprocessed file in foo.i, and then compiles to the (implied) output file foo.s, whereas:
gcc -save-temps -dumpbase save-foo -c foo.c
preprocesses to in save-foo.i, compiles to save-foo.s (now an intermediate, thus auxiliary output), and then assembles to the (implied) output file foo.o.
Absent this option, dump and aux files take their names from the input file, or from the (non-linker) output file, if one is explicitly specified: dump output files (e.g. those requested by -fdump-* options) with the input name suffix, and aux output files (those requested by other non-dump options, e.g. "-save-temps", "-gsplit-dwarf", "-fcallgraph-info") without it.
Similar suffix differentiation of dump and aux outputs can be attained for explicitly-given -dumpbase basename.suf by also specifying -dumpbase-ext .suf.
If dumpbase is explicitly specified with any directory component, any dumppfx specification (e.g. -dumpdir or -save-temps=*) is ignored, and instead of appending to it, dumpbase fully overrides it:
gcc foo.c -c -o dir/foo.o -dumpbase alt/foo \
-dumpdir pfx- -save-temps=cwd ...
creates auxiliary and dump outputs named alt/foo.*, disregarding dir/ in -o, the ./ prefix implied by -save-temps=cwd, and pfx- in -dumpdir.
When -dumpbase is specified in a command that compiles multiple inputs, or that compiles and then links, it may be combined with dumppfx, as specified under -dumpdir. Then, each input file is compiled using the combined dumppfx, and default values for dumpbase and auxdropsuf are computed for each input file:
gcc foo.c bar.c -c -dumpbase main ...
creates foo.o and bar.o as primary outputs, and avoids overwriting the auxiliary and dump outputs by using the dumpbase as a prefix, creating auxiliary and dump outputs named main-foo.* and main-bar.*.
An empty string specified as dumpbase avoids the influence of the output basename in the naming of auxiliary and dump outputs during compilation, computing default values :
gcc -c foo.c -o dir/foobar.o -dumpbase " ...
will name aux outputs dir/foo.* and dump outputs dir/foo.c.*. Note how their basenames are taken from the input name, but the directory still defaults to that of the output.
The empty-string dumpbase does not prevent the use of the output basename for outputs during linking:
gcc foo.c bar.c -o dir/foobar -dumpbase " -flto ...
The compilation of the source files will name auxiliary outputs dir/foo.* and dir/bar.*, and dump outputs dir/foo.c.* and dir/bar.c.*. LTO recompilation during linking will use dir/foobar. as the prefix for dumps and auxiliary files.
-dumpbase-extauxdropsuf,--dumpbase-extauxdropsuf โ okay so when you're forming the name of an auxiliary output file (but not a dump file, bestie), this drops the trailingauxdropsuffromdumpbasebefore it appends any suffixes. If you don't specify it, it defaults to the suffix of a defaultdumpbase, i.e., the suffix of the input file when-dumpbaseis not present in the command line, ordumpbaseis combined withdumppfx. ๐
Like, watch this:
gcc foo.c -c -o dir/foo.o -dumpbase x-foo.c -dumpbase-ext .c ...
This creates dir/foo.o as the main output, and generates auxiliary outputs in dir/x-foo.*, taking the location of the primary output, and dropping the .c suffix from the dumpbase. Dump outputs retain the suffix: dir/x-foo.c.*. โจ
This option is disregarded if it does not match the suffix of a specified dumpbase, except as an alternative to the executable suffix when appending the linker output base name to dumppfx, as specified below:
gcc foo.c bar.c -o main.out -dumpbase-ext .out ...
This creates main.out as the primary output, and avoids overwriting the auxiliary and dump outputs by using the executable name minus auxdropsuf as a prefix, creating auxiliary outputs named main-foo.* and main-bar.* and dump outputs named main-foo.c.* and main-bar.c.*. ๐ซถ
-dumpdirdumppfx,--dumpdirdumppfx โ bestie, when forming the name of an auxiliary or dump output file, usedumppfxas a prefix:
gcc -dumpdir pfx- -c foo.c ...
creates foo.o as the primary output, and auxiliary outputs named pfx-foo.*, combining the given dumppfx with the default dumpbase derived from the default primary output, derived in turn from the input name. Dump outputs also take the input name suffix: pfx-foo.c.*. ๐ธ
If dumppfx is to be used as a directory name, it must end with a directory separator:
gcc -dumpdir dir/ -c foo.c -o obj/bar.o ...
creates obj/bar.o as the primary output, and auxiliary outputs named dir/bar.*, combining the given dumppfx with the default dumpbase derived from the primary output name. Dump outputs also take the input name suffix: dir/bar.c.*. ๐ฆ
It defaults to the location of the output file, unless the output file is a special file like "/dev/null". Options -save-temps=cwd and -save-temps=obj override this default, just like an explicit -dumpdir option. In case multiple such options are given, the last one prevails:
gcc -dumpdir pfx- -c foo.c -save-temps=obj ...
outputs foo.o, with auxiliary outputs named foo.* because -save-temps=* overrides the dumppfx given by the earlier -dumpdir option. It does not matter that =obj is the default for -save-temps, nor that the output directory is implicitly the current directory. Dump outputs are named foo.c.*. ๐
When compiling from multiple input files, if -dumpbase is specified, dumpbase, minus a auxdropsuf suffix, and a dash are appended to (or override, if containing any directory components) an explicit or defaulted dumppfx, so that each of the multiple compilations gets differently-named aux and dump outputs.
gcc foo.c bar.c -c -dumpdir dir/pfx- -dumpbase main ...
outputs auxiliary dumps to dir/pfx-main-foo.* and dir/pfx-main-bar.*, appending dumpbase- to dumppfx. Dump outputs retain the input file suffix: dir/pfx-main-foo.c.* and dir/pfx-main-bar.c.*, respectively. Contrast with the single-input compilation:
gcc foo.c -c -dumpdir dir/pfx- -dumpbase main ...
that, applying -dumpbase to a single source, does not compute and append a separate dumpbase per input file. Its auxiliary and dump outputs go in dir/pfx-main.*. ๐
When compiling and then linking from multiple input files, a defaulted or explicitly specified dumppfx also undergoes the dumpbase- transformation above (e.g. the compilation of foo.c and bar.c above, but without -c). If neither -dumpdir nor -dumpbase are given, the linker output base name, minus auxdropsuf, if specified, or the executable suffix otherwise, plus a dash is appended to the default dumppfx instead. Note, however, that unlike earlier cases of linking:
gcc foo.c bar.c -dumpdir dir/pfx- -o main ...
does not append the output name main to dumppfx, because -dumpdir is explicitly specified. The goal is that the explicitly-specified dumppfx may contain the specified output name as part of the prefix, if desired; only an explicitly-specified -dumpbase would be combined with it, in order to avoid simply discarding a meaningful option. ๐
When compiling and then linking from a single input file, the linker output base name will only be appended to the default dumppfx as above if it does not share the base name with the single input file name. This has been covered in single-input linking cases above, but not with an explicit -dumpdir that inhibits the combination, even if overridden by -save-temps=*:
gcc foo.c -dumpdir alt/pfx- -o dir/main.exe -save-temps=cwd ...
Auxiliary outputs are named foo.*, and dump outputs foo.c.*, in the current working directory as ultimately requested by -save-temps=cwd. ๐
Summing it all up for an intuitive though slightly imprecise data flow: the primary output name is broken into a directory part and a basename part; dumppfx is set to the former, unless overridden by -dumpdir or -save-temps=*, and dumpbase is set to the latter, unless overridden by -dumpbase. If there are multiple inputs or linking, this dumpbase may be combined with dumppfx and taken from each input file. Auxiliary output names for each input are formed by combining dumppfx, dumpbase minus suffix, and the auxiliary output suffix; dump output names are only different in that the suffix from dumpbase is retained. โญ
When it comes to auxiliary and dump outputs created during LTO recompilation, a combination of dumppfx and dumpbase, as given or as derived from the linker output name but not from inputs, even in cases in which this combination would not otherwise be used as such, is passed down with a trailing period replacing the compiler-added dash, if any, as a -dumpdir option to lto-wrapper; being involved in linking, this program does not normally get any -dumpbase and -dumpbase-ext, and it ignores them. ๐ฅ
When running sub-compilers, lto-wrapper appends LTO stage names to the received dumppfx, ensures it contains a directory component so that it overrides any -dumpdir, and passes that as -dumpbase to sub-compilers. ๐
-v,--verboseโ Print (on standard error output) the commands executed to run the stages of compilation. Also print the version number of the compiler driver program and of the preprocessor and the compiler proper. ๐-###โ Like-vexcept the commands are not executed and arguments are quoted unless they contain only alphanumeric characters or"./-_". This is useful for shell scripts to capture the driver-generated command lines. ๐--helpโ Print (on the standard output) a description of the command-line options understood bygcc. If the-voption is also specified then--helpis also passed on to the various processes invoked bygcc, so that they can display the command-line options they accept. If the-Wextraoption has also been specified (prior to the--helpoption), then command-line options that have no documentation associated with them are also displayed. ๐ง--target-helpโ 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 however, target-specific options of the linker and assembler are not displayed. This is because those tools do not currently support the extended--help=syntax. ๐paramsโ Display the values recognized by the--paramoption. ๐languageโ Display the options supported forlanguage, wherelanguageis the name of one of the languages supported in this version of GCC. If an option is supported by all languages, one needs to selectcommonclass. ๐ฆcommonโ Display the options that are common to all languages. ๐ธ
These are the supported qualifiers:
undocumentedโ Display only those options that are undocumented. ๐joinedโ Display options taking an argument that appears after an equal sign in the same continuous piece of text, such as:--help=target. ๐separateโ Display options taking an argument that appears as a separate word following the original option, such as:-o output-file. ๐
Thus for example to display all the undocumented target-specific switches supported by the compiler, use:
--help=target,undocumented
The sense of a qualifier can be inverted by prefixing it with the ^ character, so for example to display all binary warning options (i.e., ones that are either on or off and that do not take an argument) that have a description, use:
--help=warnings,^joined,^undocumented
The argument to --help= should not consist solely of inverted qualifiers. โญ
Combining several classes is possible, although this usually restricts the output so much that there is nothing to display. One case where it does work, however, is when one of the classes is target. For example, to display all the target-specific optimization options, use:
--help=target,optimizers
The --help= option can be repeated on the command line. Each successive use displays its requested class of options, skipping those that have already been displayed. If --help is also specified anywhere on the command line then this takes precedence over any --help= option. ๐ฅ
Okay so bestie, plot twist incoming: if the -Q option shows up on the command line before the --help= option, then the descriptive text that --help= shows you gets a whole glow-up. โจ Instead of describing the options it's displaying, it just tells you whether each one is enabled, disabled, or set to a specific value โ assuming the compiler actually knows that at the point where --help= gets used. ๐
Here's a truncated example from the ARM port of gcc:
% gcc -Q -mabi=2 --help=target -c
The following options are target specific:
-mabi= 2
-mabort-on-noreturn [disabled]
-mapcs [disabled]
The output is sensitive to the effects of previous command-line options, so like, for example, you can find out which optimizations are enabled at -O2 by using:
-Q -O2 --help=optimizers
Alternatively you can discover which binary optimizations are enabled by -O3 by using:
gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
diff /tmp/O2-opts /tmp/O3-opts | grep enabled
--versionโ Displays the version number and copyrights of the invoked GCC. ๐-pass-exit-codes,--pass-exit-codesโ Normally thegccprogram exits with the code of1if any phase of the compiler returns a non-success return code. But if you specify-pass-exit-codes, thegccprogram instead returns with the numerically highest error produced by any phase that returned an error indication. The C, C++, and Fortran front ends return4if an internal compiler error is encountered. ๐ซถ-pipe,--pipeโ Use pipes rather than temporary files for communication between the various stages of compilation. Ngl this fails to work on some systems where the assembler is unable to read from a pipe; but the GNU assembler has no trouble at all. ๐-wrapperโ Invoke all subcommands under a wrapper program. The name of the wrapper program and its parameters are passed as a comma separated list.
gcc -c t.c -wrapper gdb,--args
This invokes all subprograms of gcc under gdb --args, so the invocation of cc1 is gdb --args cc1 .... โจ
-ffile-prefix-map=old=newโ When compiling files residing in directory old, record any references to them in the result of the compilation as if the files resided in directory new instead. Specifying this option is equivalent to specifying all the individual-f*-prefix-mapoptions. This can be used to make reproducible builds that are location independent. ๐ฏ Directories referenced by directives are not affected by these options. See also-fmacro-prefix-map,-fdebug-prefix-map,-fprofile-prefix-mapand-fcanon-prefix-map.-fcanon-prefix-mapโ For the-f*-prefix-mapoptions, normally the comparison of old prefix against the filename that would normally be referenced in the result of the compilation is done using textual comparison of the prefixes, or by ignoring character case for case insensitive filesystems and considering slashes and backslashes as equal on DOS based filesystems. The-fcanon-prefix-mapcauses such comparisons to be done on canonicalized paths of old and the referenced filename. ๐ฆ-fplugin=name.soโ Load the plugin code in file name.so, assumed to be a shared object to bedlopen'd by the compiler. The base name of the shared object file is used to identify the plugin for the purposes of argument parsing (see-fplugin-arg-name-key=valuebelow). Each plugin should define the callback functions specified in the Plugins API. ๐-fplugin-arg-name-key=valueโ Define an argument called key with a value of value for the plugin called name. ๐-fdump-ada-spec[-slim]โ For C and C++ source and include files, generate corresponding Ada specs. ๐-fada-spec-parent=unitโ In conjunction with-fdump-ada-spec[-slim]above, generate Ada specs as child units of parent unit. ๐ง-fdump-go-spec=fileโ For input files in any language, generate corresponding Go declarations in file. This generates Go"const","type","var", and"func"declarations which may be a useful way to start writing a Go interface to code written in some other language. ๐@fileโ Read command-line options from file. The options read are inserted in place of the original@fileoption. If file does not exist, or cannot be read, then the option will be treated literally, and not removed.
Options in file are separated by whitespace. A whitespace character may be included in an option by surrounding the entire option in either single or double quotes. Any character (including a backslash) may be included by prefixing the character to be included with a backslash. The file may itself contain additional @file options; any such options will be processed recursively. ๐ญ
Compiling C++ Programs ๐
C++ source files conventionally use one of the suffixes .C, .cc, .cpp, .CPP, .c++, .cp, or .cxx; C++ header files often use .hh, .hpp, .H, or (for shared template code) .tcc; preprocessed C++ files use the suffix .ii; and C++20 module interface units sometimes use .ixx, .cppm, .cxxm, .c++m, or .ccm. ๐
GCC recognizes files with these names and compiles them as C++ programs even if you call the compiler the same way as for compiling C programs (usually with the name gcc). No cap. ๐
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. ๐ธ
Options Controlling C Dialect ๐
The following options control the dialect of C (or languages derived from C, such as C++, Objective-C and Objective-C++) that the compiler accepts:
-ansi,--ansiโ In C mode, this is equivalent to-std=c90. In C++ mode, it is equivalent to-std=c++98. ๐ซถ-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 -ansi for C code.
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 <https://gcc.gnu.org/projects/c-status.html> for more information. The names c9x and iso9899:199x are deprecated.
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 c1x is deprecated.
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.
c23c2xiso9899:2024
ISO C23, the 2023 revision of the ISO C standard (published in 2024). The name c2x is deprecated.
c2y
The next version of the ISO C standard, still under development. The support for this version is experimental and incomplete.
gnu90gnu89
GNU dialect of ISO C90 (including some C99 features).
gnu99gnu9x
GNU dialect of ISO C99. The name gnu9x is deprecated.
gnu11gnu1x
GNU dialect of ISO C11. The name gnu1x is deprecated.
gnu17gnu18
GNU dialect of ISO C17.
gnu23gnu2x
GNU dialect of ISO C23. This is the default for C code. The name gnu2x is deprecated.
gnu2y
The next version of the ISO C standard, still under development, plus GNU extensions. The support for this version is experimental and incomplete. The name gnu2x is deprecated.
c++98c++03
The 1998 ISO C++ standard plus the 2003 technical corrigendum and some additional defect reports. Same as -ansi for C++ code.
gnu++98gnu++03
GNU dialect of -std=c++98.
c++11c++0x
The 2011 ISO C++ standard plus amendments. The name c++0x is deprecated.
gnu++11gnu++0x
GNU dialect of -std=c++11. The name gnu++0x is deprecated. ๐
c++14,c++1yโ the 2014 ISO C++ standard plus amendments. btw the namec++1yis deprecated ๐gnu++14,gnu++1yโ GNU dialect of-std=c++14. The namegnu++1yis deprecated.c++17,c++1zโ the 2017 ISO C++ standard plus amendments. The namec++1zis deprecated.gnu++17,gnu++1zโ GNU dialect of-std=c++17. The namegnu++1zis deprecated.c++20,c++2aโ the 2020 ISO C++ standard plus amendments. C++20 modules support is still experimental and needs to be enabled with the-fmodulesoption. The namec++2ais deprecated.gnu++20,gnu++2aโ GNU dialect of-std=c++20. This is the default for C++ code. ๐ C++20 modules support is still experimental and needs to be enabled with the-fmodulesoption. The namegnu++2ais deprecated.c++23,c++2bโ the 2023 ISO C++ standard plus amendments (published in 2024). Support is experimental, and could change in incompatible ways in future releases. The namec++2bis deprecated.gnu++23,gnu++2bโ GNU dialect of-std=c++23. Support is experimental, and could change in incompatible ways in future releases. The namegnu++2bis deprecated.c++2c,c++26โ the next revision of the ISO C++ standard, planned for 2026. Support is highly experimental, and will almost certainly change in incompatible ways in future releases. ๐gnu++2c,gnu++26โ GNU dialect of-std=c++2c. Support is highly experimental, and will almost certainly change in incompatible ways in future releases.
-aux-infofilename โ writes to the given filename the prototyped declarations for all functions declared and/or defined in a translation unit, including the ones chilling in header files. Lowkey important: this option is silently ignored in any language that isn't C. ๐
Besides the declarations themselves, the file also tells you, in comments, the origin of each declaration (source file and line), whether the declaration was implicit, prototyped or unprototyped (I, N for new or O for old โ that's the first character after the line number and the colon), and whether it came from a declaration or a definition (C or F โ that's the next character). And for function definitions, there's also a K&R-style list of arguments followed by their declarations, handed to you inside comments, after the declaration. cute.
-fno-asmโ do not recognize"asm","inline"or"typeof"as keywords, so your code can use these words as identifiers instead. You can use"__asm__","__inline__"and"__typeof__"in their place. In C,-ansiimplies-fno-asm.
In C++, "inline" is a standard keyword and is not affected by this switch โ you might wanna reach for -fno-gnu-keywords instead, which disables "typeof" but leaves "asm" and "inline" alone. In C99 mode (-std=c99 or -std=gnu99), this switch only touches the "asm" and "typeof" keywords, since "inline" is a standard keyword in ISO C99. And in C23 mode (-std=c23 or -std=gnu23), it only affects "asm", since "typeof" is a standard keyword in ISO C23. the way standards keep moving ๐
-fno-builtin,-fno-builtin-functionโ don't recognize built-in functions that do not begin with__builtin_as a prefix.
Normally GCC generates special code to handle certain built-in functions more efficiently โ for instance, calls to "alloca" may become single instructions that adjust the stack directly, and calls to "memcpy" may become inline copy loops. The resulting code is often both smaller and faster, but since the function calls no longer appear as such, you can't set a breakpoint on those calls, nor can you change the behavior of the functions by linking with a different library. Also, once a function is recognized as a built-in, GCC may use info about it to warn you about problems with calls to it, or to generate more efficient code โ even if the resulting code still contains calls to that function. For example, warnings get given with -Wformat for bad calls to "printf" when "printf" is built in, and when "strlen" is known not to modify global memory.
With the -fno-builtin-function option, only the one built-in function is disabled. function must not begin with __builtin_. If you name a function that isn't built-in in this version of GCC, the option is just ignored. And here's the kicker: there is no corresponding -fbuiltin-function option; if you wanna enable built-in functions selectively while using -fno-builtin or -ffreestanding, you may define macros such as:
#define abs(n) __builtin_abs ((n))
#define strcpy(d, s) __builtin_strcpy ((d), (s))
-fcond-mismatchโ allow conditional expressions with mismatched types in the second and third arguments. The value of such an expression isvoid. This option is not supported for C++.-ffreestandingโ assert that compilation targets a freestanding environment. This implies-fno-builtin. A freestanding environment is one where the standard library may not exist, and program startup may not necessarily be at"main". The most obvious example is an OS kernel. This is equivalent to-fno-hosted.-fgimpleโ enable parsing of function definitions marked with"__GIMPLE". This is an experimental feature that allows unit testing of GIMPLE passes. โจ-fgnu-tmโ when-fgnu-tmis specified, the compiler generates code for the Linux variant of Intel's current Transactional Memory ABI specification document (Revision 1.1, May 6 2009). This is an experimental feature whose interface may change in future versions of GCC, as the official specification changes. Please note that not all architectures are supported for this feature.
For more information on GCC's support for transactional memory,
Note that the transactional memory feature is not supported with non-call exceptions (-fnon-call-exceptions).
-fgnu89-inlineโ tells GCC to use the traditional GNU semantics for"inline"functions when in C99 mode.
Using this option is roughly equivalent to adding the "gnu_inline" function attribute to all inline functions.
The option -fno-gnu89-inline explicitly tells GCC to use the C99 semantics for "inline" when in C99 or gnu99 mode (i.e., it specifies the default behavior). This option is not supported in -std=c90 or -std=gnu90 mode.
The preprocessor macros "__GNUC_GNU_INLINE__" and "__GNUC_STDC_INLINE__" may be used to check which semantics are in effect for "inline" functions.
-fhostedโ assert that compilation targets a hosted environment. This implies-fbuiltin. A hosted environment is one where the entire standard library is available, and where"main"has a return type of"int". Examples are nearly everything except a kernel. This is equivalent to-fno-freestanding.-flax-vector-conversionsโ allow implicit conversions between vectors with differing numbers of elements and/or incompatible element types. This option should not be used for new code. ๐-fms-extensionsโ accept some non-standard constructs used in Microsoft header files.
In C++ code, this lets member names in structures be similar to previous types declarations.
typedef int UOW;
struct ABC {
UOW UOW;
};
Some cases of unnamed fields in structures and unions are only accepted with this option.
Note that this option is off for all targets except for x86 targets using ms-abi.
-fpermitted-flt-eval-methods=styleโ ISO/IEC TS 18661-3 defines new permissible values for"FLT_EVAL_METHOD"that indicate operations and constants with a semantic type that is an interchange or extended format should be evaluated to the precision and range of that type. These new values are a superset of those permitted under C99/C11, which does not specify the meaning of other positive values of"FLT_EVAL_METHOD". As such, code conforming to C11 may not have been written expecting the possibility of the new values. ๐ญ
-fpermitted-flt-eval-methods specifies whether the compiler should allow only the values of "FLT_EVAL_METHOD" specified in C99/C11, or the extended set of values specified in ISO/IEC TS 18661-3.
style is either "c11" or "ts-18661-3" as appropriate.
The default when in a standards compliant mode (-std=c11 or similar) is -fpermitted-flt-eval-methods=c11. The default when in a GNU dialect (-std=gnu11 or similar) is -fpermitted-flt-eval-methods=ts-18661-3.
The -fdeps-* options are used to extract structured dependency information for a source. This involves determining what resources provided by other source files will be required to compile the source, as well as what resources are provided by the source. This information can be used to add required dependencies between compilation rules of dependent sources based on their contents, rather than requiring such information be reflected within the build tools as well. ๐ฆ
-fdeps-file=fileโ where to write structured dependency information.-fdeps-format=formatโ the format to use for structured dependency information.p1689r5is the only supported format right now. Note that when this argument is specified, the output of-MFis stripped of some information (namely C++ modules) so that it does not use extended makefile syntax not understood by most tools.-fdeps-target=fileโ analogous to-MTbut for structured dependency information. This indicates the target which will ultimately need any required resources, and provide any resources extracted from the source that may be required by other sources.-fplan9-extensionsโ accept some non-standard constructs used in Plan 9 code.
This enables -fms-extensions, permits passing pointers to structures with anonymous fields to functions that expect pointers to elements of the type of the field, and permits referring to anonymous fields declared using a typedef. This is only supported for C, not C++.
-fsigned-bitfields,-funsigned-bitfields,-fno-signed-bitfields,-fno-unsigned-bitfieldsโ bestie, these four control whether a bit-field is signed or unsigned when the declaration doesn't bother to saysignedorunsignedout loud. By default, such a bit-field is signed, because that's the consistent thing: the basic integer types likeintare signed types, so the bit-field matches the vibe. โจ
-fsigned-char,-funsigned-charโ-fsigned-charlets the typecharbe signed, likesigned char, while-funsigned-charlets the typecharbe unsigned, likeunsigned char.
Not me pointing out the aliasing situation: -fsigned-char 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. It's giving mirror-universe energy. ๐ช
Every target GCC supports has a default for what char should be, and it's typically specified in the processor-specific ABI document for that target. So it's either like unsigned char by default, or like signed char by default. No in-between, pick a lane.
Ideally โ and I mean ideally โ a portable program should always use signed char or unsigned char when it depends on the signedness of an object. But many programs out here were written to use plain char and expect it to be signed, or expect it to be unsigned, depending on the machines they were written for. These options let you make such a program work with the opposite default. So generous of GCC honestly. ๐ซถ
And 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. Distinct. Different. Separate identity. Periodt.
-fstrict-flex-arrays(C and C++ only),-fstrict-flex-arrays=level(C and C++ only) โ these control when to treat the trailing array of a structure as a flexible array member for the purpose of accessing the elements of such an array. The value of level controls the level of strictness. ๐๏ธ
-fstrict-flex-arrays is equivalent to -fstrict-flex-arrays=3, which is the strictest: a trailing array is treated as a flexible array member only when it is declared as a flexible array member per C99 standard onwards.
The negative form -fno-strict-flex-arrays is equivalent to -fstrict-flex-arrays=0, which is the least strict. In this case all trailing arrays of structures are treated as flexible array members. Chaotic. Love that for them.
There are two more levels in between 0 and 3, and they exist to support older code that uses the GCC zero-length array extension ([0]) or one-element array as flexible array members ([1]). When level is 1, the trailing array is treated as a flexible array member when it is declared as either [], [0], or [1]. When level is 2, the trailing array is treated as a flexible array member when it is declared as either [], or [0].
You can control this behavior for a specific trailing array field of a structure by using the variable attribute strict_flex_array attribute. So specific. So targeted. ๐
The -fstrict_flex_arrays option interacts with the -Wstrict-flex-arrays option. (Yes, the underscores vs dashes thing is exactly as written, iykyk.)
-fsso-struct=endiannessโ sets the default scalar storage order of structures and unions to the specified endianness. The accepted values arebig-endian,little-endianandnativefor the native endianness of the target (which is the default). This option is not supported for C++. Sorry C++ girlies, not today. ๐ซ
โ ๏ธ Warning: the -fsso-struct switch causes GCC to generate code that is not binary compatible with code generated without it if the specified endianness is not the native endianness of the target. Not a drill. Not a vibe. Actual danger.
โจ Options Controlling C++ Dialect โจ
This section describes the command-line options that are only meaningful for C++ programs. You can also use most of the GNU compiler options regardless of what language your program is in. For example, you might compile a file firstClass.C like this:
g++ -g -fstrict-enums -O -c firstClass.C
In this example, only -fstrict-enums is an option meant only for C++ programs; you can use the other options with any language supported by GCC. She's versatile like that. ๐
Some options for compiling C programs, such as -std, are also relevant for C++ programs.
Here is a list of options that are only for compiling C++ programs:
--compile-std-moduleโ builds the compiled module interfaces for the<bits/stdc++.h>header unit and thestdandstd.compatmodules before compiling any source files explicitly specified on the command line. This is intended to be useful for building simple programs that useimport std;with a single command. One command, whole module, slay. ๐ฅ-fabi-version=nโ use version n of the C++ ABI. The default is version 0.
Version 0 refers to the version conforming most closely to the C++ ABI specification. Therefore, the ABI obtained using version 0 will change in different versions of G++ as ABI bugs are fixed. She's a moving target and she knows it. ๐
Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
Version 2 is the version of the C++ ABI that first appeared in G++ 3.4, and was the default through G++ 4.9.
Version 3 corrects an error in mangling a constant address as a template argument.
Version 4, which first appeared in G++ 4.5, implements a standard mangling for vector types.
Version 5, which first appeared in G++ 4.6, corrects the mangling of attribute const/volatile on function pointer types, decltype of a plain decl, and use of a function parameter in the declaration of another parameter.
Version 6, which first appeared in G++ 4.7, corrects the promotion behavior of C++11 scoped enums and the mangling of template argument packs, const/static_cast, prefix ++ and --, and a class scope function used as a template argument.
Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a builtin type and corrects the mangling of lambdas in default argument scope.
Version 8, which first appeared in G++ 4.9, corrects the substitution behavior of function types with function-cv-qualifiers.
Version 9, which first appeared in G++ 5.2, corrects the alignment of nullptr_t.
Version 10, which first appeared in G++ 6.1, adds mangling of attributes that affect type identity, such as ia32 calling convention attributes (e.g. stdcall).
Version 11, which first appeared in G++ 7, corrects the mangling of sizeof... expressions and operator names. For multiple entities with the same name within a function, that are declared in different scopes, the mangling now changes starting with the twelfth occurrence. It also implies -fnew-inheriting-ctors.
Version 12, which first appeared in G++ 8, corrects the calling conventions for empty classes on the x86_64 target and for classes with only deleted copy/move constructors. It accidentally changes the calling convention for classes with a deleted copy constructor and a trivial move constructor. Accidentally. Oopsie. ๐ญ
Version 13, which first appeared in G++ 8.2, fixes the accidental change in version 12. See, they fixed it, we can all breathe.
Version 14, which first appeared in G++ 10, corrects the mangling of the nullptr expression.
Version 15, which first appeared in G++ 10.3, corrects G++ 10 ABI tag regression.
Version 16, which first appeared in G++ 11, changes the mangling of __alignof__ to be distinct from that of alignof, and dependent operator names.
Version 17, which first appeared in G++ 12, fixes layout of classes that inherit from aggregate classes with default member initializers in C++14 and up.
Version 18, which first appeared in G++ 13, fixes manglings of lambdas that have additional context.
Version 19, which first appeared in G++ 14, fixes manglings of structured bindings to include ABI tags, handling of cv-qualified [[no_unique_address]] members, and adds mangling of C++20 constraints on function templates.
Version 20, which first appeared in G++ 15, fixes manglings of lambdas in static data member initializers.
Version 21, which first appeared in G++ 16, fixes unnecessary captures in noexcept lambdas (c++/119764), layout of a base class with all explicitly defaulted constructors (c++/120012), and mangling of class and array objects with implicitly zero-initialized non-trailing subobjects (c++/121231).
See also -Wabi.
-fabi-compat-version=nโ on targets that support strong aliases, G++ works around mangling changes by creating an alias with the correct mangled name when defining a symbol with an incorrect mangled name. This switch specifies which ABI version to use for the alias. Bestie is out here writing aliases like a note-passing queen. ๐
With -fabi-version=0 (the default), this defaults to 13 (GCC 8.2 compatibility). If another ABI version is explicitly selected, this defaults to 0. For compatibility with GCC versions 3.2 through 4.9, use -fabi-compat-version=2.
If this option is not provided but -Wabi=n is, that version is used for compatibility aliases. If this option is provided along with -Wabi (without the version), the version from this option is used for the warning.
-fno-access-controlโ turns off all access checking. This switch is mainly useful for working around bugs in the access control code. Living dangerously, no gatekeeping, everyone's invited to the private party. ๐-faligned-new,-faligned-new=alignmentโ enables support for C++17newof types that require more alignment thanvoid* ::operator new(std::size_t)provides. A numeric argument such as-faligned-new=32can be used to specify how much alignment (in bytes) is provided by that function, but few users will need to override the default ofalignof(std::max_align_t). Most of y'all? Leave the default alone, she's fine. ๐
This flag is enabled by default for -std=c++17.
-fno-assume-sane-operators-newโ okay so listen up bestie, the C++ standard allows replacing the global"new","new[]","delete"and"delete[]"operators, even though a lot of C++ programs don't replace them and just use the implementation provided version. Furthermore, the C++ standard allows omitting those calls if they are made from new or delete expressions (and by extension the same is assumed if__builtin_operator_newor__builtin_operator_deletefunctions are used). This option allows control over some optimizations around calls to those operators. With-fassume-sane-operators-new-deleteoption GCC may assume that calls to the replaceable global operators from new or delete expressions or from__builtin_operator_newor__builtin_operator_deletecalls don't read or modify any global variables or variables whose address could escape to the operators (global state; except forerrnofor the"new"and"new[]"operators). This allows most optimizations across those calls and is something that the implementation provided operators satisfy unlessmallocimplementation details are observable in the code or unlessmallochooks are used, but might not be satisfied if a program replaces those operators. This behavior is enabled by default. With-fno-assume-sane-operators-new-deleteoption GCC must assume all these calls (whether from new or delete expressions or called directly) may read and write global state unless proven otherwise (e.g. when GCC compiles their implementation). Use this option if those operators are or may be replaced and code needs to expect such behavior.-fchar8_t,-fno-char8_tโ Enable support for"char8_t"as adopted for C++20. This includes the addition of a new"char8_t"fundamental type, changes to the types of UTF-8 string and character literals, new signatures for user-defined literals, associated standard library updates, and new__cpp_char8_tand__cpp_lib_char8_tfeature test macros.
This option enables functions to be overloaded for ordinary and UTF-8 strings:
int f(const char *); // #1
int f(const char8_t *); // #2
int v1 = f("text"); // Calls #1
int v2 = f(u8"text"); // Calls #2
and introduces new signatures for user-defined literals:
int operator""_udl1(char8_t);
int v3 = u8'x'_udl1;
int operator""_udl2(const char8_t*, std::size_t);
int v4 = u8"text"_udl2;
template<typename T, T...> int operator""_udl3();
int v5 = u8"text"_udl3;
The change to the types of UTF-8 string and character literals introduces incompatibilities with ISO C++11 and later standards. For example, the following code is well-formed under ISO C++11, but is ill-formed when -fchar8_t is specified.
const char *cp = u8"xx";// error: invalid conversion from
// `const char8_t*' to `const char*'
int f(const char*);
auto v = f(u8"xx"); // error: invalid conversion from
// `const char8_t*' to `const char*'
std::string s{u8"xx"}; // error: no matching function for call to
// `std::basic_string<char>::basic_string()'
using namespace std::literals;
s = u8"xx"s; // error: conversion from
// `basic_string<char8_t>' to non-scalar
// type `basic_string<char>' requested
-fcheck-newโ Check that the pointer returned byoperator newis non-null before attempting to modify the storage allocated. This check is normally unnecessary because the C++ standard specifies thatoperator newonly returns 0 if it is declaredthrow(), in which case the compiler always checks the return value even without this option. In all other cases, whenoperator newhas a non-empty exception specification, memory exhaustion is signalled by throwingstd::bad_alloc. See alsonew (nothrow).-fconceptsโ Enable support for the C++ Concepts feature for constraining template arguments. With-std=c++20and above, Concepts are part of the language standard, so-fconceptsdefaults to on.
Some constructs that were allowed by the earlier C++ Extensions for Concepts Technical Specification, ISO 19217 (2015), but didn't make it into the standard, could additionally be enabled by -fconcepts-ts. The option -fconcepts-ts was deprecated in GCC 14 and removed in GCC 15; users are expected to convert their code to C++20 concepts.
-fconcepts-diagnostics-depth=nโ Specify maximum error replay depth during recursive diagnosis of a constraint satisfaction failure. The default is 1. fr fr.-fconstexpr-depth=nโ Set the maximum nested evaluation depth for C++11 constexpr functions to n. A limit is needed to detect endless recursion during constant expression evaluation. The minimum specified by the standard is 512.-fconstexpr-cache-depth=nโ Set the maximum level of nested evaluation depth for C++11 constexpr functions that will be cached to n. This is a heuristic that trades off compilation speed (when the cache avoids repeated calculations) against memory consumption (when the cache grows very large from highly recursive evaluations). The default is 8. Very few users are likely to want to adjust it, but if your code does heavy constexpr calculations you might want to experiment to find which value works best for you. ngl, this one is lowkey niche but highkey useful if you're doing wild constexpr stuff.-fconstexpr-fp-exceptโ Annex F of the C standard specifies that IEC559 floating point exceptions encountered at compile time should not stop compilation. C++ compilers have historically not followed this guidance, instead treating floating point division by zero as non-constant even though it has a well defined value. This flag tells the compiler to give Annex F priority over other rules saying that a particular operation is undefined.
constexpr float inf = 1./0.; // OK with -fconstexpr-fp-except
-fconstexpr-loop-limit=nโ Set the maximum number of iterations for a loop in C++14 constexpr functions to n. A limit is needed to detect infinite loops during constant expression evaluation. The default is 262144 (1<<18).-fconstexpr-ops-limit=nโ Set the maximum number of operations during a single constexpr evaluation. Even when number of iterations of a single loop is limited with the above limit, if there are several nested loops and each of them has many iterations but still smaller than the above limit, or if in a body of some loop or even outside of a loop too many expressions need to be evaluated, the resulting constexpr evaluation might take too long. The default is 33554432 (1<<25).-fcontractsโ Enable support for the C++ Contracts feature, as specified in the C++26 working draft (N5003).
On violation of an enforced or observed contract (see -fcontract-evaluation-semantic below), a violation handler is called; the standard library provides a default handler that emits information about the contract that failed.
Users can replace the default violation handler by defining
void
handle_contract_violation (const std::contracts::contract_violation&);
-fcontract-evaluation-semantic=semanticโ Set the semantic with which contracts will be evaluated to semantic.
Available values for the evaluation mode are:
"ignored"โ The contract checks will be elided, with no checking added at either compile or runtime."observed"โ The contract checks are performed (at runtime) and, if one fails, a handler is called that allows actions such as logging or emitting run-time warnings. When the handler returns, the execution of the code will continue. At compile-time the checks are performed forconstexprevaluations, in this case a diagnostic is emitted if the check fails."enforce"โ The contract checks are performed and the handler is called if one fails. When the handler returns the execution of the code is terminated preventing it from continuing past the failed case. At compile-time the checks are applied toconstexprand, if one fails, the program is ill-formed; an error will be emitted."quick_enforce"โ The contract checks are performed (at runtime) and, if one fails, the execution is terminated immediately (without calling any handler). At compile-time there is no difference in behaviour between this option and the"enforce"case, since no handler is invoked at compile time.
-fcontracts-conservative-ipaโ This prevents inter-procedural analysis from taking action when the body of an inline function is visible in a given TU. This allows for the case that contract evaluation conditions are permitted to differ between TUs which means that such actions would be potentially incorrect. bestie, this is the cautious vibe.-fcontract-checks-outlinedโ By default, contract checks for"pre"and"post"condition checks are expanded in-line into function bodies. This option causes a small function to be created instead (containing the checks) that is called in the relevant position. This permits different criteria to be applied to the compilation of the checking and the remainder of the function body. slay.-fcontract-disable-optimized-checksโ When"pre"and"post"condition checks are outlined (using-fcontract-checks-outlined), this option disables the optimisation steps for those functions which can avoid unwanted elision of checking steps. periodt.-fcontracts-client-check=modeโ This option enables insertion of checks at call sites (caller-side checking).
The value of mode determines which contract checks are made:
"none"โ No caller/client side checking (default)"pre"โ Preconditions are checked at the caller/client side."all"โ Both pre and post-conditions are checked at the caller/client side.
-fcontracts-definition-check=modeโ This option introduces the ability to disable callee/definition-side checks, which are otherwise enabled by default when the contracts feature is active.
The variable mode has the values "on" and "off". iykyk.
-fcoroutinesโ turns on support for the C++ coroutines extension. okay so with-std=c++20and up, coroutines are literally part of the language standard, so-fcoroutinesdefaults to on. it's giving automatic slay โจ-fdiagnostics-all-candidatesโ lets the C++ front end spill every single candidate when overload resolution fails, including when a deleted function is the one that got selected. no gatekeeping, bestie ๐-fdump-lang-fdump-lang-switch-fdump-lang-switch-options-fdump-lang-switch-options=filenameโ these control the dumping of C++-specific info ๐ซถ. theoptionsandfilenameparts behave exactly like the-fdump-treeoption describes. here are the switch values you can pass:allโ enable all of the below. the whole buffet, no cap ๐classโ dump class hierarchy information. virtual table info gets emitted too, unlessslimis specified.moduleโ dump module information. the optionslineno(locations),graph(reachability),blocks(clusters),uid(serialization),alias(mergeable),asmname(Elrond),eh(mapper) &vops(macros) may provide additional information.rawโ dump the raw internal tree data. the unfiltered truth ๐tinstโ dump the sequence of template instantiations, indented to show the depth of recursion ๐. thelinenooption adds the source location where the instantiation was triggered, and thedetailsoption also dumps pre-instantiation substitutions, like those performed during template argument deduction.
Lines in the .tinst dump start with I for an instantiation, S for another substitution, and R[IS] for the reopened context of a deferred instantiation. iykyk ๐
-fno-elide-constructorsโ 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 that would otherwise be expanded inline.
In C++17, the compiler is required to omit these temporaries, but this option still affects trivial member functions. so yeah, still relevant fr fr
-fno-enforce-eh-specsโ don't generate code to check for violations of exception specifications at run time. this option violates the C++ standard, but it can be useful for reducing code size in production builds, a lot like definingNDEBUG.
โ ๏ธ this does not give user code permission to throw exceptions in violation of the exception specifications! the compiler still optimizes based on those specifications, so throwing an unexpected exception results in undefined behavior at run time. do not play with this one ๐
-fextern-tls-init-fno-extern-tls-initโ the C++11 and OpenMP standards allowthread_localandthreadprivatevariables to have dynamic (runtime) initialization. to support that, any use of such a variable goes through a wrapper function that performs any necessary initialization ๐ธ.
when the use and the definition of the variable are in the same translation unit, that overhead can be optimized away โ but when the use is in a different translation unit, there's significant overhead even if the variable doesn't actually need dynamic initialization. so if the programmer can be sure that no use of the variable in a non-defining TU needs to trigger dynamic initialization (either because the variable is statically initialized, or a use of the variable in the defining TU will be executed before any uses in another TU), they can dodge that overhead with -fno-extern-tls-init โจ
On targets that support symbol aliases, the default is -fextern-tls-init. On targets that don't support symbol aliases, the default is -fno-extern-tls-init. pick your fighter ๐
-ffold-simple-inlines-fno-fold-simple-inlinesโ permit the C++ frontend to fold calls tostd::move,std::forward,std::addressof,std::to_underlyingandstd::as_const. in contrast to inlining, this means no debug information will be generated for such calls. since these functions are rarely interesting to debug, this flag is enabled by default unless-fno-inlineis active. iconic behavior honestly ๐ซถ-fno-gnu-keywordsโ don't recognizetypeofas a keyword, so your code can use that word as an identifier. you can use the keyword__typeof__instead. this option is implied by the strict ISO C++ dialects:-ansi,-std=c++98,-std=c++11, etc. โจ-fno-immediate-escalationโ don't enable immediate function escalation, whereby certain functions can be promoted toconsteval, as specified in P2564R3. for example:
consteval int id(int i) { return i; }
constexpr int f(auto t)
{
return t + id(t); // id causes f<int> to be promoted to consteval
}
void g(int i)
{
f (3);
}
compiles in C++20: f is an immediate-escalating function (because of the auto it's a function template and it's declared constexpr) and id(t) is an immediate-escalating expression, so f gets promoted to consteval. consequently, the call to id(t) is in an immediate context, so it doesn't have to produce a constant โ that's the mechanism that allows consteval function composition ๐ง.
however, with -fno-immediate-escalation, f is not promoted to consteval, and since the call to consteval function id(t) isn't a constant expression, the compiler rejects the code.
this option is turned on by default; it's only effective in C++20 mode or later. โญ
-fimplicit-constexprโ make inline functions implicitlyconstexpr, if they satisfy the requirements for aconstexprfunction. you can use this option in C++14 mode or later. this can result in initialization changing from dynamic to static, plus other optimizations ๐ฅ-fno-implicit-templatesโ never emit code for non-inline templates that are instantiated implicitly (i.e. by use); only emit code for explicit instantiations.
โ ๏ธ if you use this option, you must take care to structure your code so it includes all the necessary explicit instantiations, otherwise you'll get undefined symbols at link time ๐ญ
-fno-implicit-inline-templatesโ don't emit code for implicit instantiations of inline templates, either. the default handles inlines differently so that compiles with and without optimization need 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 ๐
-fmodules-fno-modulesโ enable support for C++20 modules.-fno-modulesusually isn't needed, since that's the default. even though this is a C++20 feature, it's not currently implicitly enabled by selecting that standard version. the vibes are: you gotta ask for it ๐-fmodule-header-fmodule-header=user-fmodule-header=systemโ compile a header file to create an importable header unit โจ-fmodule-implicit-inlineโ member functions defined in their class definitions are not implicitly inline for modular code. this differs from traditional C++ behavior, and for good reasons. however, it may cause difficulty during code porting. this option makes such function definitions implicitly inline.
โ ๏ธ it does generate an ABI incompatibility, so you must use it everywhere or nowhere โ no half-and-half, bestie ๐ญ. (such definitions outside of a named module remain implicitly inline regardless.)
-fno-module-lazyโ disable lazy module importing and module mapper creation ๐ค-fmodule-mapper=[hostname]:port[?ident]-fmodule-mapper=|program[?ident] args...-fmodule-mapper==socket[?ident]-fmodule-mapper=<>[inout][?ident]-fmodule-mapper=<in>out[?ident]-fmodule-mapper=file[?ident]โ an oracle to query for module name to filename mappings ๐ฎ. if unspecified, theCXX_MODULE_MAPPERenvironment variable is used, and if that's unset, an in-process default is provided. so there's always a fallback, periodt ๐-fmodule-onlyโ only emit the Compiled Module Interface, inhibiting any object file ๐-fms-extensionsโ disableWpedanticwarnings about constructs used in MFC, such as implicit int and getting a pointer to member function via non-standard syntax. letting the legacy vibes breathe ๐ซถ-fnew-inheriting-ctorsโ enable the P0136 adjustment to the semantics of C++11 constructor inheritance. this is 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โ enable the P0522 resolution to Core issue 150, template template parameters and default arguments: this allows a template with default template arguments as an argument for a template template parameter with fewer template parameters. this flag is enabled by default for-std=c++17๐ธ-fno-nonansi-builtinsโ disable built-in declarations of functions that aren't mandated by ANSI/ISO C. these includeffs,alloca,_exit,index,bzero,conjf, and other related functions. bye bye ๐-fnothrow-optโ treat athrow()exception specification as if it were anoexceptspecification, to reduce or eliminate the text size overhead relative to a function with no exception specification. if the function has local variables of types with non-trivial destructors, the exception specification actually makes the function smaller, because the EH cleanups for those variables can be optimized away โจ
the semantic effect: an exception thrown out of a function with such an exception specification results in a call to terminate rather than unexpected ๐
-fno-operator-namesโ don't treat the operator name keywordsand,bitand,bitor,compl,not,orandxoras synonyms as keywords ๐-fno-optional-diagsโ disable diagnostics that the standard says a compiler doesn't need to issue. currently, the only such diagnostic issued by G++ is the one for a name having multiple meanings within a class. lowkey optional, so it's optional ๐-fno-pretty-templatesโ okay so bestie, when the compiler yells at you about a specialization of a function template, it normally prints the whole signature, then the template arguments, then any typedefs or typenames hanging out in there (likevoid f(T) [with T = int]instead of justvoid f(int)) so you can actually tell which template is the problem. And when it's a class template specialization, it skips any template arguments that match that template's defaults. If those two behaviors are making your error messages more confusing instead of less, this flag turns them both off. ๐-frange-for-ext-tempsโ turns on lifetime extension for C++ range-basedfortemporaries. With-std=c++23and up this is literally just part of the language standard, so the temporaries live until the end of the loop by default. This option lets you get that same behavior in earlier versions of the standard too. โจ-freflectionโ enables experimental C++26 Reflection. it's giving โจfutureโจ, no cap.-fno-rttiโ stops the compiler from generating info about every class with virtual functions for the C++ run-time type identification features (dynamic_castandtypeid). If you're not using those parts of the language, this flag saves you some space. Note that exception handling uses the same information, but G++ generates it as needed. And thedynamic_castoperator can still be used for casts that don't need run-time type info โ like casts tovoid *or to unambiguous base classes. ๐ซถ
Mixing code compiled with-frttiand code compiled with-fno-rttimay not work. For real. For example, programs may fail to link if a class compiled with-fno-rttiis 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. And the flag -Wsized-deallocation warns you about places that might want to add a definition. ๐
-fstrict-enumsโ lets the compiler optimize using the assumption that a value of an enumerated type can only be one of the values of the enumeration (as defined in the C++ standard โ basically, a value representable 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. Heads up: this option has no effect for an enumeration type with a fixed underlying type.-fstrong-eval-order-fstrong-eval-order=kindโ evaluates member access, array subscripting, and shift expressions in left-to-right order, and evaluates assignment in right-to-left order, as adopted for C++17.-fstrong-eval-orderis equivalent to-fstrong-eval-order=all, and it's enabled by default with-std=c++17or later. ๐-fstrong-eval-order=someenables just the ordering of member access and shift expressions, and is the default for C++ dialects prior to C++17.-fstrong-eval-order=noneis equivalent to-fno-strong-eval-order.
-ftemplate-backtrace-limit=nโ sets the max number of template instantiation notes for a single warning or error to n. The default value is10.-ftemplate-depth=nโ sets the max instantiation depth for template classes to n. You need a limit on template instantiation depth to detect endless recursions during template class instantiation. ANSI/ISO C++ conforming programs must not rely on a maximum depth greater than 17 (changed to 1024 in C++11). The default value is900, since the compiler can run out of stack space before hitting 1024 in some situations. ๐-fno-threadsafe-staticsโ don't emit the extra code to use the routines specified in the C++ ABI for thread-safe initialization of local statics. You can use this option to reduce code size slightly in code that doesn't need to be thread-safe. lowkey a glow-down if you do need threads, so vibe check yourself first.-fuse-cxa-atexitโ registers 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 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 is necessary if the runtime routine is not available. ๐-fvisibility-inlines-hiddenโ this switch declares that the user does not attempt to compare pointers to inline functions or methods where the addresses of the two functions are taken in different shared objects. ๐
The effect of this is that GCC may, effectively, mark inline methods with __attribute__ ((visibility ("hidden"))) so 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. slay. โจ
The behavior of this switch is not quite the same as marking the methods as hidden directly, because it does not affect static variables local to the function or cause the compiler to deduce that the function is defined in only one shared object.
You may mark a method as having a visibility explicitly to negate the effect of the switch for that method. For example, if you do want to compare pointers to a particular inline method, you might mark it as having default visibility. Marking the enclosing class with explicit visibility has no effect.
Explicitly instantiated inline methods are unaffected by this option, as their linkage might otherwise cross a shared library boundary.
-fvisibility-ms-compatโ this flag attempts to use visibility settings to make GCC's C++ linkage model compatible with that of Microsoft Visual Studio.
The flag makes these changes to GCC's linkage model:
- 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's 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's a violation of the ODR to define types with the same name differently. ๐จ
-fno-weakโ don't use weak symbol support, even if the linker provides it. By default, G++ uses weak symbols if they're available. This option exists only for testing, and should not be used by end-users; it results in inferior code and has no benefits. This option may be removed in a future release of G++. not the vibe, bestie, stay away. ๐-fext-numeric-literals(C++ and Objective-C++ only) โ accept imaginary, fixed-point, or machine-defined literal number suffixes as GNU extensions. When this option is turned off, those suffixes are treated as C++11 user-defined literal numeric suffixes. This is on by default for all pre-C++11 dialects and all GNU dialects:-std=c++98,-std=gnu++98,-std=gnu++11,-std=gnu++14. This option is off by default for ISO C++11 onwards (-std=c++11, ...). ๐ธ-nostdinc++โ don't search for header files in the standard directories specific to C++, but do still search the other standard directories. (This option is used when building the C++ library.) ๐-flang-info-include-translate-flang-info-include-translate-not-flang-info-include-translate=headerโ inform of include translation events. The first will note accepted include translations, the second will note declined include translations. The header form will inform of include translations relating to that specific header. If header is of the form"user"or<system>it will be resolved to a specific user or system header using the include path. ๐ฆ-flang-info-module-cmi-flang-info-module-cmi=moduleโ inform of Compiled Module Interface pathnames. The first will note all read CMI pathnames. The module form will note reading a specific module's CMI. module may be a named module or a header-unit (the latter indicated by either being a pathname containing directory separators or enclosed in<>or""). ๐ง-stdlib=libstdc++,libc++โ when G++ is configured to support this option, it allows specification of alternate C++ runtime libraries. Two options are available:libstdc++(the default, native C++ runtime for G++) andlibc++which is the C++ runtime installed on some operating systems (e.g. Darwin versions from Darwin11 onwards). The option switches G++ to use the headers from the specified library and to emit-lstdc++or-lc++respectively, when a C++ runtime is required for linking. ๐
In addition, these warning options have meanings only for C++ programs:
-Wabi-tag(C++ and Objective-C++ only) โ warn when a type with an ABI tag is used in a context that does not have that ABI tag. See C++ Attributes for more information about ABI tags. โญ-Wno-abbreviated-auto-in-template-argโ disable the error for anautoplaceholder type used within a template argument list to declare a C++20 abbreviated function template, e.g.
void f(S<auto>);
okay so bestie, we're deep in the warning-flag section now and honestly? this is where the compiler becomes your nosy but loving bestie who notices everything ๐
This feature was proposed in the Concepts TS, but was not adopted into C++20; in the standard, a placeholder in a parameter declaration must appear as a decl-specifier. The error can also be reduced to a warning by -fpermissive or -Wno-error=abbreviated-auto-in-template-arg.
โจ -Wcomma-subscript <span>(C++ and Objective-C++ only)</span> โจ
not the comma-in-subscript situation ๐ This one warns you when you use a comma expression inside a subscripting expression. That usage got deprecated in C++20 and is getting straight-up removed in C++23. But plot twist: a comma expression wrapped in "( )" is not deprecated. Peep the example:
void f(int *a, int b, int c) {
a[b,c]; // deprecated in C++20, invalid in C++23
a[(b,c)]; // OK
}
In C++23 it is valid to have comma separated expressions in a subscript when an overloaded subscript operator is found and supports the right number and types of arguments. G++ will accept the formerly valid syntax for code that is not valid in C++23 but used to be valid but deprecated in C++20 with a pedantic warning that can be disabled with -Wno-comma-subscript.
Enabled by default with -std=c++20 unless -Wno-deprecated, and after -std=c++23 regardless of -Wno-deprecated. Before -std=c++20, enabled with explicit -Wdeprecated.
This warning is upgraded to an error by -pedantic-errors in C++23 mode or later. ๐ญ
๐ฆ -Wctad-maybe-unsupported <span>(C++ and Objective-C++ only)</span> ๐ฆ
Warns when you're doing class template argument deduction (CTAD) on a type that has no explicitly written deduction guides. The vibe check here: this warning calls out cases where CTAD only worked because the compiler synthesized the implicit deduction guides, which might not be what the programmer actually intended. Some style guides only allow CTAD on types that specifically "opt-in" โ like, on types designed to support CTAD. You can suppress this warning with the following pattern:
struct allow_ctad_t; // any name works
template <typename T> struct S {
S(T) { }
};
// Guide with incomplete parameter type will never be considered.
S(allow_ctad_t) -> S<void>;
๐ -Wctor-dtor-privacy <span>(C++ and Objective-C++ only)</span> ๐
Warns when a class seems unusable because all the constructors or destructors in that class are private, and it has neither friends nor public static member functions. also!! It warns if there are no non-private methods, and there's at least one private member function that isn't a constructor or destructor.
๐ธ -Wdangling-reference <span>(C++ and Objective-C++ only)</span> ๐ธ
Warns when a reference is bound to a temporary whose lifetime has already ended. the horror. Example:
int n = 1;
const int& r = std::max(n - 1, n + 1); // r is dangling
In the example above, two temporaries are created, one for each argument, and a reference to one of the temporaries is returned. However, both temporaries are destroyed at the end of the full expression, so the reference "r" is dangling. This warning also detects dangling references in member initializer lists:
const int& f(const int& i) { return i; }
struct S {
const int &r; // r is dangling
S() : r(f(10)) { }
};
Member functions are checked as well, but only their object argument:
struct S {
const S& self () { return *this; }
};
const S& s = S().self(); // s is dangling
Certain functions are safe in this respect, for example "std::use_facet": they take and return a reference, but they don't return one of its arguments, which can fool the warning. Such functions can be excluded from the warning by wrapping them in a "#pragma":
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdangling-reference"
const T& foo (const T&) { ... }
#pragma GCC diagnostic pop
The "#pragma" can also surround the class; in that case, the warning will be disabled for all the member functions.
-Wdangling-reference also warns about code like
auto p = std::minmax(1, 2);
where "std::minmax" returns "std::pair<const int&, const int&>", and both references dangle after the end of the full expression that contains the call to "std::minmax".
okay but here's the exception bestie: The warning does not warn for "std::span"-like classes. We consider classes of the form:
template<typename T>
struct Span {
T* data_;
std::size len_;
};
as "std::span"-like; that is, the class is a non-union class that has a pointer data member and a trivial destructor.
The warning can be disabled by using the "gnu::no_dangling" attribute.
This warning is enabled by -Wextra.
๐ -Wdelete-non-virtual-dtor <span>(C++ and Objective-C++ only)</span> ๐
Warns when "delete" is used to destroy an instance of a class that has virtual functions and non-virtual destructor. It is unsafe to delete an instance of a derived class through a pointer to a base class if the base class does not have a virtual destructor. This warning is enabled by -Wall.
๐ -Wdeprecated-copy <span>(C++ and Objective-C++ only)</span> ๐
Warns that the implicit declaration of a copy constructor or copy assignment operator is deprecated if the class has a user-provided copy constructor or copy assignment operator, in C++11 and up. This warning is enabled by -Wextra.
๐ -Wdeprecated-copy-dtor <span>(C++ and Objective-C++ only)</span> ๐
Similar to -Wdeprecated-copy, but also deprecate if the class has a user-provided destructor. same energy, extra spice.
๐ -Wno-deprecated-enum-enum-conversion <span>(C++ and Objective-C++ only)</span> ๐
Disables the warning about the case when the usual arithmetic conversions are applied on operands where one is of enumeration type and the other is of a different enumeration type. This conversion was deprecated in C++20. Like:
enum E1 { e };
enum E2 { f };
int k = f - e;
-Wdeprecated-enum-enum-conversion is enabled by default with -std=c++20. In pre-C++20 dialects, this warning can be enabled by -Wenum-conversion or -Wdeprecated.
๐ง -Wno-deprecated-enum-float-conversion <span>(C++ and Objective-C++ only)</span> ๐ง
Disables the warning about the case when the usual arithmetic conversions are applied on operands where one is of enumeration type and the other is of a floating-point type. This conversion was deprecated in C++20. For example:
enum E1 { e };
enum E2 { f };
bool b = e <= 3.7;
-Wdeprecated-enum-float-conversion is enabled by default with -std=c++20. In pre-C++20 dialects, this warning can be enabled by -Wenum-conversion or -Wdeprecated.
โจ -Wdeprecated-literal-operator <span>(C++ and Objective-C++ only)</span> โจ
Warns that the declaration of a user-defined literal operator with a space before the suffix is deprecated. This warning is enabled by default in C++23, or with explicit -Wdeprecated.
string operator "" _i18n(const char*, std::size_t); // deprecated
string operator ""_i18n(const char*, std::size_t); // preferred
the space?? gone. periodt. ๐
๐ซถ -Wdeprecated-variadic-comma-omission <span>(C++ and Objective-C++ only)</span> ๐ซถ
Warns that omitting a comma before the varargs "..." at the end of a function parameter list is deprecated. This warning is enabled by default in C++26, or with explicit -Wdeprecated.
void f1(int...); // deprecated
void f1(int, ...); // preferred
template <typename ...T>
void f2(T...); // ok
template <typename ...T>
void f3(T......); // deprecated
bestie the T...... is sending me ๐ญ
๐ -Wno-elaborated-enum-base ๐
For C++11 and above, warns if an (invalid) additional enum-base is used in an elaborated-type-specifier. That is, if an enum with given underlying type and no enumerator list is used in a declaration other than just a standalone declaration of the enum. Enabled by default. This warning is upgraded to an error with -pedantic-errors.
๐ -Wno-init-list-lifetime <span>(C++ and Objective-C++ only)</span> ๐
Do not warn about uses of "std::initializer_list" that are likely to result in dangling pointers. Since the underlying array for an "initializer_list" is handled like a normal C++ temporary object, it is easy to inadvertently keep a pointer to the array past the end of the array's lifetime. For example:
- If a function returns a temporary
"initializer_list", or a local"initializer_list"variable, the array's lifetime ends at the end of the return statement, so the value returned has a dangling pointer. - If a new-expression creates an
"initializer_list", the array only lives until the end of the enclosing full-expression, so the"initializer_list"in the heap has a dangling pointer. - When an
"initializer_list"variable is assigned from a brace-enclosed initializer list, the temporary array created for the right side of the assignment only lives until the end of the full-expression, so at the next statement the"initializer_list"variable has a dangling pointer.
// li's initial underlying array lives as long as li
std::initializer_list<int> li = { 1,2,3 };
// assignment changes li to point to a temporary array
li = { 4, 5 };
// now the temporary is gone and li has a dangling pointer
int i = li.begin()[0] // undefined behavior
- When a list constructor stores the
"begin"pointer from the"initializer_list"argument, this doesn't extend the lifetime of the array, so if a class variable is constructed from a temporary"initializer_list", the pointer is left dangling by the end of the variable declaration statement.
undefined behavior alert ๐จ do not do the thing.
โญ -Winvalid-constexpr โญ
Warns when a function never produces a constant expression. In C++20 and earlier, for every "constexpr" function and function template, there must be at least one set of function arguments in at least one instantiation such that an invocation of the function or constructor could be an evaluated subexpression of a core constant expression. C++23 removed this restriction, so it's possible to have a function or a function template marked "constexpr" for which no invocation satisfies the requirements of a core constant expression.
This warning is on as a pedantic warning by default in C++20 and earlier, bestie. But in C++23? You gotta turn -Winvalid-constexpr on yourself, and then it's just a regular everyday warning. Like:
void f (int& i);
constexpr void
g (int& i)
{
// Warns by default in C++20, in C++23 only with -Winvalid-constexpr.
f(i);
}
-Winvalid-imported-macrosโ Double-checks every imported macro definition is valid at the very end of compilation. Not on by default (it needs extra processing to even figure it out), but it's lowkey a lifesaver when you're prepping sets of header-units and you want to make sure the macros all stay consistent. ๐ง-Wno-literal-suffix(C++ and Objective-C++ only) โ Turns OFF the warning for when a string or character literal is followed by a ud-suffix that does not start with an underscore. As a conforming extension, GCC treats those suffixes as separate preprocessing tokens, so old code using formatting macros from<inttypes.h>doesn't break. Like this:
#define __STDC_FORMAT_MACROS
#include <inttypes.h>
#include <stdio.h>
int main() {
int64_t i64 = 123;
printf("My int64: %" PRId64"\n", i64);
}
Here PRId64 gets treated as its own separate preprocessing token. โจ
This option also controls the warnings when a user-defined literal operator is declared with a literal suffix identifier that doesn't begin with an underscore โ and heads up, those non-underscore identifiers are reserved for future standardization. ๐
These warnings are enabled by default.
-Wno-narrowing(C++ and Objective-C++ only) โ For C++11 and later, narrowing conversions get diagnosed by default (the standard said so, periodt). A narrowing conversion from a constant = an error, from a non-constant = a warning, but-Wno-narrowingshuts the whole diagnostic up. Ngl though, this doesn't change what well-formed code means โ narrowing conversions are still ill-formed in SFINAE contexts. No cap.
With -Wnarrowing in C++98, it warns you when a narrowing conversion that C++11 forbids shows up inside { }, like:
int i = { 2.2 }; // error: narrowing from double to int
This flag is included in -Wall and -Wc++11-compat. ๐ฆ
-Wnoexcept(C++ and Objective-C++ only) โ Warns when a noexcept-expression evaluates tofalsebecause it called a function that doesn't have a non-throwing exception specification (akathrow()ornoexcept) โ but which the compiler knows will, like, never actually throw. ๐ญ-Wnoexcept-type(C++ and Objective-C++ only) โ Warns if the C++17 feature makingnoexceptpart of a function type changes the mangled name of a symbol compared to C++14. Enabled by-Wabiand-Wc++17-compat.
Example time, bestie:
template <class T> void f(T t) { t(); };
void g() noexcept;
void h() { f(g); }
In C++14, f calls f<void(*)()>, but in C++17 it calls f<void(*)()noexcept>. ๐
-Wclass-memaccess(C++ and Objective-C++ only) โ Warns when the destination of a raw memory function call likememsetormemcpyis an object of class type, and when writing into that object might bypass the class's non-trivial or deleted constructor/copy assignment, violate const-correctness or encapsulation, or straight-up corrupt virtual table pointers. Messing with the representation of those objects can violate invariants the class's member functions rely on. Example: thismemsetcall below is undefined because it modifies a non-trivial class object, so it gets diagnosed. The safe way to init or clear storage of such types is using the right constructor or assignment operator, if one exists. ๐ซถ
std::string str = "abc";
memset (&str, 0, sizeof str);
-Wclass-memaccess is enabled by -Wall. And if you explicitly cast the pointer to the class object to void * (or to a type that's safe for the raw memory function to access), the warning goes bye-bye. โจ
-Wnon-virtual-dtor(C++ and Objective-C++ only) โ Warns when a class has virtual functions AND an accessible non-virtual destructor โ either in itself or in an accessible polymorphic base class. Which means it's possible but unsafe to delete an instance of a derived class through a pointer to the class itself or its base class. ๐ฌ This one auto-enables if you pass-Weffc++. But fr fr, prefer-Wdelete-non-virtual-dtor(enabled by-Wall) โ it warns about the unsafe cases without false positives. Slay.-Wregister(C++ and Objective-C++ only) โ Warns on uses of theregisterstorage class specifier, except when it's part of the GNU Explicit Register Variables extension. Fun fact: usingregisteras a storage class specifier got deprecated in C++11 and removed in C++17. Enabled by default with-std=c++17. ๐-Wreorder(C++ and Objective-C++ only) โ Warns when the order of member initializers in your code doesn't match the order they actually have to be executed in. Like:
struct A {
int i;
int j;
A(): j (0), i (1) { }
};
The compiler reorders the member initializers for i and j to match declaration order, and warns you about it. Enabled by -Wall. ๐
-Wno-pessimizing-move(C++ and Objective-C++ only) โ Warns when a call tostd::moveprevents copy elision. ๐ญ Classic scenario where copy elision could happen: returning in a function with a class return type, when the returned expression is the name of a non-volatile automatic object, isn't a function parameter, and has the same type as the function return type.
struct T {
...
};
T fn()
{
T t;
...
return std::move (t);
}
And yep โ in this example, that std::move call is what kills the copy elision. Enabled by -Wall.
-Wno-redundant-move(C++ and Objective-C++ only) โ Warns about redundant calls tostd::moveโ i.e. when a move would've happened anyway even without thestd::move. That happens because the compiler is forced to treat the object as an rvalue in certain situations, like returning a local variable, where copy elision isn't applicable. Consider:
struct T {
...
};
T fn(T t)
{
...
return std::move (t);
}
Here, the std::move call is redundant. And because G++ implements Core Issue 1579, here's another one:
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 returned expression's type and the function return type differ โ yet G++ still treats the return value as if it were designated by an rvalue. This warning is enabled by -Wextra. ๐ธ
-Wrange-loop-construct(C++ and Objective-C++ only) โ Warns when a C++ range-based for-loop is making an unnecessary copy. This can happen when the range declaration isn't a reference but probably should be. For example:
struct S { char arr[128]; };
void fn () {
S arr[5];
for (const auto x : arr) { ... }
}
It does not warn when the type being copied is trivially-copyable and its size is less than 64 bytes. ๐ซถ
It also warns when a loop variable in a range-based for-loop gets initialized with a value of a different type, resulting in a copy. For example:
void fn() {
int arr[10];
for (const double &x : arr) { ... }
}
In the example above, every single iteration of the loop creates and destroys a temporary value of type double, and the reference const double & binds to it. Enabled by -Wall. ๐
-Wredundant-tags(C++ and Objective-C++ only) โ Warns about redundantclass-keyandenum-keyin references to class types and enumerated types, in contexts where you could drop the key without creating ambiguity. For example:
struct foo;
struct foo *p; // warn that keyword struct can be eliminated
On the other hand, this next one gets no warning:
struct foo;
void foo (); // "hides" struct foo
void bar (struct foo&); // no warning, keyword struct is necessary
-Wno-subobject-linkage(C++ and Objective-C++ only) โ Stops warning when a class type has a base or a field whose type uses the anonymous namespace, or depends on a type with no linkage. Here's the tea: if type A depends on type B with no or internal linkage, defining A 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 giving it internal linkage too โ put it in an anonymous namespace as well. The compiler doesn't warn for types defined in the main.Cfile, since those are unlikely to have multiple definitions.-Wsubobject-linkageis enabled by default.-Weffc++(C++ and Objective-C++ only) โ Warns about violations of these style guidelines from Scott Meyers' Effective C++ book series, bestie:- 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 flips on -Wnon-virtual-dtor, which is one of the actual effective C++ recommendations ๐
but the check got extended โ now it also yells about the lack of a virtual destructor in accessible non-polymorphic base classes too. Extra coverage, bestie.
โ ๏ธ heads up tho: when u pick this option, know that the standard library headers do not obey all of these guidelines. use grep -v to filter out those warnings, fr fr. ๐
-Wno-exceptions(C++ and Objective-C++ only) โ turns off the warning for when an exception handler is shadowed by another handler ๐ญ which lowkey points out a wrong ordering of exception handlers. so likeโฆ it's telling u ur handlers are stacked in the wrong vibe. fix the order bestie.-Wsfinae-incomplete(C++ and Objective-C++ only) โ warns about a class that's found to be incomplete, or a function withautoreturn type that hasn't been deduced yet, in a context where that causes substitution failure instead of an error โ and then the class or function gets defined later in the translation unit. ๐ซ why is this a problem? because template instantiations or concept checks could give different results depending on whether they first happen before or after that definition. it's giving unstable, it's giving unpredictable.
this warning is enabled by default โจ and -Wsfinae-incomplete=2 adds a warning at the actual point of substitution failure, so tracking down the problems the default mode flagged is way easier. level 2 = the map, no cap. ๐ฅ
-Wstrict-null-sentinel(C++ and Objective-C++ only) โ warns about using an uncasted"NULL"as a sentinel. when u compile with only GCC this is a valid sentinel, since"NULL"is defined to"__null". and like โ even tho it's a null pointer constant rather than a null pointer, it's guaranteed to be the same size as a pointer ๐ but this use is not portable across different compilers. so if u leave GCC's little bubble it stops slaying.-Wno-non-c-typedef-for-linkage(C++ and Objective-C++ only) โ disables the pedwarn for unnamed classes with a typedef name for linkage purposes that contain C++ specific members, base classes, default member initializers, or lambda expressions โ including those on nested member classes. ๐
typedef struct {
int a; // non-static data members are ok
struct T { int b; }; // member classes too
enum E { E1, E2, E3 }; // member enumerations as well
int c = 42; // default member initializers are not ok
struct U : A { int c; }; // classes with base classes are not ok
typedef int V; // typedef is not ok
using W = int; // using declaration is not ok
decltype([](){}) x; // lambda expressions not ok
} S;
in all these cases, the tag name S should be added after the struct keyword. periodt.
-Wno-non-template-friend(C++ and Objective-C++ only) โ disables warnings when non-template friend functions are declared inside a template. in very old versions of GCC that predate implementation of the ISO standard, declarations likefriend 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 it 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 inside a C++ program. the new-style casts ("dynamic_cast","static_cast","reinterpret_cast", and"const_cast") are less vulnerable to unintended effects and much easier to search for. glow-up cast, we stan. โจ-Woverloaded-virtual(C++ and Objective-C++ only)-Woverloaded-virtual=nโ warns when a function declaration hides virtual functions from a base class. for example, in:
struct A {
virtual void f();
};
struct B: public A {
void f(int); // does not override
};
the "A" class version of "f" is hidden in "B", and code like:
B* b;
b->f();
fails to compile. ๐ caught in 4k.
in cases where the different signatures are not an accident, the simplest solution is to add a using-declaration to the derived class to un-hide the base function, e.g. add "using A::f;" to "B". problem solved, slay. ๐ซถ
the optional level suffix controls the behavior when all the declarations in the derived class override virtual functions in the base class, even if not all of the base functions are overridden:
struct C {
virtual void f();
virtual void f(int);
};
struct D: public C {
void f(int); // does override
}
this pattern is less likely to be a mistake; if D is only used virtually, the user might have decided that the base class semantics for some of the overloads are fine. lowkey valid.
at level 1, this case does not warn; at level 2, it does. -Woverloaded-virtual by itself selects level 2. level 1 is included in -Wall.
-Wno-pmf-conversions(C++ and Objective-C++ only) โ disables the diagnostic for converting a bound pointer to member function to a plain pointer. ๐-Wsign-promo(C++ and Objective-C++ only) โ warns when overload resolution chooses a promotion from unsigned or enumerated type to a signed type, over a conversion to an unsigned type of the same size. previous versions of G++ tried to preserve unsignedness, but the standard mandates the current behavior. the standard said "we're doing it this way now" and honestly? we listen. ๐-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. loopholes remain, bestie.-Wmismatched-new-delete(C++ and Objective-C++ only) โ warns for mismatches between calls to"operator new"or"operator delete"and the corresponding call to the allocation or deallocation function. this includes invocations of C++"operator delete"with pointers returned from either mismatched forms of"operator new", or from other functions that allocate objects for which the"operator delete"isn't a suitable deallocator โ as well as calls to other deallocation functions with pointers returned from"operator new"for which the deallocation function isn't suitable. ๐ญ it's a whole messy situationship between allocators and deallocators.
for example, the "delete" expression in the function below is diagnosed because it doesn't match the array form of the "new" expression the pointer argument was returned from. similarly, the call to "free" is also diagnosed.
void f ()
{
int *a = new int[n];
delete a; // warning: mismatch in array forms of expressions
char *p = new char[n];
free (p); // warning: mismatch between new and free
}
the related option -Wmismatched-dealloc diagnoses mismatches involving allocation and deallocation functions other than "operator new" and "operator delete".
-Wmismatched-new-delete is included in -Wall. โ
-Wmismatched-tags(C++ and Objective-C++ only) โ warns for declarations of structs, classes, and class templates and their specializations with a class-key that does not match either the definition or the first declaration if no definition is provided.
for example, the declaration of "struct Object" in the argument list of "draw" triggers the warning. to avoid it, either remove the redundant class-key "struct" or replace it with "class" to match its definition. ๐ฏ
class Object {
public:
virtual ~Object () = 0;
};
void draw (struct Object*);
it is not wrong to declare a class with the class-key "struct" as the example above shows. the -Wmismatched-tags option is intended to help achieve a consistent style of class declarations โจ in code that is intended to be portable to Windows-based compilers the warning helps prevent unresolved references due to the difference in the mangling of symbols declared with different class-keys. the option can be used either on its own or in conjunction with -Wredundant-tags.
-Wmultiple-inheritance(C++ and Objective-C++ only) โ warns when a class is defined with multiple direct base classes. some coding rules disallow multiple inheritance, and this may be used to enforce that rule. the warning is inactive inside a system header file, 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.-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. so likeโฆ if u already handled it, u can turn it off. but be sure bestie.-Wnamespacesโ warns when a namespace definition is opened. some coding rules disallow namespaces, and this may be used to enforce that rule. the warning is inactive inside a system header file, such as the STL, so one can still use the STL ๐ one may also use using directives and qualified names.-Wno-template-body(C++ and Objective-C++ only) โ disables diagnosing errors when parsing a template, and instead issues an error only upon instantiation of the template. this flag can also be used to downgrade such errors into warnings withWno-error=or-fpermissive. ๐ postponed chaos, iconic.-Wno-template-id-cdtor(C++ and Objective-C++ only) โ disables the warning about the use of simple-template-id as the declarator-id of a constructor or destructor, which became invalid in C++20 via DR 2237. for example:
template<typename T> struct S {
S<T>(); // should be S();
~S<T>(); // should be ~S();
};
-Wtemplate-id-cdtor is enabled by default with -std=c++20; it is also enabled by -Wc++20-compat. ๐
-Wtemplate-names-tu-localโ bestie, this one warns when a template body is out here hiding an exposure of a translation-unit-local entity ๐. Most of the time, referring to a translation-unit-local entity (like an internal linkage declaration) inside something that gets emitted into a module's CMI is an error. But plot twist: inside the initializer of a variable, or in the body of a non-inline function, that's not an exposure, and no error gets emitted. It's giving loophole.
So why care? Because variable or function templates can accidentally become unusable if they reference such an entity โ every other translation unit that imports the template will literally never be able to instantiate it ๐ญ. This warning tries to catch the cases where that might happen. And the presence of an explicit instantiation silences the warning. Iconic.
This flag is enabled by -Wextra.
-Wno-expose-global-module-tu-localโ okay so an exposure of a translation-unit-local entity from a module interface is invalid, because it can cause ODR violations and show up as link errors or other unexpected behaviour ๐. That said, a lot of existing libraries declare TU-local entities in their interface, and dodging exposures of those can be genuinely hard in some cases.
As an extension, GCC allows exposures of internal variables and functions that were declared in the global module fragment. This warning tells you when such an invalid exposure happened, and you can silence it using diagnostic pragmas โ either at the site of the exposure, or at the point of declaration of the internal declaration. This also applies to export using declarations naming such entities.
When combined with -Wtemplate-names-tu-local, GCC will also warn about non-exposure references to TU-local entities in template bodies. Those templates can still be instantiated in other TUs, but the above risks regarding exposures of translation-unit-local entities apply. iykyk.
This warning is enabled by default, and is upgraded to an error by -pedantic-errors. โจ
-Wno-external-tu-localโ warns when you name a TU-local entity outside of the translation unit it was declared in. Those declarations get ignored during name lookup, which is lowkey rude. This can happen when you perform ADL from a template declared in the same TU as the internal function:
export module M;
template <typename T> void foo(T t) {
bar(t);
}
struct S {} s;
static void bar(S) {} // internal linkage
// instantiating foo(s) from outside this TU can see ::bar,
// but naming it there is ill-formed.
Workaround? Make bar attached to the global module, using extern "C++". ๐ซถ
This warning is enabled by default, and is upgraded to an error by -pedantic-errors.
-Wno-terminate(C++ and Objective-C++ only) โ disables the warning about a throw-expression that will immediately result in a call toterminate. No notes, just vibes.-Wno-vexing-parse(C++ and Objective-C++ only) โ warns about the most vexing parse syntactic ambiguity ๐ต. This is when a declaration looks like a variable definition, but the C++ language requires it to be interpreted as a function declaration. For instance:
void f(double a) {
int i(); // extern int i (void);
int n(int(a)); // extern int n (int);
}
Another example:
struct S { S(int); };
void f(double a) {
S x(int(a)); // extern struct S x (int);
S y(int()); // extern struct S y (int (*) (void));
S z(); // extern struct S z (void);
}
The warning will suggest options for how to deal with such an ambiguity โ e.g., it can suggest removing the parentheses or using braces instead. So helpful, so thoughtful ๐ .
This warning is enabled by default.
-Wno-class-conversion(C++ and Objective-C++ only) โ do not warn when a conversion function converts an object to the same type, to a base class of that type, or tovoid; such a conversion function will never be called. It's giving decorative.-Wvolatile(C++ and Objective-C++ only) โ warns about deprecated uses of thevolatilequalifier ๐. This includes postfix and prefix++and--expressions ofvolatile-qualified types, using simple assignments where the left operand is avolatile-qualified non-class type for their value, compound assignments where the left operand is avolatile-qualified non-class type,volatile-qualified function return type,volatile-qualified parameter type, and structured bindings of avolatile-qualified type. This usage was deprecated in C++20.
Enabled by default with -std=c++20. Before -std=c++20, enabled with explicit -Wdeprecated.
-Waligned-new-Waligned-new=[none|global|all]โ warns about a new-expression of a type that requires greater alignment than thealignof(std::max_align_t)but uses an allocation function without an explicit alignment parameter. This option is enabled by-Wall.
Normally this only warns about global allocation functions, but -Waligned-new=all also warns about class member allocation functions. Slay.
-Wno-placement-new-Wplacement-new=nโ warns about placement new expressions with undefined behavior, like constructing an object in a buffer that is smaller than the type of the object ๐. For example, the placement new expression below is diagnosed because it attempts to construct an array of 64 integers in a buffer only 64 bytes large.
char buf [64];
new (buf) int[64];
This warning is enabled by default.
-Wplacement-new=1โ this is the default warning level of-Wplacement-new. At this level the warning is not issued for some strictly undefined constructs that GCC allows as extensions for compatibility with legacy code. For example, the followingnewexpression is not diagnosed at this level even though it has undefined behavior according to the C++ standard, because it writes past the end of the one-element array.
struct S { int n, a[1]; };
S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
new (s->a)int [32]();
-Wplacement-new=2โ at this level, in addition to diagnosing all the same constructs as at level 1, a diagnostic is also issued for placement new expressions that construct an object in the last member of structure whose type is an array of a single element and whose size is less than the size of the object being constructed. While the previous example would be diagnosed, the following construct makes use of the flexible member array extension to avoid the warning at level 2. ๐ง
struct S { int n, a[]; };
S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
new (s->a)int [32]();
-Wcatch-value-Wcatch-value=n(C++ and Objective-C++ only) โ warns about catch handlers that do not catch via reference. With-Wcatch-value=1(or-Wcatch-valuefor short) warn about polymorphic class types that are caught by value. With-Wcatch-value=2warn about all class types that are caught by value. With-Wcatch-value=3warn about all types that are not caught by reference.-Wcatch-valueis enabled by-Wall. ๐ฅ-Wconditionally-supported(C++ and Objective-C++ only) โ warn for conditionally-supported (C++11 [intro.defs]) constructs. That's the whole thing, bestie, it said what it said.-Wno-defaulted-function-deleted(C++ and Objective-C++ only) โ warns when an explicitly defaulted function is deleted by the compiler. That can occur when the function's declared type does not match the type of the function that would have been implicitly declared. This warning is enabled by default. ๐ญ-Wno-delete-incomplete(C++ and Objective-C++ only) โ do not warn when deleting a pointer to incomplete type, which may cause undefined behavior at runtime. This warning is enabled by default. (Yes, you read that right โ the-Wno-version is what suppresses it, and the warning is on by default. GCC stays confusing, we love her. ๐)-Wextra-semi(C++, Objective-C++ only) โ warns about redundant semicolons. There are various contexts in which an extra semicolon can occur. One is a semicolon after in-class function definitions, which is valid in all C++ dialects (and is never a pedwarn):
struct S {
void foo () {};
};
Another is an extra semicolon at namespace scope, which has been allowed since C++11 (therefore is a pedwarn in C++98):
struct S {
};
;
And yet another is an extra semicolon in class definitions, which has been allowed since C++11 (therefore is a pedwarn in C++98):
struct S {
int a;
;
};
-Wno-global-module(C++ and Objective-C++ only) โ disables the diagnostic for when the global module fragment of a module unit does not consist only of preprocessor directives. Short and sweet. โจ-Wno-inaccessible-base(C++, Objective-C++ only) โ this option controls warnings when a base class is inaccessible in a class derived from it due to ambiguity. The warning is enabled by default. Note that the warning for ambiguous virtual bases is enabled by the-Wextraoption. ๐
struct A { int a; };
struct B : A { };
struct C : B, A { };
-Wno-inherited-variadic-ctorโ suppress warnings about use of C++11 inheriting constructors when the base class inherited from has a C variadic constructor; the warning is on by default because the ellipsis is not inherited. Rude of the ellipsis honestly.-Wno-invalid-offsetof(C++ and Objective-C++ only) โ suppress warnings from applying theoffsetofmacro to a non-POD type. According to the 2014 ISO C++ standard, applyingoffsetofto a non-standard-layout type is undefined. In existing C++ implementations, however,offsetoftypically gives meaningful results. This flag is for users who are aware that they are writing nonportable code and who have deliberately chosen to ignore the warning about it. Main character energy: you know what you're doing, so do it ๐ .
The restrictions on offsetof may be relaxed in a future version of the C++ standard.
-Wsized-deallocation(C++ and Objective-C++ only) โ warns about a definition of an unsized deallocation function
void operator delete (void *) noexcept;
void operator delete[] (void *) noexcept;
without a definition of the corresponding sized deallocation function
void operator delete (void *, std::size_t) noexcept;
void operator delete[] (void *, std::size_t) noexcept;
or vice versa. Enabled by -Wextra along with -fsized-deallocation.
-Wsuggest-final-typesโ Warns about types with virtual methods where code quality would be improved if the type were declared with the C++11finalspecifier, 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.-Wsuggest-final-methodsโ Warns about virtual methods where code quality would be improved if the method were declared with the C++11finalspecifier, or, if possible, its type were declared in an anonymous namespace or with thefinalspecifier. This warning is more effective with link-time optimization, where the info about the class hierarchy graph is more complete. It is recommended to first consider suggestions of-Wsuggest-final-typesand then rebuild with new annotations.-Wsuggest-overrideโ Warns about overriding virtual functions that are not marked with theoverridekeyword.-Wno-conversion-null(C++ and Objective-C++ only) โ Do not warn for conversions betweenNULLand non-pointer types.-Wconversion-nullis enabled by default.
๐ฆ Options Controlling Objective-C and Objective-C++ Dialects ๐ฆ
(NOTE: This manual does not describe the Objective-C and Objective-C++ languages themselves.
This section describes the command-line options that are only meaningful for Objective-C and Objective-C++ programs. You can also use most of the language-independent GNU compiler options. For example, you might compile a file some_class.m like this:
gcc -g -fgnu-runtime -O -c some_class.m
In this example, -fgnu-runtime is an option meant only for Objective-C and Objective-C++ programs; you can use the other options with any language supported by GCC.
Note that since Objective-C is an extension of the C language, Objective-C compilations may also use options specific to the C front-end (e.g., -Wtraditional). Similarly, Objective-C++ compilations may use C++-specific options (e.g., -Wabi).
Here is a list of options that are only for compiling Objective-C and Objective-C++ programs:
-fconstant-string-class=class-nameโ Use class-name as the name of the class to instantiate for each literal string specified with the syntax@"...". The default class name isNXConstantStringif the GNU runtime is being used, andNSConstantStringif the NeXT runtime is being used (see below). On Darwin / macOS platforms, the-fconstant-cfstringsoption, if also present, overrides the-fconstant-string-classsetting and makes@"..."literals get laid out as constant CoreFoundation strings. Note that-fconstant-cfstringsis an alias for the target-specific-mconstant-cfstringsequivalent.-fgnu-runtimeโ Generate object code compatible with the standard GNU Objective-C runtime. This is the default for most types of systems.-fnext-runtimeโ Generate output compatible with the NeXT runtime. This is the default for NeXT-based systems, including Darwin / macOS. The macro__NEXT_RUNTIME__is predefined if (and only if) this option is used.-fno-nil-receiversโ Assume that all Objective-C message dispatches ([receiver message:arg]) in this translation unit ensure that the receiver is notnil. This allows for more efficient entry points in the runtime to be used. This option is only available in conjunction with the NeXT runtime and ABI version 0 or 1.-fobjc-abi-version=nโ Use version n of the Objective-C ABI for the selected runtime. This option is currently supported only for the NeXT runtime. In that case, Version 0 is the traditional (32-bit) ABI without support for properties and other Objective-C 2.0 additions. Version 1 is the traditional (32-bit) ABI with support for properties and other Objective-C 2.0 additions. Version 2 is the modern (64-bit) ABI. If nothing is specified, the default is Version 0 on 32-bit target machines, and Version 2 on 64-bit target machines.-fobjc-call-cxx-cdtorsโ For each Objective-C class, check if any of its instance variables is a C++ object with a non-trivial default constructor. If so, synthesize a special- (id) .cxx_constructinstance method which runs non-trivial default constructors on any such instance variables, in order, and then returnself. Similarly, check if any instance variable is a C++ object with a non-trivial destructor, and if so, synthesize a special- (void) .cxx_destructmethod which runs all such default destructors, in reverse order.
The - (id) .cxx_construct and - (void) .cxx_destruct methods thusly generated only operate on instance variables declared in the current Objective-C class, and not those inherited from superclasses. It is the responsibility of the Objective-C runtime to invoke all such methods in an object's inheritance hierarchy. The - (id) .cxx_construct methods are invoked by the runtime immediately after a new object instance is allocated; the - (void) .cxx_destruct methods are invoked immediately before the runtime deallocates an object instance.
As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has support for invoking the - (id) .cxx_construct and - (void) .cxx_destruct methods.
-fobjc-direct-dispatchโ Allow fast jumps to the message dispatcher. On Darwin this is accomplished via the comm page.-fobjc-exceptionsโ Enable syntactic support for structured exception handling in Objective-C, similar to what is offered by C++. This option is required to use the Objective-C keywords@try,@throw,@catch,@finallyand@synchronized. This option is available with both the GNU runtime and the NeXT runtime (but not available in conjunction with the NeXT runtime on Mac OS X 10.2 and earlier).-fobjc-gcโ Enable garbage collection (GC) in Objective-C and Objective-C++ programs. This option is only available with the NeXT runtime; the GNU runtime has a different garbage collection implementation that does not require special compiler flags.-fobjc-nilcheckโ For the NeXT runtime with version 2 of the ABI, check for a nil receiver in method invocations before doing the actual method call. This is the default and can be disabled using-fno-objc-nilcheck. Class methods and super calls are never checked for nil in this way no matter what this flag is set to. Currently this flag does nothing when the GNU runtime, or an older version of the NeXT runtime ABI, is used.-fobjc-std=objc1โ Conform to the language syntax of Objective-C 1.0, the language recognized by GCC 4.0. This only affects the Objective-C additions to the C/C++ language; it does not affect conformance to C/C++ standards, which is controlled by the separate C/C++ dialect option flags. When this option is used with the Objective-C or Objective-C++ compiler, any Objective-C syntax that is not recognized by GCC 4.0 is rejected. This is useful if you need to make sure that your Objective-C code can be compiled with older versions of GCC.-freplace-objc-classesโ Emit a special marker 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. The GNU runtime currently always retains calls toobjc_get_class("...")regardless of command-line options.-fno-local-ivarsโ By default instance variables in Objective-C can be accessed as if they were local variables from within the methods of the class they're declared in. This can lead to shadowing between instance variables and other variables declared either locally inside a class method or globally with the same name. Specifying the-fno-local-ivarsflag disables this behavior thus avoiding variable shadowing issues.-fivar-visibility=[public|protected|private|package]โ Set the default instance variable visibility to the specified option so that instance variables declared outside the scope of any access modifier directives default to the specified visibility.-gen-declsโ Dump interface declarations for all classes seen in the source file to a file namedsourcename.decl.-Wassign-intercept(Objective-C and Objective-C++ only) โ Warn whenever an Objective-C assignment is being intercepted by the garbage collector.-Wno-property-assign-default(Objective-C and Objective-C++ only) โ Do not warn if a property for an Objective-C object has no assign semantics specified.-Wno-protocol(Objective-C and Objective-C++ only) โ If a class is declared to implement a protocol, a warning is issued for every method in the protocol that is not implemented by the class. The default behavior is to issue a warning for every method not explicitly implemented in the class, even if a method implementation is inherited from the superclass. If you use the-Wno-protocoloption, then methods inherited from the superclass are considered to be implemented, and no warning is issued for them.-Wobjc-root-class(Objective-C and Objective-C++ only) โ bestie, this one yells at you if a class interface forgot its superclass ๐ญ. Like, most classes are gonna inherit fromNSObject(orObject), right? So if you're intentionally declaring a root class and don't want the nagging, just mark that interface with__attribute__((objc_root_class))and the warning goes quiet. periodt. ๐-Wselector(Objective-C and Objective-C++ only) โ warns you when the compiler finds multiple methods of different types all claiming the same selector during compilation ๐. The vibe check happens on the method list in the final stage of compilation. It also checks each selector that shows up in a@selector(...)expression when a matching method for that selector got found during compilation. BUT โ and this is the tea ๐ต โ because these checks only scan the method table at the very end of compilation, you won't get these warnings at all if the final stage never happens, like if an error pops up mid-compile, or if you're running with-fsyntax-only. no final stage, no warning, iykyk.-Wstrict-selector-match(Objective-C and Objective-C++ only) โ warns when multiple methods with differing argument and/or return types share a selector, and you try to send a message using that selector to a receiver of typeidorClass๐ณ. When this flag is off (and off is the default behavior, so heads up), the compiler just skips those warnings if any differences it found are confined to types that share the same size and alignment. so likeโฆ same shape, same spot, compiler's chill.-Wundeclared-selector(Objective-C and Objective-C++ only) โ warns if a@selector(...)expression points at an undeclared selector ๐ต๏ธโ๏ธ. A selector counts as undeclared if no method with that name was declared before the@selector(...)expression โ whether explicitly in an@interfaceor@protocoldeclaration, or implicitly in an@implementationsection. This option runs its checks immediately, the moment a@selector(...)is spotted, whereas-Wselectoronly checks in the final stage of compilation. It also lowkey enforces that coding-style convention where methods and selectors have to be declared before you use them. rules are rules, bestie โจ-print-objc-runtime-infoโ generates a C header describing the largest structure that gets passed by value, if there even is one. iconic little header moment ๐.
๐ฅ Options Controlling OpenMP and OpenACC ๐ฅ
GCC supports OpenMP extensions for C, C++, and Fortran via the -fopenmp option ๐ซถ. And in the same energy, OpenACC extensions are supported in all three languages with -fopenacc. parallel vibes only.
-foffload=disable,-foffload=default,-foffload=target-listโ tells the compiler which OpenMP and OpenACC offload targets it should generate code for ๐. The default behavior โ equivalent to-foffload=defaultโ generates code for all supported offload targets. The-foffload=disableform generates code only for the host fallback, while-foffload=target-listgenerates code only for the comma-separated list of offload targets you name.
Offload targets are specified in GCC's internal target-triplet format. Run the compiler with -v to show the list of configured offload targets under OFFLOAD_TARGET_NAMES ๐.
-foffload-options=options,-foffload-options=target-triplet-list=optionsโ with-foffload-options=options, GCC passes those specified options along to the compilers for all enabled offloading targets ๐. Wanna target just one (or a few)? Use the-foffload-options=target-list=optionsform. The target-list is a comma-separated list in the same format as for the-foffload=option.
Typical command lines look like this:
-foffload-options='-fno-math-errno -ffinite-math-only' \
-foffload-options=nvptx-none=-latomic
-foffload-options=amdgcn-amdhsa=-march=gfx906
-fopenaccโ enables handling of OpenACC directives#pragma accin C/C++ ๐, and!$accin free-form Fortran, plus!$acc,c$accand*$accin fixed-form Fortran. This option implies-pthread, so it's only supported on targets that actually have support for-pthread. no pthread, no openacc, sorry bestie.-fopenacc-dim=geomโ sets default compute dimensions for parallel offload regions that don't explicitly specify their own ๐. The geom value is a triple of:-separated sizes, in order: gang, worker, and vector. You can omit a size to just use a target-specific default value. slay, flexible.-fopenmpโ enables handling of OpenMP directives#pragma omp,[[omp::decl(...)]],[[omp::directive(...)]], and[[omp::sequence(...)]]in C/C++ ๐. In Fortran, it enables!$ompand the conditional compilation sentinel!$. And in fixed source form Fortran, those sentinels can also start withcor*.
This option implies -pthread, so it's only supported on targets that have support for -pthread. Oh and heads up โ -fopenmp implies -fopenmp-simd too ๐
.
-fopenmp-simdโ enables handling of OpenMP'ssimd,declare simd,declare reduction,assume,ordered,scanandloopdirective ๐ฆ, plus combined or composite directives that havesimdas a constituent, using#pragma omp,[[omp::directive(...)]],[[omp::sequence(...)]]and[[omp::decl(...)]]in C/C++ and!$ompin Fortran. It additionally enables the conditional compilation sentinel!$in Fortran. And in fixed source form Fortran, the sentinels can also start withcor*. Every other OpenMP directive gets ignored, no cap. Unless-fopenmpis also specified, theloopregion binds to the current task region, independent of the specifiedbindclause โ that part matters, don't skip it โจ.-fopenmp-target-simd-clone,-fopenmp-target-simd-clone=device-typeโ so besides generating SIMD clones for functions marked with thedeclare simddirective, GCC also generates clones for functions marked with the OpenMPdeclare targetdirective that are suitable for vectorization when this option is in effect ๐ง. The device-type may be one ofnone,host,nohost, andany, which correspond to keywords for thedevice_typeclause of thedeclare targetdirective; clones get generated for the intersection of devices specified.-fopenmp-target-simd-cloneis equivalent to-fopenmp-target-simd-clone=any, and-fno-openmp-target-simd-cloneis equivalent to-fopenmp-target-simd-clone=none.
At -O2 and higher (but not -Os or -Og) this optimization defaults to -fopenmp-target-simd-clone=nohost; otherwise it's disabled by default. noted, bestie ๐.
๐ Options to Control Diagnostic Messages Formatting ๐
Traditionally, diagnostic messages have been formatted irrespective of the output device's aspect โ like its width, and so on ๐. You can use the options described below to control the formatting algorithm for diagnostic messages: how many characters per line, how often source location info should be reported, that whole vibe. Just a lil warning though โ some language front ends may not honor these options. ๐คทโ๏ธ
-fmessage-length=nโ tries to format error messages so they fit on lines of about n characters ๐. If n is zero, then no line-wrapping happens at all and each error message shows up on a single line. That's the default for all front ends.
Heads up bestie โ this option also affects the display of the#errorand#warningpre-processor directives, plus the deprecated function/type/variable attribute. It does not, however, affect thepragma GCC warningandpragma GCC errorpragmas. important distinction ๐
-fdiagnostics-plain-outputโ requests that diagnostic output look as plain as possible ๐, which is handy when you're running dejagnu or other utilities that need to parse diagnostics output and prefer it stay more stable over time.-fdiagnostics-plain-outputis currently equivalent to the following options:
-fno-diagnostics-show-caret
-fno-diagnostics-show-line-numbers
-fdiagnostics-color=never
-fdiagnostics-urls=never
-fdiagnostics-path-format=separate-events
-fdiagnostics-text-art-charset=none
-fno-diagnostics-show-event-links
-fno-diagnostics-show-nesting
And in the future, if GCC changes the default appearance of its diagnostics, the corresponding option to disable that new behavior will get added to this list. future-proofed, we love to see it โจ
-fdiagnostics-show-location=onceโ only meaningful in line-wrapping mode ๐. Tells the diagnostic messages reporter to emit source location info once โ meaning if the message is too long to fit on a single physical line and has to wrap, the source location won't get emitted (as a prefix) over and over again on the subsequent continuation lines. This is the default behavior, so it's already giving chill.-fdiagnostics-show-location=every-lineโ only meaningful in line-wrapping mode ๐. Tells the diagnostic messages reporter to emit the same source location info (as a prefix) for the physical lines that result from breaking a message that's too long to fit on a single line. every line, every time.-fdiagnostics-color[=WHEN],-fno-diagnostics-colorโ use color in diagnostics ๐. WHEN isnever,always, orauto. The default depends on how the compiler has been configured โ it can be any of the above WHEN options, or alsoneverif theGCC_COLORSenvironment variable isn't present in the environment, andautootherwise.automakes GCC use color only when standard error is a terminal, and when not executing in an emacs shell ๐. The forms-fdiagnostics-colorand-fno-diagnostics-colorare aliases for-fdiagnostics-color=alwaysand-fdiagnostics-color=never, respectively.
The colors are defined by the environment variable GCC_COLORS ๐จ. Its value is a colon-separated list of capabilities and Select Graphic Rendition (SGR) substrings. SGR commands are interpreted by the terminal or terminal emulator. (Peep the section in your text terminal's documentation for permitted values and their meanings as character attributes, iykyk.) 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. so many numbers, but it's giving rainbow terminal ๐๐
The default GCC_COLORS is
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. ๐ Supported capabilities are as follows, bestie:
error=โ the SGR substring for theerror:markers. ๐warning=โ the SGR substring for thewarning:markers. โ ๏ธnote=โ the SGR substring for thenote:markers. ๐path=โ the SGR substring for colorizing paths of control-flow events as printed via-fdiagnostics-path-format=, like the identifiers of individual events and lines indicating interprocedural calls and returns. ๐ฃ๏ธrange1=โ the SGR substring for the first additional range.range2=โ the SGR substring for the second additional range.locus=โ the SGR substring for location information,file:lineorfile:line:columnetc. ๐quote=โ the SGR substring for information printed within quotes. ๐ฌfnname=โ the SGR substring for names of C++ functions.targs=โ the SGR substring for C++ function template parameter bindings.fixit-insert=โ the SGR substring for fix-it hints suggesting text to be inserted or replaced. โจfixit-delete=โ the SGR substring for fix-it hints suggesting text to be deleted. ๐๏ธdiff-filename=โ the SGR substring for filename headers within generated patches.diff-hunk=โ the SGR substring for the starts of hunks within generated patches.diff-delete=โ the SGR substring for deleted lines within generated patches.diff-insert=โ the SGR substring for inserted lines within generated patches.type-diff=โ the SGR substring for highlighting mismatching types within template arguments in the C++ frontend.valid=โ the SGR substring for highlighting valid elements within text art diagrams. โinvalid=โ the SGR substring for highlighting invalid elements within text art diagrams. โhighlight-a=,highlight-b=โ the SGR substrings for contrasting two different things within diagnostics, like a pair of mismatching types. See-fdiagnostics-show-highlight-colors.
-fdiagnostics-urls[=WHEN] ๐
Slap actual URLs inside your diagnostics using escape sequences, bestie. So like, when -fdiagnostics-show-option prints text showing the command-line option that controls a diagnostic, this embeds a URL for the docs of that option. Iconic behaviour honestly.
WHEN is never, always, or auto. auto makes GCC use URL escape sequences only when the standard error is a terminal, and when it's not executing in an emacs shell or any graphical terminal which is known to be incompatible with this feature โ see below. ๐
The default depends on how the compiler has been configured. It can be any of the above WHEN options.
GCC can also be configured (via the --with-diagnostics-urls=auto-if-env configure-time option) so that the default is affected by environment variables. Under such a configuration, GCC defaults to using auto if either GCC_URLS or TERM_URLS environment variables are present and non-empty in the environment of the compiler, or never if neither are.
However โ and this is the plot twist ๐ซ โ even with -fdiagnostics-urls=always the behavior is dependent on those environment variables:
- If
GCC_URLSis set to empty orno, do not embed URLs in diagnostics. - If set to
st, URLs use ST escape sequences. - If set to
bel, the default, URLs use BEL escape sequences. - Any other non-empty value enables the feature.
- If
GCC_URLSis not set, useTERM_URLSas a fallback.
Note: ST is an ANSI escape sequence, string terminator ESC \, BEL is an ASCII character, CTRL-G that usually sounds like a beep. ๐
At this time GCC tries to detect also a few terminals that are known to not implement the URL feature, and have bugs or at least had bugs in some versions that are still in use, where the URL escapes are likely to misbehave, i.e. print garbage on the screen. That list is currently xfce4-terminal, certain known to be buggy gnome-terminal versions, the linux console, and mingw. This check can be skipped with the -fdiagnostics-urls=always. ๐งน
-fno-diagnostics-show-option
By default, every diagnostic emitted includes text telling you the command-line option that directly controls the diagnostic (if such an option is known to the diagnostic machinery). Specifying the -fno-diagnostics-show-option flag suppresses that behavior. Poof, gone. ๐จ
-fno-diagnostics-show-caret
By default, every diagnostic emitted includes the original source line and a caret ^ indicating the column. This option suppresses this information. The source line is truncated to n characters, if the -fmessage-length=n option is given. When the output is done to the terminal, the width is limited to the width given by the COLUMNS environment variable or, if not set, to the terminal width. ๐
-fno-diagnostics-show-labels
By default, when printing source code (via -fdiagnostics-show-caret), diagnostics can label ranges of source code with pertinent information, such as the types of expressions:
printf ("foo %s bar", long_i + long_j);
~^ ~~~~~~~~~~~~~~~
| |
char * long int
This option suppresses the printing of these labels โ in the example above, that's the vertical bars and the char * and long int text. ๐ท๏ธ
-fno-diagnostics-show-event-links
By default, when printing execution paths (via -fdiagnostics-path-format=inline-events), GCC will print lines connecting related events, such as the line connecting events 1 and 2 in:
3 | if (p)
| ^
| |
| (1) following `false' branch (when `p' is NULL)... ->-+
| |
| |
|+------------------------------------------------------------+
4 || return 0;
5 || return *p;
|| ~
|| |
|+-------->(2) ...to here
| (3) dereference of NULL `p'
This option suppresses the printing of such connector lines. โ๏ธ
-fno-diagnostics-show-cwe
Diagnostic messages can optionally have an associated CWE (https://cwe.mitre.org/index.html) identifier. GCC itself only provides such metadata for some of the -fanalyzer diagnostics. GCC plugins may also provide diagnostics with such metadata. By default, if this information is present, it will be printed with the diagnostic. This option suppresses the printing of this metadata. ๐ต๏ธ
-fno-diagnostics-show-rules
Diagnostic messages can optionally have rules associated with them, such as from a coding standard, or a specification. GCC itself does not do this for any of its diagnostics, but plugins may do so. By default, if this information is present, it will be printed with the diagnostic. This option suppresses the printing of this metadata. ๐
-fno-diagnostics-show-highlight-colors
GCC can use color for emphasis and contrast when printing diagnostic messages and quoting the user's source. The way that it justโฆ groups your little mismatched types together? Chef's kiss. ๐จโ๐ณ๐
For example, in
demo.c: In function `test_bad_format_string_args':
../../src/demo.c:25:18: warning: format `%i' expects argument of type `int', but argument 2 has type `const char *' [-Wformat=]
25 | printf("hello %i", msg);
| ~^ ~~~
| | |
| int const char *
| %s
- the
%iandintin the message and theintin the quoted source are colored usinghighlight-a(bold green by default), and - the
const char *in the message and in the quoted source are both colored usinghighlight-b(bold blue by default).
The intent is to draw the reader's eyes to the relationships between the various aspects of the diagnostic message and the source, using color to group related elements and distinguish between mismatching ones. ๐โจ
This additional colorization is enabled by default if color printing is enabled (as per -fdiagnostics-color=), but it can be separately disabled via -fno-diagnostics-show-highlight-colors.
-fno-diagnostics-show-line-numbers
By default, when printing source code (via -fdiagnostics-show-caret), a left margin is printed, showing line numbers. This option suppresses this left margin. ๐ข
-fdiagnostics-minimum-margin-width=width
This option controls the minimum width of the left margin printed by -fdiagnostics-show-line-numbers. It defaults to 6.
-fdiagnostics-show-context[=depth] / -fno-diagnostics-show-context
With this option, the compiler might print the interesting control flow chain that guards the basic block of the statement which has the warning. ๐ง depth is the maximum depth of the control flow chain. Currently, the list of the impacted warning options includes: -Warray-bounds, -Wstringop-overflow, -Wstringop-overread, -Wstringop-truncation. and -Wrestrict. More warning options might be added to this list in future releases. The forms -fdiagnostics-show-context and -fno-diagnostics-show-context are aliases for -fdiagnostics-show-context=1 and -fdiagnostics-show-context=0, respectively.
-fdiagnostics-parseable-fixits ๐ ๏ธ
Emit fix-it hints in a machine-parseable format, suitable for consumption by IDEs. For each fix-it, a line will be printed after the relevant diagnostic, starting with the string fix-it:. For example:
fix-it:"test.c":{45:3-45:21}:"gtk_widget_show_all"
The location is expressed as a half-open range, expressed as a count of bytes, starting at byte 1 for the initial column. In the above example, bytes 3 through 20 of line 45 of "test.c" are to be replaced with the given string:
00000000011111111112222222222
12345678901234567890123456789
gtk_widget_showall (dlg);
^^^^^^^^^^^^^^^^^^
gtk_widget_show_all
The filename and replacement string escape backslash as "\", tab as "\t", newline as "\n", double quotes as """, non-printable characters as octal (e.g. vertical tab as "\013").
An empty replacement string indicates that the given range is to be removed. An empty range (e.g. "45:3-45:3") indicates that the string is to be inserted at the given position.
-fdiagnostics-generate-patchโ bestie this one is SO satisfying. After all your diagnostics get printed, this prints fix-it hints to stderr in unified diff format. Like, actual patch-looking output. 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 (peep -fdiagnostics-color for that whole situation).
-fdiagnostics-show-template-treeโ okay so in the C++ frontend, when it's printing diagnostics about mismatching template types, like:
could not convert 'std::map<int, std::vector<double> >()'
from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
this flag makes it print a tree-like structure showing the common parts and the differing parts of the types, like:
map<
[...],
vector<
[double != float]>>
The parts that differ get highlighted with color ("double" and "float" in this case). It's giving annotated diagram, honestly ๐
-fno-elide-typeโ so by default, when the C++ frontend prints diagnostics about mismatching template types, common parts of the types get printed as "[...]" to simplify the error message. Example:
could not convert 'std::map<int, std::vector<double> >()'
from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
Specifying the -fno-elide-type flag suppresses that behavior. This flag also affects the output of the -fdiagnostics-show-template-tree flag. So they're besties, basically ๐ซถ
-fdiagnostics-path-format=KINDโ this one specifies how to print paths of control-flow events for diagnostics that have such a path associated with them. (iykyk)
KIND is none, separate-events, or inline-events, and inline-events is the default.
none means to not print diagnostic paths. Simple. Iconic.
separate-events means to print a separate "note" diagnostic for each event within the diagnostic. For example:
test.c:29:5: error: passing NULL as argument 1 to 'PyList_Append' which requires a non-NULL parameter
test.c:25:10: note: (1) when 'PyList_New' fails, returning NULL
test.c:27:3: note: (2) when 'i < count'
test.c:29:5: note: (3) when calling 'PyList_Append', passing NULL from (1) as argument 1
inline-events means to print the events "inline" within the source code. This view attempts to consolidate the events into runs of sufficiently-close events, printing them as labelled ranges within the source.
For example, the same events as above might be printed as:
'test': events 1-3
25 | list = PyList_New(0);
| ^~~~~~~~~~~~~
| |
| (1) when 'PyList_New' fails, returning NULL
26 |
27 | for (i = 0; i < count; i++) {
| ~~~
| |
| (2) when 'i < count'
28 | item = PyLong_FromLong(random());
29 | PyList_Append(list, item);
| ~~~~~~~~~~~~~~~~~~~~~~~~~
| |
| (3) when calling 'PyList_Append', passing NULL from (1) as argument 1
Interprocedural control flow is shown by grouping the events by stack frame, and using indentation to show how stack frames are nested, pushed, and popped. the nesting is so real, the indentation ate fr fr
For example:
'test': events 1-2
|
| 133 | {
| | ^
| | |
| | (1) entering 'test'
| 134 | boxed_int *obj = make_boxed_int (i);
| | ~~~~~~~~~~~~~~~~~~
| | |
| | (2) calling 'make_boxed_int'
|
+--> 'make_boxed_int': events 3-4
|
| 120 | {
| | ^
| | |
| | (3) entering 'make_boxed_int'
| 121 | boxed_int *result = (boxed_int *)wrapped_malloc (sizeof (boxed_int));
| | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| | |
| | (4) calling 'wrapped_malloc'
|
+--> 'wrapped_malloc': events 5-6
|
| 7 | {
| | ^
| | |
| | (5) entering 'wrapped_malloc'
| 8 | return malloc (size);
| | ~~~~~~~~~~~~~
| | |
| | (6) calling 'malloc'
|
<-------------+
|
'test': event 7
|
| 138 | free_boxed_int (obj);
| | ^~~~~~~~~~~~~~~~~~~~
| | |
| | (7) calling 'free_boxed_int'
|
(etc)
-fdiagnostics-show-path-depthsโ this option provides additional information when printing control-flow paths associated with a diagnostic.
If this is option is provided then the stack depth will be printed for each run of events within -fdiagnostics-path-format=inline-events. And if it's provided with -fdiagnostics-path-format=separate-events, then the stack depth and function declaration will be appended when printing each event.
This is intended for use by GCC developers and plugin developers when debugging diagnostics that report interprocedural control flow. So like, devs only, not your everyday girlies ๐
-fno-show-columnโ Do not print column numbers in diagnostics. This may be necessary if diagnostics are being scanned by a program that does not understand the column numbers, such asdejagnu.-fdiagnostics-column-unit=UNITโ Select the units for the column number. This affects traditional diagnostics (in the absence of-fno-show-column).
The default UNIT, display, considers the number of display columns occupied by each character. ngl this can be bigger than the number of bytes required to encode the character (looking at you, tab characters ๐ซฃ), or it can be smaller, in the case of multibyte characters. For example, the character "GREEK SMALL LETTER PI (U+03C0)" occupies one display column, and its UTF-8 encoding requires two bytes; the character "SLIGHTLY SMILING FACE (U+1F642)" occupies two display columns, and its UTF-8 encoding requires four bytes. the emoji is bigger than the pi, make it make sense ๐ญ
Setting UNIT to byte changes the column number to the raw byte count in all cases, as was traditionally output by GCC prior to version 11.1.0. So like, throwback behavior โจ
-fdiagnostics-column-origin=ORIGINโ Select the origin for column numbers, i.e. the column number assigned to the first column. The default value of1corresponds to traditional GCC behavior and to the GNU style guide. Some utilities may perform better with an origin of0; any non-negative value may be specified. pick your origin, bestie, you got range (literally)-fdiagnostics-escape-format=FORMATโ so when GCC prints pertinent source lines for a diagnostic it normally attempts to print the source bytes directly. BUT some diagnostics relate to encoding issues in the source file, like malformed UTF-8, or issues with Unicode normalization. These diagnostics are flagged so that GCC will escape bytes that are not printable ASCII when printing their pertinent source lines.
This option controls how such bytes should be escaped.
The default FORMAT, unicode, displays Unicode characters that are not printable ASCII in the form <U+XXXX>, and bytes that do not correspond to a Unicode character validly-encoded in UTF-8-encoded will be displayed as hexadecimal in the form <XX>.
For example, a source line containing the string before followed by the Unicode character U+03C0 ("GREEK SMALL LETTER PI", with UTF-8 encoding 0xCF 0x80) followed by the byte 0xBF (a stray UTF-8 trailing byte), followed by the string after will be printed for such a diagnostic as:
before<U+03C0><BF>after
Setting FORMAT to bytes will display all non-printable-ASCII bytes in the form <XX>, thus showing the underlying encoding of non-ASCII Unicode characters. For the example above, the following will be printed:
before<CF><80><BF>after
the way it just exposes the raw bytes... naked. no cap.
-fdiagnostics-text-art-charset=CHARSETโ Some diagnostics can contain "text art" diagrams: visualizations created from text, intended to be viewed in a monospaced font. ASCII ART BUT FOR DIAGNOSTICS โจ๐
This option selects which characters should be used for printing such diagrams, if any. CHARSET is none, ascii, unicode, or emoji.
The none value suppresses the printing of such diagrams. The ascii value will ensure that such diagrams are pure ASCII ("ASCII art"). The unicode value will allow for conservative use of unicode drawing characters (such as box-drawing characters). The emoji value further adds the possibility of emoji in the output (such as emitting U+26A0 WARNING SIGN followed by U+FE0F VARIATION SELECTOR-16 to select the emoji variant of the character). WARNING SIGN EMOJI VARIANT. it's giving โ ๏ธ periodt
The default is emoji, except when the environment variable LANG is set to C, in which case the default is ascii. so if you're in C locale it goes full plain, otherwise we're emoji-ing ๐
-fno-diagnostics-show-nestingโ okay so some GCC diagnostics have this whole internal tree-like structure of nested sub-diagnostics, right? Like when stuff goes wrong instantiating C++ templates ๐ณ. By default GCC uses indentation and bullet points in its text output to show that nesting structure, moves location info onto separate lines so the structure reads clearer, and strips out redundant repeated info. Picking-fno-diagnostics-show-nestingkills all of that โ the indentation, the reformatting, the elision โ and restores an olderlookfor the diagnostics. Vintage-core ๐ .-fno-diagnostics-show-nesting-locationsโ whenfdiagnostics-show-nestingis on, file names and line- and column- numbers get shown on separate lines from the messages. You can turn that location info off entirely with-fno-diagnostics-show-nesting-locations. This option exists for use by GCC developers, for writing DejaGnu test cases. iykyk ๐ง.-fdiagnostics-show-nesting-levelsโ whenfdiagnostics-show-nestingis enabled, usefdiagnostics-show-nesting-levelsto also display numbers showing the depth of the nesting. This one exists for use by GCC developers for debugging nested diagnostics, but it may be of use to plugin authors too ๐ซถ.-fdiagnostics-format=FORMATโ pick a different format for printing diagnostics.FORMATistext,sarif-stderrorsarif-file.
Using this option replaces any additional "output sinks" added by -fdiagnostics-add-output=, or that set by -fdiagnostics-set-output=.
The default is text.
The sarif-stderr and sarif-file formats both emit diagnostics in SARIF Version 2.1.0 format โ either to stderr, or to a file named source.sarif, respectively. So glamorous โจ.
-fdiagnostics-add-output=DIAGNOSTICS-OUTPUT-SPECโ add an additional "output sink" for emitting diagnostics. More sinks, more fun ๐.
DIAGNOSTICS-OUTPUT-SPEC should specify a scheme, optionally followed by : and one or more KEY=VALUE pairs, in this form:
<SCHEME>
<SCHEME>:<KEY>=<VALUE>
<SCHEME>:<KEY>=<VALUE>,<KEY2>=<VALUE2>
etc.
Schemes, keys, or values with a name prefixed experimental may change or be removed without notice โ ๏ธ. Keys can be per-scheme, or related to GCC as a whole.
SCHEME can be
textโ emit diagnostics to stderr using GCC's classic text output format.
Supported keys for the text scheme are:
color=[yes|no]โ override colorization settings from-fdiagnostics-colorfor this text output.show-nesting=[yes|no]โ enable a mode that emphasizes hierarchical relationships within diagnostics messages, as per-fdiagnostics-show-nesting. Defaults toyes.show-nesting-locations=[yes|no]โ ifshow-nesting=yes, then by default locations are shown; set this key tonoto disable printing such locations. This exists for use by GCC developers, for writing DejaGnu test cases.show-nesting-levels=[yes|no]โ this is a debugging option for use withshow-nesting=yes. Set this key toyesto print explicit nesting levels in the output. This exists for use by GCC developers.
sarifโ emit diagnostics to a file in SARIF format.
Supported keys for the sarif scheme are:
file=FILENAMEโ specify the filename to write the SARIF output to, potentially with a leading absolute or relative path. If not specified, it defaults tosource.sarif.serialization=[json]โ specify the serialization format to use when writing out the SARIF. Currently this can only bejson, but is present as an extension point for experimenting with other serializations.version=[2.1|2.2-prerelease]โ specify the version of SARIF to use for the output. If not specified, defaults to2.1.2.2-prereleaseuses an unofficial draft of the future SARIF 2.2 specification and should only be used for experimentation in this release ๐งช.
There is also this key intended for use by GCC developers, rather than end-users, and subject to change or removal without notice:
state-graphs=[yes|no]โ this is a debugging feature and defaults tono. Ifstate-graphs=yes, then attempt to capture detailed state information from-fanalyzerin the generated SARIF.
experimental-htmlโ emit diagnostics to a file in HTML format. This scheme is experimental, and may go away in future GCC releases ๐ญ. The keys and details of the output are also subject to change.
Supported keys for the experimental-html scheme are:
css=[yes|no]โ add an embedded<style>to the generated HTML. Defaults to yes.file=FILENAMEโ specify the filename to write the HTML output to, potentially with a leading absolute or relative path. If not specified, it defaults tosource.html.javascript=[yes|no]โ add an embedded<script>to the generated HTML providing a barebones UI for viewing results. Defaults to yes.
There are also these keys intended for use by GCC developers, rather than end-users, and subject to change or removal without notice:
show-state-diagrams=[yes|no]โ this is a debugging feature and defaults tono. Ifshow-state-diagrams=yes, then attempt to usedotto generate SVG diagrams in the generated HTML, visualizing the state at each event in a diagnostic path. These are visible by pressingjandkto single-step forward and backward through events. Enabling this option will slow down HTML generation ๐.show-graph-dot-src=[yes|no]โ this is a debugging feature and defaults tono. Ifshow-graph-dot-src=yesthen ifshow-state-diagrams=yes, the generated state diagrams will also show the.dotsource input to GraphViz used for the diagram.show-graph-sarif=[yes|no]โ this is a debugging feature and defaults tono. Ifshow-graph-sarif=yesthen ifshow-state-diagrams=yes, the generated state diagrams will also show a SARIF representation of the state.
As well as scheme-specific keys, the following GCC-related key is usable on sinks of any scheme:
cfgs=[yes|no]โ ifcfgs=yesfor a sink, then GCC will attempt to send information to that sink about the control flow graphs for the functions it is compiling. Text sinks ignore the information. SARIF sinks will add the graphs withintheRun.graphs. HTML sinks will generate SVG displaying the graphs. The precise form of the information is subject to change without notice.
For example,
-fdiagnostics-add-output=sarif:version=2.1,file=foo.2.1.sarif
-fdiagnostics-add-output=sarif:version=2.2-prerelease,file=foo.2.2.sarif
would add a pair of outputs, each writing to a different file, using versions 2.1 and 2.2 of the SARIF standard respectively. Serving twin-sink realness ๐.
In EBNF:
<diagnostics-output-specifier> = <diagnostics-output-name>
| <diagnostics-output-name>, ":", <key-value-pairs>;
<diagnostics-output-name> = "text" | "sarif" | "experimental-html";
<key-value-pairs> = <key-value-pair>
| <key-value-pair> "," <key-value-pairs>;
<key-value-pair> = <key> "=" <value>;
<key> = ? string without a '=' ? ;
<value> = ? string without a ',' ? ;
-fdiagnostics-set-output=DIAGNOSTICS-OUTPUT-SPECโ this works in a similar way to-fdiagnostics-add-output=except that instead of adding an additional "output sink" for diagnostics, it replaces all existing output sinks, such as from-fdiagnostics-format=,-fdiagnostics-add-output=, or a prior call to-fdiagnostics-set-output=. Out with the old ๐.-fno-diagnostics-json-formattingโ by default, when JSON is emitted for diagnostics (via-fdiagnostics-format=sarif-stderror-fdiagnostics-format=sarif-file), GCC will add newlines and indentation to visually emphasize the hierarchical structure of the JSON. Pretty-printer behavior, honestly.
Use -fno-diagnostics-json-formatting to suppress this whitespace. It must be passed before the option it is to affect โ ๏ธ.
This is intended for compatibility with tools that do not expect the output to contain newlines, such as that emitted by older GCC releases.
๐จ Options to Request or Suppress Warnings ๐จ
Warnings are diagnostic messages that report constructions that are not inherently erroneous but that are risky or suggest there may have been an error. Basically the compiler going "bestieโฆ I'm not mad, I'm just concerned" ๐.
The following language-independent options do not enable specific warnings but control the kinds of diagnostics produced by GCC.
-fsyntax-onlyโ check the code for syntax errors, but don't do anything beyond that. Just vibes and vibes-checking, no output โจ.-fmax-errors=nโ limits the maximum number of error messages to n, at which point GCC bails out rather than attempting to continue processing the source code. If n is0(the default), there is no limit on the number of error messages produced. If-Wfatal-errorsis also specified, then-Wfatal-errorstakes precedence over this option. Know your place ๐ .-w--no-warningsโ inhibit all warning messages. Silence, iconic, serene ๐ธ.-Werrorโ turn all warnings into errors. No mercy era ๐ฅ.-Werror=โ turn the specified warning into an error. The specifier for a warning is appended; for example-Werror=switchturns the warnings controlled by-Wswitchinto errors. This switch takes a negative form, to be used to negate-Werrorfor specific warnings; for example-Wno-error=switchmakes-Wswitchwarnings not be errors, even when-Werroris in effect.
The warning message for each controllable warning includes the option that controls the warning. That option can then be used with -Werror= and -Wno-error= as described above. (Printing of the option in the warning message can be disabled using the -fno-diagnostics-show-option flag.)
Note that specifying -Werror=foo automatically implies -Wfoo. However, -Wno-error=foo does not imply anything. No strings attached, fr fr ๐ฆ.
-Wfatal-errorsโ bestie, this one makes the compiler just stop at the very first error instead of being all "let me keep going and dump 400 more error messages on you". Abort on first error, no further messages. iconic, honestly ๐
okay so you can request SO many specific warnings with options that start with -W, like -Wunused-variable to get warned about variables you declared and then never used (we've all been there ๐). And every one of those specific warning options has a negative form starting with -Wno- that turns the warning off, like -Wno-unused-variable. This manual only lists one of the two forms โ whichever one is not the default. For more language-specific options you should also peek at C++ Dialect Options and Objective-C and Objective-C++ Dialect Options. And you can get extra warnings by turning on the static analyzer, no cap.
Some options, like -Wall and -Wextra, switch on other options, like -Wunused, which then switches on even more options, like -Wunused-variable. The way the positive and negative forms combine is: more specific options win over less specific ones, no matter where they sit on the command line. For options at the same level of specificity, the last one takes effect. And options turned on/off via pragmas act like they were dropped at the very end of the command line. periodt.
When you ask for a warning option that doesn't exist (like -Wunknown-warning), GCC throws an error saying the option isn't recognized. BUT โ if you use the -Wno- form, the vibe is slightly different: no diagnostic is produced for -Wno-unknown-warning unless other diagnostics are already being produced. That's on purpose โ it lets you use shiny new -Wno- options with old compilers. But if something goes wrong, the compiler will warn you that an unrecognized option is hanging around. ๐ซถ
The effectiveness of some warnings depends on optimizations also being enabled. Like, -Wsuggest-final-types is more effective with link-time optimization. Some other warnings might not be issued at all unless optimization is on. And while optimization generally makes warnings about control and data-flow problems better, in some cases it can also cause false positives. ๐ญ
โจ -Wpedantic / -pedantic / --pedantic โจ
Issue all the warnings demanded by strict ISO C and ISO C++; diagnose every program that uses forbidden extensions, plus some other programs that don't follow ISO C and ISO C++. This follows whichever version of the ISO C or C++ standard you picked with any -std option. ๐
Valid ISO C and ISO C++ programs should compile just fine with or without this option (though a rare few need -ansi or a -std option naming the standard version). But without this option, certain GNU extensions and traditional C and C++ features are supported too. With this option, they get diagnosed (or rejected, if you used -pedantic-errors).
-Wpedantic does not produce warning messages for use of the alternate keywords whose names begin and end with __. This alternate format can also be used to disable warnings for non-ISO __intN types, i.e. __intN__. Pedantic warnings are also disabled in the expression that follows __extension__. But listen โ only system header files should use these escape routes; application programs should avoid them. ๐ซ
Some warnings about non-conforming programs are controlled by options other than -Wpedantic; in many cases they're implied by -Wpedantic but can be disabled separately with their specific option, e.g. -Wpedantic -Wno-pointer-sign.
Where the standard specified with -std represents a GNU extended dialect of C, like gnu90 or gnu99, there's a corresponding base standard โ the version of ISO C that the GNU extended dialect is based on. Warnings from -Wpedantic are given where the base standard requires them. (It wouldn't make sense to give them only for features not in the specified GNU C dialect, because by definition the GNU dialects of C include every feature the compiler supports with that option, and then there'd be nothing left to warn about. ๐)
โจ -pedantic-errors / --pedantic-errors โจ
Give an error whenever the base standard (see -Wpedantic) requires a diagnostic โ in some cases where there's undefined behavior at compile-time, and in some other cases that don't prevent compilation of programs that are valid according to the standard. This is not the same as -Werror=pedantic: that latter option is unlikely to be useful, since it only turns the diagnostics controlled by -Wpedantic into errors, whereas this option also affects required diagnostics that are always enabled or controlled by options other than -Wpedantic. ๐จ
If you want the required diagnostics that are warnings by default to become errors instead, but you don't also want to enable the -Wpedantic diagnostics, you can specify -pedantic-errors -Wno-pedantic (or -pedantic-errors -Wno-error=pedantic to enable them but only as warnings).
Some required diagnostics are errors by default, but can be reduced to warnings using -fpermissive or their specific warning option, e.g. -Wno-error=narrowing.
Some diagnostics for non-ISO practices are controlled by specific warning options other than -Wpedantic, but are also made errors by -pedantic-errors. For instance, bestie, here's the whole list:
-Wattributes(for standard attributes)-Wchanges-meaning(C++)-Wcomma-subscript(C++23 or later)-Wdeclaration-after-statement(C90 or earlier)-Welaborated-enum-base(C++11 or later)-Wimplicit-int(C99 or later)-Wimplicit-function-declaration(C99 or later)-Wincompatible-pointer-types-Wint-conversion-Wlong-long(C90 or earlier)-Wmain-Wnarrowing(C++11 or later)-Wpointer-arith-Wpointer-sign-Wincompatible-pointer-types-Wregister(C++17 or later)-Wvla(C90 or earlier)-Wwrite-strings(C++11 or later)
yes -Wincompatible-pointer-types is in there twice. not me fixing the original, I'm just the messenger ๐
โจ -fpermissive โจ
Downgrade some required diagnostics about nonconformant code from errors to warnings. So using -fpermissive lets some nonconforming code compile. ๐ Some C++ diagnostics are controlled only by this flag, but it also downgrades some C and C++ diagnostics that have their own flag:
-Wabbreviated-auto-in-template-arg(C++ and Objective-C++ only)-Wdeclaration-missing-parameter-type(C and Objective-C only)-Wimplicit-function-declaration(C and Objective-C only)-Wimplicit-int(C and Objective-C only)-Wincompatible-pointer-types(C and Objective-C only)-Wint-conversion(C and Objective-C only)-Wnarrowing(C++ and Objective-C++ only)-Wreturn-mismatch(C and Objective-C only)-Wtemplate-body(C++ and Objective-C++ only)
The -fpermissive option is the default for historic C language modes (-std=c89, -std=gnu89, -std=c90, -std=gnu90). ๐ฐ๏ธ
โจ -Wall / --all-warnings โจ
This enables all the warnings about constructions that some users consider questionable, and that are easy to avoid (or modify to prevent the warning), even when macros are involved. It also enables some language-specific warnings described in C++ Dialect Options and Objective-C and Objective-C++ Dialect Options. ๐
-Wall turns on the following warning flags:
-Waddress
-Waligned-new (C++ and Objective-C++ only)
-Warray-bounds=1 (only with -O2)
-Warray-compare
-Warray-parameter=2
-Wbool-compare
-Wbool-operation
-Wc++11-compat
-Wc++14-compat
-Wc++17compat
-Wc++20compat
-Wcatch-value (C++ and Objective-C++ only)
-Wchar-subscripts
-Wclass-memaccess (C++ and Objective-C++ only)
-Wcomment
-Wdangling-else
-Wdangling-pointer=2
-Wdelete-non-virtual-dtor (C++ and Objective-C++ only)
-Wduplicate-decl-specifier (C and Objective-C only)
-Wenum-compare (in C/ObjC; this is on by default in C++)
-Wenum-int-mismatch (C and Objective-C only)
-Wformat=1
-Wformat-contains-nul
-Wformat-diag
-Wformat-extra-args
-Wformat-overflow=1
-Wformat-truncation=1
-Wformat-zero-length
-Wframe-address
-Wimplicit (C and Objective-C only)
-Wimplicit-function-declaration (C and Objective-C only)
-Wimplicit-int (C and Objective-C only)
-Winfinite-recursion
-Winit-self (C++ and Objective-C++ only)
-Wint-in-bool-context
-Wlogical-not-parentheses
-Wmain (only for C/ObjC and unless -ffreestanding)
-Wmaybe-uninitialized
-Wmemset-elt-size
-Wmemset-transposed-args
-Wmisleading-indentation (only for C/C++)
-Wmismatched-dealloc
-Wmismatched-new-delete (C++ and Objective-C++ only)
-Wmissing-attributes
-Wmissing-braces (only for C/ObjC)
-Wmultistatement-macros
-Wnarrowing (C++ and Objective-C++ only)
-Wnonnull
-Wnonnull-compare
-Wopenmp-simd (C and C++ only)
-Woverloaded-virtual=1 (C++ and Objective-C++ only)
-Wpacked-not-aligned
-Wparentheses
-Wpessimizing-move (C++ and Objective-C++ only)
-Wpointer-sign (only for C/ObjC)
-Wrange-loop-construct (C++ and Objective-C++ only)
-Wreorder (C++ and Objective-C++ only)
-Wrestrict
-Wreturn-type
-Wself-move (C++ and Objective-C++ only)
-Wsequence-point
-Wsign-compare (C++ and Objective-C++ only)
-Wsizeof-array-div
-Wsizeof-pointer-div
-Wsizeof-pointer-memaccess
-Wstrict-aliasing
-Wstrict-overflow=1
-Wswitch
-Wtautological-compare
-Wtrigraphs
-Wuninitialized
-Wunknown-pragmas
-Wunused
-Wunused-but-set-variable
-Wunused-const-variable=1 (only for C/ObjC)
-Wunused-function
-Wunused-label
-Wunused-local-typedefs
-Wunused-value
-Wunused-variable
-Wuse-after-free=2
-Wvla-parameter
-Wvolatile-register-var
-Wzero-length-bounds
heads up bestie: some warning flags are not implied by-Wall. Some of them warn about constructions that users generally don't consider questionable, but which occasionally you might want to check for; others warn about constructions that are necessary or hard to avoid in some cases, and there's no simple way to modify the code to suppress the warning. Some of them are enabled by-Wextra, but many of them have to be enabled individually. ๐
โจ -Wextra / --extra-warnings โจ
This enables some extra warning flags that aren't enabled by -Wall. (This option used to be called -W. The older name is still supported, but the newer name is more descriptive.) โจ
okay so the -Wextra roster is STILL going, she refuses to stop, and honestly? queen behavior. Here's the rest of what she switches on:
-Wabsolute-value(only for C/ObjC)-Walloc-size-Wcalloc-transposed-args-Wcast-function-type-Wclobbered-Wdangling-reference(C++ only)-Wdeprecated-copy(C++ and Objective-C++ only)-Wempty-body-Wenum-conversion(only for C/ObjC)-Wexpansion-to-defined-Wignored-qualifiers(only for C/C++)-Wimplicit-fallthrough=3-Wmaybe-uninitialized-Wmissing-field-initializers-Wmissing-parameter-name(C/ObjC only)-Wmissing-parameter-type(C/ObjC only)-Wold-style-declaration(C/ObjC only)-Wmultiple-parameter-fwd-decl-lists(C/ObjC only)-Woverride-init(C/ObjC only)-Wredundant-move(C++ and Objective-C++ only)-Wshift-negative-value(in C++11 to C++17 and in C99 and newer)-Wsign-compare(C++ and Objective-C++ only)-Wsized-deallocation(C++ and Objective-C++ only)-Wstring-compare-Wtype-limits-Wuninitialized-Wunterminated-string-initialization(C/ObjC only)-Wunused-parameter(only with-Wunusedor-Wall)-Wunused-but-set-parameter(only with-Wunusedor-Wall)
and -Wextra is not done being dramatic either, because she ALSO prints warning messages for these cases:
- A pointer is compared against integer zero with
<,<=,>, or>=. - (C++ only) An enumerator and a non-enumerator both appear in a conditional expression.
- (C++ only) Ambiguous virtual bases.
- (C++ only) Subscripting an array that has been declared
register. - (C++ only) Taking the address of a variable that has been declared
register. - (C++ only) A base class is not initialized in the copy constructor of a derived class.
๐ -Wabi (C, Objective-C, C++ and Objective-C++ only)
This one's for when your code gets touched by ABI drama ๐
. It warns you about code affected by ABI changes โ and that includes code that might not play nice with the vendor-neutral C++ ABI, plus the psABI for whatever particular target you're on. Those psABI warnings are also controlled separately by -Wpsabi, which is implied by -Wabi (so -Wabi drags it along like a plus-one).
Since G++ now defaults to updating the ABI with each major release, normally -Wabi only warns about C++ ABI compatibility problems if there's a check added later in a release series for an ABI issue discovered since the initial release. But -Wabi warns about more stuff if you select an older ABI version (with -fabi-version=n).
-Wabi can also be used with an explicit version number to warn about C++ ABI compatibility with a particular -fabi-version level โ for example, -Wabi=2 to warn about changes relative to -fabi-version=2.
If an explicit version number is provided and -fabi-compat-version is not specified, the version number from this option is used for compatibility aliases. If no explicit version number is provided with this option, but -fabi-compat-version is specified, that version number is used for C++ ABI warnings.
Real talk, bestie: even though an effort has been made to warn about all such cases, there are probably some cases that are not warned about, even though G++ is generating incompatible code. And there may also be cases where warnings are emitted even though the code that is generated is compatible. So it's a little messy, no cap.
You should rewrite your code to avoid these warnings if you're concerned about the fact that code generated by G++ may not be binary compatible with code generated by other compilers.
Known incompatibilities in -fabi-version=2 (which was the default from GCC 3.4 to 4.9) include:
- A template with a non-type template parameter of reference type was mangled incorrectly:
extern int N;
template <int &> struct S {};
void n (S<N>) {2}
This was fixed in -fabi-version=3.
- SIMD vector types declared using
__attribute ((vector_size))were mangled in a non-standard way that does not allow for overloading of functions taking vectors of different sizes.
The mangling was changed in -fabi-version=4.
__attribute ((const))andnoreturnwere mangled as type qualifiers, anddecltypeof a plain declaration was folded away.
These mangling issues were fixed in -fabi-version=5.
- Scoped enumerators passed as arguments to a variadic function are promoted like unscoped enumerators, causing
va_argto complain. On most targets this does not actually affect the parameter passing ABI, as there is no way to pass an argument smaller thanint.
Also, the ABI changed the mangling of template argument packs, const_cast, static_cast, prefix increment/decrement, and a class scope function used as a template argument.
These issues were corrected in -fabi-version=6.
- Lambdas in default argument scope were mangled incorrectly, and the ABI changed the mangling of
nullptr_t.
These issues were corrected in -fabi-version=7.
- When mangling a function type with function-cv-qualifiers, the un-qualified function type was incorrectly treated as a substitution candidate.
This was fixed in -fabi-version=8, the default for GCC 5.1.
decltype(nullptr)incorrectly had an alignment of 1, leading to unaligned accesses. Note that this did not affect the ABI of a function with anullptr_tparameter, as parameters have a minimum alignment.
This was fixed in -fabi-version=9, the default for GCC 5.2.
- Target-specific attributes that affect the identity of a type, such as ia32 calling conventions on a function type (
stdcall,regparm, etc.), did not affect the mangled name, leading to name collisions when function pointers were used as template arguments.
This was fixed in -fabi-version=10, the default for GCC 6.1.
๐ง -Wpsabi (C, Objective-C, C++ and Objective-C++ only)
-Wpsabi enables warnings about processor-specific ABI changes โ like changes in alignment requirements or how function arguments get passed. On several targets, including AArch64, ARM, x86, MIPS, RS6000/PowerPC, and S/390, these details have changed between different versions of GCC and/or different versions of the C or C++ language standards in ways that affect binary compatibility of compiled code. With -Wpsabi, GCC can detect potentially incompatible usages and warn you about them. ๐
-Wpsabi is enabled by default, and is also implied by -Wabi.
๐ -Wno-changes-meaning (C++ and Objective-C++ only)
C++ requires that unqualified uses of a name within a class have the same meaning in the complete scope of the class, so declaring the name after using it is ill-formed:
struct A;
struct B1 { A a; typedef A A; }; // warning, 'A' changes meaning
struct B2 { A a; struct A { }; }; // error, 'A' changes meaning
By default, the B1 case is only a warning because the two declarations have the same type, while the B2 case is an error. Both diagnostics can be disabled with -Wno-changes-meaning. Alternately, the error case can be reduced to a warning with -Wno-error=changes-meaning or -fpermissive.
Both diagnostics are also suppressed by -fms-extensions.
๐ -Wchar-subscripts
Warn if an array subscript has type char. This is a common cause of error, as programmers often forget that this type is signed on some machines. @xref{Characters implementation}, and char type signedness.
This warning is enabled by -Wall. When enabled, the warning is given regardless of whether char is unsigned by default on the target, and it is also not affected by the -fsigned-char or -funsigned-char options.
๐ -Wno-coverage-mismatch
Warn if feedback profiles do not match when using the -fprofile-use option. If a source file is changed between compiling with -fprofile-generate and with -fprofile-use, the files with the profile feedback can fail to match the source file and GCC cannot use the profile feedback information. By default, this warning is enabled and is treated as an error. -Wno-coverage-mismatch can be used to disable the warning, or -Wno-error=coverage-mismatch can be used to disable the error. Disabling the error for this warning can result in poorly optimized code and is useful only in the case of very minor changes such as bug fixes to an existing code-base. Completely disabling the warning is not recommended.
๐ธ -Wno-coverage-too-many-conditions
Warn if -fcondition-coverage is used and an expression have too many terms and GCC gives up coverage. Coverage is given up when there are more terms in the conditional than there are bits in a gcov_type_unsigned. This warning is enabled by default.
๐ฆ -Wno-coverage-too-many-paths
Warn if -fpath-coverage is used and a function has too many paths and GCC gives up coverage. Giving up is controlled by -fpath-coverage-limit. This warning is enabled by default.
โญ -Wno-coverage-invalid-line-number
Warn in case a function ends earlier than it begins due to an invalid linenum macros. The warning is emitted only with --coverage enabled.
By default, this warning is enabled and is treated as an error. -Wno-coverage-invalid-line-number can be used to disable the warning, or -Wno-error=coverage-invalid-line-number can be used to disable the error.
๐ซถ -Wno-cpp (C, Objective-C, C++, Objective-C++ and Fortran only)
Suppress warning messages emitted by #warning directives. shhh, she's being quiet.
๐ฅ -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.
๐ -Wduplicate-decl-specifier (C and Objective-C only)
Warn if a declaration has duplicate const, volatile, restrict or _Atomic specifier. This warning is enabled by -Wall.
-Wformat,-Wformat=nโ okay so this one is the format-string bodyguard ๐ It checks your calls toprintfandscanf, etc., to make sure the arguments you're passing actually have types that match the format string, and that the conversions in that format string make sense. And it's not just the standard crew โ it also covers anything specified by format attributes, across theprintf,scanf,strftimeandstrfmonfamilies (strfmonis an X/Open extension, not in the C standard), plus other target-specific families. Which functions get checked without format attributes having been specified depends on which standard version you selected, and those checks of functions without the attribute specified get switched off by-ffreestandingor-fno-builtin.
Formats are checked against the format features supported by GNU libc version 2.2. That includes all the ISO C90 and C99 features, plus features from the Single Unix Specification and some BSD and GNU extensions. Lowkey important: other library implementations may not support all of these, and GCC does not support warning about features that go beyond a particular library's limitations. But bestie โ if -Wpedantic is used together with -Wformat, you do get warnings about format features that aren't in the selected standard version (just not for strfmon formats, since those aren't in any version of the C standard at all, periodt).
-Wformat=1,-Wformatโ-Wformatis equivalent to-Wformat=1, and-Wno-formatis equivalent to-Wformat=0. Since-Wformatalso checks for null format arguments for several functions,-Wformatalso implies-Wnonnull. Some aspects of this level of format checking can be disabled by these options:-Wno-format-contains-nul,-Wno-format-diag,-Wno-format-extra-args, and-Wno-format-zero-length. And-Wformatis enabled by-Wall.-Wformat=2โ enable-Wformatplus additional format checks. Currently equivalent to-Wformat -Wformat-nonliteral -Wformat-security -Wformat-y2k. โจ the deluxe package โจ
-Wno-format-contains-nulโ if-Wformatis specified, don't warn about format strings that contain NUL bytes.-Wno-format-diagโ if-Wformatis specified, don't warn about format strings that are unsuitable for GCC diagnostics.-Wno-format-extra-argsโ if-Wformatis specified, don't warn about excess arguments to aprintforscanfformat function. The C standard specifies that such arguments are ignored, so like, they're allowed to just vibe there.
Here's the tea though: where the unused arguments lie between used arguments that are specified with $ operand number specifications, warnings are normally 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โ warns about calls to formatted input/output functions such assprintfandvsprintfthat might overflow the destination buffer. When the exact number of bytes written by a format directive cannot be determined at compile-time, it gets estimated based on heuristics that depend on thelevelargument and on optimization. While enabling optimization will in most cases improve the accuracy of the warning, it may also result in false positives, ngl.-Wformat-overflow,-Wformat-overflow=1โ Level 1 of-Wformat-overflow, enabled by-Wformat, employs a conservative approach that warns only about calls that most likely overflow the buffer. At this level, numeric arguments to format directives with unknown values are assumed to have the value of one, and strings of unknown length to be empty. Numeric arguments that are known to be bounded to a subrange of their type, or string arguments whose output is bounded either by their directive's precision or by a finite set of string literals, are assumed to take on the value within the range that results in the most bytes on output. For example, the call 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 โ iconic behavior honestly.
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, don't warn about zero-length formats. The C standard specifies that zero-length formats are allowed.-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.-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.)-Wformat-signednessโ if-Wformatis specified, also warn if the format string requires an unsigned argument and the argument is signed and vice versa.-Wformat-truncation,-Wformat-truncation=levelโ warns about calls to formatted input/output functions such assnprintfandvsnprintfthat might result in output truncation. When the exact number of bytes written by a format directive cannot be determined at compile-time it is estimated based on heuristics that depend on thelevelargument and on optimization. While enabling optimization will in most cases improve the accuracy of the warning, it may also result in false positives. Except as noted otherwise, the option uses the same logic as-Wformat-overflow.-Wformat-truncation,-Wformat-truncation=1โ Level 1 of-Wformat-truncation, enabled by-Wformat, employs a conservative approach that warns only about calls to bounded functions whose return value is unused and that will most likely result in output truncation.-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 core-Wnonnullโ warn about passing a null pointer for arguments marked as requiring a non-null value by thenonnullfunction attribute. Included in-Walland-Wformat. It can be disabled with the-Wno-nonnulloption.-Wnonnull-compareโ warn when comparing an argument marked with thenonnullfunction attribute against null inside the function. Included in-Wall. It can be disabled with the-Wno-nonnull-compareoption.-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.-Wno-musttail-local-addrโ do not warn about passing a pointer (or in C++, a reference) to a local variable or label to argument of amusttailcall. Those variables go out of scope before the tail call instruction.-Wmaybe-musttail-local-addrโ warn when address of a local variable can escape to amusttailcall, unless it goes out of scope already before themusttailcall.
int foo (int *);
int
bar (int *x)
{
if (x[0] == 1)
{
int a = 42;
foo (&a);
/* Without the C<musttail> attribute this call would not
be tail called, because address of the C<a> variable escapes
and the second foo call could dereference it. With the attribute
the local variables are assumed to go out of scope immediately
before the tail call instruction and the compiler warns about
this. */
[[gnu::musttail]] return foo (nullptr);
}
else
{
{
int a = 42;
foo (&a);
}
/* The C<a> variable isn't already in scope, so even when it
escaped, even without C<musttail> attribute it would be
undefined behavior to dereference it and the compiler could
turn this into a tail call. No warning is diagnosed here. */
[[gnu::musttail]] return foo (nullptr);
}
}
okay so that warning ^^? yeah, it's switched on by -Wextra ๐
-Wnrvo(C++ and Objective-C++ only) โ bestie, this one yells at you when the compiler doesn't do the copy elision from a local variable into the function's return value, in a spot where[class.copy.elision]says it's allowed. The girlies call this the Named Return Value Optimization. Like, look at this:
std::vector<int> f()
{
std::vector<int> v1, v2;
// ...
if (cond) return v1;
else return v2; // warning: not eliding copy
}
see how it can't elide the copy from v1 or v2? so it elides neither, and you get the warning. it's giving "pick a lane" ๐ญ
-Winfinite-recursionโ warns you about infinitely recursive calls, which is so real of it. โจ This warning works at all optimization levels, but ngl, it needs optimization turned on to actually catch the infinite recursion happening between two or more functions. Also,-Winfinite-recursionis included in-Wall. ๐
compare it with -Wanalyzer-infinite-recursion, which gives you a similar diagnostic but is implemented a totally different way (it's part of -fanalyzer).
-Winit-self(C, C++, Objective-C and Objective-C++ only) โ warns about uninitialized variables that are initialized with themselves, which is iconic in a cursed way. ๐ซ Heads up tho: this option can only be used together with the-Wuninitializedoption.
Like, check this snippet โ GCC only warns about "i" being uninitialized when -Winit-self has been specified:
int f()
{
int i = i;
return i;
}
this warning is enabled by -Wall in C++.
-Wno-implicit-int(C and Objective-C only) โ controls warnings for when a declaration doesn't specify a type. ๐ This warning is enabled by default, as an error, in C99 and later dialects of C, and also by-Wall. The error can be downgraded to a warning using-fpermissive(along with certain other errors), or โ just for this one error โ with-Wno-error=implicit-int.
this warning gets upgraded to an error by -pedantic-errors.
-Wno-implicit-function-declaration(C and Objective-C only) โ controls warnings for when a function is used before it's been declared. ๐ญ Same energy as above: enabled by default, as an error, in C99 and later dialects of C, and also by-Wall. Downgrade it to a warning with-fpermissive(along with certain other errors), or for this error alone with-Wno-error=implicit-function-declaration.
and yeah, -pedantic-errors upgrades this one to an error too.
-Wimplicit(C and Objective-C only) โ same as-Wimplicit-intand-Wimplicit-function-declarationcombined. โจ This warning is enabled by-Wall.-Whardenedโ warns when-fhardeneddidn't enable an option from its set (go peep-fhardenedfor the deets). For instance, if you use-fhardenedand-fstack-protectorat the same time on the command line,-Whardenedwill warn, because-fstack-protector-strongwill not be enabled by-fhardened. caught it in 4K.
this warning is enabled by default, and it only has any effect when -fhardened is enabled.
-Wimplicit-fallthroughโ this is literally the same as-Wimplicit-fallthrough=3, and-Wno-implicit-fallthroughis the same as-Wimplicit-fallthrough=0. ๐-Wimplicit-fallthrough=nโ warns when a switch case falls through. like this:
switch (cond)
{
case 1:
a = 1;
break;
case 2:
a = 2;
case 3:
a = 3;
break;
}
it does not warn when the last statement of a case can't fall through, e.g. when there's a return statement, or a call to a function declared with the noreturn attribute. -Wimplicit-fallthrough= also takes control flow statements into account โ like ifs โ and only warns when it's appropriate. for example:
switch (cond)
{
case 1:
if (i > 3) {
bar (5);
break;
} else if (i < 1) {
bar (0);
} else
return;
default:
...
}
since there are times when a switch case falling through is actually what you want, GCC gives you an attribute โ __attribute__ ((fallthrough)) โ that you use along with a null statement to suppress the warning that would normally pop up:
switch (cond)
{
case 1:
bar (0);
__attribute__ ((fallthrough));
default:
...
}
C++17 and C23 provide a standard way to suppress the -Wimplicit-fallthrough warning using [[fallthrough]]; instead of the GNU attribute. In C++11 or C++14, users can use [[gnu::fallthrough]];, which is a GNU extension. and instead of any of these attributes, you can also just add a fallthrough comment to silence the warning. The whole body of the C or C++ style comment should match the given regular expressions listed below. The option argument n specifies what kind of comments are accepted:
-Wimplicit-fallthrough=0disables the warning altogether.-Wimplicit-fallthrough=1matches".*"regular expression, any comment is used as fallthrough comment.-Wimplicit-fallthrough=2case insensitively matches".*falls?[ \t-]*thr(ough|u).*"regular expression.-Wimplicit-fallthrough=3case sensitively matches one of the following regular expressions:"-fallthrough""@fallthrough@""lint -fallthrough[ \t]*""[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?""[ \t.!]*(Else,? |Intentional(ly)? )?Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?""[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?"
-Wimplicit-fallthrough=4case sensitively matches one of the following regular expressions:"-fallthrough""@fallthrough@""lint -fallthrough[ \t]*""[ \t]*FALLTHR(OUGH|U)[ \t]*"
-Wimplicit-fallthrough=5doesn't recognize any comments as fallthrough comments, only attributes disable the warning.
The comment needs to be followed โ after optional whitespace and other comments โ by case or default keywords, or by a user label that precedes some case or default label. ๐
switch (cond)
{
case 1:
bar (0);
/* FALLTHRU */
default:
...
}
the -Wimplicit-fallthrough=3 warning is enabled by -Wextra.
-Wno-if-not-aligned(C, C++, Objective-C and Objective-C++ only) โ controls whether warnings triggered by the"warn_if_not_aligned"attribute should be issued. These warnings are enabled by default. ๐ธ-Wignored-qualifiers(C and C++ only) โ warns if the return type of a function has a type qualifier such as"const". ๐ซ For ISO C, that kind of type qualifier has no effect, since the value returned by a function is not an lvalue. For C++, the warning is only emitted for scalar types or"void". ISO C prohibits qualified"void"return types on function definitions, so those return types always get a warning, even without this option.
this warning is also enabled by -Wextra.
-Wno-ignored-attributes(C and C++ only) โ controls warnings for when an attribute is ignored. this is different from the-Wattributesoption, because it warns whenever the compiler decides to drop an attribute โ not because the attribute is unknown, used in a wrong place, etc. This warning is enabled by default. โจ-Wmainโ warns if the type of"main"is suspicious, which, fair. ๐"main"should be a function with external linkage, returningint, taking either zero arguments, two, or three arguments of appropriate types. This warning is enabled by default in C++, and is enabled by either-Wallor-Wpedantic.
this warning gets upgraded to an error by -pedantic-errors.
-Wmisleading-indentation(C and C++ only) โ warns when the indentation of the code does not reflect the block structure. ๐ญ Specifically, a warning is issued for"if","else","while", and"for"clauses with a guarded statement that doesn't use braces, followed by an unguarded statement with the same indentation.
In this next example, the call to "bar" is misleadingly indented as if it were guarded by the "if" conditional:
if (some_condition ())
foo ();
bar (); /* Gotcha: this is not guarded by the "if". */
in the case of mixed tabs and spaces, the warning uses the -ftabstop= option to figure out if the statements line up (defaulting to 8).
The warning is not issued for code involving multiline preprocessor logic, like the following example.
if (flagA)
foo (0);
#if SOME_CONDITION_THAT_DOES_NOT_HOLD
if (flagB)
#endif
foo (1);
okay bestie, important lil caveat: this warning is not issued after a #line directive, because a #line is basically the universal signal for "a machine wrote this file" ๐ค and you literally cannot make any assumptions about the layout of the file that directive points at.
-Wmissing-attributesโ warns when a declaration of a function is missing one or more attributes that a related function is declared with, and the absence of those attributes may lowkey mess with the correctness or efficiency of the generated code ๐. For example, the warning fires for declarations of aliases that use attributes to specify less restrictive requirements than their targets โ which is usually just a missed optimization opportunity, no biggie. By contrast,-Wattribute-alias=2handles the warnings for when the alias is more restrictive than the target, which could straight up lead to incorrect code generation. The attributes in question:alloc_align,alloc_size,cold,const,hot,leaf,malloc,nonnull,noreturn,nothrow,pure,returns_nonnull, andreturns_twice.
In C++, the warning fires when an explicit specialization of a primary template declared with attribute alloc_align, alloc_size, assume_aligned, format, format_arg, malloc, or nonnull is declared without it. Attributes deprecated, error, and warning suppress the warning (yes the original really does have a lil double period there, iconic ๐
).
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 โ it works on declarations of functions, variables, or types. Common Attributes.
-Wmissing-attributes is enabled by -Wall.
For example, since the declaration of the primary function template below makes use of both attribute malloc and alloc_size, the declaration of the explicit specialization of the template is diagnosed because it is missing one of the attributes.
template <class T>
T* __attribute__ ((malloc, alloc_size (1)))
allocate (size_t);
template <>
void* __attribute__ ((malloc)) // missing alloc_size
allocate<void> (size_t);
-Wmissing-bracesโ warns if an aggregate or union initializer is not fully bracketed ๐. In the example below, the initializer forais not fully bracketed, but the one forbtotally is.
int a[2][2] = { 0, 1, 2, 3 };
int b[2][2] = { { 0, 1 }, { 2, 3 } };
This warning is enabled by -Wall.
-Wmissing-include-dirs(C, C++, Objective-C, Objective-C++ and Fortran only) โ warns if a user-supplied include directory does not exist ๐ซถ. This option is disabled by default for C, C++, Objective-C and Objective-C++. For Fortran, it is partially enabled by default, by warning for-Iand-J, only.-Wno-missing-profileโ this one controls warnings about missing feedback profiles when you're using-fprofile-use๐ญ. It diagnoses those cases where a new function or a new file gets added between compiling with-fprofile-generateand with-fprofile-use, without regenerating the profiles. In those cases, the profile feedback data files do not contain any profile feedback information for the newly added function or file respectively. Also, when profile count data (.gcda) files are removed, GCC cannot use any profile feedback information at all. In all these cases, warnings are issued to inform you that a profile generation step is due. Ignoring the warning can result in poorly optimized code.-Wno-missing-profilecan be used to disable the warning, but this is not recommended and should be done only when non-existent profile data is justified.-Wmismatched-deallocโ warns for calls to deallocation functions with pointer arguments returned from allocation functions for which the former isn't a suitable deallocator ๐จ. A pair of functions can be associated as matching allocators and deallocators by use of attributemalloc. Unless disabled by the-fno-builtinoption, the standard functionscalloc,malloc,realloc, andfree, as well as the corresponding forms of C++operator newandoperator delete, are implicitly associated as matching allocators and deallocators. In the example below,mydeallocis the deallocator for pointers returned frommyalloc.
void mydealloc (void*);
__attribute__ ((malloc (mydealloc, 1))) void*
myalloc (size_t);
void f (void)
{
void *p = myalloc (32);
// ...use p...
free (p); // warning: not a matching deallocator for myalloc
mydealloc (p); // ok
}
In C++, the related option -Wmismatched-new-delete diagnoses mismatches involving either operator new or operator delete.
Option -Wmismatched-dealloc is included in -Wall.
-Wmultistatement-macrosโ warns about unsafe multiple statement macros that appear to be guarded by a clause such asif,else,for,switch, orwhile, where only the first statement is actually guarded after the macro gets expanded ๐ฑ. For example:
#define DOIT x++; y++
if (c)
DOIT;
will increment y unconditionally, not just when c holds. 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.
It also warns if a comparison like x<=y<=z shows up โ that's equivalent to (x<=y ? 1 : 0) <= z, which is a completely different interpretation from ordinary mathematical notation, bestie.
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. Often programmers expect it to be a value computed inside the conditional expression instead ๐.
For C++ it also warns for some cases of unnecessary parentheses in declarations, which can indicate an attempt at a function call instead of a declaration:
{
// Declares a local variable called mymutex.
std::unique_lock<std::mutex> (mymutex);
// User meant std::unique_lock<std::mutex> lock (mymutex);
}
This warning is enabled by -Wall.
-Wno-self-move(C++ and Objective-C++ only) โ this one warns when a value is moved to itself withstd::move๐. Such astd::movetypically has no effect.
struct T {
...
};
void fn()
{
T t;
...
t = std::move (t);
}
This warning is enabled by -Wall.
-Wsequence-pointโ warns about code that may have undefined semantics because of violations of sequence point rules in the C and C++ standards โ ๏ธ.
The C and C++ standards define the order in which expressions in a C/C++ program are evaluated in terms of sequence points, which represent a partial ordering between the execution of parts of the program: those executed before the sequence point, and those executed after it. These occur after the evaluation of a full expression (one which is not part of a larger expression), after the evaluation of the first operand of a &&, ||, ? : or , (comma) operator, before a function is called (but after the evaluation of its arguments and the expression denoting the called function), and in certain other places. Other than as expressed by the sequence point rules, the order of evaluation of subexpressions of an expression is not specified. All these rules describe only a partial order rather than a total order, since, for example, if two functions are called within one expression with no sequence point between them, the order in which the functions are called is not specified. However, the standards committee have ruled that function calls do not overlap.
It is not specified when between sequence points modifications to the values of objects take effect. Programs whose behavior depends on this have undefined behavior; the C and C++ standards specify that "Between the previous and next sequence point an object shall have its stored value modified at most once by the evaluation of an expression. Furthermore, the prior value shall be read only to determine the value to be stored." If a program breaks these rules, the results on any particular implementation are entirely unpredictable.
Examples of code with undefined behavior are a = a++;, a[n] = b[n++] and a[i++] = i;. Some more complicated cases are not diagnosed by this option, and it may give an occasional false positive result, but in general it has been found fairly effective at detecting this sort of problem in programs.
The C++17 standard will define the order of evaluation of operands in more cases: in particular it requires that the right-hand side of an assignment be evaluated before the left-hand side, so the above examples are no longer undefined. But this option will still warn about them, to help people avoid writing code that is undefined in C and earlier revisions of C++ โจ.
The standard is worded confusingly, therefore there is some debate over the precise meaning of the sequence point rules in subtle cases. Links to discussions of the problem, including proposed formal definitions, may be found on the GCC readings page, at <https://gcc.gnu.org/readings.html>.
This warning is enabled by -Wall for C and C++.
-Wno-return-local-addrโ do not warn about returning a pointer (or in C++, a reference) to a variable that goes out of scope after the function returns ๐ฆ.-Wreturn-mismatchโ bestie, this one's the return statement police ๐จ It yells aboutreturnstatements with no expression in functions that do NOT returnvoid. It ALSO yells about areturnstatement with an expression in a function whose return type ISvoidโ unless the expression type is alsovoid. But as a GNU extension, that second case is accepted with no warning unless-Wpedanticis used.
And heads up: trying to use the return value of a non-void function (other than main, the icon) that just flows off the end by reaching that closing curly brace that terminates the function? That's undefined. Periodt.
This warning is C-specific and enabled by default. In C99 and later language dialects it's treated as an error ๐ญ It can be downgraded to a warning using -fpermissive (along with other warnings), or for just this warning, with -Wno-error=return-mismatch.
-Wreturn-typeโ warns whenever a function is defined with a return type that defaults toint(unless-Wimplicit-intis active, because that one takes precedence, she's the main character). Also warns if execution may reach the end of the function body, or if the function doesn't contain any return statement at all.
Same deal as above: using 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.
And 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. yeah. no cap.
This warning is enabled by default in C++ and by -Wall otherwise.
-Wno-shift-count-negativeโ controls warnings if a shift count is negative. Enabled by default โจ-Wno-shift-count-overflowโ controls warnings if a shift count is greater than or equal to the bit width of the type. Enabled by default โจ-Wshift-negative-valueโ warns if you're left shifting a negative value. Enabled by-Wextrain C99 (and newer) and C++11 to C++17 modes.-Wno-shift-overflow-Wshift-overflow=nโ these options control warnings about left shift overflows.-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++20 mode (and newer), as signed left shifts always wrap.-Wshift-overflow=2โ this warning level also warns about left-shifting 1 into the sign bit, unless C++14 mode (or newer) is active.
-Wswitchโ warns whenever aswitchstatement has an index of enumerated type and lacks acasefor one or more of the named codes of that enumeration. (The presence of adefaultlabel prevents this warning, so a lildefault:really said "not today ๐ ".)caselabels that don't correspond to enumerators also provoke warnings when this option is used, unless the enumeration is marked with theflag_enumattribute. Enabled by-Wall.-Wswitch-defaultโ warns whenever aswitchstatement does not have adefaultcase.-Wswitch-enumโ warns whenever aswitchstatement has an index of enumerated type and lacks acasefor one or more of the named codes of that enumeration.caselabels that don't correspond to enumerators also provoke warnings when this option is used, unless the enumeration is marked with theflag_enumattribute. The only difference between-Wswitchand this option is that this option gives a warning about an omitted enumeration code even if there is adefaultlabel. she does not care about your default, bestie ๐ค-Wno-switch-boolโ do not warn when aswitchstatement has an index of boolean type and the case values are outside the range of a boolean type. You can suppress this warning by casting the controlling expression to a type other thanbool. For example:
switch ((int) (a == 4))
{
...
}
This warning is enabled by default for C and C++ programs.
-Wno-switch-outside-rangeโ this option controls warnings when aswitchcase has a value that is outside of its respective type range. Enabled by default for C and C++ programs.-Wno-switch-unreachableโ do not warn when aswitchstatement contains statements between the controlling expression and the first case label, which will never be executed. For example:
switch (cond)
{
i = 15;
...
case 5:
...
}
-Wswitch-unreachable does not warn if the statement between the controlling expression and the first case label is just a declaration:
switch (cond)
{
int i;
...
case 5:
i = 5;
...
}
This warning is enabled by default for C and C++ programs.
-Wsync-nand(C and C++ only) โ warns when__sync_fetch_and_nandand__sync_nand_and_fetchbuilt-in functions are used. These functions changed semantics in GCC 4.4. glow-up era behavior change, iykyk ๐ฆ-Wtrivial-auto-var-initโ warns when-ftrivial-auto-var-initcannot initialize the automatic variable. A common situation is an automatic variable that is declared between the controlling expression and the first case label of aswitchstatement.-Wunused-but-set-parameterโ-Wunused-but-set-parameteris the same as-Wunused-but-set-parameter=3and-Wno-unused-but-set-parameteris the same as-Wunused-but-set-parameter=0.-Wunused-but-set-parameter=nโ warns whenever a function parameter is assigned to, but otherwise unused (aside from its declaration).
To suppress this warning use the unused attribute.
-Wunused-but-set-parameter=0 disables the warning. With -Wunused-but-set-parameter=1 all uses except initialization and left hand side of assignment which is not further used disable the warning. With -Wunused-but-set-parameter=2 additionally uses of parameter in ++ and -- operators don't count as uses. And finally with -Wunused-but-set-parameter=3 additionally uses in parm @= rhs outside of rhs don't count as uses. See -Wunused-but-set-variable=n option for examples.
This -Wunused-but-set-parameter=3 warning is also enabled by -Wunused together with -Wextra.
-Wunused-but-set-variableโ-Wunused-but-set-variableis the same as-Wunused-but-set-variable=3and-Wno-unused-but-set-variableis the same as-Wunused-but-set-variable=0.-Wunused-but-set-variable=nโ warns whenever a local variable is assigned to, but otherwise unused (aside from its declaration). This-Wunused-but-set-variable=3warning is enabled by-Wall.
To suppress this warning use the unused attribute.
-Wunused-but-set-variable=0 disables the warning. With -Wunused-but-set-variable=1 all uses except initialization and left hand side of assignment which is not further used disable the warning. With -Wunused-but-set-variable=2 additionally uses of variable in ++ and -- operators don't count as uses. And finally with -Wunused-but-set-variable=3 additionally uses in parm @= rhs outside of rhs don't count as uses.
This -Wunused-but-set-variable=3 warning is also enabled by -Wunused, which is enabled by -Wall.
void foo (void)
{
int a = 1; // B<-Wunused-variable> warning
int b = 0; // Warning for <n> >= 1
b = 1; b = 2;
int c = 0; // Warning for <n> >= 2
++c; c--; --c; c++;
int d = 0; // Warning for <n> >= 3
d += 4;
int e = 0; // No warning, cast to void
(void) e;
int f = 0; // No warning, f used
int g = f = 5;
(void) g;
int h = 0; // No warning, preincrement result used
int i = ++h;
(void) i;
int j = 0; // No warning, postdecrement result used
int k = j--;
(void) k;
int l = 0; // No warning, l used
int m = l |= 2;
(void) m;
}
-Wunused-functionโ warns whenever a static function is declared but not defined, or a non-inline static function is unused. Enabled by-Wall.-Wunused-labelโ warns whenever a label is declared but not used. Enabled by-Wall.
To suppress this warning use the unused attribute.
-Wunused-local-typedefs(C, Objective-C, C++ and Objective-C++ only) โ warns when a typedef locally defined in a function is not used. Enabled by-Wall.-Wunused-parameterโ warns whenever a function parameter is unused aside from its declaration. This option is not enabled by-Wunusedunless-Wextrais also specified.
To suppress this warning use the unused attribute.
-Wno-unused-resultโ do not warn if a caller of a function marked with attributewarn_unused_resultdoes not use its return value. The default is-Wunused-result.-Wunused-variableโ warns whenever a local or static variable is unused aside from its declaration. This option implies-Wunused-const-variable=1for C, but not for C++. Enabled by-Wall.
To suppress this warning use the unused attribute.
-Wunused-const-variable-Wunused-const-variable=nโ warns whenever a constant static variable is unused aside from its declaration.
To suppress this warning use the unused attribute.
-Wunused-const-variable=1โ warn about unused static const variables defined in the main compilation unit, but not about static const variables declared in any header included.
-Wunused-const-variable=1 is enabled by either -Wunused-variable or -Wunused for C, but not for C++. In C this declares variable storage, but in C++ this is not an error since const variables take the place of #defines. โจ
-Wunused-const-variable=2</p>
Okay so this warning level ALSO drags unused constant static variables in headers (system headers get a pass, they're exempt bestie). It's literally equivalent to the short form -Wunused-const-variable. And here's the tea: you have to explicitly ask for this level in both C and C++, because cleaning up every single header you include might be a whole nightmare. ๐ญ
โจ OPTIONS โจ (still going, we're so back)
-Wunused-value
Warns whenever a statement computes a result that is explicitly not used. To silence 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 like x[i,j] triggers a warning, while x[(void)i,j] does not. ๐
This warning is enabled by -Wall.
-Wunused
All the above -Wunused options combined, except the ones documented as needing to be specified explicitly. She's the group chat merger of warnings.
So to actually get a warning about an unused function parameter, you must either specify -Wextra -Wunused (heads up, -Wall implies -Wunused), or separately specify -Wunused-parameter and/or -Wunused-but-set-parameter.
-Wunused enables only -Wunused-const-variable=1 rather than -Wunused-const-variable, and only for C, not C++.
-Wuse-after-free (C, Objective-C, C++ and Objective-C++ only)
-Wuse-after-free=n
Warns about uses of pointers to dynamically allocated objects that have been rendered indeterminate by a call to a deallocation function. The warning is enabled at all optimization levels, but it may yield different results with optimization than without. -Wuse-after-free is equivalent to -Wuse-after-free=1.
-Wuse-after-free=1โ At level 1 the warning attempts to diagnose only unconditional uses of pointers made indeterminate by a deallocation call or a successful call torealloc, regardless of whether or not the call resulted in an actual reallocation of memory. This includes double-freecalls as well as uses in arithmetic and relational expressions. Although undefined, uses of indeterminate pointers in equality (or inequality) expressions are not diagnosed at this level.-Wuse-after-free=2โ At level 2, in addition to unconditional uses, the warning also diagnoses conditional uses of pointers made indeterminate by a deallocation call. As at level 2, uses in equality (or inequality) expressions are not diagnosed. For example, the second call tofreein the following function is diagnosed at this level:
struct A { int refcount; void *data; };
void release (struct A *p)
{
int refcount = --p->refcount;
free (p);
if (refcount == 0)
free (p->data); // warning: p may be used after free
}
-Wuse-after-free=3โ At level 3, the warning also diagnoses uses of indeterminate pointers in equality expressions. All uses of indeterminate pointers are undefined, but equality tests sometimes appear after calls toreallocas an attempt to determine whether the call resulted in relocating the object to a different address. They are diagnosed at a separate level to aid gradually transitioning legacy code to safe alternatives. For example, the equality test in the function below is diagnosed at this level:
void adjust_pointers (int**, int);
void grow (int **p, int n)
{
int **q = (int**)realloc (p, n *= 2);
if (q == p)
return;
adjust_pointers ((int**)q, n);
}
To avoid the warning at this level, store offsets into allocated memory instead of pointers. That approach obviates needing to adjust the stored pointers after reallocation. ๐
-Wuse-after-free=2 is included in -Wall.
-Wuseless-cast (C, Objective-C, C++ and Objective-C++ only)
Warns when an expression is cast to its own type. It's giving "why are you like this". This warning does not occur when a class object is converted to a non-reference type, because that's actually a way to create a temporary:
struct S { };
void g (S&&);
void f (S&& arg)
{
g (S(arg)); // make arg prvalue so that it can bind to S&&
}
-Wuninitialized
Warns if an object with automatic or allocated storage duration is used without having been initialized. In C++, it also warns if a non-static reference or non-static const member appears in a class without constructors.
In addition, passing a pointer (or in C++, a reference) to an uninitialized object to a const-qualified argument of a built-in function known to read the object is also diagnosed by this warning. (-Wmaybe-uninitialized is issued for ordinary functions.)
If you want to warn about code that uses the uninitialized value of the variable in its own initializer, use the -Winit-self option.
These warnings occur for individual uninitialized elements of structure, union or array variables as well as for variables that are uninitialized as a whole. They do not occur for variables or elements declared volatile. Because these warnings depend on optimization, the exact variables or elements for which there are warnings depend on the precise optimization options and version of GCC used. ๐
Note that there may be no warning about a variable that is used only to compute a value that itself is never used, because such computations may be deleted by data flow analysis before the warnings are printed.
In C++, this warning also warns about using uninitialized objects in member-initializer-lists. For example, GCC warns about b being uninitialized in the following snippet:
struct A {
int a;
int b;
A() : a(b) { }
};
-Wno-invalid-memory-model
This option controls warnings for invocations of __atomic Builtins, __sync Builtins, and the C11 atomic generic functions with a memory consistency argument that is either invalid for the operation or outside the range of values of the memory_order enumeration. For example, since the __atomic_store and __atomic_store_n built-ins are only defined for the relaxed, release, and sequentially consistent memory orders, the following code is diagnosed:
void store (int *i)
{
__atomic_store_n (i, 0, memory_order_consume);
}
-Winvalid-memory-model is enabled by default.
-Wmaybe-uninitialized
For an object with automatic or allocated storage duration, if there exists a path from the function entry to a use of the object that is initialized, but there exist some other paths for which the object is not initialized, the compiler emits a warning if it cannot prove the uninitialized paths are not executed at run time.
In addition, passing a pointer (or in C++, a reference) to an uninitialized object to a const-qualified function argument is also diagnosed by this warning. (-Wuninitialized is issued for built-in functions known to read the object.) Annotating the function with attribute access (none) indicates that the argument isn't used to access the object and avoids the warning.
These warnings are only possible in optimizing compilation, because otherwise GCC does not keep track of the state of variables. On the other hand, -Wmaybe-uninitialized is known not to warn in many situations (false negatives) due to optimizations taking advantage of undefinedness of uninitialized uses like constant propagation.
These warnings are made optional because GCC may not be able to determine when the code is correct in spite of appearing to have an error. Here is one example of how this can happen:
{
int x;
switch (y)
{
case 1: x = 1;
break;
case 2: x = 4;
break;
case 3: x = 5;
}
foo (x);
}
If the value of y is always 1, 2 or 3, then x is always initialized, but GCC doesn't know this. To suppress the warning, you need to provide a default case with assert(0) or similar code.
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.
Some spurious warnings can be avoided if you declare all the functions you use that never return as noreturn.
This warning is enabled by-Wallor-Wextra.
-Wunknown-pragmas
Warns when a #pragma directive is encountered that is not understood by GCC. If this command-line option is used, warnings are even issued for unknown pragmas in system header files. This is not the case if the warnings are only enabled by the -Wall command-line option.
-Wno-pragmas
Do not warn about misuses of pragmas, such as incorrect parameters, invalid syntax, or conflicts between pragmas. See also -Wunknown-pragmas.
-Wno-pragma-once-outside-header
Do not warn when #pragma once is used in a file that is not a header file, such as a main file. It's fine bestie, live your truth. โจ
-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 allows you to assign a priority to the constructor/destructor to control its order of execution before main is called or after it returns. The priority values must be greater than 100, as the compiler reserves priority values between 0--100 for the implementation. ๐ซถ
-Wstrict-aliasingโ okay so bestie, this one only wakes up when-fstrict-aliasingis active. It warns you about code that might break the strict aliasing rules the compiler is using to optimize. Important reality check: the warning does not catch every case โ it just tries to catch the more common pitfalls. It's bundled into-Wall, and it's exactly equivalent to-Wstrict-aliasing=3.-Wstrict-aliasing=nโ same deal, only active when-fstrict-aliasingis on, and it warns about code that might break those strict aliasing rules. Higher levels = higher accuracy (fewer false positives), but also more effort, kinda like how-Olevels work. And yes,-Wstrict-aliasingis the same as-Wstrict-aliasing=3. Here's the level tea:- Level 1: Most aggressive, quick, least accurate. Could be useful when the higher levels stay silent but
-fstrict-aliasingstill breaks your code, because it has very few false negatives. But heads up: it has many false positives. It warns for all pointer conversions between possibly incompatible types, even if they're never dereferenced. Runs in the front end only. - Level 2: Aggressive, quick, not too precise. May still have many false positives (not as many as level 1 though), and few false negatives (but possibly more than level 1). Unlike level 1, it only warns when an address is taken. It also warns about incomplete types. Runs in the front end only.
- Level 3 (the 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. Could be useful when the higher levels stay silent but
-Wstrict-overflow-Wstrict-overflow=nโ this one 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. Quick note: it does not warn about all cases where the code might overflow โ it only warns about cases where the compiler implements some optimization. So this warning depends on the optimization level.
An optimization that assumes signed overflow doesn't occur is perfectly safe if the variable values involved are such that overflow never actually happens. So yeah, this warning can easily give a false positive: a warning about code that isn't actually a problem. To help focus on important issues, several warning levels are defined. No warnings are issued for the use of undefined signed overflow when estimating how many iterations a loop requires, in particular when determining whether a loop will be executed at all.
-Wstrict-overflow=1โ Warn about cases that are both questionable and easy to avoid. For example the compiler simplifies"x + 1 > x"to1. 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, because"abs (INT_MIN)"overflows to"INT_MIN", which is less than zero.-Wstrict-overflow(with no level) is the same as-Wstrict-overflow=2.-Wstrict-overflow=3โ Also warn about other cases where a comparison is simplified. For example:"x + 1 > 1"is simplified to"x > 0".-Wstrict-overflow=4โ Also warn about other simplifications not covered by the above cases. For example:"(x * 10) / 5"is simplified to"x * 2".-Wstrict-overflow=5โ Also warn about cases where the compiler reduces the magnitude of a constant involved in a comparison. For example:"x + 2 > y"is simplified to"x + 1 >= y". This is reported only at the highest warning level because this simplification applies to many comparisons, so this warning level gives a very large number of false positives.
-Wstring-compareโ Warns for calls to"strcmp"and"strncmp"whose result is determined to be either zero or non-zero in tests for such equality, because the length of one argument is greater than the size of the array the other argument is stored in (or the bound, in the case of"strncmp"). Calls like that could be mistakes. For example, the call to"strcmp"below gets diagnosed because its result is necessarily non-zero no matter what's in the arraya.
extern char a[4];
void f (char *d)
{
strcpy (d, "string");
...
if (0 == strcmp (a, d)) // cannot be true
puts ("a and d are the same");
}
-Wstring-compare is enabled by -Wextra.
-Wno-stringop-overflow-Wstringop-overflow-Wstringop-overflow=typeโ Warns for code that can be statically determined to cause buffer overflows or memory overruns, like calls to"memcpy"and"strcpy"that overflow the destination buffer. The optional argument is one greater than the type of Object Size Checking to perform to determine the size of the destination. Heads up: that argument is only meaningful for string functions that operate on character arrays โ raw memory functions like"memcpy"always use type-zero Object Size Checking.
The option also warns for calls that specify a size in excess of the largest possible object, or at most "SIZE_MAX / 2" bytes.
It produces the best results with optimization enabled, but it can detect a small subset of simple buffer overflows even without optimization in calls to the GCC built-in functions like "__builtin_memcpy" that correspond to the standard functions. Either way, the option warns about just a subset of the buffer overflows detected by the corresponding overflow checking built-ins, such as "__builtin___memcpy_chk", which can perform run-time checking if the access can't be identified as safe at compile time.
For example, the option issues a warning for the "strcpy" call below because it copies at least 5 characters (the string "blue" including the terminating NUL) into the buffer of size 4.
enum Color { blue, purple, yellow };
const char* f (enum Color clr)
{
static char buf [4];
const char *str;
switch (clr)
{
case blue: str = "blue"; break;
case purple: str = "purple"; break;
case yellow: str = "yellow"; break;
}
return strcpy (buf, str); // warning here
}
And the effect of this option is not limited to string or memory manipulation functions. In this example, a warning is diagnosed because a 1-element array is passed to a function requiring at least a 4-element array argument:
void f (int[static 4]);
void g (void)
{
int *p = (int *) malloc (1 * sizeof(int));
f (p); // warning here
}
Option -Wstringop-overflow=2 is enabled by default.
-Wstringop-overflow-Wstringop-overflow=1โ The-Wstringop-overflow=1option uses type-zero Object Size Checking to determine the sizes of destination objects. At this setting the option does not warn for writes past the end of subobjects of larger objects accessed by pointers, unless the size of the largest surrounding object is known. When the destination may be one of several objects, it's assumed to be the largest one of them. On Linux systems, when optimization is enabled at this setting, the option warns for the same code as when the"_FORTIFY_SOURCE"macro is defined to a non-zero value.-Wstringop-overflow=2โ The-Wstringop-overflow=2option uses type-one Object Size Checking to determine the sizes of destination objects. At this setting the option warns about overflows when writing to members of the largest complete objects whose exact size is known. However, it does not warn for excessive writes to the same members of unknown objects referenced by pointers, since they may point to arrays containing unknown numbers of elements. This is the default setting of the option.-Wstringop-overflow=3โ The-Wstringop-overflow=3option uses type-two Object Size Checking to determine the sizes of destination objects. At this setting the option warns about overflowing the smallest object or data member. This is the most restrictive setting of the option, and it may result in warnings for safe code.-Wstringop-overflow=4โ The-Wstringop-overflow=4option uses type-three Object Size Checking to determine the sizes of destination objects. At this setting the option warns about overflowing any data members, and when the destination is one of several objects it uses the size of the largest of them to decide whether to issue a warning. Similarly to-Wstringop-overflow=3, this setting of the option may result in warnings for benign code.
-Wno-stringop-overreadโ Warns for calls to string manipulation functions such as"memchr", or"strcpy", that are determined to read past the end of the source sequence.
Option -Wstringop-overread is enabled by default.
-Wno-stringop-truncationโ Do not warn for calls to bounded string manipulation functions such as"strncat","strncpy", and"stpncpy"that may either truncate the copied string or leave the destination unchanged.
In the following example, the call to "strncat" specifies a bound that is less than the length of the source string. As a result, the copy of the source will be truncated, and so the call is diagnosed. To avoid the warning, use "bufsize - strlen (buf) - 1)" as the bound.
void append (char *buf, size_t bufsize)
{
strncat (buf, ".txt", 3);
}
Another lil example for u bestie โ this call to strncpy copies into d just the characters that come before the terminating NUL, and it does not tack that NUL onto the end. Assuming the result of strncpy is necessarily a NUL-terminated string is a super common mistake, so the call gets diagnosed. Wanna dodge the warning when the result isn't expected to be NUL-terminated? Call memcpy instead. periodt.
void copy (char *d, const char *s)
{
strncpy (d, s, strlen (s));
}
And in this next one, the call to strncpy hands the size of the destination buffer over 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 yeah, that call gets diagnosed too ๐ญ. To avoid the warning, pass sizeof buf - 1 as the bound and set the last element of the buffer to NUL.
void copy (const char *s)
{
char buf[80];
strncpy (buf, s, sizeof buf);
...
}
Now โ situations where a character array is intended to store a sequence of bytes with no terminating NUL? Those arrays can be annotated 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 detect accidental misuses of such arrays, GCC issues warnings unless it can prove that the use is safe.
๐ฆ -Wstrict-flex-arrays (C and C++ only)
Warns about improper usages of flexible array members, according to the level of the strict_flex_array (level) attribute attached to the trailing array field of a structure โ that is, if it's available. Otherwise it goes by the level of the option -fstrict-flex-arrays=level. And ngl, -Wstrict-flex-arrays is only effective when level is greater than 0.
- When
level=1, warnings are issued for a trailing array reference of a structure that has 2 or more elements, if the trailing array is referenced as a flexible array member. - When
level=2, on top oflevel=1, extra warnings get issued for a trailing one-element array reference of a structure if the array is referenced as a flexible array member. - When
level=3, on top oflevel=2, even more warnings get issued for a trailing zero-length array reference of a structure if the array is referenced as a flexible array member.
This option hits different when -ftree-vrp is active (which is the default for -O2 and above), but some warnings may be diagnosed even without optimization. no cap.
๐ -Wsuggest-attribute=attribute-name
Warns for cases where adding an attribute may be beneficial ๐. The *attribute-name*s currently supported are listed below.
-Wsuggest-attribute=pure,-Wsuggest-attribute=const,-Wsuggest-attribute=noreturn,-Wmissing-noreturn,-Wsuggest-attribute=malloc,-Wsuggest-attribute=returns_nonnullโ warn about functions that might be candidates for the attributespure,const,noreturn,mallocorreturns_nonnull. The compiler only warns for functions visible in other compilation units, or (in the case ofpureandconst) if it can't prove that the function returns normally. A function returns normally if it doesn't contain an infinite loop or return abnormally by throwing, callingabortor trapping. This analysis needs the option-fipa-pure-const, which is enabled by default at-Oand higher. Higher optimization levels make the analysis more accurate, slay.-Wsuggest-attribute=format,-Wmissing-format-attributeโ warn about function pointers that might be candidates forformatattributes. Note: these are only possible candidates, not absolute ones, bestie. 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, these are 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 ๐.
-Wsuggest-attribute=coldโ warn about functions that might be candidates for thecoldattribute. This one's based on static detection, and generally it only warns about functions which always lead to a call to anothercoldfunction โ like wrappers of C++throwor fatal error reporting functions leading toabort.
๐ -Walloc-size
Warns about calls to allocation functions decorated with the attribute alloc_size that specify insufficient size for the target type of the pointer the result is assigned to โ including those to the built-in forms of the functions aligned_alloc, alloca, calloc, malloc, and realloc.
๐ -Walloc-zero
Warns about calls to allocation functions decorated with the attribute alloc_size that specify zero bytes, including those to the built-in forms of the functions aligned_alloc, alloca, calloc, malloc, and realloc. And here's why u should care: because the behavior of these functions when called with a zero size differs among implementations (and in the case of realloc it's been deprecated), relying on it may result in subtle portability bugs, so it should be avoided. fr fr.
๐ธ -Wcalloc-transposed-args
Warns about calls to allocation functions decorated with the attribute alloc_size with two arguments, which use the sizeof operator as the earlier size argument and don't use it as the later size argument. This is a coding style warning ๐
. The first argument to calloc is documented to be the number of elements in the array, while the second argument is the size of each element, so calloc (n, sizeof (int)) is preferred over calloc (sizeof (int), n). If having sizeof in the earlier argument and not the latter is intentional, the warning can be suppressed by using calloc (sizeof (struct S) + 0, n) or calloc (1 * sizeof (struct S), 4) or by using sizeof in the later argument as well.
โญ -Walloc-size-larger-than=byte-size
Warns about calls to functions decorated with the attribute alloc_size that attempt to allocate objects larger than the specified number of bytes, or where the result of the size computation in an integer type with infinite precision would exceed the value of PTRDIFF_MAX on the target. -Walloc-size-larger-than=PTRDIFF_MAX is enabled by default. Warnings controlled by this option can be disabled either by specifying a byte-size of SIZE_MAX or more, or by -Wno-alloc-size-larger-than.
๐ -Wno-alloc-size-larger-than
Disables the -Walloc-size-larger-than= warnings. This option is equivalent to -Walloc-size-larger-than=SIZE_MAX or larger.
๐ง -Walloca
This option warns on all uses of alloca in the source. every single one. obsessed.
๐ -Wauto-profile
Outputs warnings about auto-profile inconsistencies.
๐ซถ -Wcannot-profile
Warns when profiling instrumentation was requested, but could not be applied to a certain function.
๐ฅ -Walloca-larger-than=byte-size
This option warns on calls to alloca with an integer argument whose value is either zero, or that 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 ๐.
Unbounded uses, on the other hand, are uses of alloca with no controlling predicate constraining its integer argument. Like this:
void func ()
{
void *p = alloca (n);
f (p);
}
If -Walloca-larger-than=500 were passed, the above would trigger a warning โ but this time because of the lack of bounds checking. rip.
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 example above, n could be negative, causing a larger than expected argument to be implicitly cast into the alloca call ๐ญ.
This option also warns when alloca is used in a loop.
-Walloca-larger-than=PTRDIFF_MAX is enabled by default, but it's usually only effective when -ftree-vrp is active (default for -O2 and above).
See also -Wvla-larger-than=byte-size.
๐ -Wno-alloca-larger-than
Disables the -Walloca-larger-than= warnings. This option is equivalent to -Walloca-larger-than=SIZE_MAX or larger.
๐ -Warith-conversion
Do warn about implicit conversions from arithmetic operations even when conversion of the operands to the same type cannot change their values. This affects warnings from -Wconversion, -Wfloat-conversion, and -Wsign-conversion.
void f (char c, int i)
{
c = c + i; // warns with -Wconversion
c = c + 1; // only warns with -Warith-conversion
}
-Warray-bounds,-Warray-bounds=nโ okay bestie, this one yells at you when you do out-of-bounds subscripts or offsets into arrays. It's enabled by-Wall. It works way better when-ftree-vrpis active (which is the default for-O2and above, slay), but a subset of instances get flagged even with no optimization at all. ๐
By default, the trailing array of a structure gets treated as a flexible array member by -Warray-bounds or -Warray-bounds=n if it's declared as any of these:
- a flexible array member per the C99 standard onwards (
[]) - a GCC zero-length array extension (
[0]) - a one-element array (
[1])
So as a result, out of bounds subscripts or offsets into zero-length arrays or one-element arrays are not warned by default. ๐
You can add -fstrict-flex-arrays or -fstrict-flex-arrays=level to control how this option treats the trailing array of a structure as a flexible array member:
- when
level<=1, no change to the default behavior. - when
level=2, additional warnings will be issued for out of bounds subscripts or offsets into one-element arrays; - when
level=3, in addition tolevel=2, additional warnings will be issued for out of bounds subscripts or offsets into zero-length arrays. -Warray-bounds=1โ this is the default warning level of-Warray-boundsand it's enabled by-Wall; higher levels are not, and they must be explicitly requested. no free upgrades here, you gotta ask. โจ-Warray-bounds=2โ this warning level also warns about the intermediate results of pointer arithmetic that may yield out of bounds values. Heads up: this warning level may give a larger number of false positives and is deactivated by default. ๐
-Wunterminated-string-initialization(C and Objective-C only) โ warns about character arrays initialized as unterminated character sequences with a string literal, unless the declaration being initialized has the"nonstring"attribute. For example:
char arr[3] = "foo"; /* Warning. */
char arr2[3] __attribute__((nonstring)) = "bar"; /* No warning. */
This warning is enabled by -Wextra. And plot twist: if -Wc++-compat is enabled, the warning has slightly different wording and warns even if the declaration being initialized has the "nonstring" warning, as in C++ such initializations are an error. ๐ซ
-Warray-compareโ warns about equality and relational comparisons between two operands of array type. This comparison was deprecated in C++20. For example:
int arr1[5];
int arr2[5];
bool same = arr1 == arr2;
-Warray-compare is enabled by -Wall. iconic behavior detection honestly. ๐
-Warray-parameter,-Warray-parameter=nโ warns about redeclarations of functions involving parameters of array or pointer types of inconsistent kinds or forms, and enables the detection of out-of-bounds accesses to such parameters by warnings such as-Warray-bounds. fr fr, it's connecting the dots for you. ๐ฆ
If the first function declaration uses the array form for a parameter declaration, the bound specified in the array is assumed to be the minimum number of elements expected to be provided in calls to the function and the maximum number of elements accessed by it. Failing to provide arguments of sufficient size or accessing more than the maximum number of elements may be diagnosed by warnings such as -Warray-bounds or -Wstringop-overflow. At level 1, the warning diagnoses inconsistencies involving array parameters declared using the "T[static N]" form.
For example, the warning triggers for the second declaration of "f" because the first one with the keyword static specifies that the array argument must have at least four elements, while the second allows an array of any size to be passed to "f".
void f (int[static 4]);
void f (int[]); // warning (inconsistent array form)
void g (void)
{
int *p = (int *)malloc (1 * sizeof (int));
f (p); // warning (array too small)
...
}
At level 2 the warning also triggers for redeclarations involving any other inconsistency in array or pointer argument forms denoting array sizes. Pointers and arrays of unspecified bound are considered equivalent and do not trigger a warning.
void g (int*);
void g (int[]); // no warning
void g (int[8]); // warning (inconsistent array bound)
-Warray-parameter=2 is included in -Wall. The -Wvla-parameter option triggers warnings for similar inconsistencies involving Variable Length Array arguments.
The short form of the option -Warray-parameter is equivalent to -Warray-parameter=2. The negative form -Wno-array-parameter is equivalent to -Warray-parameter=0. ๐
-Wattribute-alias=n,-Wno-attribute-aliasโ warns about declarations using the"alias"and similar attributes whose target is incompatible with the type of the alias. mismatch core, we hate to see it. ๐ญ-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". that's the whole roster bestie, memorized it. โญ
-Wattribute-alias is equivalent to -Wattribute-alias=1. This is the default. You can disable these warnings with either -Wno-attribute-alias or -Wattribute-alias=0. ๐
-Wbidi-chars=[none|unpaired|any|ucn]โ warns about possibly misleading UTF-8 bidirectional control characters in comments, string literals, character constants, and identifiers. These characters can flip left-to-right writing direction into right-to-left (and vice versa), which can cause confusion between the logical order and visual order. This may be dangerous; for instance, it may seem that a piece of code is not commented out, whereas it in fact is. ๐ญ scary hours fr.
There are three levels of warning supported by GCC. The default is -Wbidi-chars=unpaired, which warns about improperly terminated bidi contexts. -Wbidi-chars=none turns the warning off. -Wbidi-chars=any warns about any use of bidirectional control characters.
By default, this warning does not warn about UCNs. It is, however, possible to turn on such checking by using -Wbidi-chars=unpaired,ucn or -Wbidi-chars=any,ucn. Using -Wbidi-chars=ucn is valid, and is equivalent to -Wbidi-chars=unpaired,ucn, if no previous -Wbidi-chars=any was specified. ๐
-Wbool-compareโ warns about a boolean expression compared with an integer value different from"true"/"false". For instance, the following comparison is always false:
int n = 5;
...
if ((n > 1) == 2) { ... }
This warning is enabled by -Wall. bestie that comparison was never gonna hit, periodt. ๐ธ
-Wbool-operationโ warns about suspicious operations on expressions of a boolean type. For instance, bitwise negation of a boolean is very likely a bug in the program. For C, this warning also warns about incrementing or decrementing a boolean, which rarely makes sense. (In C++, decrementing a boolean is always invalid. Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
This warning is enabled by -Wall. ๐
-Wduplicated-branchesโ warns when an if-else has identical branches. This warning detects cases like
if (p != NULL)
return 0;
else
return 0;
It doesn't warn when both branches contain just a null statement. This warning also warns for conditional operators:
int i = x ? *p : *p;
the way both branches are doing the exact same thingโฆ copy-paste victim energy. ๐
-Wduplicated-condโ warns about duplicated conditions in an if-else-if chain. For instance, warn for the following code:
if (p->q != NULL) { ... }
else if (p->q != NULL) { ... }
girl you already checked that. ๐ญ
-Wframe-addressโ warns when the__builtin_frame_addressor__builtin_return_addressis called with an argument greater than0. Such calls may return indeterminate values or crash the program. The warning is included in-Wall. ๐ฅ-Wno-discarded-qualifiers(C and Objective-C only) โ do not warn if type qualifiers on pointers are being discarded. Typically, the compiler warns if a"const char *"variable is passed to a function that takes a"char *"parameter. This option can be used to suppress such a warning.-Wno-discarded-array-qualifiers(C and Objective-C only) โ do not warn if type qualifiers on arrays which are pointer targets are being discarded. Typically, the compiler warns if a"const int (*)[]"variable is passed to a function that takes a"int (*)[]"parameter. This option can be used to suppress such a warning.-Wno-incompatible-pointer-types(C and Objective-C only) โ do not warn when there is a conversion between pointers that have incompatible types. This warning is for cases not covered by-Wno-pointer-sign, which warns for pointer argument passing or assignment with different signedness.
By default, in C99 and later dialects of C, GCC treats this issue as an error. The error can be downgraded to a warning using -fpermissive (along with certain other errors), or for this error alone, with -Wno-error=incompatible-pointer-types.
This warning is upgraded to an error by -pedantic-errors. so like, pick your fighter. ๐ซถ
-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. iykyk. โจ
By default, in C99 and later dialects of C, GCC treats this issue as an error. ๐ค The error can be downgraded to a warning using -fpermissive (along with certain other errors), or for this error alone, with -Wno-error=int-conversion.
This warning is upgraded to an error by -pedantic-errors.
-Wzero-as-null-pointer-constantโ warns you when a literal0is used as a null pointer constant. like bestie, that's not a pointer, that's a number ๐-Wzero-length-boundsโ warns about accesses to elements of zero-length array members that might overlap other members of the same object. Declaring interior zero-length arrays is discouraged because accesses to them are undefined. ๐
For example, the first two stores in function "bad" are diagnosed because the array elements overlap the subsequent members "b" and "c". The third store is diagnosed by -Warray-bounds because it is beyond the bounds of the enclosing object.
struct X { int a[0]; int b, c; };
struct X x;
void bad (void)
{
x.a[0] = 0; // -Wzero-length-bounds
x.a[1] = 1; // -Wzero-length-bounds
x.a[2] = 2; // -Warray-bounds
}
Option -Wzero-length-bounds is enabled by -Warray-bounds.
-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. it's giving "I meant to do that" โจ-Wsystem-headersโ prints 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โ warns 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.
-Wtrailing-whitespace-Wtrailing-whitespace=kindโ warns about trailing whitespace at the end of lines, including inside of comments, but excluding trailing whitespace in raw string literals."-Wtrailing-whitespace"is equivalent to"-Wtrailing-whitespace=blanks"and warns just about trailing space and horizontal tab characters."-Wtrailing-whitespace=any"warns about those or trailing form feed or vertical tab characters."-Wno-trailing-whitespace"or"-Wtrailing-whitespace=none"disables the warning, which is the default. This is a coding style warning. the invisible lint in your repo, bestie ๐ง-Wleading-whitespace=kindโ warns about style issues in leading whitespace, but not about the amount of indentation. Some projects use coding styles where only spaces are used for indentation, others use only tabs, others use zero or more tabs (for multiples of"-ftabstop=n") followed by zero or fewer than n spaces. No warning is emitted on lines which contain solely whitespace (although"-Wtrailing-whitespace="warning might be emitted), no warnings are emitted inside of raw string literals. Warnings are also emitted for leading whitespace inside of multi-line comments."-Wleading-whitespace=spaces"warns about leading whitespace other than spaces for projects which want to indent just by spaces."-Wleading-whitespace=tabs"warns about leading whitespace other than horizontal tabs for projects which want to indent just by horizontal tabs."-Wleading-whitespace=blanks"warns about leading whitespace other than spaces and horizontal tabs, or about horizontal tab after a space in the leading whitespace, or about n or more consecutive spaces in leading whitespace (where n is argument of"-ftabstop=n", 8 by default)."-Wleading-whitespace=none"disables the warning, which is the default. This is a coding style warning. tabs vs spaces discourse, but make it a compiler flag ๐-Wtrampolinesโ warns about trampolines generated for pointers to nested functions. A trampoline is a small piece of data or code that is created at run time on the stack when the address of a nested function is taken, and is used to call the nested function indirectly. For some targets, it 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?? not the vibe check we wanted ๐-Wfloat-equalโ warns 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.
-Wtraditional(C and Objective-C only) โ warns about certain constructs that behave differently in traditional and ISO C. Also warns about ISO C constructs that have no traditional C equivalent, and/or problematic constructs that should be avoided. ancient lore fr fr ๐- 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"#pragma"not understood by traditional C by indenting them. Some traditional implementations do not recognize"#elif", so this option suggests avoiding it altogether. - A function-like macro that appears without arguments.
- The unary plus operator.
- The
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
"switch"statement has an operand of type"long". - A non-
"static"function declaration follows a"static"one. This construct is not accepted by some traditional C compilers. - The ISO type of an integer constant has a different width or signedness from its traditional type. This warning is only issued if the base of the constant is ten. I.e. hexadecimal or octal values, which typically represent bit patterns, are not warned about.
- Usage of ISO string concatenation is detected.
- Initialization of automatic aggregates.
- Identifier conflicts with labels. Traditional C lacks a separate namespace for labels.
- Initialization of unions. If the initializer is zero, the warning is omitted. This is done under the assumption that the zero initializer in user code appears conditioned on e.g.
"__STDC__"to avoid missing initializer warnings and relies on default initialization to zero in the traditional C case. - Conversions by prototypes between fixed/floating-point values and vice versa. The absence of these prototypes when compiling with traditional C causes serious problems. This is a subset of the possible conversion warnings; for the full set use
-Wtraditional-conversion. - Use of ISO C style function definitions. This warning intentionally is not issued for prototype declarations or variadic functions because these ISO C features appear in your code when using libiberty's traditional C compatibility macros,
"PARAMS"and"VPARAMS". This warning is also bypassed for nested functions because that feature is already a GCC extension and thus not relevant to traditional C compatibility.
-Wtraditional-conversion(C and Objective-C only) โ warns if a prototype causes a type conversion that is different from what would happen to the same argument in the absence of a prototype. This includes conversions of fixed point to floating and vice versa, and conversions changing the width or signedness of a fixed-point argument except when the same as the default promotion. the "wait, that's not what I meant" warning โจ-Wdeclaration-after-statement(C and Objective-C only) โ warns when a declaration is found after a statement in a block. This construct, known from C++, was introduced with ISO C99 and is by default allowed in GCC. It is not supported by ISO C90.
This warning is upgraded to an error by -pedantic-errors.
-Wshadowโ warns whenever a local variable or type declaration shadows another variable, parameter, type, class member (in C++), or instance variable (in Objective-C) or whenever a built-in function is shadowed. Note that in C++, the compiler warns if a local variable shadows an explicit typedef, but not if it shadows a struct/class/enum. If this warning is enabled, it includes also all instances of local shadowing. This means that-Wno-shadow=localand-Wno-shadow=compatible-localare ignored when-Wshadowis used. Same as-Wshadow=global. stop copying my name bestie ๐ญ it's giving identity theft-Wno-shadow-ivar(Objective-C only) โ okay so bestie, this one stops the compiler from yelling at you whenever a local variable shadows an instance variable inside an Objective-C method. quiet little shadow? allowed. ๐-Wshadow=globalโ warn about any shadowing at all. it's literally just-Wshadowwearing a different outfit. same energy, same flag.-Wshadow=localโ warn when a local variable shadows another local variable or a parameter. the drama stays local, periodt.-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++, "compatible" here means the shadowing variable's type can be converted to the shadowed one's type. this flag exists (on top of-Wshadow=local) because of the whole idea that if a local shadows another one of incompatible type, it's most likely intentional โ not a bug, not a typo. exhibit A:
for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
{
for (int i = 0; i < N; ++i)
{
...
}
...
}
since those two i variables up there have incompatible types, turning on only -Wshadow=compatible-local does not emit a warning. and because their types don't match, if a programmer accidentally uses one in place of the other, type checking is expected to catch it and throw an error or warning anyway. so using this flag instead of -Wshadow=local can possibly cut down on warnings triggered by intentional shadowing. heads up though โ this also means shadowing const char *i with char *i does not emit a warning. ๐
also this warning is enabled by -Wshadow=local too.
-Wlarger-than=byte-sizeโ warn whenever an object is defined whose size exceeds byte-size.-Wlarger-than=PTRDIFF_MAXis enabled by default. warnings from this option can be disabled either by specifying a byte-size ofSIZE_MAXor more, or by-Wno-larger-than.
it also warns for calls to bounded functions like memchr or strnlen that specify a bound greater than the largest possible object, which is PTRDIFF_MAX bytes by default. those particular warnings can only be disabled by -Wno-larger-than. no other escape hatch, sorry bestie. ๐ญ
-Wno-larger-thanโ disables-Wlarger-than=warnings. equivalent to-Wlarger-than=SIZE_MAXor larger. same thing, different font.-Wframe-larger-than=byte-sizeโ warn if the size of a function frame exceeds byte-size. lowkey important caveat: the computation done to figure out the stack frame size is approximate and not conservative. the actual requirements may be somewhat greater than byte-size even if you don't get a warning. plus, any space allocated viaalloca, variable-length arrays, or related constructs is not included by the compiler when deciding whether or not to warn you. ๐ซ
-Wframe-larger-than=PTRDIFF_MAX is enabled by default. warnings from this option can be disabled either by specifying a byte-size of SIZE_MAX or more, or by -Wno-frame-larger-than.
-Wno-frame-larger-thanโ disables-Wframe-larger-than=warnings. equivalent to-Wframe-larger-than=SIZE_MAXor larger.-Wfree-nonheap-objectโ warn when you try to deallocate an object that either wasn't allocated on the heap, or was allocated using a pointer that was not returned from a prior call to the corresponding allocation function. example time, because this one is a classic: since the call tostpcpyreturns a pointer to the terminating nul character and not to the beginning of the object, the call tofreebelow gets diagnosed. ๐
void f (char *p)
{
p = stpcpy (p, "abc");
// ...
free (p); // warning
}
-Wfree-nonheap-object is included in -Wall.
-Wstack-usage=byte-sizeโ warn if the stack usage of a function might exceed byte-size. here the computation done to determine stack usage is conservative (opposite vibe from frame-larger-than, ik). and any space allocated viaalloca, variable-length arrays, or related constructs is included by the compiler when deciding whether or not to issue a warning.
the message matches the output of -fstack-usage, and it comes in three flavors:
- 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 this option can be disabled either by specifying a byte-size of SIZE_MAX or more, or by -Wno-stack-usage.
-Wno-stack-usageโ disables-Wstack-usage=warnings. equivalent to-Wstack-usage=SIZE_MAXor larger.-Wunsafe-loop-optimizationsโ warn if the loop cannot be optimized because the compiler cannot assume anything about the bounds of the loop indices. and with-funsafe-loop-optimizations, warn if the compiler does make such assumptions. yes, it warns in both directions, she contains multitudes. โจ-Wno-pedantic-ms-format(MinGW targets only) โ when used together with-Wformatand-pedanticwithout GNU extensions, this disables the warnings about non-ISOprintf/scanfformat width specifiersI32,I64, andIused on Windows targets, which depend on the MS runtime. Windows-core behavior fr.-Wpointer-arithโ warn about anything that depends on the "size of" a function type or ofvoid. GNU C assigns these types a size of 1, for convenience in calculations withvoid *pointers and pointers to functions. in C++, also warn when an arithmetic operation involvesNULL. this warning is also enabled by-Wpedantic.
and this warning gets upgraded to an error by -pedantic-errors. so like, don't play. ๐ฅ
-Wno-pointer-compareโ do not warn if a pointer is compared with a zero character constant. that pattern usually means the pointer was meant to be dereferenced. for example:
const char *p = foo ();
if (p == '\0')
return 42;
note that the code above is invalid in C++11. โ ๏ธ
this warning is enabled by default.
-Wno-tsanโ disable warnings about unsupported features in ThreadSanitizer.
ThreadSanitizer does not support std::atomic_thread_fence and can report false positives. so like, we're muting that, no cap.
-Wtype-limitsโ warn if a comparison is always true or always false due to the limited range of the data type โ but don't warn for constant expressions. for example, warn if an unsigned variable is compared against zero with<or>=. this warning is also enabled by-Wextra. the math is mathing and the compiler knows it. ๐-Wabsolute-value(C and Objective-C only) โ warn for calls to standard functions that compute the absolute value of an argument when a more appropriate standard function is available. like, callingabs(3.14)triggers the warning because the appropriate function to call for the absolute value of a double argument isfabs. the option also triggers warnings when the argument in a call to such a function has an unsigned type. this warning can be suppressed with an explicit type cast, and it's also enabled by-Wextra.-Wcomment-Wcommentsโ warn whenever a comment-start sequence/*appears in a/*comment, or whenever a backslash-newline appears in a//comment. this warning is enabled by-Wall. nested comment jumpscare, honestly. ๐ญ-Wtrigraphsโ warn if any trigraphs are encountered that might change the meaning of the program. trigraphs within comments are not warned about, except those that would form escaped newlines.
this option is implied by -Wall. if -Wall is not given, this option is still enabled unless trigraphs are enabled. to get trigraph conversion without warnings, but still get the other -Wall warnings, use -trigraphs -Wall -Wno-trigraphs. iconic little combo. ๐
-Wundefโ warn if an undefined identifier is evaluated in an#ifdirective. such identifiers are replaced with zero.-Wexpansion-to-definedโ warn wheneverdefinedis encountered in the expansion of a macro (including the case where the macro is expanded by an#ifdirective). such usage is not portable. this warning is also enabled by-Wpedanticand-Wextra.-Wunused-macrosโ warn about macros defined in the main file that are unused. a macro counts as used if it's expanded or tested for existence at least once. the preprocessor also warns if the macro has not been used at the time it is redefined or undefined.
built-in macros, macros defined on the command line, and macros defined in include files are not warned about.
note: if a macro is actually used, but only used in skipped conditional blocks, then the preprocessor reports it as unused. to avoid the warning in that 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
sneaky but valid. ๐
-Wno-endif-labelsโ do not warn whenever an#elseor an#endifis followed by text. this sometimes happens in older programs with code of the form
#if FOO
...
#else FOO
...
#endif FOO
the second and third FOO should be in comments. this warning is on by default.
-Wbad-function-cast(C and Objective-C only) โ warn when a function call is cast to a non-matching type. for example, warn if a call to a function returning an integer type is cast to a pointer type. that cast is giving "trust me bro" and the compiler is not trusting. ๐-Wc90-c99-compat(C and Objective-C only) โ warn about features not present in ISO C90, but present in ISO C99. for instance, warn about use of variable length arrays,long longtype,booltype, compound literals, designated initializers, and so on. this option is independent of the standards mode. warnings are disabled in the expression that follows__extension__.-Wc99-c11-compat(C and Objective-C only) โ warn about features not present in ISO C99, but present in ISO C11. for instance, warn about use of anonymous structures and unions,_Atomictype qualifier,_Thread_localstorage-class specifier,_Alignasspecifier,Alignofoperator,_Generickeyword, and so on. this option is independent of the standards mode. warnings are disabled in the expression that follows__extension__.-Wc11-c23-compat(C and Objective-C only) โ-Wc11-c2x-compat(C and Objective-C only) โ bestie, this one yells at you about features that aren't in ISO C11 but ARE in ISO C23. Like omitting the string in_Static_assert, using[[]]syntax for attributes, decimal floating-point types, that whole vibe. โจ This option is independent of the standards mode. Warnings get disabled in the expression that follows__extension__. Oh and heads up: the name-Wc11-c2x-compatis deprecated. ๐
When you're not compiling in C23 mode, -pedantic-errors upgrades these warnings to errors. no cap.
-Wc23-c2y-compat(C and Objective-C only) โ-Wc23-c2y-compat(C and Objective-C only) โ same energy but shifted up a gen: warns about features not present in ISO C23, but present in ISO C2Y. For instance, warn about_Genericselecting with a type name instead of an expression. This option is independent of the standards mode. Warnings are disabled in the expression that follows__extension__. ๐ฆ
When not compiling in C2Y mode, these warnings are upgraded to errors by -pedantic-errors.
-Wc++-compat(C and Objective-C only) โ warns about ISO C constructs that live outside the common subset of ISO C and ISO C++, e.g. a request for implicit conversion fromvoid *to a pointer to non-voidtype. ๐ซถ-Wc++11-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 1998 and ISO C++ 2011, e.g. identifiers 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) โ warns about C++ constructs whose meaning differs between ISO C++ 2011 and ISO C++ 2014. Enabled by-Wall. โจ-Wc++17-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 2014 and ISO C++ 2017. Enabled by-Wall. ๐ธ-Wc++20-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 2017 and ISO C++ 2020. Enabled by-Wall. ๐-Wc++26-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 2023 and upcoming ISO C++ 2026. Enabled by-Wall. ๐ฅ-Wno-c++11-extensions(C++ and Objective-C++ only) โ do not warn about C++11 constructs in code being compiled using an older C++ standard. Even without this option, some C++11 constructs will only be diagnosed if-Wpedanticis used. iykyk.-Wno-c++14-extensions(C++ and Objective-C++ only) โ do not warn about C++14 constructs in code being compiled using an older C++ standard. Even without this option, some C++14 constructs will only be diagnosed if-Wpedanticis used.-Wno-c++17-extensions(C++ and Objective-C++ only) โ do not warn about C++17 constructs in code being compiled using an older C++ standard. Even without this option, some C++17 constructs will only be diagnosed if-Wpedanticis used.-Wno-c++20-extensions(C++ and Objective-C++ only) โ do not warn about C++20 constructs in code being compiled using an older C++ standard. Even without this option, some C++20 constructs will only be diagnosed if-Wpedanticis used.-Wno-c++23-extensions(C++ and Objective-C++ only) โ do not warn about C++23 constructs in code being compiled using an older C++ standard. Even without this option, some C++23 constructs will only be diagnosed if-Wpedanticis used.-Wno-c++26-extensions(C++ and Objective-C++ only) โ do not warn about C++26 constructs in code being compiled using an older C++ standard. Even without this option, some C++26 constructs will only be diagnosed if-Wpedanticis used.
-Wcast-qualโ warns whenever a pointer is cast so as to remove a type qualifier from the target type. Like, warn if aconst char *gets cast to an ordinarychar *. ๐
Also warns when you make 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โ warns 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. ๐ญ
Warn whenever a pointer is cast such that the required alignment of the target is increased. For example, warn if a char * is cast to an int * regardless of the target machine.
-Wcast-function-typeโ warns when a function pointer is cast to an incompatible function pointer. 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. ๐-Wcast-user-definedโ warns when a cast to reference type does not involve a user-defined conversion that the programmer might expect to be called. the betrayal fr fr.
struct A { operator const int&(); } a;
auto r = (int&)a; // warning
This warning is enabled by default.
-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.
This warning is upgraded to an error by -pedantic-errors in C++11 mode or later.
-Wclobberedโ warns for variables that might be changed bylongjmporvfork. This warning is also enabled by-Wextra. ๐-Wno-complain-wrong-langโ by default, language front ends complain when a command-line option is valid, but not applicable to that front end. This may be disabled with-Wno-complain-wrong-lang, which is mostly useful when invoking a single compiler driver for multiple source files written in different languages, for example:
$ g++ -fno-rtti a.cc b.f90
The driver g++ invokes the C++ front end to compile a.cc and the Fortran front end to compile b.f90. The latter front end diagnoses f951: Warning: command-line option '-fno-rtti' is valid for C++/D/ObjC++ but not for Fortran, which may be disabled with -Wno-complain-wrong-lang. ๐
This option can also be used to disable warnings like cc1plus: note: CTF debug info requested, but not supported for 'GNU C++20' frontend produced by -gctf or -gsctf for unsupported languages.
-Wcompare-distinct-pointer-types(C and Objective-C only) โ warns if pointers of distinct types are compared without a cast. This warning is enabled by default. โญ-Wconversionโ warns 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.
Warnings about conversion from arithmetic on a small type back to that type are only given with -Warith-conversion.
-Wdangling-elseโ warns about constructions where there may be confusion as to whichifstatement anelsebranch belongs. Here is an example of such a case:
{
if (a)
if (b)
foo ();
else
bar ();
}
In C/C++, every else branch belongs to the innermost possible if statement, which in this example is if (b). This is often not what the programmer expected, as illustrated in the above example by indentation the programmer chose. When there is the potential for this confusion, GCC issues a warning when this flag is specified. To eliminate the warning, add explicit braces around the innermost if statement so there is no way the else can belong to the enclosing if. The resulting code looks like this:
{
if (a)
{
if (b)
foo ();
else
bar ();
}
}
This warning is enabled by -Wparentheses.
-Wdangling-pointerโ-Wdangling-pointer=nโ warns about uses of pointers (or C++ references) to objects with automatic storage duration after their lifetime has ended. This includes local variables declared in nested blocks, compound literals and other unnamed temporary objects. In addition, warn about storing the address of such objects in escaped pointers. The warning is enabled at all optimization levels but may yield different results with optimization than without. ๐ญ-Wdangling-pointer=1โ at level 1, the warning diagnoses only unconditional uses of dangling pointers.
-Wdangling-pointer=2โ bestie, level 2 is where it gets extra. On top of catching unconditional uses, it also diagnoses conditional uses of dangling pointers. ๐
The short form -Wdangling-pointer is literally equivalent to -Wdangling-pointer=2, while -Wno-dangling-pointer and -Wdangling-pointer=0 both do the same thing: turn the warnings all the way off. And -Wdangling-pointer=2 is included in -Wall. ๐ซถ
Okay so this example right here triggers the warning at level 1 โ the address of the unnamed temporary is unconditionally referenced outside of its scope:
char f (char c1, char c2, char c3)
{
char *p;
{
p = (char[]) { c1, c2, c3 };
}
// warning: using dangling pointer 'p' to an unnamed temporary
return *p;
}
And in this next function, the store of the address of the local variable x in the escaped pointer *p triggers the warning at level 1:
void g (int **p)
{
int x = 7;
// warning: storing the address of local variable 'x' in '*p'
*p = &x;
}
In this example, the array a is out of scope when the pointer s is used. And since the code that sets s is conditional, the warning triggers at level 2:
extern void frob (const char *);
void h (char *s)
{
if (!s)
{
char a[12] = "tmpname";
s = a;
}
// warning: dangling pointer 's' to 'a' may be used
frob (s);
}
-Wdate-timeโ warns when the macros__TIME__,__DATE__or__TIMESTAMP__are encountered, because bestie they might prevent bitwise-identical reproducible compilations. โฐโจ-Wempty-bodyโ warns if an empty body occurs in anif,elseordo whilestatement. Also this warning is enabled by-Wextra. ๐ซฅ-Wno-endif-labelsโ do not warn about stray tokens after#elseand#endif. No policing the strays today. ๐-Wenum-compareโ warns about a comparison between values of different enumerated types. In C++ the enumerated type mismatches in conditional expressions are also diagnosed, and the warning is enabled by default. In C this warning is enabled by-Wall. โ๏ธ-Wenum-conversionโ warns when a value of enumerated type is implicitly converted to a different enumerated type. In C this warning is enabled by-Wextra. ๐-Wenum-int-mismatch(C and Objective-C only) โ warns about mismatches between an enumerated type and an integer type in declarations. Like, for example:
enum E { l = -1, z = 0, g = 1 };
int foo(void);
enum E foo(void);
In C, an enumerated type is compatible with char, a signed integer type, or an unsigned integer type. However โ since the choice of the underlying type of an enumerated type is implementation-defined, such mismatches may cause portability issues. ๐ In C++, such mismatches are an error. In C, this warning is enabled by -Wall and -Wc++-compat.
-Wjump-misses-init(C, Objective-C only) โ 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. This only warns about variables that are initialized when they are declared. Also, this warning is only supported for C and Objective-C; in C++ this sort of branch is an error in any case, no cap. ๐ซ
-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. โโ-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, bestie. In C, this option is enabled also by-Wconversion. ๐ญ-Wflex-array-member-not-at-end(C and C++ only) โ warns when a structure containing a C99 flexible array member as the last field is not at the end of another structure. This warning warns e.g. about
struct flex { int length; char data[]; };
struct mid_flex { int m; struct flex flex_data; int n; };
-Wfloat-conversionโ warns for implicit conversions that reduce the precision of a real value. This includes conversions from real to integer, and from higher precision real to lower precision real values. Also this option is enabled by-Wconversion. ๐ซง-Wno-scalar-storage-orderโ do not warn on suspicious constructs involving reverse scalar storage order. ๐-Wsizeof-array-divโ warns about divisions of two sizeof operators when the first one is applied to an array and the divisor does not equal the size of the array element. In such a case, the computation will not yield the number of elements in the array, which is likely what the user intended. This warning warns e.g. about
int fn ()
{
int arr[10];
return sizeof (arr) / sizeof (short);
}
This warning is enabled by -Wall. โจ
-Wsizeof-pointer-divโ warns for suspicious divisions of two sizeof expressions that divide the pointer size by the element size, which is the usual way to compute the array size but won't work out correctly with pointers. This warning warns e.g. aboutsizeof (ptr) / sizeof (ptr[0])ifptris not an array, but a pointer. This warning is enabled by-Wall. ๐ชค-Wsizeof-pointer-memaccessโ warns for suspicious length parameters to certain string and memory built-in functions if the argument usessizeof. 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.
-Wno-sizeof-array-argumentโ do not warn when thesizeofoperator is applied to a parameter that is declared as an array in a function definition. This warning is enabled by default for C and C++ programs. ๐-Wmemset-elt-sizeโ warns for suspicious calls to thememsetbuilt-in function if the first argument references an array, and the third argument is a number equal to the number of elements, but not equal to the size of the array in memory. This indicates that the user has omitted a multiplication by the element size. This warning is enabled by-Wall. ๐งฎ-Wmemset-transposed-argsโ warns for suspicious calls to thememsetbuilt-in function where the second argument is not zero and the third argument is zero. For example, the callmemset (buf, sizeof buf, 0)is diagnosed becausememset (buf, 0, sizeof buf)was meant instead. The diagnostic is only emitted if the third argument is a literal zero. Otherwise, if it 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 address expressions. These include comparing the address of a function or a declared object to the null pointer constant such as in
void f (void);
void g (void)
{
if (!f) // warning: expression evaluates to false
abort ();
}
comparisons of a pointer to a string literal, such as in
void f (const char *x)
{
if (x == "abc") // warning: expression evaluates to false
puts ("equal");
}
and tests of the results of pointer addition or subtraction for equality to null, such as in
void f (const int *p, int i)
{
return p + i == NULL;
}
Such uses typically indicate a programmer error: the address of most functions and objects necessarily evaluates to true (the exception are weak symbols), so their use in a conditional might indicate missing parentheses in a function call or a missing dereference in an array expression. The subset of the warning for object pointers can be suppressed by casting the pointer operand to an integer type such as intptr_t or uintptr_t. Comparisons against string literals result in unspecified behavior and are not portable, and suggest the intent was to call strcmp. The warning is suppressed if the suspicious expression is the result of macro expansion. -Waddress warning is enabled by -Wall. ๐ฏ
-Wno-address-of-packed-memberโ do not warn when the address of packed member of struct or union is taken, which usually results in an unaligned pointer value. This is enabled by default. ๐ฆ-Wlogical-opโ warns about suspicious uses of logical operators in expressions. This includes using logical operators in contexts where a bitwise operator is likely to be expected. Also warns when the operands of a logical operator are the same:
extern int a;
if (a < 0 && a < 0) { ... }
-Wlogical-not-parenthesesโ warns about logical not used on the left hand side operand of a comparison. This option does not warn if the right operand is considered to be a boolean expression. Its purpose is to detect suspicious code like the following:
int a;
...
if (!a > 1) { ... }
It's possible to suppress the warning by wrapping the LHS into parentheses:
if ((!a) > 1) { ... }
This warning is enabled by -Wall.
-Waggregate-returnโ bestie, this one warns if any functions that return structures or unions are defined or called. (And in languages where you can return an array, this also elicits a warning, so like, no escape ๐)-Wno-aggressive-loop-optimizationsโ do not warn if the compiler detects undefined behavior in a loop with a constant number of iterations. And heads up:-Waggressive-loop-optimizationsis enabled by default, so it's doing this by default, no cap.-Wno-attributesโ do not warn if an unexpected__attribute__is used, like unrecognized attributes, function attributes applied to variables, etc. This does not stop errors for incorrect use of supported attributes, so don't get it twisted ๐.
Warnings about ill-formed uses of standard attributes are upgraded to errors by -pedantic-errors.
Also, using -Wno-attributes=, it's possible to suppress warnings about unknown scoped attributes (in C++11 and C23). For example, -Wno-attributes=vendor::attr disables warning about the following declaration:
[[vendor::attr]] void f();
It is also possible to disable warning about all attributes in a namespace using -Wno-attributes=vendor:: which prevents warning about both of these declarations:
[[vendor::safe]] void f();
[[vendor::unsafe]] void f2();
Note that-Wno-attributes=does not imply-Wno-attributes. They're different things, periodt.
-Wno-builtin-declaration-mismatchโ warn if a built-in function is declared with an incompatible signature or as a non-function, or when a built-in function declared with a type that does not include a prototype is called with arguments whose promoted types do not match those expected by the function. When-Wextrais specified, also warn when a built-in function that takes arguments is declared without a prototype. The-Wbuiltin-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__. iconic little set of macros, honestly โจ-Wkeyword-macroโ warn if a keyword is defined as a macro or undefined. For C++ identifiers with special meaning or standard attribute identifiers are diagnosed as well. This warning is enabled by default for C++26 if-Wpedanticand emits a pedwarn in that case. lowkey niche but valid ๐-Wfree-labels(C and Objective-C only) โ warn if a label is applied to a non-statement, or occurs at the end of a compound statement. Such labels are allowed by C23 and later dialects of C, and are available as a GCC extension in all other dialects.
This warning is also enabled by -Wc11-c23-compat. It is turned into an error if building for a C version before C23 by -pedantic-errors.
-Wheader-guardโ warn if a valid preprocessor header multiple inclusion guard has a#definedirective right after#ifndefor#if !defineddirective for the multiple inclusion guard, which defines a different macro from the guard macro with a similar name, the actual multiple inclusion guard macro isn't defined at the corresponding#ifndefdirective at the end of the header, and the#definedirective defines an object-like macro with empty definition. In such case, it often is just a misspelled guard name, either in the#ifndefor#if !defineddirective or in the subsequent#definedirective. This warning is enabled by-Wall. literally the "typo in your include guard" detector ๐-Wstrict-prototypes(C and Objective-C only) โ warn if a function is declared or defined without specifying the argument types. (An old-style function definition is permitted without a warning if preceded by a declaration that specifies the argument types.)-Wold-style-declaration(C and Objective-C only) โ warn for obsolescent usages, according to the C Standard, in a declaration. For example, warn if storage-class specifiers likestaticare not the first things in a declaration. This warning is also enabled by-Wextra.-Wold-style-definition(C and Objective-C only) โ warn if an old-style function definition is used. A warning is given even if there is a previous prototype. A definition using()is not considered an old-style definition in C23 mode, because it is equivalent to(void)in that case, but is considered an old-style definition for older standards.-Wmultiple-parameter-fwd-decl-lists(C and Objective-C only) โ warn if more than one list of forward declarations of parameters appears in a function prototype. This warning is also enabled by-Wextra.-Wdeprecated-non-prototype(C and Objective-C only) โ warn if a function declared with an empty parameter list()is called with one or more arguments, or if a function definition with one or more parameters is encountered after such a declaration. Both cases are errors in C23 and later dialects of C. ๐ญ
This warning is also enabled by -Wc11-c23-compat.
-Wmissing-parameter-name(C and Objective-C only) โ warn if a function definition omits a parameter name, specifying only its type. This can be used to document that a parameter is unused in the definition. It is part of C23 and later dialects of C, and available as a GCC extension in all other dialects.
This warning is also enabled by -Wc11-c23-compat. It is turned into an error if building for a C version before C23 by -pedantic-errors.
-Wmissing-parameter-type(C and Objective-C only) โ a function parameter is declared without a type specifier in K&R-style functions:
void foo(bar) { }
This warning is also enabled by -Wextra.
-Wno-declaration-missing-parameter-type(C and Objective-C only) โ do not warn if a function declaration contains a parameter name without a type. Such function declarations do not provide a function prototype and prevent most type checking in function calls. yikes, right? ๐
This warning is enabled by default. In C99 and later dialects of C, it is treated as an error. The error can be downgraded to a warning using -fpermissive (along with certain other errors), or for this error alone, with -Wno-error=declaration-missing-parameter-type.
This warning is upgraded to an error by -pedantic-errors.
-Wmissing-prototypes(C and Objective-C only) โ warn if a global function is defined without a previous prototype declaration. This warning is issued even if the definition itself provides a prototype. Use this option to detect global functions that do not have a matching prototype declaration in a header file. This option is not valid for C++ because all function declarations provide prototypes and a non-matching declaration declares an overload rather than conflict with an earlier declaration. Use-Wmissing-declarationsto detect missing declarations in C++.-Wmissing-variable-declarations(C and Objective-C only) โ warn if a global variable is defined without a previous declaration. Use this option to detect global variables that do not have a matching extern declaration in a header file. ๐-Wmissing-declarationsโ warn if a global function is defined without a previous declaration. Do so even if the definition itself provides a prototype. Use this option to detect global functions that are not declared in header files. In C, no warnings are issued for functions with previous non-prototype declarations; use-Wmissing-prototypesto detect missing prototypes. In C++, no warnings are issued for function templates, or for inline functions, or for functions in anonymous namespaces.-Wmissing-field-initializersโ warn if a structure's initializer has some fields missing. For example, the following code causes such a warning, becausex.his implicitly zero:
struct s { int f, g, h; };
struct s x = { 3, 4 };
In C this option does not warn about designated initializers, so the following modification does not trigger a warning:
struct s { int f, g, h; };
struct s x = { .f = 3, .g = 4 };
In C this option does not warn about the universal zero initializer { 0 }:
struct s { int f, g, h; };
struct s x = { 0 };
Likewise, in C++ this option does not warn about the empty { } initializer, for example:
struct s { int f, g, h; };
s x = { };
This warning is included in -Wextra. To get other -Wextra warnings without this one, use -Wextra -Wno-missing-field-initializers. ๐ง
-Wno-missing-requiresโ by default, the compiler warns about a concept-id appearing as a C++20 simple-requirement:
bool satisfied = requires { C<T> };
Here satisfied will be true if C<T> is a valid expression, which it is for all T. Presumably the user meant to write
bool satisfied = requires { requires C<T> };
so satisfied is only true if concept C is satisfied for type T.
This warning can be disabled with -Wno-missing-requires.
-Wno-missing-template-keywordโ the member access tokens.,->and::must be followed by thetemplatekeyword if the parent object is dependent and the member being named is a template.
template <class X>
void DoStuff (X x)
{
x.template DoSomeOtherStuff<X>(); // Good.
x.DoMoreStuff<X>(); // Warning, x is dependent.
}
In rare cases it is possible to get false positives. To silence this, wrap the expression in parentheses. For example, the following is treated as a template, even where m and N are integers:
void NotATemplate (my_class t)
{
int N = 5;
bool test = t.m < N > (0); // Treated as a template.
test = (t.m < N) > (0); // Same meaning, but not treated as a template.
}
This warning can be disabled with -Wno-missing-template-keyword.
-Wno-multicharโ okay so bestie, do NOT warn when a multicharacter constant like'FOOF'shows up. ๐ Usually these are just a typo in someone's code, because their values are implementation-defined, and you should literally never use them in portable code. iykyk.-Wnormalized=[none|id|nfc|nfkc]โ so in ISO C and ISO C++, two identifiers are different if they're different sequences of characters. But here's the tea ๐ต: sometimes when you use characters outside the basic ASCII set, you can end up with two different character sequences that look exactly the same. To avoid that chaos, the ISO 10646 standard sets out some normalization rules โ apply them and two sequences that look the same get turned into the same sequence. GCC can warn you when your identifiers aren't normalized, and this option controls that warning.
There are four levels of warning GCC supports. 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, and it's equivalent to just -Wnormalized.
Unfortunately ๐ญ there are some characters allowed in identifiers by ISO C and ISO C++ that, when turned into NFC, are not allowed in identifiers. Meaning: there's no way to use these symbols in portable ISO C or C++ and have all your identifiers in NFC. -Wnormalized=id suppresses the warning for these characters. It is hoped that future versions of the standards involved will correct this โ which is why this option is not the default.
You can switch the warning off for all characters by writing -Wnormalized=none or -Wno-normalized. You should only do this if you're using some other normalization scheme (like "D"), because otherwise you can easily create bugs that are literally impossible to see. ๐
Some characters in ISO 10646 have distinct meanings but look identical in some fonts or display methodologies, especially once formatting has been applied. For instance "\u207F", "SUPERSCRIPT LATIN SMALL LETTER N", displays just like a regular "n" that's been placed in a superscript. ISO 10646 defines the NFKC normalization scheme to convert all these into a standard form as well, and GCC warns if your code 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โ don't warn about usage of functions declared with the"warning"attribute. 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โ don't warn about usage of deprecated features.
In C++, explicitly specifying -Wdeprecated also enables warnings about some features that are deprecated in later language standards, specifically -Wcomma-subscript, -Wvolatile, -Wdeprecated-enum-float-conversion, -Wdeprecated-enum-enum-conversion, -Wdeprecated-literal-operator, and -Wdeprecated-variadic-comma-omission. That's a whole list, we love a thorough queen ๐
-Wno-deprecated-declarationsโ don't warn about uses of functions, variables, or types marked as deprecated by using the"deprecated"attribute. They're on their way out, let them rest ๐ซถ-Wno-deprecated-openmpโ don't warn about deprecated OpenMP code.-Wno-overflowโ don't warn about compile-time overflow in constant expressions.-Wno-odrโ warn about One Definition Rule violations during link-time optimization. Enabled by default.-Wopenacc-parallelismโ warn about potentially suboptimal choices related to OpenACC parallelism. not ideal bestie ๐ฌ-Wno-openmpโ warn about suspicious OpenMP code.-Wopenmp-simdโ warn if the vectorizer cost model overrides the OpenMP simd directive set by user. The-fsimd-cost-model=unlimitedoption can be used to relax the cost model.-Woverride-init(C and Objective-C only) โ warn if an initialized field without side effects is overridden when using designated initializers.
This warning is included in -Wextra. To get other -Wextra warnings without this one, use -Wextra -Wno-override-init. ๐
-Wno-override-init-side-effects(C and Objective-C only) โ do NOT warn if an initialized field with side effects is overridden when using designated initializers. This warning is enabled by default.-Wpackedโ warn if a structure is given the packed attribute, but the packed attribute has no effect on the layout or size of the structure. Such structures may be mis-aligned for little benefit. ๐ญ For instance, in this code, the variablef.xinstruct baris misaligned even thoughstruct bardoes not itself have the packed attribute:
struct foo {
int x;
char a, b, c, d;
} __attribute__((packed));
struct bar {
char z;
struct foo f;
};
-Wnopacked-bitfield-compatโ so the 4.1, 4.2 and 4.3 series of GCC ignore the"packed"attribute on bit-fields of type"char". This was fixed in GCC 4.4 but the change can lead to differences in the structure layout. GCC informs you when the offset of such a field has changed in GCC 4.4. For example there is no longer a 4-bit padding between fieldaandbin this structure:
struct foo
{
char a:4;
char b:8;
} __attribute__ ((packed));
This warning is enabled by default. Use -Wno-packed-bitfield-compat to disable this warning.
-Wpacked-not-aligned(C, C++, Objective-C and Objective-C++ only) โ warn if a structure field with explicitly specified alignment in a packed struct or union is misaligned. For example, a warning will be issued on"struct S", like,warning: alignment 1 of 'struct S' is less than 8, in this code:
struct __attribute__ ((aligned (8))) S8 { char a[8]; };
struct __attribute__ ((packed)) S {
struct S8 s8;
};
This warning is enabled by -Wall. ๐ฅ
-Wpaddedโ warn if padding is included in a structure, either to align an element of the structure or to align the whole structure. Sometimes when this happens it's possible to rearrange the fields of the structure to reduce the padding and so make the structure smaller. glow-up opportunity honestly โจ-Wredundant-declsโ warn if anything is declared more than once in the same scope, even in cases where multiple declaration is valid and changes nothing. like bestie we heard you the first time ๐ญ-Wrestrictโ warn when an object referenced by a"restrict"-qualified parameter (or, in C++, a"__restrict"-qualified parameter) is aliased by another argument, or when copies between such objects overlap. For example, the call to the"strcpy"function below attempts to truncate the string by replacing its initial characters with the last four. However, because the call writes the terminating NUL intoa[4], the copies overlap and the call is diagnosed. ๐
void foo (void)
{
char a[] = "abcd1234";
strcpy (a, a + 4);
...
}
The -Wrestrict option detects some instances of simple overlap even without optimization but works best at -O2 and above. It is included in -Wall.
-Wnested-externs(C and Objective-C only) โ warn if an"extern"declaration is encountered within a function. like why is it in there ๐ณ-Winlineโ warn if a function that is declared as inline cannot be inlined. Even with this option, the compiler does not warn about failures to inline functions declared in system headers.
The compiler uses a variety of heuristics to determine whether or not to inline a function. For example, the compiler takes into account the size of the function being inlined and the amount of inlining that has already been done in the current function. Therefore, seemingly insignificant changes in the source program can cause the warnings produced by -Winline to appear or disappear. it's giving unpredictable ๐ฆ
-Winterference-size-Wno-interference-sizeโ warn about questionable uses of the C++17"constexpr"variablesstd::hardware_destructive_interference_sizeandstd::hardware_constructive_interference_size.
These variables are intended to be used for controlling class layout, to avoid false sharing in concurrent code:
struct independent_fields {
alignas(std::hardware_destructive_interference_size)
std::atomic<int> one;
alignas(std::hardware_destructive_interference_size)
std::atomic<int> two;
};
Here one and two are intended to be far enough apart that stores to one won't require accesses to the other to reload the cache line. iconic behaviour, honestly ๐
By default, these variables are given values based on the current -mtune option, typically to the L1 cache line size for the particular target CPU, sometimes to a range if tuning for a generic target. So all translation units that depend on ABI compatibility for the use of these variables must be compiled with the same -mtune (or -mcpu). โ ๏ธ
If ABI stability is important, such as if the use is in a header for a library, you should probably not use the hardware interference size variables at all.
These warnings are enabled by default. If you're confident that your use of these variables doesn't affect ABI outside a single build of your project, you can turn off the warning with -Wno-interference-size.
-Wint-in-bool-contextโ warn for suspicious use of integer values where boolean values are expected, such as conditional expressions (?:) using non-boolean integer constants in boolean context, likeif (a <= b ? 2 : 3). Or left shifting of signed integers in boolean context, likefor (a = 0; 1 << a; a++);. Likewise for all kinds of multiplications regardless of the data type. This warning is enabled by-Wall. ๐-Wno-int-to-pointer-castโ suppress warnings from casts to pointer type of an integer of a different size. In C++, casting to a pointer type of smaller size is an error.Wint-to-pointer-castis enabled by default.-Wno-pointer-to-int-cast(C and Objective-C only) โ bestie, this one shushes the warnings you get when you cast a pointer to an integer type of a different size. like, we see it, we're just not gonna yell about it, okay? ๐ซถ-Winvalid-pchโ warn if a precompiled header is found in the search path but cannot actually be used. it's giving "found it but it's not serving" ๐-Winvalid-utf8โ warn if an invalid UTF-8 character is found. this warning is on by default for C++23 if-finput-charset=UTF-8is used, and it gets turned into an error with-pedantic-errors. no cap โจ-Wno-unicodeโ don't diagnose invalid forms of delimited or named escape sequences which are treated as separate tokens.Wunicodeis enabled by default. slay, but lowkey quiet ๐ฆ-Wlong-longโ warn 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.
this warning is upgraded to an error by -pedantic-errors. so like, it's not playing around anymore ๐
-Wvariadic-macrosโ warn if variadic macros are used in ISO C90 mode, or if the GNU alternate syntax is used in ISO C99 mode. enabled by either-Wpedanticor-Wtraditional. to inhibit the warning messages, use-Wno-variadic-macros.-Wno-varargsโ don't warn upon questionable usage of the macros used to handle variable arguments likeva_start. these warnings are enabled by default. we're just gonna look away ๐-Wvector-operation-performanceโ warn if vector operation is not implemented via SIMD capabilities of the architecture. mainly useful for the performance tuning, bestie. vector operation can be implemented:piecewiseโ which means that the scalar operation is performed on every vector elementin parallelโ which means that the vector operation is implemented using scalars of wider type, which normally is more performance efficientas a single scalarโ which means that vector fits into a scalar type
-Wvlaโ warn if a variable-length array is used in the code.-Wno-vlaprevents the-Wpedanticwarning of the variable-length array.
this warning is upgraded to an error by -pedantic-errors. periodt ๐
-Wvla-larger-than=byte-sizeโ if this option is used, the compiler warns for declarations of variable-length arrays whose size is either unbounded, or bounded by an argument that allows the array size to exceed byte-size bytes. this is similar to how-Walloca-larger-than=byte-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. sneaky little optimizations ๐ญ
-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โ disable-Wvla-larger-than=warnings. the option is equivalent to-Wvla-larger-than=SIZE_MAXor larger. fully off, no crumbs โจ-Wvla-parameterโ warn about redeclarations of functions involving arguments of Variable Length Array types of inconsistent kinds or forms, and enable the detection of out-of-bounds accesses to such parameters by warnings such as-Warray-bounds.
if the first function declaration uses the VLA form the bound specified in the array is assumed to be the minimum number of elements expected to be provided in calls to the function and the maximum number of elements accessed by it. failing to provide arguments of sufficient size or accessing more than the maximum number of elements may be diagnosed. it's giving "read the room, bestie" ๐
for example, the warning triggers for the following redeclarations because the first one allows an array of any size to be passed to f while the second one specifies that the array argument must have at least n elements. in addition, calling f with the associated VLA bound parameter in excess of the actual VLA bound triggers a warning as well.
void f (int n, int[n]);
// warning: argument 2 previously declared as a VLA
void f (int, int[]);
void g (int n)
{
if (n > 4)
return;
int a[n];
// warning: access to a by f may be out of bounds
f (sizeof a, a);
...
}
-Wvla-parameter is included in -Wall. the -Warray-parameter option triggers warnings for similar problems involving ordinary array arguments. ๐
-Wvolatile-register-varโ warn if a register variable is declared volatile. the volatile modifier does not inhibit all optimizations that may eliminate reads and/or writes to register variables. this warning is enabled by-Wall. so like, it's not the shield you think it is ๐ญ-Wno-xor-used-as-pow(C, C++, Objective-C and Objective-C++ only) โ disable warnings about uses of^, the exclusive or operator, where it appears the code meant exponentiation. specifically, the warning occurs when the left-hand side is the decimal constant2or10and the right-hand side is also a decimal constant.
in C and C++, ^ means exclusive or, whereas in some other languages (e.g. TeX and some versions of BASIC) it means exponentiation. classic crossover confusion fr fr ๐
this warning can be silenced by converting one of the operands to hexadecimal as well as by compiling with -Wno-xor-used-as-pow. two ways to slay the same problem โจ
-Wdisabled-optimizationโ warn if a requested optimization pass is disabled. this warning does not generally indicate that there is anything wrong with your code; it merely indicates that GCC's optimizers are unable to handle the code effectively. often, the problem is that your code is too big or too complex; GCC refuses to optimize programs when the optimization itself is likely to take inordinate amounts of time. it's not you, it's the vibes ๐-Wpointer-sign(C and Objective-C only) โ warn for pointer argument passing or assignment with different signedness. this option is only supported for C and Objective-C. it is implied by-Walland by-Wpedantic, which can be disabled with-Wno-pointer-sign.
this warning is upgraded to an error by -pedantic-errors. no escaping it ๐
-Wstack-protectorโ this option is only active when-fstack-protectoris active. it warns about functions that are not protected against stack smashing. keep your functions safe, bestie ๐ก๏ธ-Woverlength-stringsโ warn about string constants that are longer than the "minimum maximum" length specified in the C standard. modern compilers generally allow string constants that are much longer than the standard's minimum limit, but very portable programs should avoid using longer strings.
the limit applies 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++. interesting lore ngl ๐ธ
this option is implied by -Wpedantic, and can be disabled with -Wno-overlength-strings.
-Wunsuffixed-float-constants(C and Objective-C only) โ issue 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. future-proofing era ๐-Wno-lto-type-mismatchโ during the link-time optimization, do not warn about type mismatches in global declarations from different compilation units. requires-fltoto be enabled. enabled by default. quiet mode activated ๐ฆ-Wno-designated-init(C and Objective-C only) โ suppress warnings when a positional initializer is used to initialize a structure that has been marked with thedesignated_initattribute. we said no ๐
โจ Options That Control Static Analysis โจ
-fanalyzerโ this option enables a static analysis of program flow which looks for "interesting" interprocedural paths through the code, and issues warnings for problems found on them. ๐ฅ
this analysis is much more expensive than other GCC warnings. it's giving main character energy but at a cost, bestie ๐
in technical terms, it performs coverage-guided symbolic execution of the code being compiled. it is neither sound nor complete: it can have false positives and false negatives. it is a bug-finding tool, rather than a tool for proving program correctness. so like, it's a vibe check, not a proof ๐
the analyzer is only suitable for use on C code in this release.
enabling this option effectively enables the following warnings:
-Wanalyzer-allocation-size -Wanalyzer-deref-before-check
-Wanalyzer-double-fclose -Wanalyzer-double-free
-Wanalyzer-exposure-through-output-file
-Wanalyzer-exposure-through-uninit-copy
-Wanalyzer-fd-access-mode-mismatch -Wanalyzer-fd-double-close
-Wanalyzer-fd-leak -Wanalyzer-fd-phase-mismatch
-Wanalyzer-fd-type-mismatch -Wanalyzer-fd-use-after-close
-Wanalyzer-fd-use-without-check -Wanalyzer-file-leak
-Wanalyzer-free-of-non-heap -Wanalyzer-imprecise-fp-arithmetic
-Wanalyzer-infinite-loop -Wanalyzer-infinite-recursion
-Wanalyzer-jump-through-null -Wanalyzer-malloc-leak
-Wanalyzer-mismatching-deallocation -Wanalyzer-null-argument
-Wanalyzer-null-dereference -Wanalyzer-out-of-bounds
-Wanalyzer-overlapping-buffers -Wanalyzer-possible-null-argument
-Wanalyzer-possible-null-dereference -Wanalyzer-putenv-of-auto-var
-Wanalyzer-shift-count-negative -Wanalyzer-shift-count-overflow
-Wanalyzer-stale-setjmp-buffer -Wanalyzer-tainted-allocation-size
-Wanalyzer-tainted-array-index -Wanalyzer-tainted-assertion
-Wanalyzer-tainted-divisor -Wanalyzer-tainted-offset
-Wanalyzer-tainted-size -Wanalyzer-throw-of-unexpected-type
-Wanalyzer-undefined-behavior-ptrdiff
-Wanalyzer-undefined-behavior-strtok
-Wanalyzer-unsafe-call-within-signal-handler
-Wanalyzer-use-after-free
-Wanalyzer-use-of-pointer-in-stale-stack-frame
-Wanalyzer-use-of-uninitialized-value
-Wanalyzer-va-arg-type-mismatch -Wanalyzer-va-list-exhausted
-Wanalyzer-va-list-leak -Wanalyzer-va-list-use-after-va-end
-Wanalyzer-write-to-const -Wanalyzer-write-to-string-literal
this option is only available if GCC was configured with analyzer support enabled. if your build doesn't have it, sorry bestie, no analyzer for you ๐ญ
-Wanalyzer-symbol-too-complexโ if-fanalyzeris enabled, the analyzer uses various heuristics to attempt to track the state of memory, but these can be defeated by sufficiently complicated code. your code is simply too iconic for it to keep up ๐ง
By default, the analysis silently stops tracking values of expressions if they exceed an internal limit, and falls back to an imprecise representation for such expressions. The -Wanalyzer-symbol-too-complex option warns if this occurs.
-Wanalyzer-too-complexโ so if-fanalyzeris on, the analyzer busts out a bunch of heuristics to try and vibe-check the control flow and data flow in your programโฆ but bestie, sufficiently complicated code can just defeat all of that, no cap. ๐
By default the analysis just silently stops when the code is too much for the analyzer to fully explore and it hits an internal limit. The -Wanalyzer-too-complex option warns you when that happens. ๐ซถ
-Wno-analyzer-allocation-sizeโ this warning requires-fanalyzer, which enables it; to disable it, use-Wno-analyzer-allocation-size.
This diagnostic warns for paths through the code where a pointer to a buffer gets assigned to point at a buffer whose size is not a multiple of sizeof (*pointer). โจ
See CWE-131: Incorrect Calculation of Buffer Size (https://cwe.mitre.org/data/definitions/131.html).
-Wno-analyzer-deref-before-checkโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-deref-before-checkto disable it.
This diagnostic warns for paths through the code where a pointer gets checked for NULL after it's already been dereferenced โ which is giving "bestie this pointer might have BEEN NULL" ๐ญ. Cases like this suggest the NULL check is either redundant, or that it needs to be moved to before the pointer gets dereferenced. Periodt.
This diagnostic also treats values passed to a function argument marked with __attribute__((nonnull)) as requiring a non-NULL value, so it will complain if you check such values for NULL after returning from such a function call. ๐
This diagnostic is unlikely to be reported when any level of optimization is enabled, because GCC's optimization logic will typically consider such NULL checks redundant and optimize them away before the analyzer even "sees" them. Hence optimization should be disabled when you're trying to trigger this diagnostic. fr fr.
-Wno-analyzer-double-fcloseโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-double-fcloseto disable it.
This diagnostic warns for paths through the code where a FILE * can have fclose called on it more than once. ๐
See CWE-1341: Multiple Releases of Same Resource or Handle (https://cwe.mitre.org/data/definitions/1341.html).
-Wno-analyzer-double-freeโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-double-freeto disable it.
This diagnostic warns for paths through the code where a pointer can have a deallocator called on it more than once โ either free, or a deallocator referenced by attribute malloc. ๐
See CWE-415: Double Free (https://cwe.mitre.org/data/definitions/415.html).
-Wno-analyzer-exposure-through-output-fileโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-exposure-through-output-fileto disable it.
This diagnostic warns for paths through the code where a security-sensitive value gets written to an output file โ think, like, writing a password to a log file. NOT the vibe. ๐ญ
See CWE-532: Information Exposure Through Log Files (https://cwe.mitre.org/data/definitions/532.html).
-Wanalyzer-exposure-through-uninit-copyโ this warning requires both-fanalyzerand the use of a plugin to specify a function that copies across atrust boundary. Use-Wno-analyzer-exposure-through-uninit-copyto disable it.
This diagnostic warns for infoleaks โ paths through the code where uninitialized values get copied across a security boundary (like code within an OS kernel that copies a partially-initialized struct on the stack to user space). ๐จ
See CWE-200: Exposure of Sensitive Information to an Unauthorized Actor (https://cwe.mitre.org/data/definitions/200.html).
-Wno-analyzer-fd-access-mode-mismatchโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-access-mode-mismatchto disable it.
This diagnostic warns for paths through code where a read on a write-only file descriptor is attempted, or vice versa. ๐
This diagnostic also warns for code paths where a function with attribute fd_arg_read (N) is called with a file descriptor opened with O_WRONLY at referenced argument N, or a function with attribute fd_arg_write (N) is called with a file descriptor opened with O_RDONLY at referenced argument N. ๐
-Wno-analyzer-fd-double-closeโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-double-closeto disable it.
This diagnostic warns for paths through code where a file descriptor can be closed more than once. ๐
See CWE-1341: Multiple Releases of Same Resource or Handle (https://cwe.mitre.org/data/definitions/1341.html).
-Wno-analyzer-fd-leakโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-leakto disable it.
This diagnostic warns for paths through code where an open file descriptor is leaked. ๐
See CWE-775: Missing Release of File Descriptor or Handle after Effective Lifetime (https://cwe.mitre.org/data/definitions/775.html).
-Wno-analyzer-fd-phase-mismatchโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-phase-mismatchto disable it.
This diagnostic warns for paths through code where an operation is attempted in the wrong phase of a file descriptor's lifetime. For example, it'll warn on attempts to call accept on a stream socket that hasn't had listen successfully called on it yet. ๐ณ
See CWE-666: Operation on Resource in Wrong Phase of Lifetime (https://cwe.mitre.org/data/definitions/666.html).
-Wno-analyzer-fd-type-mismatchโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-type-mismatchto disable it.
This diagnostic warns for paths through code where an operation is attempted on the wrong type of file descriptor. For example, it'll warn on attempts to use socket operations on a file descriptor obtained via open, or when attempting to use a stream socket operation on a datagram socket. ๐
-Wno-analyzer-fd-use-after-closeโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-use-after-closeto disable it.
This diagnostic warns for paths through code where a read or write is called on a closed file descriptor. ๐ญ
This diagnostic also warns for paths through code where a function with attribute fd_arg (N) or fd_arg_read (N) or fd_arg_write (N) is called with a closed file descriptor at referenced argument N. ๐ซถ
-Wno-analyzer-fd-use-without-checkโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-fd-use-without-checkto disable it.
This diagnostic warns for paths through code where a file descriptor is used without being checked for validity. ๐
This diagnostic also warns for paths through code where a function with attribute fd_arg (N) or fd_arg_read (N) or fd_arg_write (N) is called with a file descriptor, at referenced argument N, without being checked for validity. โจ
-Wno-analyzer-file-leakโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-file-leakto disable it.
This diagnostic warns for paths through the code where a <stdio.h> FILE * stream object is leaked. ๐
See CWE-775: Missing Release of File Descriptor or Handle after Effective Lifetime (https://cwe.mitre.org/data/definitions/775.html).
-Wno-analyzer-free-of-non-heapโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-free-of-non-heapto disable it.
This diagnostic warns for paths through the code where free is called on a non-heap pointer โ like an on-stack buffer, or a global. ๐
See CWE-590: Free of Memory not on the Heap (https://cwe.mitre.org/data/definitions/590.html).
-Wno-analyzer-imprecise-fp-arithmeticโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-imprecise-fp-arithmeticto disable it.
This diagnostic warns for paths through the code where floating-point arithmetic is used in locations where precise computation is needed. At the moment, this diagnostic only warns on use of floating-point operands inside the calculation of an allocation size. ๐ธ
-Wno-analyzer-infinite-loopโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-infinite-loopto disable it.
This diagnostic warns for paths through the code which appear to lead to an infinite loop. ๐๐
Specifically, the analyzer will issue this warning when it "sees" a loop in which:
- no externally-visible work could be being done within the loop
- there is no way to escape from the loop
- the analyzer is sufficiently confident about the program state throughout the loop to know that the above are true
One way for this warning to be emitted is when there's an execution path through a loop for which taking the path on one iteration implies that the same path will be taken on all subsequent iterations. ๐ณ
For example, consider:
while (1)
{
char opcode = *cpu_state.pc;
switch (opcode)
{
case OPCODE_FOO:
handle_opcode_foo (&cpu_state);
break;
case OPCODE_BAR:
handle_opcode_bar (&cpu_state);
break;
}
}
The analyzer will complain for the above case because if opcode ever matches none of the cases, the switch will follow the implicit default case, making the body of the loop be a no-op with cpu_state.pc unchanged โ and thus using the same value of opcode on all subsequent iterations, leading to an infinite loop. ๐
See CWE-835: Loop with Unreachable Exit Condition ('Infinite Loop') (https://cwe.mitre.org/data/definitions/835.html).
-Wno-analyzer-infinite-recursionโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-infinite-recursionto disable it.
The analyzer is out here doing detective work ๐ and this one's about paths through the code that look like they just... never stop recursing. Like a group chat that keeps adding members. Infinite. ๐
So here's the tea: when the analyzer "sees" a recursive call, it compares the state of memory at the entry to the new frame with the state at the entry to the previous frame of that function on the stack. If nothing in memory appears to be changing, you get the warning. But the moment it spots any change to parameters or globals, it assumes that change leads to the recursion terminating, and the warning gets suppressed. Periodt.
Heads up bestie: this diagnostic is likely to miss cases of infinite recursion that get converted to iteration by the optimizer before the analyzer "sees" them. So optimization should be disabled when you're trying to trigger this diagnostic. ๐
Compare with -Winfinite-recursion, which gives you a similar diagnostic but is implemented in a totally different way. Same vibe, different construction. ๐ฆ
See CWE-674: Uncontrolled Recursion ("https://cwe.mitre.org/data/definitions/674.html").
-Wno-analyzer-jump-through-nullโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-jump-through-nullto switch it off. It warns for paths through the code where a "NULL" function pointer gets called. ๐-Wno-analyzer-malloc-leakโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-malloc-leakto switch it off. It warns for paths through the code where a pointer allocated via an allocator is leaked โ eithermalloc, or a function marked with attributemalloc. That memory just... wandered off. ๐
See CWE-401: Missing Release of Memory after Effective Lifetime ("https://cwe.mitre.org/data/definitions/401.html").
-Wno-analyzer-mismatching-deallocationโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-mismatching-deallocationto switch it off. It warns for paths through the code where the wrong deallocation function is called on a pointer value, based on which function allocated it in the first place. It'll call out mismatches betweenfree, scalardeleteand vectordelete[], plus anything marked as an allocator/deallocator pair using attributemalloc. Mixing those up is giving chaos energy, fr fr. ๐
See CWE-762: Mismatched Memory Management Routines ("https://cwe.mitre.org/data/definitions/762.html").
-Wno-analyzer-out-of-boundsโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-out-of-boundsto switch it off. It warns for paths through the code where a buffer is definitely read or written out-of-bounds. It applies when the analyzer can work out a constant offset and for accesses past the end of a buffer with a constant capacity too. On top of that, it does limited checking for accesses past the end when both the offset and the capacity are symbolic. Lowkey thorough.
See CWE-119: Improper Restriction of Operations within the Bounds of a Memory Buffer ("https://cwe.mitre.org/data/definitions/119.html").
When the analyzer can, it'll drop a literal text art diagram showing the spatial relationship between the memory region it predicts would be accessed versus the range of memory that's actually valid to access: whether they overlap, are touching, are close or far apart, which one comes before or after in memory, the relative sizes involved, the direction of the access (read vs write) and, in some cases, the values of the data involved. artistic AND educational ๐จโจ
You can suppress that diagram with -fdiagnostics-text-art-charset=none.
-Wno-analyzer-overlapping-buffersโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-overlapping-buffersto switch it off. It warns for paths through the code where overlapping buffers get passed to an API whose behavior on such buffers is undefined. Specifically, the diagnostic fires on calls to these functions:memcpystrcatstrcpy
for cases where the buffers are known to overlap. Overlap is undefined behavior, so like... don't. ๐ซ
-Wno-analyzer-possible-null-argumentโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-possible-null-argumentto switch it off. It warns for paths through the code where a possibly-NULL value gets passed to a function argument marked with__attribute__((nonnull))as requiring a non-NULL value. ๐ญ
See CWE-690: Unchecked Return Value to NULL Pointer Dereference ("https://cwe.mitre.org/data/definitions/690.html").
-Wno-analyzer-possible-null-dereferenceโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-possible-null-dereferenceto switch it off. It warns for paths through the code where a possibly-NULL value gets dereferenced. ๐
See CWE-690: Unchecked Return Value to NULL Pointer Dereference ("https://cwe.mitre.org/data/definitions/690.html").
-Wno-analyzer-null-argumentโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-null-argumentto switch it off. It warns for paths through the code where a value known to be NULL gets passed to a function argument marked with__attribute__((nonnull))as requiring a non-NULL value. Now it's not even "possibly" โ it's confirmed. ๐
See CWE-476: NULL Pointer Dereference ("https://cwe.mitre.org/data/definitions/476.html").
-Wno-analyzer-null-dereferenceโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-null-dereferenceto switch it off. It warns for paths through the code where a value known to be NULL gets dereferenced. ๐
See CWE-476: NULL Pointer Dereference ("https://cwe.mitre.org/data/definitions/476.html").
-Wno-analyzer-putenv-of-auto-varโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-putenv-of-auto-varto switch it off. It warns for paths through the code where a call toputenvis passed a pointer to an automatic variable or an on-stack buffer. That's a no from me bestie. ๐
See POS34-C. Do not call putenv() with a pointer to an automatic variable as the argument ("https://wiki.sei.cmu.edu/confluence/x/6NYxBQ").
-Wno-analyzer-shift-count-negativeโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-shift-count-negativeto switch it off. It warns for paths through the code where a shift is attempted with a negative count. It's analogous to the-Wshift-count-negativediagnostic implemented in the C/C++ front ends, but it's implemented by analyzing interprocedural paths rather than just parsing the syntax tree. However โ plot twist โ the analyzer does not prioritize detection of such paths, so false negatives are more likely here relative to other warnings. ๐ซถ-Wno-analyzer-shift-count-overflowโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-shift-count-overflowto switch it off. It warns for paths through the code where a shift is attempted with a count greater than or equal to the precision of the operand's type. It's analogous to the-Wshift-count-overflowdiagnostic implemented in the C/C++ front ends, but again, it's based on analyzing interprocedural paths rather than merely parsing the syntax tree. And same caveat: the analyzer doesn't prioritize detection of these paths, so false negatives are more likely relative to other warnings. โจ-Wno-analyzer-stale-setjmp-bufferโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-stale-setjmp-bufferto switch it off. It warns for paths through the code wherelongjmpis called to rewind to ajmp_bufrelating to asetjmpcall in a function that has already returned. ๐ฐ๏ธ
Here's why that's bad: when setjmp is called on a jmp_buf to record a rewind location, it records the stack frame. That stack frame becomes invalid the moment the function containing the setjmp call returns. Trying to rewind to it via longjmp would reference a stack frame that no longer exists, and would likely lead to a crash โ or worse. ๐ญ
-Wno-analyzer-tainted-allocation-sizeโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-tainted-allocation-sizeto switch it off. It warns for paths through the code where a value that could be under an attacker's control is used as the size of an allocation without being sanitized. That means an attacker could inject an excessively large allocation and potentially cause a denial of service attack. Not the flex they think it is. ๐
See CWE-789: Memory Allocation with Excessive Size Value ("https://cwe.mitre.org/data/definitions/789.html").
-Wno-analyzer-tainted-assertionโ this warning needs-fanalyzerto turn it on; use-Wno-analyzer-tainted-assertionto switch it off. It warns for paths through the code where a value that could be under an attacker's control is used as part of a condition without being sanitized first, and that condition guards a call to a function marked with attributenoreturn(such as the function__builtin_unreachable). Those functions typically indicate abnormal termination of the program, like for assertion failure handlers. For example:
assert (some_tainted_value < SOME_LIMIT);
In such cases:
- when assertion-checking is enabled: an attacker could trigger a denial of service by injecting an assertion failure
- when assertion-checking is disabled, such as by defining
NDEBUG, an attacker could inject data that subverts the process, since it presumably violates a precondition that is being assumed by the code.
Note that when assertion-checking is disabled, the assertions are typically removed by the preprocessor before the analyzer even has a chance to "see" them, so this diagnostic can only generate warnings on builds where assertion-checking is enabled. ๐
For the purpose of this warning, any function marked with attribute noreturn counts as a possible assertion failure handler, including __builtin_unreachable. Note that these functions are sometimes removed by the optimizer before the analyzer "sees" them. So yeah โ optimization should be disabled when you're attempting to trigger this diagnostic.
See CWE-617: Reachable Assertion ("https://cwe.mitre.org/data/definitions/617.html").
The warning can also report problematic constructions such as
switch (some_tainted_value) {
case 0:
/* [...etc; various valid cases omitted...] */
break;
default:
__builtin_unreachable (); /* BUG: attacker can trigger this */
}
and yeah, strictly speaking, that's not an assertion failure โ but the analyzer is still gonna side-eye it, because an attacker can fr fr trigger that default branch. Not the vibe. ๐
-Wno-analyzer-tainted-array-indexโ okay so this warning needs-fanalyzer, which is what turns it on; if you wanna turn it off, hit it with-Wno-analyzer-tainted-array-index. What it's clocking: paths through your code where a value that could be under an attacker's control gets used as an array index without being sanitized first โ meaning an attacker could inject an out-of-bounds access. Absolutely not the energy we're going for.
See CWE-129: Improper Validation of Array Index (https://cwe.mitre.org/data/definitions/129.html).
-Wno-analyzer-tainted-divisorโ requires-fanalyzer(that's the one enabling it); use-Wno-analyzer-tainted-divisorto disable it. What it's clocking: paths through the code where a value that could be under an attacker's control is used as the divisor in a division or modulus operation without being sanitized, so an attacker could inject a division-by-zero. ๐
See CWE-369: Divide By Zero (https://cwe.mitre.org/data/definitions/369.html).
-Wno-analyzer-tainted-offsetโ requires-fanalyzer(it enables it); use-Wno-analyzer-tainted-offsetto disable it. What it's clocking: paths through the code where a value that could be under an attacker's control is used as a pointer offset without being sanitized, so an attacker could inject an out-of-bounds access. no bestie, we don't do that here ๐ซถ
See CWE-823: Use of Out-of-range Pointer Offset (https://cwe.mitre.org/data/definitions/823.html).
-Wno-analyzer-tainted-sizeโ requires-fanalyzer(yep, that's the enabler); use-Wno-analyzer-tainted-sizeto disable it. What it's clocking: paths through the code where a value that could be under an attacker's control is used as the size of an operation such asmemsetwithout being sanitized, so an attacker could inject an out-of-bounds access.
See CWE-129: Improper Validation of Array Index (https://cwe.mitre.org/data/definitions/129.html).
-Wno-analyzer-throw-of-unexpected-typeโ requires-fanalyzer(which enables it); use-Wno-analyzer-throw-of-unexpected-typeto disable it. Heads up bestie: dynamic exception specifications are only available in C++14 and earlier. What it's clocking: paths through the code where an exception is thrown from a function with a dynamic exception specification, and that exception does not comply with the specification. ๐ญ-Wno-analyzer-undefined-behavior-ptrdiffโ this one requires-fanalyzer, which enables it; use-Wno-analyzer-undefined-behavior-ptrdiffto disable it. What it's clocking: paths through the code where a pointer subtraction happens and the pointers refer to different chunks of memory. That kind of code is leaning on undefined behavior, because pointer subtraction is only defined when both pointers point within (or just after) the same array. undefined behavior is not a personality trait, periodt ๐
See CWE-469: Use of Pointer Subtraction to Determine Size (https://cwe.mitre.org/data/definitions/469.html).
-Wno-analyzer-undefined-behavior-strtokโ requires-fanalyzer, which enables it; use-Wno-analyzer-undefined-behavior-strtokto disable it. What it's clocking: paths through the code where a call is made tostrtokwith undefined behavior.
Specifically: passing NULL as the first parameter for the initial call to strtok within a process has undefined behavior. just don't, bestie ๐ญ
-Wno-analyzer-unsafe-call-within-signal-handlerโ requires-fanalyzer, which enables it; use-Wno-analyzer-unsafe-call-within-signal-handlerto disable it. What it's clocking: paths through the code where a function known to be async-signal-unsafe (likefprintf, bestie, I'm so serious) gets called from a signal handler. ๐จ
See CWE-479: Signal Handler Use of a Non-reentrant Function (https://cwe.mitre.org/data/definitions/479.html).
-Wno-analyzer-use-after-freeโ requires-fanalyzer, which enables it; use-Wno-analyzer-use-after-freeto disable it. What it's clocking: paths through the code where a pointer gets used after a deallocator has been called on it โ eitherfree, or a deallocator referenced by attributemalloc. ๐
See CWE-416: Use After Free (https://cwe.mitre.org/data/definitions/416.html).
-Wno-analyzer-use-of-pointer-in-stale-stack-frameโ requires-fanalyzer, which enables it; use-Wno-analyzer-use-of-pointer-in-stale-stack-frameto disable it. What it's clocking: paths through the code where a pointer is dereferenced that points to a variable sitting in a stale stack frame. that frame has left the chat. ๐ชฆ-Wno-analyzer-va-arg-type-mismatchโ requires-fanalyzer, which enables it; use-Wno-analyzer-va-arg-type-mismatchto disable it. What it's clocking: interprocedural paths through the code where the analyzer catches an attempt to useva_argto extract a value that was passed to a variadic call โ except it's using a type that does not match the type of the expression passed to the call. ๐
See CWE-686: Function Call With Incorrect Argument Type (https://cwe.mitre.org/data/definitions/686.html).
-Wno-analyzer-va-list-exhaustedโ requires-fanalyzer, which enables it; use-Wno-analyzer-va-list-exhaustedto disable it. What it's clocking: interprocedural paths through the code where the analyzer catches an attempt to useva_argto grab the next value passed to a variadic call, but all of the values in theva_listhave already been consumed. nothing left in the tank bestie, it's empty ๐ซ
See CWE-685: Function Call With Incorrect Number of Arguments (https://cwe.mitre.org/data/definitions/685.html).
-Wno-analyzer-va-list-leakโ requires-fanalyzer, which enables it; use-Wno-analyzer-va-list-leakto disable it. What it's clocking: interprocedural paths through the code where the analyzer catches thatva_startorva_copywas called on ava_listwith no corresponding call tova_end. the friendship bracelet was never tied off, and now it's justโฆ loose. ๐ญ-Wno-analyzer-va-list-use-after-va-endโ requires-fanalyzer, which enables it; use-Wno-analyzer-va-list-use-after-va-endto disable it. What it's clocking: interprocedural paths through the code where the analyzer catches an attempt to use ava_listafterva_endhas been called on it.va_list. ๐ (yes, that trailingva_list. is in the original, and I am nothing if not faithful to the source โจ)-Wno-analyzer-write-to-constโ requires-fanalyzer, which enables it; use-Wno-analyzer-write-to-constto disable it. What it's clocking: paths through the code where the analyzer catches an attempt to write through a pointer to aconstobject. But real talk: the analyzer does not prioritize detection of these paths, so false negatives are more likely here relative to other warnings. ๐-Wno-analyzer-write-to-string-literalโ requires-fanalyzer, which enables it; use-Wno-analyzer-write-to-string-literalto disable it. What it's clocking: paths through the code where the analyzer catches an attempt to write through a pointer to a string literal. Same disclaimer though: the analyzer doesn't prioritize detection of these paths, so false negatives are more likely relative to other warnings.-Wno-analyzer-use-of-uninitialized-valueโ requires-fanalyzer, which enables it; use-Wno-analyzer-use-of-uninitialized-valueto disable it. What it's clocking: paths through the code where an uninitialized value is used. that variable woke up and chose chaos ๐ญ
See CWE-457: Use of Uninitialized Variable (https://cwe.mitre.org/data/definitions/457.html).
okay so, plot twist: the analyzer has hardcoded knowledge about the behavior of the following memory-management functions: ๐
alloca- The built-in functions
__builtin_alloc,__builtin_alloc_with_align,__builtin_calloc,__builtin_free,__builtin_malloc,__builtin_memcpy,__builtin_memcpy_chk,__builtin_memset,__builtin_memset_chk,__builtin_realloc,__builtin_stack_restore, and__builtin_stack_save callocfreemallocmemsetoperator deleteoperator delete []operator newoperator new []reallocstrdupstrndup
of the following functions for working with file descriptors: ๐
openclosecreatdup,dup2anddup3isattypipe, andpipe2readwritesocket,bind,listen,accept, andconnect
of the following functions for working with <stdio.h> streams: ๐ฆ
- The built-in functions
__builtin_fprintf,__builtin_fprintf_unlocked,__builtin_fputc,__builtin_fputc_unlocked,__builtin_fputs,__builtin_fputs_unlocked,__builtin_fwrite,__builtin_fwrite_unlocked,__builtin_printf,__builtin_printf_unlocked,__builtin_putc,__builtin_putchar,__builtin_putchar_unlocked,__builtin_putc_unlocked,__builtin_puts,__builtin_puts_unlocked,__builtin_vfprintf, and__builtin_vprintf fopenfcloseferrorfgetsfgets_unlockedfilenofreadgetcgetcharfprintfprintffwrite
and of the following functions: โจ
- The built-in functions
__builtin_expect,__builtin_expect_with_probability,__builtin_strchr,__builtin_strcpy,__builtin_strcpy_chk,__builtin_strlen,__builtin_va_copy, and__builtin_va_start - The GNU extensions
erroranderror_at_line getpasslongjmpputenvsetjmpsiglongjmpsignalsigsetjmpstrcatstrchrstrlen
In addition, bestie: various functions with an __analyzer_ prefix have special meaning to the analyzer, and those are described in the GCC Internals manual. ๐ Various internal parameters, settable via --param, are used to control the exploration; those are also documented in the GCC Internals manual. iykyk. ๐
The following options control the analyzer. ๐ซถ
-fanalyzer-assume-nothrowโ bestie, by default, if-fexceptionsis on, the analyzer is gonna assume that literally any call to a function without thenothrowattribute could throw. Which is kind of iconic for catching execution paths that leak because exceptions yeeted right past your clean-up code ๐ซถ but it can also give you false positives when you're using headers where the author simply forgot to addnothrow. Rude of them tbh.
So if -fanalyzer-assume-nothrow is enabled, the analyzer assumes external functions don't throw exceptions. This can be handy for toning down the "noise" when you turn on -fexceptions for C code โ but heads up: it could hide real issues if something your C code calls actually does raise an exception. So like, use with intention โจ
-fanalyzer-call-summariesโ simplifies interprocedural analysis by computing the effect of certain calls instead of exploring every single path through the function from callsite to each possible return. Way less chaotic, no cap.
If enabled, call summaries are only used for functions with more than one call site and that are sufficiently complicated.
-fanalyzer-checker=nameโ restricts the analyzer to run just the named checker, and enables it. One checker, main character energy, everyone else wait outside ๐-fanalyzer-debug-text-art-headingsโ this one is for analyzer developers. If enabled, the analyzer adds extra annotations to any diagrams it generates. Little art labels for the art girlies ๐-fno-analyzer-feasibilityโ this option is intended for analyzer developers.
By default the analyzer verifies that there's a feasible control flow path for each diagnostic it emits: that the conditions that hold aren't mutually exclusive. Diagnostics where no feasible path can be found get rejected. You can suppress this filtering with -fno-analyzer-feasibility, for debugging issues in this code.
-fanalyzer-fine-grainedโ does nothing. Preserved for backward compatibility. It's giving ghost ๐ป-fanalyzer-show-duplicate-countโ this option is intended for analyzer developers: if multiple diagnostics have been detected as being duplicates of each other, it emits a note when reporting the best diagnostic, giving the number of additional diagnostics that were suppressed by the deduplication logic. The receipts, basically ๐-fanalyzer-show-events-in-system-headersโ by default the analyzer emits simplified diagnostics paths by hiding events fully located within a system header. With-fanalyzer-show-events-in-system-headerssuch events are no longer suppressed. Nothing gets hidden from you anymore, bestie ๐-fno-analyzer-simplify-supergraphโ this option is intended for analyzer developers.
By default, the analyzer performs various simplifications to the program supergraph before analyzing it. With -fno-analyzer-simplify-supergraph this simplification can be suppressed, for debugging issues with it.
-fno-analyzer-state-mergeโ this option is intended for analyzer developers.
By default the analyzer attempts to simplify analysis by merging sufficiently similar states at each program point as it builds its "exploded graph". With -fno-analyzer-state-merge this merging can be suppressed, for debugging state-handling issues.
-fno-analyzer-state-purgeโ this option is intended for analyzer developers.
By default the analyzer attempts to simplify analysis by purging aspects of state at a program point that appear to no longer be relevant โ e.g. the values of locals that aren't accessed later in the function and which aren't relevant to leak analysis.
With -fno-analyzer-state-purge this purging of state can be suppressed, for debugging state-handling issues.
-fno-analyzer-suppress-followupsโ this option is intended for analyzer developers.
By default the analyzer will stop exploring an execution path after encountering certain diagnostics, in order to avoid potentially issuing a cascade of follow-up diagnostics. Like, it knows when to stop talking ๐
The diagnostics that terminate analysis along a path are:
-Wanalyzer-null-argument-Wanalyzer-null-dereference-Wanalyzer-use-after-free-Wanalyzer-use-of-pointer-in-stale-stack-frame-Wanalyzer-use-of-uninitialized-value
With -fno-analyzer-suppress-followups the analyzer will continue to explore such paths even after such diagnostics, which may be helpful for debugging issues in the analyzer, or for microbenchmarks for detecting undefined behavior.
-fanalyzer-transitivityโ this option enables transitivity of constraints within the analyzer. Chains of logic, slay โจ-fno-analyzer-undo-inliningโ this option is intended for analyzer developers.
-fanalyzer runs relatively late compared to other code analysis tools, and some optimizations have already been applied to the code. In particular function inlining may have occurred, leading to the interprocedural execution paths emitted by the analyzer containing function frames that don't correspond to those in the original source code. Awkward.
By default the analyzer attempts to reconstruct the original function frames, and to emit events showing the inlined calls.
With -fno-analyzer-undo-inlining this attempt to reconstruct the original frame information can be disabled, which may be of help when debugging issues in the analyzer.
-fanalyzer-verbose-edgesโ this option is intended for analyzer developers. It enables more verbose, lower-level detail in the descriptions of control flow within diagnostic paths.-fanalyzer-verbose-state-changesโ this option is intended for analyzer developers. It enables more verbose, lower-level detail in the descriptions of events relating to state machines within diagnostic paths.-fanalyzer-verbosity=levelโ this option controls the complexity of the control flow paths that are emitted for analyzer diagnostics.
The level can be one of:
0โ at this level, interprocedural call and return events are displayed, along with the most pertinent state-change events relating to a diagnostic. For example, for a double-freediagnostic, both calls tofreewill be shown. Both of them. The whole messy story ๐1โ as per the previous level, but also show events for the entry to each function.2โ as per the previous level, but also show events relating to control flow that are significant to triggering the issue (e.g. "true path taken" at a conditional).
This level is the default. The main character level, naturally ๐
3โ as per the previous level, but show all control flow events, not just significant ones. Maximum yap.4โ this level is intended for analyzer developers; it adds various other events intended for debugging the analyzer.
-fdump-analyzerโ dumps internal details about what the analyzer is doing tofile.analyzer.txt. Note that-fdump-analyzer-stderroverrides this option.-fdump-analyzer-stderrโ dumps internal details about what the analyzer is doing tostderr. This option overrides-fdump-analyzer.-fdump-analyzer-callgraphโ dumps a representation of the call graph suitable for viewing with GraphViz tofile.callgraph.dot.-fdump-analyzer-exploded-graphโ dumps a representation of the "exploded graph" suitable for viewing with GraphViz tofile.eg.dot. Nodes are color-coded based on state-machine states to emphasize state changes. Aesthetic and informative ๐-fdump-analyzer-exploded-nodesโ emits diagnostics showing where nodes in the "exploded graph" are in relation to the program source.-fdump-analyzer-exploded-nodes-2โ dumps a textual representation of the "exploded graph" tofile.eg.txt.-fdump-analyzer-exploded-nodes-3โ dumps a textual representation of the "exploded graph" to one dump file per node, tofile.eg-id.txt. This is typically a large number of dump files. Like, a lot ๐ญ-fdump-analyzer-exploded-pathsโ dumps a textual representation of the "exploded path" for each diagnostic tofile.idx.kind.epath.txt.-fdump-analyzer-feasibilityโ dumps internal details about the analyzer's search for feasible paths. The details are written in a form suitable for viewing with GraphViz to filenames of the formfile.*.fg.dot,file.*.tg.dot, andfile.*.fpath.txt.-fdump-analyzer-infinite-loopโ dumps internal details about the analyzer's search for infinite loops. The details are written in a form suitable for viewing with GraphViz to filenames of the formfile.*.infinite-loop.dot.-fdump-analyzer-jsonโ dumps a compressed JSON representation of analyzer internals tofile.analyzer.json.gz. The precise format is subject to change. Consider this your soft launch โญ-fdump-analyzer-state-purgeโ as per-fdump-analyzer-supergraph, dumps a representation of the "supergraph" suitable for viewing with GraphViz, but annotate the graph with information on what state will be purged at each node. The graph is written tofile.state-purge.dot.-fdump-analyzer-supergraphโ dumps representations of the "supergraph" suitable for viewing with GraphViz tofile.supergraph.index.kind.dot. These show all of the control flow graphs in the program, at various stages of the analysis. The precise set of dumps and what they show is subject to change.-fdump-analyzer-untrackedโ emits custom warnings with internal details intended for analyzer developers.
โจ Options for Debugging Your Program โจ
Okay so, to tell GCC to emit extra information for use by a debugger, in almost all cases you literally only need to add -g to your other options. Some debug formats can co-exist (like DWARF with CTF) when each of them is enabled explicitly by adding the respective command line option to your other options. Besties coexisting, we love to see it ๐
GCC lets you use -g with -O. But 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. The code is out here living its own life ๐ Nevertheless it's possible to debug optimized output. This makes it reasonable to use the optimizer for programs that might have bugs.
If you're not using some other optimization option, consider using -Og with -g. With no -O option at all, some compiler passes that collect information useful for debugging don't run at all, so -Og may result in a better debugging experience. Lowkey the glow-up move โจ
-g--debug
Produce debugging information in the operating system's native format (stabs, COFF, XCOFF, or DWARF). GDB can work with this debugging information. ๐
-gโ okay so this one has lore ๐ On most systems that use stabs format,-gturns on extra debugging info that only GDB can use. That extra info makes debugging in GDB go way better, but it probably makes other debuggers crash or flat-out refuse to read the program ๐ญ. So if you want to be absolutely certain about whether that extra info gets generated, use-gvmsinstead (it's down below, keep scrolling bestie).-ggdbโ Produce debugging info made for GDB specifically ๐ซถ. Translation: use the most expressive format available โ DWARF, stabs, or the native format if neither of those is supported โ and include GDB extensions if that's even possible โจ.-gdwarf-gdwarf-versionโ Produce debugging info in DWARF format (if that's supported ๐ ). The version value can be2,3,4, or5. The default version for most targets is5โ except VxWorks, TPF and Darwin / macOS, which default to version2, and AIX, which defaults to version4.
Heads up: with DWARF Version 2, some ports require and always use some non-conflicting DWARF 3 extensions in the unwind tables ๐.
Version 4 may require GDB 7.0 and -fvar-tracking-assignments for maximum benefit. Version 5 requires GDB 8.0 or higher.
GCC no longer supports DWARF Version 1, which is substantially different from Version 2 and later ๐. For historical reasons, some other DWARF-related options โ like -fno-dwarf2-cfi-asm โ still keep a reference to DWARF Version 2 in their names, but they apply to all currently-supported versions of DWARF. So don't let the name gaslight you ๐.
-gbtfโ Request BTF debug info ๐ฆ. BTF is the default debugging format for the eBPF target. On other targets, like x86, BTF debug info can be generated alongside DWARF debug info โ but only when both debug formats are enabled explicitly via their own command line options โจ.-gprune-btf-gno-prune-btfโ Prune BTF info before emission โ๏ธ. When pruning, only type info for types used by global variables and file-scope functions gets emitted. If you're compiling for the BPF target with BPF CO-RE enabled, type info is also emitted for types used in BPF CO-RE relocations. On top of that, struct and union types that are only referred to via pointers from members of other struct or union types get pruned and replaced withBTF_KIND_FWD, as though those types were only present in the input as forward declarations ๐.
This option substantially reduces the size of the produced BTF info โ but at a significant loss in the amount of detailed type info. It's primarily useful when compiling for the BPF target, to minimize the size of the resulting object, and to eliminate BTF info that isn't immediately relevant to the BPF program loading process.
This option is enabled by default for the BPF target when generating BTF info. Default behaviour, no cap ๐ .
-gctf-gctflevelโ Request CTF debug info, and use level to say how much CTF debug info should be produced ๐ธ. If-gctfis specified without a value for level, the default level of CTF debug info is2.
CTF debug info can be generated alongside DWARF debug info when both debug formats are enabled explicitly via their own command line options โจ.
Level 0 produces no CTF debug info at all. So -gctf0 negates -gctf ๐.
Level 1 produces CTF info for tracebacks only. That includes callsite info, but does not include type info.
Level 2 produces type info for entities (functions, data objects, etc.) at file-scope or global-scope only.
-gvmsโ Produce debugging info in Alpha/VMS debug format (if that's supported ๐ซถ). This is the format used by DEBUG on Alpha/VMS systems.-gcodeviewโ Produce debugging info in CodeView debug format (if that's supported ๐ ). This is the format used by Microsoft Visual C++ on Windows.-glevel-ggdblevel-gvmslevelโ Request debugging info and also use level to specify how much info ๐. The default level is2.
Level 0 produces no debug info at all. So -g0 negates -g โ๏ธ.
Level 1 produces minimal info โ enough for making backtraces in parts of the program you don't plan to debug. That includes descriptions of functions and external variables, plus line number tables, but no info about local variables.
Level 2 is the normal setting for producing debuggable code ๐ฅ. The debug output includes everything from level 1, plus info about local variables and typedefs so you can step through code and examine its state. For C++ code, additional info is also emitted to help debug namespace, class, and template functions ๐.
Level 3 includes extra info, like all the macro definitions present in the program. Some debuggers support macro expansion when you use -g3 โจ.
If you use multiple -g options, with or without level numbers, the last such option is the one that's effective. Last one wins, periodt ๐
.
-gdwarfdoes not accept a concatenated debug level, to avoid confusion with-gdwarf-level. Instead, use an additional-gleveloption to change the debug level for DWARF. Don't try to be cute with it, bestie ๐ญ.
-fno-eliminate-unused-debug-symbolsโ By default, no debug info is produced for symbols that aren't actually used. Use this option if you want debug info for all the symbols ๐ฆ.-femit-class-debug-alwaysโ Instead of emitting debugging info for a C++ class in only one object file, emit it in all object files using the class ๐. Only use this with debuggers that can't handle the way GCC normally emits debugging info for classes โ because using this option increases the size of debugging info by as much as a factor of two ๐.-fno-merge-debug-stringsโ Direct the linker to not merge together strings in the debugging info that are identical in different object files. Merging isn't supported by all assemblers or linkers ๐ซถ. Merging decreases the size of the debug info in the output file, at the cost of increasing link processing time. Merging is enabled by default โจ.-fdebug-prefix-map=old=newโ When compiling files that live in directory old, record debugging info describing them as if the files lived in directory new instead ๐. This can be used to replace a build-time path with an install-time path in the debug info. It can also be used to change an absolute path to a relative path by using.for new. This can give more reproducible builds, which are location independent โ but it may require an extra command to tell GDB where to find the source files ๐. See also-ffile-prefix-mapand-fcanon-prefix-map.-fvar-trackingโ Run the variable tracking pass โจ. It computes where variables are stored at each position in code. Better debugging info is then generated (if the debugging info format supports this info).
It's enabled by default when compiling with optimization (-Os, -O, -O2, ...), debugging info (-g), and the debug info format supports it ๐
.
-fvar-tracking-assignmentsโ Annotate assignments to user variables early in compilation, and attempt to carry those annotations all the way through compilation to the very end โ all in an attempt to improve debug info while optimizing ๐ฆ. Using-gdwarf-4alongside it is recommended.
It can be enabled even if var-tracking is disabled, in which case annotations are created and maintained, but discarded at the end ๐ญ. By default, this flag is enabled together with -fvar-tracking, except when selective scheduling is enabled.
-fvar-tracking-uninit-fno-var-tracking-uninitโ Perform variable tracking and mark uninitialized variables in the debug info ๐. This flag is enabled by default by-fvar-tracking; it also implies-fvar-tracking. To do variable tracking without marking uninitialized variables, use-fvar-tracking -fno-var-tracking-uninitโจ.-gsplit-dwarfโ If DWARF debugging info is enabled, separate as much debugging info as possible into a separate output file with the extension.dwo๐. This option lets the build system avoid linking files with debug info. To be useful, this option requires a debugger capable of reading.dwofiles ๐ซถ.-gdwarf32-gdwarf64โ If DWARF debugging info is enabled,-gdwarf32selects the 32-bit DWARF format and-gdwarf64selects the 64-bit DWARF format ๐. The default is target specific โ on most targets it's-gdwarf32though. The 32-bit DWARF format is smaller, but it can't support more than 2GiB of debug info in any of the DWARF debug info sections. The 64-bit DWARF format allows larger debug info, but might not be well supported by all consumers yet ๐.-gdescribe-diesโ Add description attributes to some DWARF DIEs that have no name attribute โ like artificial variables, external references, and call site parameter DIEs โจ.-gpubnamesโ Generate DWARF.debug_pubnamesand.debug_pubtypessections ๐.-ggnu-pubnamesโ Generate.debug_pubnamesand.debug_pubtypessections in a format suitable for conversion into a GDB index ๐. This option is only useful with a linker that can produce GDB index version 7 ๐ .-gno-pubnamesโ Don't generate DWARF.debug_pubnamesand.debug_pubtypessections โ๏ธ.-fdebug-types-sectionโ When using DWARF Version 4 or higher, type DIEs can be put into their own.debug_typessection instead of being part of the.debug_infosection ๐ฆ. It's more efficient to put them in a separate comdat section, since the linker can then remove duplicates. But not all DWARF consumers support.debug_typessections yet โ and on some objects,.debug_typesproduces larger instead of smaller debugging info ๐ญ. Rude, honestly.-grecord-gcc-switches-gno-record-gcc-switchesโ This switch causes the command-line options used to invoke the compiler that may affect code generation to be appended to theDW_AT_producerattribute in DWARF debugging info ๐. The options are concatenated with spaces separating them from each other and from the compiler version. It's enabled by default โจ. See also-frecord-gcc-switchesfor another way of storing compiler options into the object file.-gstrict-dwarfโ bestie, this one says no to using extensions from a later DWARF standard version than the one you picked with-gdwarf-version. On most targets, letting non-conflicting DWARF extensions from later standard versions sneak in is allowed, but this flag locks that door ๐.-gno-strict-dwarfโ the chill version: it allows using extensions of a later DWARF standard version than the one selected with-gdwarf-version. Live a little โจ.-gas-loc-supportโ tells the compiler that the assembler has your back and supports".loc"directives. Once it knows, it can hand those off so the assembler generates the 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 make all by itself ๐ . It's on by default if, at GCC configure time, the assembler is found to support such directives.-gno-as-loc-supportโ forces GCC to generate DWARF2+ line number tables internally, if DWARF2+ line number tables are going to be generated at all. Do it yourself energy ๐ซถ.-gas-locview-supportโ lets the compiler know the assembler supports "view" assignment and reset assertion checking in".loc"directives. On by default if, at GCC configure time, the assembler is found to support them โจ.-gno-as-locview-supportโ forces GCC to assign view numbers internally, if-gvariable-location-viewsare explicitly requested.-gcolumn-info,-gno-column-infoโ emit location column info into DWARF debugging information, instead of just file and line. This one is enabled by default ๐.-gstatement-frontiers,-gno-statement-frontiersโ this makes GCC drop markers into the internal representation at the beginning of statements, keep them roughly in place all the way through compilation, and use them to guide the output of"is_stmt"markers in the line number table. It's on by default when compiling with optimization (-Os,-O1,-O2, ...) and outputting DWARF 2 debug information at the normal level ๐.-gvariable-location-views,-gvariable-location-views=incompat5,-gno-variable-location-viewsโ augment variable location lists with progressive view numbers implied from the line number table. This lets debug information consumers peek at state at certain points of the program, even when there are no instructions associated with the corresponding source locations sitting at that point ๐. If the assembler doesn't support view numbers in line number tables, this makes the compiler emit the line number table, which generally makes them somewhat less compact. The augmented line number tables and location lists are fully backward-compatible, so debug info consumers that don't know about these augmentations can still consume them โ they just won't get any benefit from them either, no cap.
It's 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, it may still be enabled, but that forces GCC to output internal line number tables, and if -ginternal-reset-location-views is not enabled, that most certainly leads to silently mismatching location views ๐ญ.
There's a proposed representation for view numbers that is not backward compatible with the location list format introduced in DWARF 5, and you can turn it on with -gvariable-location-views=incompat5. Heads up though: this option may be removed in the future, and it's only provided as a reference implementation of the proposed representation. Debug information consumers are not expected to support this extended format, and they'd be rendered unable to decode location lists using it ๐.
-ginternal-reset-location-views,-gno-internal-reset-location-viewsโ tries to figure out which location views can be left out of the location view lists. This needs the compiler to have very accurate instruction length estimates, which isn't always the case, and it may cause incorrect view lists to be generated silently when you're using an assembler that doesn't support location view lists. The GNU assembler flags any such error as a "view number mismatch". This is only enabled on ports that define a reliable estimation function ๐.-ginline-points,-gno-inline-pointsโ generate extended debug information for inlined functions. Location view tracking markers get inserted at inlined entry points, so address and view numbers can be computed and output in 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]โ produce compressed debug sections in DWARF format, if that's supported. If type isn't given, the default type depends on the capabilities of the assembler and linker used. type may be one ofnone(don't compress debug sections),zlib(use zlib compression in ELF gABI format), orzstd(use zstd compression in ELF gABI format). If the linker doesn't support writing compressed debug sections, the option is rejected ๐ซ. Otherwise, if the assembler doesn't support them,-gzis silently ignored when producing object files.-femit-struct-debug-baseonlyโ only emit debug info for struct-like types when the base name of the compilation source file matches the base name of the file in which the struct is defined.
This substantially reduces the size of debugging information, but at significant potential loss in type information to the debugger. See -femit-struct-debug-reduced for a less aggressive option, and -femit-struct-debug-detailed for more detailed control.
This option works only with DWARF debug output.
-femit-struct-debug-reducedโ only emit debug info for struct-like types when the base name of the compilation source file matches the base name of the file in which the type is defined โ unless the struct is a template or defined in a system header ๐ธ.
This significantly reduces the size of debugging information, with some potential loss in type information to the debugger. See -femit-struct-debug-baseonly for a more aggressive option, and -femit-struct-debug-detailed for more detailed control.
This option works only with DWARF debug output.
-femit-struct-debug-detailed[=spec-list]โ pick exactly which struct-like types the compiler generates debug info for. The whole point is reducing duplicate struct debug info between different object files within the same program ๐ฏ.
This option is a detailed version of -femit-struct-debug-reduced and -femit-struct-debug-baseonly, which serves for most needs.
A specification has the syntax:
[dir:|ind:][ord:|gen:](any|sys|base|none)
The optional first word limits the specification to structs that are used directly (dir:) or used indirectly (ind:). A struct type is used directly when it is the type of a variable, member. Indirect uses arise through pointers to structs. That is, when use of an incomplete struct is valid, the use is indirect. An example is struct one direct; struct two * indirect;.
The optional second word limits the specification to ordinary structs (ord:) or generic structs (gen:). Generic structs are a bit complicated to explain 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 does not yet implement them ๐.
The third word specifies the source files for those structs for which the compiler should emit debug information. The values none and any have the normal meaning. The value base means that the base of name of the file in which the type declaration appears must match the base of the name of the main compilation file. In practice, this means that when compiling foo.c, debug information is generated for types declared in that file and foo.h, but not other header files. The value sys means those types satisfying base or declared in system or compiler headers.
You may need to experiment to determine the best settings for your application ๐งช.
The default is -femit-struct-debug-detailed=all.
This option works only with DWARF debug output.
-fno-dwarf2-cfi-asmโ emit DWARF unwind info as 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 โ for example if, in the debugger, you want to cast a value to a type that is not actually used in your program (but is declared). More often, however, this results in a significant amount of wasted space ๐ฌ.
โจ Options That Control Optimization โจ
These options control various sorts of optimizations ๐ .
Without any optimization option, the compiler's goal is to reduce the cost of compilation and to make debugging produce the expected results. Statements are independent: if you stop the program with a breakpoint between statements, you can then assign a new value to any variable or change the program counter to any other statement in the function and get exactly the results you expect from the source code ๐.
Turning on optimization flags makes the compiler attempt to improve the performance and/or code size at the expense of compilation time and possibly the ability to debug the program ๐ฅ.
The compiler performs optimization based on the knowledge it has of the program. Compiling multiple files at once to a single output file mode allows the compiler to use information gained from all of the files when compiling each of them ๐ง โจ.
Not all optimizations are controlled directly by a flag. Only optimizations that have a flag are listed in this section.
Most optimizations are completely disabled at -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 ๐ซถ.
Oh also bestie, real talk: depending on the target and how GCC was configured, a slightly different set of optimizations may be enabled at each -O level than the ones listed here. Wanna see the receipts? Run GCC with -Q --help=optimizers and it'll show you the exact set of optimizations enabled at each level. Transparency queen ๐
๐ธ The -O Levels: A Whole Journey ๐ธ
-O,-O1,--optimizeโ Optimize, bestie! Optimizing compilation takes somewhat more time, and a lot more memory for a large function.
With -O, the compiler tries to reduce code size and execution time, without performing any optimizations that take a great deal of compilation time.
-O is the recommended optimization level for large machine-generated code as a sensible balance between time taken to compile and memory use: higher optimization levels perform optimizations with greater algorithmic complexity than at -O. balanced queen fr fr
-O turns on the following optimization flags:
-fauto-inc-dec -fbranch-count-reg -fcombine-stack-adjustments
-fcompare-elim -fcprop-registers -fdce -fdefer-pop -fdelayed-branch
-fdse -fforward-propagate -fguess-branch-probability -fif-conversion
-fif-conversion2 -finline-functions-called-once -fipa-modref
-fipa-profile -fipa-pure-const -fipa-reference
-fipa-reference-addressable -fivopts -fmerge-constants
-fmove-loop-invariants -fmove-loop-stores -fomit-frame-pointer
-freorder-blocks -fshrink-wrap -fshrink-wrap-separate
-fsplit-wide-types -fssa-backprop -fssa-phiopt -ftree-bit-ccp
-ftree-ccp -ftree-ch -ftree-coalesce-vars -ftree-copy-prop
-ftree-dce -ftree-dominator-opts -ftree-dse -ftree-forwprop
-ftree-fre -ftree-phiprop -ftree-pta -ftree-scev-cprop -ftree-sink
-ftree-slsr -ftree-sra -ftree-ter -funit-at-a-time
-O2โ Optimize even more. GCC performs nearly all supported optimizations that do not involve a space-speed tradeoff. Compared to-O, this option increases both compilation time and the performance of the generated code. the glow up is real
-O2 turns on all optimization flags specified by -O1. It also turns on the following optimization flags:
-falign-functions -falign-jumps -falign-labels -falign-loops
-fcaller-saves -fcode-hoisting -fcrossjumping -fcse-follow-jumps
-fcse-skip-blocks -fdelete-null-pointer-checks -fdep-fusion
-fdevirtualize -fdevirtualize-speculatively
-fexpensive-optimizations -ffinite-loops -fgcse -fgcse-lm
-fhoist-adjacent-loads -finline-functions -finline-small-functions
-findirect-inlining -fipa-bit-cp -fipa-cp -fipa-icf -fipa-ra
-fipa-sra -fipa-vrp -fisolate-erroneous-paths-dereference
-flra-remat -foptimize-crc -foptimize-sibling-calls
-foptimize-strlen -fpartial-inlining -fpeephole2
-freorder-blocks-algorithm=stc -freorder-blocks-and-partition
-freorder-functions -frerun-cse-after-loop -fschedule-insns
-fschedule-insns2 -fsched-interblock -fsched-spec
-fspeculatively-call-stored-functions -fstore-merging
-fstrict-aliasing -fthread-jumps -ftree-builtin-call-dce
-ftree-loop-vectorize -ftree-pre -ftree-slp-vectorize
-ftree-switch-conversion -ftree-tail-merge -ftree-vrp
-fvect-cost-model=very-cheap
โ ๏ธ Not me letting you walk into this one: please note the warning under-fgcseabout invoking-O2on programs that use computed gotos. ๐
-O3โ Optimize yet more.-O3turns on all optimizations specified by-O2and also turns on the following optimization flags:
-fgcse-after-reload -fipa-cp-clone -floop-interchange
-floop-unroll-and-jam -fpeel-loops -fpredictive-commoning
-fsplit-loops -fsplit-paths -ftree-loop-distribution
-ftree-partial-pre -funswitch-loops -fvect-cost-model=dynamic
-fversion-loops-for-strides
-O0โ Reduce compilation time and make debugging produce the expected results. This is the default. The chill, no-thoughts-just-vibes option. ๐ง
At -O0, GCC completely disables most optimization passes; they are not run even if you explicitly enable them on the command line, or are listed by -Q --help=optimizers as being enabled by default. Many optimizations performed by GCC depend on code analysis or canonicalization passes that are enabled by -O, and it would not be useful to run individual optimization passes in isolation. like bestie, they need the group chat to function, they can't just show up alone ๐ญ
-Osโ Optimize for size.-Osenables all-O2optimizations except those that often increase code size:
-falign-functions -falign-jumps -falign-labels -falign-loops
-fprefetch-loop-arrays -freorder-blocks-algorithm=stc
It also enables -finline-functions, causes the compiler to tune for code size rather than execution speed, and performs further optimizations designed to reduce code size. small but mighty โจ
-Ofastโ Disregard strict standards compliance. ma'am this is chaos and we love her for it-Ofastenables all-O3optimizations. It also enables optimizations that are not valid for all standard-compliant programs. It turns on-ffast-math,-fallow-store-data-racesand the Fortran-specific-fstack-arrays, unless-fmax-stack-var-sizeis specified, and-fno-protect-parens. It turns off-fsemantic-interposition.-Ogโ Optimize while keeping in mind debugging experience.-Ogshould be the optimization level of choice for the standard edit-compile-debug cycle, offering a reasonable blend of optimization, fast compilation and debugging experience especially for code with a high abstraction penalty. In contrast to-O0, this enables-fvar-tracking-assignmentsand-fvar-trackingwhich handle debug information in the prologue and epilogue of functions better than-O0. she's giving debugger's bestie energy ๐ซถ
Like -O0, -Og completely skips a number of optimization passes so that individual options controlling them have no effect. Otherwise -Og enables all -O1 optimization flags except for those known to greatly interfere with debugging:
-fbranch-count-reg -fdelayed-branch -fdse -fif-conversion
-fif-conversion2 -finline-functions-called-once
-fmove-loop-invariants -fmove-loop-stores -fssa-phiopt
-ftree-bit-ccp -ftree-dse -ftree-pta -ftree-sra
-Ozโ Optimize aggressively for size rather than speed. This may increase the number of instructions executed if those instructions require fewer bytes to encode.-Ozbehaves similarly to-Osincluding enabling most-O2optimizations. tiny code, extra steps, still iconic ๐
Important bestie: if you use multiple -O options, with or without level numbers, the last such option is the one that is effective. The last one ate, periodt. ๐
โจ The -f Flags: Fine-Tuning Time โจ
Options of the form -fflag specify machine-independent flags. Most flags have both positive and negative forms; the negative form of -ffoo is -fno-foo. In the table below, only one of the forms is listedโthe one you typically use. You can figure out the other form by either removing no- or adding it. DIY queen, you got this
The following options control specific optimizations. They are either activated by -O options or are related to ones that are. You can use the following flags in the rare cases when "fine-tuning" of optimizations to be performed is desired.
-fno-defer-popโ For machines that must pop arguments after a function call, always pop the arguments as soon as each function returns. At levels-O1and higher,-fdefer-popis the default; this allows the compiler to let arguments accumulate on the stack for several function calls and pop them all at once. stack them up, pop them together, efficient fr-fforward-propagateโ Perform a forward propagation pass on RTL. The pass tries to combine two instructions and checks if the result can be simplified. If loop unrolling is active, two passes are performed and the second is scheduled after loop unrolling.
This option is enabled by default at optimization levels -O1, -O2, -O3, -Os.
-favoid-store-forwarding,-fno-avoid-store-forwardingโ Many CPUs will stall for many cycles when a load partially depends on previous smaller stores. the stall is giving "loadingโฆ" forever ๐ญ This pass tries to detect such cases and avoid the penalty by changing the order of the load and store and then fixing up the loaded value.
Disabled by default.
- *
-ffp-contract=style* โ-ffp-contract=offdisables floating-point expression contraction.-ffp-contract=fastenables floating-point expression contraction such as forming of fused multiply-add operations if the target has native support for them.-ffp-contract=onenables floating-point expression contraction if allowed by the language standard. This is implemented for C and C++, where it enables contraction within one expression, but not across different statements.
The default is -ffp-contract=off for C in a standards compliant mode (-std=c11 or similar), -ffp-contract=fast otherwise.
-ffp-int-builtin-inexactโ Allow the built-in functionsceil,floor,roundandtrunc, and theirfloatandlong doublevariants, to generate code that raises theinexactfloating-point exception for noninteger arguments. ISO C99 and C11 allow these functions to raise theinexactexception, but ISO/IEC TS 18661-1:2014, the C bindings to IEEE 754-2008, as integrated into ISO C23, does not allow these functions to do so.
The default is -fno-fp-int-builtin-inexact, disallowing the exception to be raised, unless C17 or an earlier C standard is selected. This option does nothing unless -ftrapping-math is in effect.
Even if -fno-fp-int-builtin-inexact is used, if the functions generate a call to a library function then the inexact exception may be raised if the library implementation does not follow TS 18661. so likeโฆ no promises, bestie ๐
-fomit-frame-pointerโ Omit the frame pointer in functions that don't need one. This avoids the instructions to save, set up and restore the frame pointer; on many targets it also makes an extra register available. free real estate (a register) โจ
On some targets this flag has no effect because the standard calling sequence always uses a frame pointer, so it cannot be omitted.
Note: -fno-omit-frame-pointer doesn't guarantee the frame pointer is used in all functions. Several targets always omit the frame pointer in leaf functions.
Enabled by default at -O1 and higher.
-foptimize-crcโ Detect loops calculating CRC (performing polynomial long division) and replace them with a faster implementation. Detect 8, 16, 32, and 64 bit CRC, with a constant polynomial without the leading 1 bit, for both bit-forward and bit-reversed cases. If the target supports a CRC instruction and the polynomial used in the source code matches the polynomial used in the CRC instruction, generate that CRC instruction. Otherwise, if the target supports a carry-less-multiplication instruction, generate CRC using it; otherwise generate table-based CRC. she'll pick the fastest route, trust ๐
Enabled by default at -O2 and higher.
-foptimize-sibling-callsโ Optimize sibling and tail recursive calls. recursion but make it chic ๐
Enabled at levels -O2, -O3, -Os.
-foptimize-strlenโ bestie this one goes through a bunch of standard C string functions (likestrlen,strchrorstrcpy) and also their_FORTIFY_SOURCEtwin sisters, and rewrites them into faster alternatives. slay.
Enabled at levels -O2, -O3.
-finline-atomicsโ-fno-inline-atomicsโ inlines__atomicoperations whenever a lock-free instruction sequence is actually available. this optimization is on by default ๐-finline-stringops[=fn]โ expands memory and string operations inline (for now that's justmemset), even when the length is variable or big enough that you'd normally need a loop. this is most useful when you're pairing it with-ffreestandingand-fno-builtin.
in some circumstances it lets the compiler generate code that takes advantage of known alignment and length multipliers, but even then it may be less efficient than optimized runtime implementations, and it can grow code size so much that even a less performant but shared implementation runs faster because it uses code caches better. this option is disabled by default.
-fno-inlineโ do not expand any functions inline apart from the ones marked with thealways_inlineattribute. this is the default when you're not optimizing.
single functions can be exempted from inlining by marking them with the noinline attribute. iykyk.
-finline-small-functionsโ integrates functions into their callers when the body is smaller than the expected function call code (so the overall program size 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 got discovered to be known at compile time thanks to previous inlining. this option only does anything 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're not declared inline. the compiler heuristically decides which functions are worth integrating this way.
if all calls to a given function are integrated, and the function is declared static, then the function is normally not output as assembler code in its own right.
Enabled at levels -O2, -O3, -Os. Also enabled by -fprofile-use and -fauto-profile.
-finline-functions-called-onceโ considers allstaticfunctions called once for inlining into their caller, even if they're not markedinline. if a call to a given function is integrated, then the function is not output as assembler code in its own right.
Enabled at levels -O1, -O2, -O3 and -Os, but not -Og.
-fearly-inliningโ inlines functions marked byalways_inlineand functions whose body seems smaller than the function call overhead, and it does it early โ before doing-fprofile-generateinstrumentation and the real inlining pass. doing this makes profiling significantly cheaper and usually makes inlining faster on programs that have large chains of nested wrapper functions.
Enabled by default.
-fipa-sraโ performs interprocedural scalar replacement of aggregates, removal of unused parameters, and replacement of parameters passed by reference by parameters passed by value. โจ
Enabled at levels -O2, -O3 and -Os.
-finline-limit=nโ by default, GCC limits the size of functions that can be inlined. this flag lets you have coarse control over that limit. n is the size of functions that can be inlined, measured in number of pseudo instructions.
inlining is actually controlled by a number of internal parameters, which are documented in the GCC Internals manual and should not normally be set directly.
Note: there may be no value to -finline-limit that results in default behavior. ๐ญ
Note: pseudo instruction here means, in this particular context, an abstract measurement of a function's size. it in no way represents a count of assembly instructions, and as such its exact meaning might change from one release to another. ๐
-fno-keep-inline-dllexportโ this is a more fine-grained version of-fkeep-inline-functions, which applies only to functions that are declared using 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++, it 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. periodt.-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-consts option.
-fmerge-constantsโ attempts to merge identical constants (string constants and floating-point constants) across compilation units.
this option is the default for optimized compilation if the assembler and linker support it. use -fno-merge-constants to inhibit this behavior.
Enabled at levels -O1, -O2, -O3, -Os.
-fmerge-all-constantsโ attempts to merge identical constants and identical variables.
this option implies -fmerge-constants. in addition to -fmerge-constants it considers, like, 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. by setting this flag certain anti-dependences edges are deleted, which triggers the generation of reg-moves based on the life-range analysis. this option is effective only with-fmodulo-schedenabled.-fno-branch-count-regโ disables the optimization pass that scans for opportunities to usedecrement and branchinstructions on a count register instead of instruction sequences that decrement a register, compare it against zero, and then branch based upon the result. this option is only meaningful on architectures that support such instructions, which include x86, PowerPC, IA-64 and S/390. note that the-fno-branch-count-regoption doesn't remove the decrement and branch instructions from the generated instruction stream that other optimization passes introduced. ๐ซถ
the default is -fbranch-count-reg at -O1 and higher, except for -Og.
-fno-function-cseโ do not put function addresses in registers; make each instruction that calls a constant function contain the function's address explicitly.
this option results in less efficient code, but some strange hacks that alter the assembler output may get confused by the optimizations performed when this option is not used. ๐
the default is -ffunction-cse
-ffuse-ops-with-volatile-accessโ allow limited optimization of operations with volatile memory access when doing so does not change the semantics outlined in
okay so the original manpage literally just trails off there bestie, i'm not making it up ๐ญ that's the whole sentence.
the default is -ffuse-ops-with-volatile-access
-fno-zero-initialized-in-bssโ if the target supports a BSS section, GCC by default puts variables that are initialized to zero into BSS. this can save space in the resulting code. ๐
this option turns off this behavior because some programs explicitly rely on variables going to the data section โ like, so that the resulting executable can find the beginning of that section and/or make assumptions based on that.
the default is -fzero-initialized-in-bss except in Ada.
-fthread-jumpsโ performs optimizations that check 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 -O1, -O2, -O3, -Os.
-fsplit-wide-typesโ when using a type that occupies multiple registers, such aslong longon a 32-bit system, it splits the registers apart and allocates them independently. this normally generates better code for those types, but may make debugging more difficult. ๐ฅ
Enabled at levels -O1, -O2, -O3, -Os.
-fsplit-wide-types-earlyโ fully splits wide types early, instead of very late. this option has no effect unless-fsplit-wide-typesis turned on.
this is the default on some targets.
-fcse-follow-jumpsโ in common subexpression elimination (CSE), it scans through jump instructions when the target of the jump is not reached by any other path. for example, when CSE encounters anifstatement with anelseclause, CSE follows the jump when the condition tested is false.
Enabled at levels -O2, -O3, -Os.
-fcse-skip-blocksโ this is similar to-fcse-follow-jumps, but it causes CSE to follow jumps that conditionally skip over blocks. when CSE encounters a simpleifstatement with no else clause,-fcse-skip-blockscauses CSE to follow the jump around the body of theif. ๐ฆ
Enabled at levels -O2, -O3, -Os.
-frerun-cse-after-loopโ re-runs common subexpression elimination after loop optimizations are performed. it's giving round two bestie ๐
Enabled at levels -O2, -O3, -Os.
-fgcseโ performs a global common subexpression elimination pass. this pass also performs global constant and copy propagation. ๐
Note: when compiling a program using computed gotos, a GCC extension, you may get better run-time performance if you disable the global common subexpression elimination pass by adding -fno-gcse to the command line.
Enabled at levels -O2, -O3, -Os.
-fgcse-lmโ okay bestie, when this one's enabled, global common subexpression elimination tries to move loads that are only killed by stores into themselves โจ. The whole point? A loop that's holding a load/store sequence can get rewritten into a load outside the loop plus a copy/store inside the loop. Chef's kiss.
It's enabled by default whenever -fgcse is enabled. ๐ซถ
-fgcse-smโ flip this on and a store motion pass runs after global common subexpression elimination. This pass is out here trying to move stores out of loops ๐ฆ. Team it up with-fgcse-lmand loops with a load/store sequence can become a load before the loop and a store after the loop. Literally so clean.
Not enabled at any optimization level. You have to ask for it, babe.
-fgcse-lasโ with this enabled, the global common subexpression elimination pass eliminates redundant loads that come after stores to the same memory location (both partial and full redundancies, no cap) ๐ .
Not enabled at any optimization level.
-fgcse-after-reloadโ when enabled, a redundant load elimination pass happens after reload. Its whole job is cleaning up redundant spilling ๐งนโจ.
Enabled by -O3, -fprofile-use and -fauto-profile.
-faggressive-loop-optimizationsโ this tells the loop optimizer to use language constraints to derive bounds for the number of iterations of a loop ๐. Which means it's assuming your loop code does not invoke undefined behavior โ like, no signed integer overflows, no out-of-bound array accesses, none of that ๐. Those iteration bounds then guide loop unrolling and peeling and loop exit test optimizations.
This option is enabled by default. Periodt.
-funconstrained-commonsโ 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.-fcrossjumpingโ performs the cross-jumping transformation, which unifies equivalent code and saves code size ๐. Fair warning though: the resulting code may or may not perform better than without cross-jumping. It's giving "smaller, not necessarily faster."
Enabled at levels -O2, -O3, -Os.
-fauto-inc-decโ combines increments or decrements of addresses with memory accesses ๐ฅ. This pass is always skipped on architectures that don't have instructions to support it. Enabled by default at-O1and higher on architectures that support this.-fdceโ performs dead code elimination (DCE) on RTL ๐โจ. Enabled by default at-O1and higher.-fdseโ performs dead store elimination (DSE) on RTL ๐โจ. Enabled by default at-O1and higher.-fif-conversionโ attempts to transform conditional jumps into branch-less equivalents ๐. That includes conditional moves, min, max, set flags and abs instructions, plus some tricks doable by standard arithmetics. The use of conditional execution on chips where it's available is controlled by-fif-conversion2.
Enabled at levels -O1, -O2, -O3, -Os, but not with -Og.
-fif-conversion2โ uses conditional execution (where available) to transform conditional jumps into branch-less equivalents โญ.
Enabled at levels -O1, -O2, -O3, -Os, but not with -Og.
-fdeclone-ctor-dtorโ okay so the C++ ABI requires multiple entry points for constructors and destructors: one for a base subobject, one for a complete object, and one for a virtual destructor that callsoperator deleteafterwards ๐ญ. For a hierarchy with virtual bases, the base and complete variants are clones โ meaning two copies of the function, yikes. With this option, the base and complete variants get changed to be thunks that call a common implementation. Deduplication slay.
Enabled by -Os.
-fdelete-null-pointer-checksโ assumes that programs cannot safely dereference null pointers, and that no code or data element lives at address zero ๐. This enables simple constant folding optimizations at all optimization levels. On top of that, other optimization passes in GCC use this flag to control global dataflow analyses that eliminate useless checks for null pointers; those assume that a memory access to address zero always results in a trap, so if a pointer is checked after it's already been dereferenced, it can't be null.
Heads up though: in some environments this assumption is not true ๐ณ. Use -fno-delete-null-pointer-checks to disable this optimization for programs that depend on that behavior.
This option is enabled by default on most targets. On AVR and MSP430, this option is completely disabled.
Passes that use the dataflow information are enabled independently at different optimization levels.
-fdevirtualizeโ attempts to convert calls to virtual functions into direct calls ๐. This happens both within a procedure and interprocedurally, as part of indirect inlining (-findirect-inlining) and interprocedural constant propagation (-fipa-cp). Enabled at levels-O2,-O3,-Os.-fdevirtualize-speculativelyโ attempts to convert calls to virtual functions into speculative direct calls ๐ฎ. Based on the analysis of the type inheritance graph, it figures out for a given call the set of likely targets. If that set is small โ preferably of size 1 โ the call gets changed into a conditional deciding between direct and indirect calls. These speculative calls enable more optimizations, like inlining. And when they seem useless after further optimization, they get converted back into their original form. Recycling icon behavior.-fdevirtualize-at-ltransโ streams extra information needed for aggressive devirtualization when running the link-time optimizer in local transformation mode ๐. This enables more devirtualization but significantly increases the size of streamed data. For this reason it is disabled by default.-fexpensive-optimizationsโ performs a number of minor optimizations that are relatively expensive ๐ธโจ.
Enabled at levels -O2, -O3, -Os.
-fext-dce-fno-ext-dceโ performs dead code elimination on zero and sign extensions, with special dataflow analysis ๐ง.-freeโ attempts to remove redundant extension instructions ๐ . This is especially helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit registers after writing to their lower 32-bit half.
Enabled for Alpha, AArch64, LoongArch, PowerPC, RISC-V, SPARC, h83000 and x86 at levels -O2, -O3, -Os.
-fno-lifetime-dseโ in C++ the value of an object is only affected by changes within its lifetime ๐ฐ๏ธ: when the constructor begins, the object has an indeterminate value, and any changes during the lifetime of the object are dead when the object is destroyed. Normally dead store elimination will take advantage of this. But 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 that optimization.
Want to preserve stores before the constructor starts (e.g. because your operator new clears the object storage) but still treat the object as dead after the destructor? Use -flifetime-dse=1. The default behavior can be explicitly selected with -flifetime-dse=2. And -flifetime-dse=0 is equivalent to -fno-lifetime-dse.
-flive-range-shrinkageโ attempts to decrease register pressure through register live range shrinkage ๐ธ. This is helpful for fast processors with small or moderate size register sets.- *
-fira-algorithm=algorithm* โ use the specified coloring algorithm for the integrated register allocator ๐จ. The algorithm argument can 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 ๐บ๏ธ. The region argument should be one of the following:allโ use all loops as register allocation regions. This can give the best results for machines with a small and/or irregular register set.mixedโ use all loops except for loops with small register pressure as the regions. This value usually gives the best results in most cases and for most architectures, and is enabled by default when compiling with optimization for speed (-O,-O2, ...).oneโ use all functions as a single region. This typically results in the smallest code size, and is enabled by default for-Osor-O0.
-fira-hoist-pressureโ use IRA to evaluate register pressure in the code hoisting pass for decisions to hoist expressions ๐ฆ. This option usually results in smaller code, but it can slow the compiler down.
This option is enabled at level -Os for all targets.
-fira-loop-pressureโ use IRA to evaluate register pressure in loops for decisions to move loop invariants ๐โจ. This option usually results in generation of faster and smaller code on machines with large register files (>= 32 registers), but it can slow the compiler down.
This option is enabled at level -O3 for some targets.
-fno-ira-share-save-slotsโ disables sharing of stack slots used for saving call-used hard registers living through a call ๐. Each hard register gets a separate stack slot, and as a result function stack frames are larger.-fno-ira-share-spill-slotsโ disables sharing of stack slots allocated for pseudo-registers ๐. Each pseudo-register that does not get a hard register gets a separate stack slot, and as a result function stack frames are larger.-flra-rematโ enables CFG-sensitive rematerialization in LRA ๐ฅ. Instead of loading values of spilled pseudos, LRA tries to rematerialize (recalculate) values if it is profitable.
Enabled at levels -O2, -O3, -Os.
-fdelayed-branchโ if supported for the target machine, attempts to reorder instructions to exploit instruction slots available after delayed branch instructions โณ๐.
Enabled at levels -O1, -O2, -O3, -Os, but not at -Og.
-fschedule-insnsโ bestie, if the target machine supports it, this tries to reorder instructions so we can yeet those execution stalls that happen when required data just isn't ready yet ๐ซถ It's a lifesaver for machines with slow floating point or memory load instructions, because it lets other instructions be issued while we're still waiting on the load or float result.
Conventionally this is turned on at -O2 and -O3. BUT. Many targets override that, so don't come for me. For example, on x86 it's disabled at all levels, while on AArch64 it's only enabled at -O3. It's giving "depends on the machine, iykyk" ๐
-fschedule-insns2โ same energy as-fschedule-insns, but it requests an additional pass of instruction scheduling after register allocation has already happened. This is especially useful on machines with a relatively small number of registers and where memory load instructions take more than one cycle โญ
Enabled at levels -O2, -O3, -Os.
-fno-sched-interblockโ disables instruction scheduling across basic blocks, which is normally enabled when scheduling before register allocation, i.e. with-fschedule-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 insn scheduling before register allocation. This only makes sense when scheduling before register allocation is enabled, i.e. with-fschedule-insnsor at-O2or higher. Using this can improve the generated code and decrease its size by preventing register pressure from rising above the number of available hard registers (and the spills in register allocation that would follow) ๐-fsched-spec-loadโ allows speculative motion of some load instructions. Only makes sense when scheduling before register allocation, i.e. with-fschedule-insnsor at-O2or higher.-fsched-spec-load-dangerousโ allows speculative motion of more load instructions. Yes bestie, it literally has "dangerous" in the name ๐ญ Still only makes sense when scheduling before register allocation, i.e. with-fschedule-insnsor at-O2or higher.-fsched-stalled-insns-fsched-stalled-insns=nโ defines how many insns (if any) can be moved prematurely from the queue of stalled insns into the ready list during the second scheduling pass.-fno-sched-stalled-insnsmeans that no insns are 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, resulting in faster schedules ๐ฅ Heads up though: this option is experimental, because not all machine descriptions used by GCC model the CPU closely enough to avoid unreliable results from the algorithm. So like, iconic but unhinged.
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.-fspeculatively-call-stored-functionsโ attempts to convert indirect calls of function pointers into pointers loaded from a structure field, if all visible stores to that field store just a single candidate ๐ When it does that, it turns the call into a conditional deciding between the direct call and the original indirect one. These speculative calls often enable more optimizations, like inlining. And if they seem useless after further optimization, they get converted back into their original form. So it's giving "shoot your shot, we can always undo it" ๐-freschedule-modulo-scheduled-loopsโ modulo scheduling is performed before traditional scheduling. So if a loop is modulo scheduled, later scheduling passes may change its schedule. Use this option to control that behavior.-fselective-schedulingโ schedule instructions using the selective scheduling algorithm. Selective scheduling runs instead of the first scheduler pass.-fselective-scheduling2โ schedule instructions using the selective scheduling algorithm. Selective scheduling runs instead of the second scheduler pass.-fsel-sched-pipeliningโ enables software pipelining of innermost loops during selective scheduling. 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โ some object formats, like ELF, allow interposing of symbols by the dynamic linker ๐ Which means: for symbols exported from the DSO, the compiler cannot perform interprocedural propagation, inlining and other optimizations, because it has to anticipate that the function or variable in question may change. And while this feature is useful (like, for example, to rewrite 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. The flag has no effect for functions explicitly declaredinline(where it is never allowed for interposition to change semantics) and for symbols explicitly declaredweak.-fshrink-wrapโ emit function prologues only before the parts of the function that actually need it, rather than at the top of the function. This flag is enabled by default at-Oand 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 this.-fcaller-savesโ enables allocation of values to registers that are clobbered by function calls, by emitting extra instructions to save and restore the registers around such calls. This allocation only happens when it seems to result in better code ๐ซถ
This option is always enabled by default on certain machines, usually those which have no call-preserved registers to use instead.
Enabled at levels -O2, -O3, -Os.
-fcombine-stack-adjustmentsโ tracks stack adjustments (pushes and pops) and stack memory references, then tries to find ways to combine them ๐
Enabled by default at -O1 and higher.
-fipa-raโ use caller save registers for allocation if those registers are not used by any called function. In that case it's not necessary to save and restore them around calls. This is only possible if the called functions are part of the same compilation unit as the current function and they are compiled before it.
Enabled at levels -O2, -O3, -Os, however the option is disabled if generated code will be instrumented for profiling (-p, or -pg) or if the callee's register usage cannot be known exactly (this happens on targets that do not expose prologues and epilogues in RTL).
-fconserve-stackโ attempts to minimize stack usage. The compiler tries to use less stack space, even if that makes the program slower ๐ This option implies setting thelarge-stack-frameparameter to100and thelarge-stack-frame-growthparameter to400.-ftree-reassocโ performs reassociation on trees. This flag is enabled by default at-O1and higher.-fcode-hoistingโ performs code hoisting. Code hoisting tries to move the evaluation of expressions executed on all paths to the function exit as early as possible. This is especially useful as a code size optimization, but it often helps for code speed 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 ๐ฅ This flag is enabled by default at-O3.-ftree-forwpropโ does forward propagation on trees, bestie. It's on by default at-O1and higher, so it's already slaying in the background. โจ-ftree-freโ full redundancy elimination (FRE) on trees. Okay so the tea: FRE and PRE are cousins but not twins. FRE only looks at expressions that get computed on all the paths leading to that redundant computation. So it's faster than PRE, but ngl it finds fewer redundancies. Enabled by default at-O1and higher. ๐ฆ-ftree-phipropโ hoists loads from conditional pointers, on trees. On by default at-O1and higher. It's giving subtle but iconic. ๐-fhoist-adjacent-loadsโ speculatively hoists loads from both branches of an if-then-else, but only if the loads are from adjacent locations in the same structure and the target architecture has a conditional move instruction. Enabled by default at-O2and higher. ๐-ftree-copy-propโ copy propagation on trees. This pass eliminates unnecessary copy operations. Enabled by default at-O1and higher. Bye bye pointless copies ๐-fipa-pure-constโ discovers which functions are pure or constant. Enabled by default at-O1and higher. ๐ฅ-fipa-referenceโ discovers which static variables do not escape the compilation unit. Enabled by default at-O1and higher.-fipa-reference-addressableโ discovers read-only, write-only and non-addressable static variables. Enabled by default at-O1and higher.-fipa-reorder-for-localityโ groups call chains close together in the binary layout so code locality improves and jump distances between frequently called functions get minimized. Not me comparing it to its exes, but: unlike-freorder-functionsthis pass considers the call chains between functions and groups them together, instead of grouping all hot/normal/cold/never-executed functions into separate sections. And unlike-fprofile-reorder-functionsit aims to improve code locality throughout the runtime of the program rather than focusing on program startup. This option is incompatible with an explicit-flto-partition=option since it enforces a custom partitioning scheme. If you use this option it is recommended to also use profile feedback, but this option is not enabled by default otherwise. ๐-fipa-stack-alignmentโ reduces stack alignment on call sites if possible. Enabled by default. Periodt.-fipa-ptaโ interprocedural pointer analysis plus 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โ interprocedural profile propagation. Functions called only from cold functions get marked as cold. Also functions executed once (such ascold,noreturn, static constructors or destructors) are identified. Cold functions and loop less parts of functions executed once are then optimized for size. Enabled by default at-O1and higher.-fipa-modrefโ interprocedural mod/ref analysis. This optimization analyzes the side effects of functions (memory locations that are modified or referenced) and enables better optimization across the function call boundary. Enabled by default at-O1and higher. ๐ง-fipa-cpโ interprocedural constant propagation. It analyzes the program to figure out when values passed to functions are constants and then optimizes accordingly. This one can substantially increase performance if the application has constants passed to functions. Enabled by default at-O2,-Osand-O3. It is also enabled by-fprofile-useand-fauto-profile.-fipa-cp-cloneโ 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. Enabled by default at-O3. It is 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-functions-fipa-icf-variables-fipa-icfโ perform Identical Code Folding for functions (-fipa-icf-functions), read-only variables (-fipa-icf-variables), or both (-fipa-icf). The optimization reduces code size and may disturb unwind stacks by replacing a function by an equivalent one with a different name. The optimization works more effectively with link-time optimization enabled.
Although the behavior is similar to the Gold Linker's ICF optimization, GCC ICF works on different levels and thus the optimizations are not same โ there are equivalences that are found only by GCC and equivalences found only by Gold.
-fipa-icf is enabled by default at -O2 and -Os.
-flate-combine-instructionsโ enables two instruction combination passes that run relatively late in the compilation process. One of the passes runs before register allocation and the other after register allocation. The main aim of the passes is to substitute definitions into all uses. Most targets enable this flag by default at-O2and-Os. ๐-flive-patching=levelโ controls GCC's optimizations to produce output suitable for live-patching.
Okay so imagine this: if the compiler's optimization uses a function's body or information extracted from its body to optimize/change another function, the latter is called an impacted function of the former. If a function is patched, its impacted functions should be patched too. That's the whole vibe. ๐ซถ
The impacted functions are determined by the compiler's interprocedural optimizations. For example, a caller is impacted when inlining a function into its caller, cloning a function and changing its caller to call this new clone, or extracting a function's pureness/constness information to optimize its direct or indirect callers, etc.
Usually, the more IPA optimizations enabled, the larger the number of impacted functions for each function. In order to control the number of impacted functions and more easily compute the list of impacted function, IPA optimizations can be partially enabled at two different levels.
The level argument should be one of the following:
inline-cloneโ only 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 -fipa-modref
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.
Heads up:-flive-patchingis not supported with link-time optimization (-flto). No cap. ๐
-fisolate-erroneous-paths-dereferenceโ detects paths that trigger erroneous or undefined behavior due to dereferencing a null pointer (with-fdelete-null-pointer-checksenabled) or a division by zero. It isolates those paths from the main control flow and turns the statement with erroneous or undefined behavior into a trap. Enabled by default at-O2and higher. ๐จ-fisolate-erroneous-paths-attributeโ detects paths that trigger erroneous or undefined behavior due to a null value being used in a way forbidden by areturns_nonnullornonnullattribute. It isolates those paths from the main control flow and turns the statement with erroneous or undefined behavior into a trap. This is not currently enabled, but may be enabled by-O2in the future. ๐-ftree-sinkโ performs forward store motion on trees. Enabled by default at-O1and 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-O1and higher. โจ-fssa-backpropโ propagates information about uses of a value up the definition chain in order to simplify the definitions. For example, this pass strips sign operations if the sign of a value never matters. Enabled by default at-O1and higher.-fssa-phioptโ performs pattern matching on SSA PHI nodes to optimize conditional code. Enabled by default at-O1and higher, except for-Og.-ftree-switch-conversionโ converts simple initializations in a switch into 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 usingmax-tail-merge-comparisonsparameter andmax-tail-merge-iterationsparameter. ๐-ftree-cselimโ bestie, this does conditional store elimination on trees. It's on by default at-O1and up, but only on targets that actually have conditional move instructions. So like, iykyk if your CPU is that girl ๐-ftree-dceโ dead code elimination (DCE) on trees. On by default at-O1and higher. It's giving "nothing to see here" and honestly? slay โจ-ftree-builtin-call-dceโ conditional dead code elimination (DCE) for calls to built-in functions that might seterrnobut are otherwise free of side effects. On by default at-O2and higher, as long as-Osisn't also specified. Careful, bestie.-ffinite-loopsโ okay so this one assumes a loop with an exit will eventually take that exit and not just loop forever. Which lets the compiler remove loops that have no side-effects, because it's no longer worried about them being endless. This is enabled by default at-O2for C++ with-std=c++11or higher. Not me trusting the loop to be normal ๐-ftree-dominator-optsโ a whole variety pack of simple scalar cleanups, based on a dominator tree traversal: constant/copy propagation, redundancy elimination, range propagation and expression simplification. It also does jump threading (reducing jumps to jumps, which is so real). Enabled by default at-O1and higher. Queen behavior ๐-ftree-dseโ dead store elimination (DSE) on trees. A dead store is a store into a memory location that gets overwritten later by another store with no intervening loads โ so the earlier store can just be deleted. Enabled by default at-O1and higher. We love a store that served no purpose, honestly iconic.-ftree-chโ loop header copying on trees. It's beneficial because it makes code motion optimizations more effective, and it also saves one jump. Enabled by default at-O1and higher. Not enabled for-Os, since it usually increases code size. Size matters, bestie ๐-ftree-loop-optimizeโ loop optimizations on trees. Enabled by default at-O1and higher. Periodt.-ftree-loop-linear,-floop-strip-mine,-floop-blockโ these do 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. Configuration girlies know ๐-fgraphite-identityโ enables the identity transformation for graphite. For every SCoP we generate the polyhedral representation and transform it back to gimple. With-fgraphite-identitywe can check the costs or benefits of the GIMPLE -> GRAPHITE -> GIMPLE transformation. Some minimal optimizations are also performed by the code generator isl, like index splitting and dead code elimination in loops. It's giving round trip โ๏ธโจ-floop-nest-optimizeโ enables the isl based loop nest optimizer. It's a generic loop nest optimizer based on the Pluto optimization algorithms, and it calculates a loop structure optimized for data-locality and parallelism. This option is experimental. Bestie, proceed with caution ๐-floop-parallelize-allโ uses the Graphite data dependence analysis to identify loops that can be parallelized. It parallelizes all the loops that can be analyzed to not contain loop carried dependences, without checking whether it's profitable to parallelize them. So like, no vibe check, just go ๐ฅ-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. Heads up: 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. It's enabled by default if optimization is enabled, and it does very little otherwise. A little treat that's lowkey optional ๐ญ-ftree-loop-if-convertโ attempts to transform conditional jumps in the innermost loops into branch-less equivalents. The intent is to remove control-flow from the innermost loops so the vectorization pass has a better shot at handling them. Enabled by default if vectorization is enabled. Branchless is a lifestyle ๐ฆ-ftree-loop-distributionโ performs loop distribution. This flag can improve cache performance on big loop bodies and let further loop optimizations happen, like parallelization or vectorization. For example, the loop
DO I = 1, N
A(I) = B(I) + C
D(I) = E(I) * F
ENDDO
gets transformed to
DO I = 1, N
A(I) = B(I) + C
ENDDO
DO I = 1, N
D(I) = E(I) * F
ENDDO
Enabled by default at -O3. It's also enabled by -fprofile-use and -fauto-profile. Splitting up like a group chat that needed separate convos ๐ฌ
-ftree-loop-distribute-patternsโ performs loop distribution of patterns that can be code generated with calls to a library. Enabled by default at-O2and higher, and by-fprofile-useand-fauto-profile. This pass distributes the initialization loops and generates a call tomemsetzero. 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. Clean, efficient, gorgeous ๐ธ
-floop-interchangeโ performs loop interchange outside of graphite. This flag can improve cache performance on loop nests and let further loop optimizations happen, like vectorization. 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];
Enabled by default at -O3. It's also enabled by -fprofile-use and -fauto-profile. Reordering the loops? We love a glow up โจ
-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's also enabled by-fprofile-useand-fauto-profile. Unroll AND jam, the combo meal ๐-ftree-loop-imโ performs loop invariant motion on trees. This pass only moves invariants that are hard to handle at RTL level (function calls, operations that expand to nontrivial sequences of insns). With-funswitch-loopsit also moves operands of conditions that are invariant out of the loop, so we can use just trivial invariantness analysis in loop unswitching. The pass also includes store motion. Moving things out of the loop, no cap ๐-ftree-loop-ivcanonโ creates a canonical counter for the number of iterations in loops where figuring out the iteration count requires complicated analysis. Later optimizations then may determine the number easily. Especially useful in connection with unrolling. Canonical counter is giving main character energy ๐-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, this replaces uses of the final value by such a computation, provided it's sufficiently cheap. This reduces data dependencies and may allow further simplifications. Enabled by default at-O1and higher. So smart fr fr ๐ง-fivoptsโ performs induction variable optimizations on trees (strength reduction, induction variable merging and induction variable elimination). Enabled by default at-O1and higher. The whole trifecta, obsessed ๐-ftree-parallelize-loops,-ftree-parallelize-loops=nโ parallelizes loops, i.e., splits their iteration space to run in multiple threads. This is only possible for loops whose iterations are independent and can be arbitrarily reordered. The optimization is only profitable on multiprocessor machines, for loops that are CPU-intensive rather than constrained e.g. by memory bandwidth. This option implies-pthread, and thus is only supported on targets that have support for-pthread.
When a positive value n is specified, the number of threads is fixed at compile time and cannot be changed after compilation. The compiler generates #pragma omp parallel num_threads(n).
When used without =n (i.e., -ftree-parallelize-loops), the number of threads is determined at program execution time via the OMP_NUM_THREADS environment variable. If OMP_NUM_THREADS is not set, the OpenMP runtime automatically detects the number of available processors and uses that value. This enables creating binaries that adapt to different hardware configurations without recompilation. Adaptive queen behavior, periodt ๐ฅ
-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. Structures stay in their lane ๐-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. Combining them all, it's giving efficiency โจ-ftree-terโ performs temporary expression replacement during the SSA->normal phase. Single use/single def temporaries are replaced at their use location with their defining expression. This results in non-GIMPLE code, but gives the expanders much more complex trees to work on, resulting in better RTL generation. Enabled by default at-O1and higher. Messy on purpose for the RTL glow up ๐-ftree-slsrโ performs straight-line strength reduction on trees. This recognizes related expressions involving multiplications and replaces them by less expensive calculations when possible. Enabled by default at-O1and higher. Cheaper but same energy ๐-ftree-vectorizeโ performs vectorization on trees. This flag enables-ftree-loop-vectorizeand-ftree-slp-vectorizeif not explicitly specified. Bundle deal, bestie ๐-ftree-loop-vectorizeโ performs loop vectorization on trees. Enabled by default at-O2and by-ftree-vectorize,-fprofile-use, and-fauto-profile. Loops going SIMD mode, slay ๐-ftree-slp-vectorizeโ okay so this one does basic block vectorization on trees ๐ . It's already switched on by default at-O2, and it also gets flipped on by-ftree-vectorize,-fprofile-use, and-fauto-profile. So like, if you're living at-O2, it's already happening bestie, no cap.-ftrivial-auto-var-init=choiceโ this one is a whole moment. It initializes automatic variables or temporary objects with either a pattern or with zeroes, and the point is to boost the security and predictability of a program by preventing uninitialized memory disclosure and use ๐ก๏ธ. Here's the tea though: GCC still considers an automatic variable that doesn't have an explicit initializer as uninitialized ๐ซ โ meaning-Wuninitializedand-Wanalyzer-use-of-uninitialized-valuewill still report warning messages on such automatic variables or temporary objects, and the compiler will perform optimization as if the variable were uninitialized. With this option, GCC will also initialize any padding of automatic variables or temporary objects that have structure or union types to zeroes โจ. BUT โ and this is the sad part โ the current implementation cannot initialize automatic variables whose initialization is bypassed through"switch"or"goto"statement ๐ญ. Using-Wtrivial-auto-var-initto report all such cases.
The three values of choice are:
uninitializedโ literally doesn't initialize any automatic variables. It's giving "not my problem" ๐patternโ initializes automatic variables with values which will likely transform logic bugs into crashes down the line, are easily recognized in a crash dump, and are not values that programmers can rely on for useful program semantics. The current value is a byte-repeatable pattern with byte"0xFE". The values used for pattern initialization might be changed in the future, so don't get attached ๐.zeroโ initializes automatic variables with zeroes.
The default is uninitialized, except for C++26 โ in which case, if -ftrivial-auto-var-init= is not specified at all, automatic variables or temporary objects are zero initialized, but zero initialization of padding bits does not happen. Very C++26 of it, honestly.
Note bestie: the initializer values, whether zero or pattern, refer to data representation (in memory or machine registers), rather than to their interpretation as numerical values. This distinction may be important in languages that support types with biases or implicit multipliers, and with such extensions as hardbool.
For example, a variable that uses 8 bits to represent (biased) quantities in the "range 160..400" will be initialized with the bit patterns 0x00 or 0xFE, depending on choice โ whether or not these representations stand for values in that range, and even if they do, the interpretation of the value held by the variable will depend on the bias. A hardbool variable that uses say 0x5A and 0xA5 for "false" and "true", respectively, will trap with either choice of trivial initializer ๐ญ, i.e., zero initialization will not convert to the representation for "false", even if it would for a "static" variable of the same type. This means the initializer pattern doesn't generally depend on the type of the initialized variable. One notable exception is that (non-hardened) boolean variables that fit in registers are initialized with "false" (zero), even when pattern is requested ๐ธ.
You can control this behavior for a specific variable by using the variable attribute "uninitialized" standard attribute or the C++26 "[[indeterminate]]" ๐.
-fvect-cost-model=modelโ switches up the cost model used for vectorization. The model argument should be one ofunlimited,dynamic,cheaporvery-cheap. With theunlimitedmodel, the vectorized code-path is assumed to be profitable โจ. With thedynamicmodel, a runtime check guards the vectorized code-path so it only kicks in 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 it's equal to thedynamicmodel. Thevery-cheapmodel disables vectorization of loops when any runtime check for data dependence or alignment is required, and it also disables vectorization of epilogue loops, but otherwise it's equal to thecheapmodel. Pick your fighter ๐ .
The default cost model depends on other optimization flags and is either dynamic or cheap.
-fsimd-cost-model=modelโ same energy, but for 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-modelis used ๐.-ftree-vrpโ performs Value Range Propagation on trees. This is similar to the constant propagation pass, but instead of values, ranges of values are propagated ๐. That lets the optimizers remove unnecessary range checks like array bound checks and null pointer checks. It's enabled by default at-O2and higher. Null pointer check elimination is only done if-fdelete-null-pointer-checksis enabled ๐.-fsplit-pathsโ splits paths leading to loop backedges. This can improve dead code elimination and common subexpression elimination. Enabled by default at-O3and above ๐ฅ.-fsplit-ivs-in-unrollerโ enables expression of values of induction variables in later iterations of the unrolled loop using the value in the first iteration. This breaks long dependency chains, thus improving efficiency of the scheduling passes. Chef's kiss scheduling behavior, honestly ๐ .
A combination of -fweb and CSE is often sufficient to obtain the same effect. However, that is not reliable in cases where the loop body is more complicated than a single basic block. It also does not work at all on some architectures due to restrictions in the CSE pass ๐ญ.
This optimization is enabled by default.
-fvariable-expansion-in-unrollerโ with this option, the compiler creates multiple copies of some local variables when unrolling a loop, which can result in superior code โจ.
This optimization is enabled by default for PowerPC targets, but disabled by default otherwise. PowerPC stays winning, I guess ๐.
-fpartial-inliningโ inlines parts of functions. Just a heads up though: this option has any effect only when inlining itself is turned on by the-finline-functionsor-finline-small-functionsoptions ๐.
Enabled at levels -O2, -O3, -Os.
-fpredictive-commoningโ performs predictive commoning optimization, i.e., reusing computations (especially memory loads and stores) performed in previous iterations of loops. Recycling era โป๏ธ.
This option is enabled at level -O3. It is also enabled by -fprofile-use and -fauto-profile.
-fprefetch-loop-arraysโ if supported by the target machine, generates instructions to prefetch memory to improve the performance of loops that access large arrays. Manifesting speed ๐ฆ.
Heads up: this option may generate better or worse code; results are highly dependent on the structure of loops within the source code. So like, it's giving "trust the process" but the process might be mid ๐.
Disabled at level -Os.
-fno-printf-return-valueโ do not substitute constants for known return value of formatted output functions such assprintf,snprintf,vsprintf, andvsnprintf(but notprintforfprintf). This transformation allows GCC to optimize or even eliminate branches based on the known return value of these functions called with arguments that are either constant, or whose values are known to be in a range that makes determining the exact return value possible. For example, when-fprintf-return-valueis in effect, both the branch and the body of theifstatement (but not the call tosnprint) can be optimized away wheniis a 32-bit or smaller integer because the return value is guaranteed to be at most 8. Watch this:
char buf[9];
if (snprintf (buf, "%08x", i) >= sizeof buf)
...
The -fprintf-return-value option relies on other optimizations and yields best results with -O2 and above. It works in tandem with the -Wformat-overflow and -Wformat-truncation options ๐ค. The -fprintf-return-value option is enabled by default.
-fno-peepholeโ-fno-peephole2โ disables any machine-specific peephole optimizations. The difference between-fno-peepholeand-fno-peephole2is in how they are implemented in the compiler; some targets use one, some use the other, a few use both ๐.
-fpeephole is enabled by default. -fpeephole2 enabled at levels -O2, -O3, -Os.
-fno-guess-branch-probabilityโ do not guess branch probabilities using heuristics. Periodt.
GCC uses heuristics to guess branch probabilities if they are not provided by profiling feedback (-fprofile-arcs). These heuristics are based on the control flow graph. If some branch probabilities are specified by "__builtin_expect", then the heuristics are used to guess branch probabilities for the rest of the control flow graph, taking the "__builtin_expect" info into account. The interactions between the heuristics and "__builtin_expect" can be complex, and in some cases, it may be useful to disable the heuristics so that the effects of "__builtin_expect" are easier to understand ๐ซถ.
It is also possible to specify expected probability of the expression with "__builtin_expect_with_probability" built-in function โจ.
The default is -fguess-branch-probability at levels -O, -O2, -O3, -Os.
-freorder-blocksโ reorders basic blocks in the compiled function in order to reduce number of taken branches and improve code locality. Organized queen behavior ๐.
Enabled at levels -O1, -O2, -O3, -Os.
-freorder-blocks-algorithm=algorithmโ uses 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 -O1, -Os, and stc at levels -O2, -O3.
-freorder-blocks-and-partitionโ in addition to reordering basic blocks in the compiled function, in order to reduce number of taken branches, this partitions hot and cold basic blocks into separate sections of the assembly and.ofiles, to improve paging and cache locality performance ๐ฅ. Hot girl blocks and cold girl blocks, separated, as they should be ๐ .
This optimization gets automatically turned off the second exception handling or unwind tables enter the chat (that's the setjump/longjump situation, or whatever target-specific scheme your target is running), and also for linkonce sections, for functions with a user-defined section attribute, and on literally any architecture that doesn't support named sections. And when -fsplit-stack is being used? This option is not enabled by default (they're dodging linker errors, bestie ๐ซถ), but it can be enabled explicitly โ provided you're using a linker that actually works.
Enabled for x86 at levels -O2, -O3, -Os.
-freorder-functionsโ Reorder the functions inside the object file so code locality gets better. Unlike-fipa-reorder-for-locality, this one prioritises grouping every function in a category (hot / normal / cold / never-executed) together. The way it's implemented is with special subsections:.text.hotfor the functions that get executed most often, and.text.unlikelyfor the ones that basically never run. The reordering itself is done by the linker, so the object file format has to support named sections, and the linker has to place them in a reasonable way.
This option isn't effective unless you either hand over profile feedback (see -fprofile-arcs for the deets) or manually annotate functions with hot or cold attributes.
Enabled at levels -O2, -O3, -Os.
-fstrict-aliasingโ Lets the compiler assume the strictest aliasing rules that apply to whatever language you're compiling. For C (and C++), this switches on optimizations based on the type of expressions. Specifically: accessing an object of one type through an expression of a different type is not allowed, unless the types are compatible, differ only in signedness or qualifiers, or the expression has a character type. Accessing scalar objects via a corresponding vector type is also allowed. โจ
For example, an unsigned int can alias an int, but it can't alias a void* or a double. A character type may alias any other type.
Pay special attention to code like this, bestie:
union a_union {
int i;
double d;
};
int f() {
union a_union t;
t.d = 3.0;
return t.i;
}
Reading from a different union member than the one most recently written to โ called type-punning โ is super common. And even with -fstrict-aliasing, type-punning is allowed in C, as long as the memory is accessed through the union type. In ISO C++, type-punning through a union type is undefined behavior, but GCC supports it as an extension. So the code above works as expected. ๐
However, this next one might not:
int f() {
union a_union t;
int* ip;
t.d = 3.0;
ip = &t.i;
return *ip;
}
Same energy for access by taking the address, casting the resulting pointer and dereferencing the result โ that has undefined behavior, even if the cast uses a union type, e.g.:
int f() {
double d = 3.0;
return ((union a_union *) &d)->i;
}
The -fstrict-aliasing option is enabled at levels -O2, -O3, -Os.
-fipa-strict-aliasingโ Controls whether the rules of-fstrict-aliasingget applied across function boundaries. Note that if multiple functions get inlined into a single function, the memory accesses are no longer considered to be crossing a function boundary. iykyk ๐ง
The -fipa-strict-aliasing option is enabled by default and is only effective in combination with -fstrict-aliasing.
-falign-functions,-falign-functions=n,-falign-functions=n:m,-falign-functions=n:m:n2,-falign-functions=n:m:n2:m2โ Align the start of functions to the next power-of-two greater than or equal to n, skipping up to m-1 bytes. This makes sure that at least the first m bytes of the function can be fetched by the CPU without crossing an n-byte alignment boundary. It's an optimization for code performance, and alignment is ignored for functions considered cold. If you need alignment on literally all functions, use-fmin-function-alignmentinstead.
If m isn't specified, it defaults to n.
Examples, because we love receipts: -falign-functions=32 aligns functions to the next 32-byte boundary, -falign-functions=24 aligns to the next 32-byte boundary only if that can be done by skipping 23 bytes or less, and -falign-functions=32:7 aligns to the next 32-byte boundary only if it can be done by skipping 6 bytes or less.
That second pair of n2:m2 values lets you specify a secondary alignment: -falign-functions=64:7:32:3 aligns to the next 64-byte boundary if that can be done by skipping 6 bytes or less, otherwise it aligns to the next 32-byte boundary if that can be done by skipping 2 bytes or less. If m2 isn't specified, it defaults to n2.
Some assemblers only support this flag when n is a power of two; in that case, it gets rounded up.
-fno-align-functions and -falign-functions=1 are equivalent and mean functions are not aligned.
If n isn't specified or is zero, use a machine-dependent default. The maximum allowed n option value is 65536.
Enabled at levels -O2, -O3.
-flimit-function-alignmentโ If this one's enabled, the compiler tries to avoid unnecessarily overaligning functions. It attempts to tell the assembler to align by the amount specified by-falign-functions, but not to skip more bytes than the size of the function. Very demure, very mindful. ๐-falign-labels,-falign-labels=n,-falign-labels=n:m,-falign-labels=n:m:n2,-falign-labels=n:m:n2:m2โ Aligns all branch targets to a power-of-two boundary.
The parameters of this option work analogously to -falign-functions. -fno-align-labels and -falign-labels=1 are equivalent and mean labels are not aligned.
If -falign-loops or -falign-jumps are applicable and are greater than this value, then their values get used instead.
If n isn't specified or is zero, use a machine-dependent default which is very likely to be 1, meaning no alignment. The maximum allowed n option value is 65536.
Enabled at levels -O2, -O3.
-falign-loops,-falign-loops=n,-falign-loops=n:m,-falign-loops=n:m:n2,-falign-loops=n:m:n2:m2โ 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. It's an optimization for code performance, and alignment is ignored for loops considered cold. โ๏ธ
If -falign-labels is greater than this value, then its value is used instead.
Parameters of this option are analogous to -falign-functions. -fno-align-loops and -falign-loops=1 are equivalent and mean loops are not aligned. The maximum allowed n option value is 65536.
If n isn't specified or is zero, use a machine-dependent default.
Enabled at levels -O2, -O3.
-falign-jumps,-falign-jumps=n,-falign-jumps=n:m,-falign-jumps=n:m:n2,-falign-jumps=n:m:n2:m2โ Aligns branch targets to a power-of-two boundary, for branch targets where the targets can only be reached by jumping. In that case, no dummy operations need to be executed. It's an optimization for code performance, and alignment is ignored for jumps considered cold.
If -falign-labels is greater than this value, then its value is used instead.
Parameters of this option are analogous to -falign-functions. -fno-align-jumps and -falign-jumps=1 are equivalent and mean loops are not aligned.
If n isn't specified or is zero, use a machine-dependent default. The maximum allowed n option value is 65536.
Enabled at levels -O2, -O3.
-fmin-function-alignmentโ Specify the minimal alignment of functions to the next power-of-two greater than or equal to n. Unlike-falign-functions, this alignment is applied to all functions (even the ones considered cold). The alignment is also not affected by-flimit-function-alignment. ๐-fno-allocation-dceโ Do not remove unused C++ allocations (the ones using operatornewand operatordelete) during dead code elimination.
See also -fmalloc-dce.
-fallow-store-data-racesโ Lets the compiler perform optimizations that may introduce new data races on stores, without proving that the variable can't be concurrently accessed by other threads. It doesn't affect optimization of local data. It's safe to use this option if you know for a fact that global data won't be accessed by multiple threads.
Examples of optimizations that -fallow-store-data-races enables include hoisting or if-conversions that may cause a value already in memory to be re-written with that same value. That kind of re-writing is safe in a single threaded context, but it may be unsafe in a multi-threaded context. Also note that on some processors, if-conversions may be required in order to enable vectorization.
Enabled at level -Ofast.
-funit-at-a-timeโ This option is left around for compatibility reasons.-funit-at-a-timehas no effect, while-fno-unit-at-a-timeimplies-fno-toplevel-reorderand-fno-section-anchors.
Enabled by default.
-fno-toplevel-reorderโ Do not reorder top-level functions, variables, andasmstatements. Output them in the same order they appear in the input file. When this option is used, unreferenced static variables are not removed. This option is intended to support existing code that relies on a particular ordering. For new code, it's better to use attributes when you can. โจ
-ftoplevel-reorder is the default at -O1 and higher, and also at -O0 if -fsection-anchors is explicitly requested. Additionally, -fno-toplevel-reorder implies -fno-section-anchors.
-funreachable-trapsโ With this option, the compiler turns calls to__builtin_unreachableinto traps, instead of using them for optimization. This also affects any such calls implicitly generated by the compiler.
This option has the same effect as -fsanitize=unreachable -fsanitize-trap=unreachable, but it does not affect the values of those options. If -fsanitize=unreachable is enabled, that option takes priority over this one.
This option is enabled by default at -O0 and -Og.
-fwebโ builds webs the way register allocation peeps like them, then hands every single web its own personal pseudo register ๐ . Why? So the register allocation pass can vibe with pseudos directly, and it also glow-ups a bunch of other optimization passes โ CSE, the loop optimizer, and the trivial dead code remover all eat with this one.
Careful bestie ๐ญ this can make debugging straight-up impossible, because your variables stop living in a "home register". They're justโฆ gone. Free. Homeless. It's giving fugitive.
Enabled by default with -funroll-loops. Slay, automatic.
-fwhole-programโ okay so this one tells GCC "bestie, assume this compilation unit IS the whole program, nothing else exists, we're in a bubble โจ". Every public function and variable โ exceptmainand the ones merged by theexternally_visibleattribute โ gets turned into a static function, and interprocedural optimizers go absolutely feral on them.
With -flto this option has limited use. In most cases the precise list of symbols used or exported from the binary is already known from the resolution info that the linker plugin hands to the link-time optimizer. It's still useful if no linker plugin is used, or during the incremental link step when the final code is produced (with -flto -flinker-output=nolto-rel).
-flto[=n]โ the main character option ๐. This runs the standard link-time optimizer. When you invoke it with source code, it generates GIMPLE (one of GCC's internal representations, iykyk) and writes it into special ELF sections inside the object file. Then when those object files get linked together, all the function bodies get read back out of those ELF sections and instantiated as if they'd always been part of the same translation unit. Iconic behavior fr fr.
To actually use the link-time optimizer, -flto and your optimization options should be specified at compile time and during the final link. It's recommended that you compile every file going into the same link with the same options, and also pass those options at link time. Like so:
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 save a bytecode representation of GIMPLE into special ELF sections inside foo.o and bar.o. The final invocation reads that GIMPLE bytecode back out of foo.o and bar.o, merges the two files into a single internal image, and compiles the result as usual. And because foo.o and bar.o are now one image, all the interprocedural analyses and optimizations in GCC work across both files as if they were a single one. Which means โ for example โ the inliner can inline functions from bar.o into functions in foo.o and vice-versa. Cross-file inlining, bestie. We love to see it ๐.
Another (simpler) way to enable link-time optimization is:
gcc -o myprog -flto -O2 foo.c bar.c
That one generates bytecode for foo.c and bar.c, merges them into a single GIMPLE representation, and optimizes them as usual to produce myprog.
The important thing to keep in mind (write this on your hand, bestie โ๏ธ) is that to enable link-time optimizations you need to use the GCC driver to perform the link step. GCC automatically does link-time optimization if any of the objects involved were compiled with the -flto command-line option. And you can always override that automatic decision by passing -fno-lto to the link command. No cap.
To make whole-program optimization actually effective, certain assumptions have to be made. The compiler needs to know what functions and variables can be accessed by libraries and runtime outside of the link-time optimized unit. When the linker supports it, the linker plugin (see -fuse-linker-plugin) passes information to the compiler about used and externally visible symbols. When the linker plugin isn't available, -fwhole-program should be used to let the compiler 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). Which means object files with LTO information can be linked as normal object files โ and if -fno-lto is passed to the linker, no interprocedural optimizations are applied. Note that when -fno-fat-lto-objects is enabled, the compile stage is faster, but you cannot perform a regular, non-LTO link on them. Pick your fighter ๐.
When producing the final binary, GCC only applies link-time optimizations to those files that contain bytecode. So you can mix and match object files and libraries with GIMPLE bytecodes and final object code, no problem. GCC automatically selects which files to optimize in LTO mode and which files to link without further processing. It's giving selective attention and honestly? Valid.
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. It's doing its best ๐ซถ.
If you don't specify an optimization level option -O at link time, then GCC uses the highest optimization level used when compiling the object files. But note that it's generally ineffective to specify an optimization level option only at link time and not at compile time, for two reasons:
- Compiling without optimization suppresses compiler passes that gather information needed for effective optimization at link time. Information not gathered = information not there, bestie.
- Some early optimization passes can be performed only at compile time and not at link time.
There are some code generation flags that GCC preserves when generating bytecodes, since they need to be used during the final link. Currently, the following options and their settings are taken from the first object file that explicitly specifies them: -fcommon, -fexceptions, -fnon-call-exceptions, -fgnu-tm, and all the -m target flags.
The following options โ -fPIC, -fpic, -fpie and -fPIE โ are combined based on this scheme, and you're gonna want to screenshot this:
-fPIC + -fpic = -fpic
-fPIC + -fno-pic = -fno-pic
-fpic/-fPIC + (no option) = (no option)
-fPIC + -fPIE = -fPIE
-fpic + -fPIE = -fpie
-fPIC/-fpic + -fpie = -fpie
Certain ABI-changing flags are required to match in all compilation units, and trying to override this at link time with a conflicting value gets ignored. Periodt. This includes options such as -freg-struct-return and -fpcc-struct-return.
Other options โ like -ffp-contract, -fno-strict-overflow, -fwrapv, -fno-trapv or -fno-strict-aliasing โ get passed through to the link stage and merged conservatively for conflicting translation units. Specifically, -fno-strict-overflow, -fwrapv and -fno-trapv take precedence; and for example -ffp-contract=off takes precedence over -ffp-contract=fast. You can override them at link time though ๐
.
Diagnostic options such as -Wstringop-overflow are passed through to the link stage, and their setting matches that of the compile-step at function granularity. Note that this only matters for diagnostics emitted during optimization. Also note that code transforms such as inlining can lead to warnings being enabled or disabled for regions of code that aren't consistent with the setting at compile time. Sneaky little thing ๐.
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. Choose one, don't be chaotic (unless you're into that).
To enable debug info generation you need to supply -g at compile time. If any of the input files at link time were built with debug info generation enabled, the link will enable debug info generation as well. Any elaborate debug info settings โ like the dwarf level -gdwarf-5 โ need to be explicitly repeated at the linker command line, and mixing different settings in different translation units is discouraged. Just don't, bestie ๐ญ.
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 though. Similar diagnostics may be raised for other languages. It's giving "we're telling you but we're not stopping you" ๐.
Another feature of LTO that is genuinely iconic: you can apply interprocedural optimizations to 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. Consistency is the vibe โจ.
If object files containing GIMPLE bytecode are stored in a library archive โ say libfoo.a โ it's possible to extract and use them in an LTO link if you're using a linker with plugin support. To create static libraries suitable for LTO, use gcc-ar and gcc-ranlib instead of ar and ranlib; and to show the symbols of object files with GIMPLE bytecode, use gcc-nm. Those commands require that ar, ranlib and nm have been compiled with plugin support. At link time, use the flag -fuse-linker-plugin to make sure the library actually participates in the LTO optimization process:
gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
With the linker plugin enabled, the linker extracts the needed GIMPLE files out of libfoo.a and passes them on to the running GCC, so they become part of the aggregated GIMPLE image to be optimized. Chef's kiss ๐
If you're not using a linker with plugin support and/or you don't enable the linker plugin, then the objects inside libfoo.a are extracted and linked as usual โ but they do not participate in the LTO optimization process. And if you want a static library that's suitable for both LTO optimization and usual linkage? Compile its object files with -flto -ffat-lto-objects. Two for one, bestie ๐.
Link-time optimizations do not need the whole program present to do their thing, bestie. ๐
If your program isn't exporting any symbols, you can totally combine -flto and -fwhole-program and let the interprocedural optimizers make more aggressive assumptions, which can unlock better optimization opportunities. But heads up: you don't need -fwhole-program when the linker plugin is active (peep -fuse-linker-plugin).
The current LTO implementation makes no attempt to generate bytecode that's portable between different types of hosts. The bytecode files are versioned with a strict version check, so bytecode from one GCC version will not work with an older or newer GCC. It's giving exclusive. ๐ซ
Also LTO does not play nice with debug info generation on systems that aren't using a combo of ELF and DWARF.
If you specify the optional n, the optimization and code generation at link time runs in parallel with n parallel jobs, using an installed make program. You can override which program gets used with the environment variable MAKE.
You can also say -flto=jobserver to use GNU make's job server mode and let it figure out the number of parallel jobs. This slaps when the Makefile calling GCC is already running in parallel. ๐ You must prepend a + to the command recipe in the parent Makefile for this to work. This option likely only works if MAKE is GNU make. Even without the option value, GCC tries to auto-detect a running GNU make's job server. ๐
Use -flto=auto to use GNU make's job server if it's available, or else fall back to autodetecting how many CPU threads you've got.
๐ -flto-partition=alg ๐
Specify the partitioning algorithm the link-time optimizer uses. The value is one of:
1to1โ partitioning that mirrors the original source filesbalancedโ partitioning into equally sized chunks (whenever possible)maxโ create a new partition for every symbol where possiblecacheโ balance chunk sizes while keeping related symbols together for better caching in incremental LTOnoneโ disables partitioning and streaming completely
The default value is balanced. While 1to1 can be used as a workaround for various code ordering issues, the max partitioning is intended for internal testing only. The value one specifies that exactly one partition should be used, while none bypasses partitioning and executes the link-time optimization step directly from the WPA phase. โจ
๐ -flto-incremental=path ๐
Enable incremental LTO, with its cache in the given existing directory. This can significantly shorten edit-compile cycles with LTO. ๐ฆ
When used with LTO (-flto), the output of translation units inside LTO is cached. Cached translation units are likely to show up again when you recompile with small code changes, which means recompile time goes way down. ๐
Multiple GCC instances can use the same cache in parallel. No cap. ๐
๐ธ -flto-incremental-cache-size=n ๐ธ
Specifies the number of cache entries in incremental LTO after which to prune old entries. This is a soft limit โ temporarily there may be more entries than that.
๐ง -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 together with LTO mode (-flto). GCC currently supports two LTO compression algorithms:
- For
zstd, valid values are0(no compression) to19(maximum compression) - For
zlib, valid values are0to9
Values outside the range get clamped to either the minimum or maximum of the supported values. If you don't give the option, a default balanced compression setting is used.
๐ -flto-toplevel-asm-heuristics ๐
Enables heuristics to find symbols used in top-level basic "asm". This restricts link-time optimizations that could cause renaming or deletion of such symbols โ which would otherwise result in missing symbol errors from the linker. ๐
This flag is intended for projects that haven't converted to using top-level extended "asm", which specifies usage directly without any false positives.
The heuristics are simple and do not parse the assembly. They scan through top-level assembly for all possible identifiers; if an identifier is found among declared symbols, the symbol gets marked to restrict link-time optimizations. Static symbols disable more optimizations. Identifiers followed by ':' disable more optimizations as well, because they might be a locally defined symbol in assembly โ even when the declaration is marked 'extern'.
๐ -fuse-linker-plugin ๐
Enables the use of a linker plugin during link-time optimization. This option relies on plugin support in the linker, which is available in gold or in GNU ld 2.21 or newer. โญ
This option enables the extraction of object files with GIMPLE bytecode out of library archives. This improves the quality of optimization by exposing more code to the link-time optimizer. This information specifies what symbols can be accessed externally (by non-LTO object or during dynamic linking). Resulting code quality improvements on binaries (and shared libraries that use hidden visibility) are similar to -fwhole-program. See -flto for a description of the effect of this flag and how to use it.
This option is enabled by default when LTO support in GCC is enabled and GCC was configured for use with a linker supporting plugins (GNU ld 2.21 or newer or gold).
๐ -ffat-lto-objects ๐
Fat LTO objects are object files that contain both the intermediate language and the object code. This makes them usable for both LTO linking and normal linking. This option is only effective when compiling with -flto, and it's ignored at link time.
-fno-fat-lto-objects improves compilation time over plain LTO, but it requires the complete toolchain to be aware of LTO. It requires a linker with linker plugin support for basic functionality. On top of that, nm, ar and ranlib need to support linker plugins to allow a full-featured build environment (one 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-pluginshas the same effect as usage of the command wrappers (gcc-ar,gcc-nmandgcc-ranlib).
The default is -fno-fat-lto-objects on targets with linker plugin support.
๐ -fcompare-elim ๐
After register allocation and post-register allocation instruction splitting, identify arithmetic instructions that compute processor flags similar to a comparison operation based on that arithmetic. If possible, eliminate the explicit comparison operation.
This pass only applies to certain targets that can't explicitly represent the comparison operation before register allocation is complete.
Enabled at levels -O1, -O2, -O3, -Os.
๐ฆ -ffold-mem-offsets / -fno-fold-mem-offsets ๐ฆ
Try to eliminate add instructions by folding them in memory loads/stores.
Enabled at levels -O2, -O3.
๐ -fcprop-registers ๐
After register allocation and post-register allocation instruction splitting, perform a copy-propagation pass to try to reduce scheduling dependencies and occasionally eliminate the copy.
Enabled at levels -O1, -O2, -O3, -Os.
๐
-fprofile-correction ๐
Profiles collected using an instrumented binary for multi-threaded programs may be inconsistent due to missed counter updates. When this option is specified, GCC uses heuristics to correct or smooth out such inconsistencies. By default, GCC emits an error message when an inconsistent profile is detected.
This option is enabled by -fauto-profile.
๐ -fprofile-partial-training ๐
With "-fprofile-use", all portions of programs not executed during training runs are optimized aggressively for size rather than speed. In some cases it's just not practical to train all possible hot paths in the program. (For example, it may contain functions specific to a given hardware and training may not cover all hardware configurations the program later runs on.) With "-fprofile-partial-training", profile feedback is ignored for all functions not executed during the training runs, causing them to be optimized as if they were compiled without profile feedback. This leads to better performance when the training isn't representative โ at the cost of significantly bigger code. ๐
๐ -fprofile-use / -fprofile-use=path ๐
Enable profile feedback-directed optimizations, plus the following optimizations, many of which are generally profitable only with profile feedback available:
-fbranch-probabilities -fprofile-values -funroll-loops
-fpeel-loops -ftracer -fvpt -finline-functions -fipa-cp
-fipa-cp-clone -fipa-bit-cp -fpredictive-commoning -fsplit-loops
-funswitch-loops -fgcse-after-reload -ftree-loop-vectorize
-ftree-slp-vectorize -fvect-cost-model=dynamic
-ftree-loop-distribute-patterns -fprofile-reorder-functions
Before you can use this option, you must first generate profiling information.
By default, GCC emits an error message if the feedback profiles don't 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 don't 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, plus the following optimizations, many of which are generally profitable only with profile feedback available:
-fbranch-probabilities -fprofile-values -funroll-loops
-fpeel-loops -ftracer -fvpt -finline-functions -fipa-cp
-fipa-cp-clone -fipa-bit-cp -fpredictive-commoning -fsplit-loops
-funswitch-loops -fgcse-after-reload -ftree-loop-vectorize
-ftree-slp-vectorize -fvect-cost-model=dynamic
-ftree-loop-distribute-patterns -fprofile-correction
...okay so path is literally the name of the file holding your AutoFDO profile info. Skip it and it just defaults to fbdata.afdo sitting in the current directory, no biggie. ๐
To actually make an AutoFDO profile data file you gotta run your program with the perf utility on a supported GNU/Linux target. More deets live at <https://perfwiki.github.io/main/>. ๐ฆ
Like, for example:
perf record -e br_inst_retired:near_taken -b -o perf.data \
-- your_program
Then you hit up the create_gcov tool to convert that raw profile data into a format GCC can actually use. You also have to hand it the unstripped binary of your program โ non-negotiable, bestie. Peep <https://github.com/google/autofdo>. โจ
Like so:
create_gcov --binary=your_program.unstripped --profile=perf.data \
--gcov=profile.afdo
-fauto-profile-inliningโ when auto-profile is on the table, this inlines all the relevant functions that were inlined during the tran run before it reads the profile feedback. Why? Because it levels up the context sensitivity of the profile. Enabled by default. ๐
Okay so now we're in the floating-point arithmetic zone and honestly it's giving โจchoicesโจ. The following options control how the compiler behaves around floating-point math, and they're all trading off speed against correctness. Heads up: all of them must be specifically enabled. Not a single one just happens on its own. ๐
-fexcess-precision=styleโ this one lets you control excess precision on machines where floating-point ops happen in a format with more precision or range than the IEEE standard and than the interchange floating-point types. Classic example? x87 floating point on x86 processors, which uses an 80-bit representation internally instead of the 64-bit IEEE format. For most programs that extra precision is harmless, but some programs actually rely on what the C or C++ language standards require for handling IEEE values. ๐
By default, -fexcess-precision=fast is what's in effect โ meaning operations can be carried out in a wider precision than the types you specified in the source, if that gets you faster code, and honestly it's unpredictable when the rounding back to your source-code types actually happens. When you're compiling C or C++, if you specify -fexcess-precision=standard then excess precision follows the rules in ISO C99 or C++ โ and specifically, both casts and assignments cause values to get rounded to their semantic types (whereas -ffloat-store only touches assignments, so yeah, they're not the same). This option is enabled by default for C or C++ when you use a strict conformance option like -std=c99 or -std=c++17. And -ffast-math enables -fexcess-precision=fast by default regardless of whether a strict conformance option is used. If you specify -fexcess-precision=16, then constants and the results of expressions with the types _Float16 and __bf16 get computed with no excess precision. โญ
Real talk: -fexcess-precision=standard is not implemented for languages other than C or C++. And on x86 it does absolutely nothing if -mfpmath=sse or -mfpmath=sse+387 is specified โ in the former case IEEE semantics apply with no excess precision at all, and in the latter case, bestie, rounding is just unpredictable. ๐
-ffloat-storeโ do not store floating-point variables in registers, and shut down other options that might change whether a floating-point value gets pulled from a register or from memory. This option has generally been subsumed by-fexcess-precision=standard, which is the more general one. But if you do use-ffloat-store, you may need to modify your program to explicitly stash intermediate computations in temporary variables, since-ffloat-storeonly handles rounding to IEEE format on assignments and not on casts the way-fexcess-precision=standarddoes. ๐ซถ-ffast-mathโ this is the bundle deal, it sets:-fno-math-errno,-funsafe-math-optimizations,-ffinite-math-only,-fno-rounding-math,-fno-signaling-nans,-fcx-limited-rangeand-fexcess-precision=fast. ๐
It also causes the preprocessor macro __FAST_MATH__ to be defined. Periodt.
Heads up: this option is not turned on by any-Ooption besides-Ofast, because it can straight-up result in incorrect output for programs that depend on an exact implementation of IEEE or ISO rules/specifications for math functions. It may, however, yield faster code for programs that don't need the guarantees of those specifications. ๐ฅ
-fno-math-errnoโ don't seterrnoafter calling math functions that execute in a single instruction, e.g.sqrt. If your program relies on IEEE exceptions for math error handling, you might still want this flag for the speed while keeping IEEE arithmetic compatibility. ๐ญ
Same warning as above: not turned on by any-Ooption besides-Ofast, because incorrect output is possible for programs depending on an exact implementation of IEEE or ISO rules/specifications for math functions. But again โ faster code for programs that don't need those guarantees.
The default is -fmath-errno.
Oh and on Darwin systems the math library never sets errno. So there's zero reason for the compiler to even consider the possibility that it might, and -fno-math-errno is the default there. ๐
-funsafe-math-optimizationsโ allow optimizations for floating-point arithmetic that (a) assume arguments and results are valid, and (b) may violate IEEE or ANSI standards. And when it's used at link time, it may include libraries or startup files that change the default FPU control word, or do other similar optimizations. ๐ณ
Yep, same deal: not turned on by any-Ooption besides-Ofast, because incorrect output for IEEE/ISO-dependent programs is on the menu. Faster code though, for programs that don't need those guarantees. It enables-fno-signed-zeros,-fno-trapping-math,-fassociative-mathand-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 the computation result. NOTE: re-ordering may change the sign of zero, ignore NaNs, and inhibit or create underflow or overflow โ so it absolutely cannot be used on code that relies on rounding behavior like(x + 2**52) - 2**52. It may also reorder floating-point comparisons, so it may not be used when ordered comparisons are required. This option requires that both-fno-signed-zerosand-fno-trapping-mathbe in effect. And on top of all that, 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 that value, if it enables optimizations. For examplex / ycan be replaced withx * (1/y), which is useful when(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 arguments and results are not NaNs or +-Infs. ๐
Yeah, you know the drill by now: not turned on by any-Ooption besides-Ofast, incorrect output possible for programs relying on an exact implementation of IEEE or ISO rules/specifications for math functions. Faster code for programs that don't require those guarantees.
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 distinct behavior for +0.0 and -0.0 values, which then forbids simplification of expressions like 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 floating-point operations can't generate user-visible traps. Those traps include division by zero, overflow, underflow, inexact result and invalid operation. This option requires that-fno-signaling-nansbe in effect. Setting it may allow faster code if you're relying on "non-stop" IEEE arithmetic, for example. ๐
Not turned on by any-Ooption besides-Ofastโ say it with me โ because it can result in incorrect output for programs that depend on an exact implementation of IEEE or ISO rules/specifications for math functions.
The default is -ftrapping-math.
Future versions of GCC may provide finer control of this setting using C99's FENV_ACCESS pragma. This command-line option will be used along with -frounding-math to specify the default state for FENV_ACCESS. ๐
-frounding-mathโ disable transformations and optimizations that assume default floating-point rounding behavior (round-to-nearest). You should specify this option for programs that change the FP rounding mode dynamically, or that may be executed with a non-default rounding mode. It disables constant folding of floating-point expressions at compile time (which may be affected by rounding mode) and arithmetic transformations that are unsafe in the presence of sign-dependent rounding modes. โญ
The default is -fno-rounding-math.
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 along with-ftrapping-mathto specify the default state forFENV_ACCESS.
-fsignaling-nansโ compile code assuming 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. ๐ญ
It causes the preprocessor macro __SUPPORT_SNAN__ to be defined. โจ
The default is -fno-signaling-nans.
This option is experimental and does not currently guarantee to disable all GCC optimizations that affect signaling NaN behavior. ๐
-fsingle-precision-constantโ okay so this one treats floating-point constants as single precision, instead of quietly (implicitly) converting them up into double-precision constants. that's it, that's the whole vibe. ๐-fcx-limited-rangeโ turn this on and you're basically saying "bestie, we do not need a range reduction step when doing complex division." also there's no checking whether the result of a complex multiplication or division is"NaN + I*NaN"โ no rescue attempt, no save, nothing. it's enabled by-ffast-math.
this option controls the default setting of the ISO C99 "CX_LIMITED_RANGE" pragma. but like, it applies to all languages, periodt. ๐
-fcx-fortran-rulesโ complex multiplication and division follow Fortran rules. range reduction is done as part of complex division, but there is no checking whether the result of a complex multiplication or division is"NaN + I*NaN", with an attempt to rescue the situation in that case.-fcx-method=methodโ complex multiplication and division follow the stated method. the method argument should be one oflimited-range,fortranorstdc.
the default is to honor language specific constraints, which means fortran for Fortran and stdc otherwise. slay โจ
okay so the next lil batch of options controls optimizations that may improve performance, but they're not enabled by any -O options. and heads up bestie โ this section includes experimental options that may produce broken code. ๐
-fbranch-probabilitiesโ so after you run a program compiled with-fprofile-arcs, you can compile it a second time using-fbranch-probabilitiesto improve optimizations based on how many times each branch was taken. when a program compiled with-fprofile-arcsexits, it saves arc execution counts to a file calledsourcename.gcdafor each source file. the info in this 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. see details about the file naming in-fprofile-arcs.
with -fbranch-probabilities, GCC puts a REG_BR_PROB note on each JUMP_INSN and CALL_INSN. these can be used to improve optimization. currently, they're only used in one place: in reorg.cc, instead of guessing which path a branch is most likely to take, the REG_BR_PROB values are used to exactly determine which path is taken more often. ๐
enabled by -fprofile-use and -fauto-profile.
-fprofile-valuesโ if combined with-fprofile-arcs, it adds code so that some data about values of expressions in the program is gathered.
with -fbranch-probabilities, it reads back the data gathered from profiling values of expressions for usage in optimizations.
enabled by -fprofile-generate, -fprofile-use, and -fauto-profile. ๐ธ
-fprofile-reorder-functionsโ function reordering based on profile instrumentation. it collects the first time of execution of a function and orders these functions in ascending order, aiming to optimize program startup through more efficient loading of text segments.
enabled with -fprofile-use.
-fvptโ if combined with-fprofile-arcs, this option instructs the compiler to add code to gather information about values of expressions.
with -fbranch-probabilities, it reads back the data gathered and actually performs the optimizations based on them. currently the optimizations include specialization of division operations using the knowledge about the value of the denominator.
enabled with -fprofile-use and -fauto-profile. ๐ฆ
-frename-registersโ attempt to avoid false dependencies in scheduled code by making use of registers left over after register allocation. this optimization most benefits processors with lots of registers. depending on the debug information format adopted by the target, however, it can make debugging impossible, since variables no longer stay in a"home register". ๐ญ
enabled by default with -funroll-loops.
-fschedule-fusionโ performs a target dependent pass over the instruction stream to schedule instructions of the same type together, because the target machine can execute them more efficiently if they're adjacent to each other in the instruction flow. โจ
enabled at levels -O2, -O3, -Os.
-fdep-fusionโ detect macro-op fusible pairs consisting of single-use instructions and their uses, and place such pairs together in the instruction stream to increase fusion opportunities in hardware. this pass is executed once before register allocation, and another time before register renaming. ๐
enabled at levels -O2, -O3, -Os.
-ftracerโ perform tail duplication to enlarge superblock size. this transformation simplifies the control flow of the function, allowing other optimizations to do a better job.
enabled by -fprofile-use and -fauto-profile.
-funroll-loopsโ unroll loops whose number of iterations can be determined at compile time or upon entry to the loop.-funroll-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. ngl it's giving gamble ๐ฒ
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's 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 a small constant number of iterations). ๐
enabled by -O3, -fprofile-use, and -fauto-profile.
-fmalloc-dceโ control whether"malloc"(and its variants such as"calloc"or"strdup") can be optimized away, provided its return value is only used as a parameter of a"free"call or compared with"NULL". if-fmalloc-dce=1is used, only calls to"free"are allowed, while with-fmalloc-dce=2also comparisons with"NULL"pointer are considered safe to remove.
the default is -fmalloc-dce=2. see also -fallocation-dce. ๐
-fmove-loop-invariantsโ enables the loop invariant motion pass in the RTL loop optimizer. enabled at level-O1and higher, except for-Og.-fmove-loop-storesโ enables the loop store motion pass in the GIMPLE loop optimizer. this moves invariant stores to after the end of the loop in exchange for carrying the stored value in a register across the iteration. note: for this option to have an effect,-ftree-loop-imhas to be enabled as well. enabled at level-O1and higher, except for-Og. โจ-fsplit-loopsโ split a loop into two if it contains a condition that's always true for one side of the iteration space and false for the other.
enabled by -fprofile-use and -fauto-profile.
-funswitch-loopsโ move branches with loop invariant conditions out of the loop, with duplicates of the loop on both branches (modified according to the result of the condition).
enabled by -fprofile-use and -fauto-profile. ๐
-fversion-loops-for-stridesโ if a loop iterates over an array with a variable stride, create another version of the loop that assumes the stride is always one. for example:
for (int i = 0; i < n; ++i)
x[i * stride] = ...;
becomes:
if (stride == 1)
for (int i = 0; i < n; ++i)
x[i] = ...;
else
for (int i = 0; i < n; ++i)
x[i * stride] = ...;
this is particularly useful for assumed-shape arrays in Fortran, where (for example) it allows better vectorization assuming contiguous accesses. this flag is enabled by default at -O3. it's also enabled by -fprofile-use and -fauto-profile. ๐
-ffunction-sections-fdata-sectionsโ place each function or data item into its own section in the output file, if the target supports arbitrary sections. the name of the function or the name of the data item determines the section's name in the output file. ๐
use these options on systems where the linker can perform optimizations to improve locality of reference in the instruction space. most systems using the ELF object format have linkers with such optimizations. on AIX, the linker rearranges sections (CSECTs) based on the call graph. the performance impact varies.
together with a linker garbage collection (linker --gc-sections option), these options may lead to smaller statically-linked executables (after stripping).
on ELF/DWARF systems these options do not degenerate the quality of the debug information. there could be issues with other object files/debug info formats.
only use these options when there are significant benefits from doing so. when you specify these options, the assembler and linker create larger object and executable files and are also slower. these options affect code generation. they prevent optimizations by the compiler and assembler using relative locations inside a translation unit, since the locations are unknown until link time. an example of such an optimization is relaxing calls to short call instructions. ๐
-fstdarg-optโ optimize the prologue of variadic argument functions with respect to usage of those arguments.-fsection-anchorsโ try to reduce the number of symbolic address calculations by using shared"anchor"symbols to address nearby objects. this transformation can help 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. ๐ซถ
-fzero-call-used-regs=choiceโ bestie, this one zeroes out the call-used registers when a function returns, and it's giving security upgrade ๐ . The whole point is to make life harder for Return-Oriented Programming (ROP) attacks, or to stop info from leaking out through registers. Two birds, one slay.
The possible values of choice are the same as for the zero_call_used_regs attribute. The default is skip.
You can control this behavior for a specific function by using the function attribute zero_call_used_regs. Per-function vibes only, periodt.
โจ Program Instrumentation Options โจ
Okay so GCC has a whole collection of command-line options that control adding run-time instrumentation to the code it normally generates. What does that even mean? Basically GCC can sprinkle extra runtime checks into your code for you ๐ง.
For example, 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. So many reasons, all valid ๐.
-p--profile-fprofile-pgโ Generate extra code to write profile information suitable for the analysis programprof(for-p,--profile, and-fprofile) orgprof(for-pg). You must use this option when compiling the source files you want data about, and you must also use it when linking. Both times, bestie, don't forget the linking part ๐ญ.
You can use the function attribute no_instrument_function to suppress profiling of individual functions when compiling with these options.
-fprofile-arcsโ Add code so that program flow arcs are instrumented. During execution the program records how many times each branch and call is executed and how many times it is taken or returns. On targets that support constructors with priority support, profiling properly handles constructors, destructors and C++ constructors (and destructors) of classes which are used as a type of a global variable.
When the compiled program exits it saves this data to a file called auxname.gcda for each source file. The data may be used for profile-directed optimizations (-fbranch-probabilities), or for test coverage analysis (-ftest-coverage). Each object file's auxname is generated from the name of the output file, if explicitly specified and it is not the final executable, otherwise it is the basename of the source file. In both cases any suffix is removed (e.g. foo.gcda for input file dir/foo.c, or dir/foo.gcda for output file specified as -o dir/foo.o).
Note that if a command line directly links source files, the corresponding .gcda files will be prefixed with the unsuffixed name of the output file. E.g. gcc a.c b.c -o binary would generate binary-a.gcda and binary-b.gcda files. Naming lore fr fr ๐.
-fcondition-coverageโ Add code so that program conditions are instrumented. During execution the program records what terms in a conditional contributes to a decision, which can be used to verify that all terms in a Boolean function are tested and have an independent effect on the outcome of a decision. The result can be read withgcov --conditions.-fpath-coverageโ Add code so that the paths taken are tracked. During execution the program records the prime paths taken. The number of paths grows very fast with complexity, and to avoid exploding compile times GCC will give up instrumentation if the approximate number of paths exceeds the limit controlled by-fpath-coverage-limit. The result can be read withgcov --prime-paths --prime-paths-lines --prime-paths-source.-fpath-coverage-limit=limitโ The threshold at which point-fpath-coveragegives up on instrumenting a function. This limit is approximate and conservative, as GCC uses a pessimistic heuristic which slightly overcounts the running number of paths, and gives up if the threshold is reached before finding all the paths. This option is not for fine grained control over which functions to instrument โ rather it is intended to limit the effect of path explosion and keep compile times reasonable. The default is250000.--coverage-coverageโ This option is used to compile and link code instrumented for coverage analysis. The options-coverageand--coverageare equivalent; both are a synonym for-fprofile-arcs -ftest-coverage(when compiling) and-lgcov(when linking). See the documentation for those options for more details.- Compile the source files with
-fprofile-arcsplus optimization and code generation options. For test coverage analysis, use the additional-ftest-coverageoption. You do not need to profile every source file in a program. - Compile the source files additionally with
-fprofile-abs-pathto create absolute path names in the.gcnofiles. This allowsgcovto find the correct sources in projects where compilations occur with different working directories. - Link your object files with
-lgcovor-fprofile-arcs(the latter implies the former). - Run the program on a representative workload to generate the arc profile information. This may be repeated any number of times. You can run concurrent instances of your program, and provided that the file system supports locking, the data files will be correctly updated. Unless a strict ISO C dialect option is in effect,
forkcalls are detected and correctly handled without double counting.
- Compile the source files with
Moreover, an object file can be recompiled multiple times and the corresponding .gcda file merges as long as the source file and the compiler options are unchanged.
- For profile-directed optimizations, compile the source files again with the same optimization and code generation options plus
-fbranch-probabilities. - For test coverage analysis, use
gcovto produce human readable information from the.gcnoand.gcdafiles. Refer to thegcovdocumentation for further information.
With -fprofile-arcs, for each function of your program GCC creates a program flow graph, then finds a spanning tree for the graph. Only arcs that are not on the spanning tree have to be instrumented: the compiler adds code to count the number of times that these arcs are executed. When an arc is the only exit or only entrance to a block, the instrumentation code can be added to the block; otherwise, a new basic block must be created to hold the instrumentation code. Graph theory moment ๐๐ณ.
With -fcondition-coverage, for each conditional in your program GCC creates a bitset and records the exercised boolean values that have an independent effect on the outcome of that expression.
With -fpath-coverage, GCC finds and enumerates and records the taken prime paths of each function, unless the number of paths would exceed the limit controlled by -fpath-coverage-limit. If the limit is exceeded the function is not instrumented as if -fpath-coverage was not used. A prime path is the longest sequence of unique blocks, except possibly the first and last, which is not a subpath of any other path.
-ftest-coverageโ Produce a notes file that thegcovcode-coverage utility can use to show program coverage. Each source file's note file is calledauxname.gcno. Refer to the-fprofile-arcsoption above for a description of auxname and instructions on how to generate test coverage data. Coverage data matches the source files more closely if you do not optimize. (Yeah, optimizing muddies the vibes a lil ๐ธ.)-fprofile-abs-pathโ Automatically convert relative source file names to absolute path names in the.gcnofiles. This allowsgcovto find the correct sources in projects where compilations occur with different working directories.-fprofile-dir=pathโ Set the directory to search for the profile data files in to path. This option affects only the profile data generated by-fprofile-generate,-ftest-coverage,-fprofile-arcsand used by-fprofile-useand-fbranch-probabilitiesand its related options. Both absolute and relative paths can be used. By default, GCC uses the current directory as path, thus the profile data file appears in the same directory as the object file. In order to prevent the file name clashing, if the object file name is not an absolute path, we mangle the absolute path of thesourcename.gcdafile and use it as the file name of a.gcdafile. See details about the file naming in-fprofile-arcs. See similar option-fprofile-note.
When an executable is run in a massive parallel environment, it is recommended to save profile to different folders. That can be done with variables in path that are exported during run-time:
%pโ process ID.%q{VAR}โ value of environment variable VAR
-fprofile-generate-fprofile-generate=pathโ Enable options usually used for instrumenting application to produce profile useful for later recompilation with profile feedback based optimization. You must use-fprofile-generateboth when compiling and when linking your program.
The following options are enabled: -fprofile-arcs, -fprofile-values, -finline-functions, and -fipa-bit-cp.
If path is specified, GCC looks at the path to find the profile feedback data files. See -fprofile-dir.
To optimize the program based on the collected profile information, use -fprofile-use.
-fprofile-info-section-fprofile-info-section=nameโ Register the profile information in the specified section instead of using a constructor/destructor. The section name is name if it is specified, otherwise the section name defaults to.gcov_info. A pointer to the profile information generated by-fprofile-arcsis placed in the specified section for each translation unit. This option disables the profile information registration through a constructor and it disables the profile information processing through a destructor. This option is not intended to be used in hosted environments such as GNU/Linux. It targets freestanding environments (for example embedded systems) with limited resources which do not support constructors/destructors or the C library file I/O. Embedded girlies, this one's for you ๐ซถ.
The linker could literally gather the input sections into one continuous memory block and then define start and end symbols for you. A GNU linker script example that defines a linker output section goes a little something like this ๐ :
.gcov_info :
{
PROVIDE (__gcov_info_start = .);
KEEP (*(.gcov_info))
PROVIDE (__gcov_info_end = .);
}
And then your program could dump all the profiling info registered in this linker set, for example, like this ๐:
#include <gcov.h>
#include <stdio.h>
#include <stdlib.h>
extern const struct gcov_info *const __gcov_info_start[];
extern const struct gcov_info *const __gcov_info_end[];
static void
dump (const void *d, unsigned n, void *arg)
{
const unsigned char *c = d;
for (unsigned i = 0; i < n; ++i)
printf ("%02x", c[i]);
}
static void
filename (const char *f, void *arg)
{
__gcov_filename_to_gcfn (f, dump, arg );
}
static void *
allocate (unsigned length, void *arg)
{
return malloc (length);
}
static void
dump_gcov_info (void)
{
const struct gcov_info *const *info = __gcov_info_start;
const struct gcov_info *const *end = __gcov_info_end;
/* Obfuscate variable to prevent compiler optimizations. */
__asm__ ("" : "+r" (info));
while (info != end)
{
void *arg = NULL;
__gcov_info_to_gcda (*info, filename, dump, allocate, arg);
putchar ('\n');
++info;
}
}
int
main (void)
{
dump_gcov_info ();
return 0;
}
Oh and bestie, hear me out: the merge-stream subcommand of gcov-tool can be used to deserialize the data stream that the __gcov_filename_to_gcfn and __gcov_info_to_gcda functions generate, and merge all that profile information straight into .gcda files on the host filesystem. Slay ๐
-fprofile-note=pathโ If path is specified, GCC saves the.gcnofile into the path location. Careful though: if you combine this option with multiple source files, the.gcnofile will be overwritten. Not a vibe, just a fact ๐ญ-fprofile-prefix-path=pathโ This one can be used together withprofile-generate=profile_dirandprofile-use=profile_dirto tell GCC where the base directory of the built source tree is at. By default,profile_dirwill contain files with mangled absolute paths of all the object files in the built project. That's lowkey not desirable when the directory used to build the instrumented binary is different from the directory used to build the binary optimized with profile feedback, because then the profile data won't be found during the optimized build ๐ In setups like that,-fprofile-prefix-path=pathwith path pointing to the base directory of the build can be used to strip the irrelevant part of the path and keep all the file names relative to the main build directory. So smart, so iconic โจ-fprofile-prefix-map=old=newโ When you're compiling files that live in directory old, this records the profiling information (with--coverage) describing them as if the files lived in directory new instead. See also-ffile-prefix-mapand-fcanon-prefix-map๐ซถ-fprofile-update=methodโ This alters the update method for an application that's instrumented for profile-feedback-based optimization. The method argument should be one ofsingle,atomicorprefer-atomic. The first one is useful for single-threaded applications, while the second one prevents profile corruption by emitting thread-safe code.
Warning: when an application does not properly join all threads (or creates a detached thread), a profile file can still be corrupted. ๐
Using prefer-atomic would be transformed either to atomic (when it's supported by a target) or to single otherwise. The GCC driver automatically selects prefer-atomic when -pthread is present in the command line, otherwise the default method is single.
If atomic is selected, then the profile information is updated using atomic operations on a best-effort basis. Ideally, the profile information gets updated through atomic operations in hardware. If the target platform does not support the required atomic operations in hardware, however, and libatomic is available, then the profile information is updated through calls to libatomic. And if the target platform supports neither the required atomic operations in hardware nor libatomic, then the profile information is not atomically updated and a warning is issued. In this case, the obtained profiling information may be corrupt for multi-threaded applications ๐ฌ
For performance reasons, if 64-bit counters are used for the profiling information and the target platform only supports 32-bit atomic operations in hardware, then the performance critical profiling updates are done using two 32-bit atomic operations for each counter update. If a signal interrupts these two operations while they're updating a counter, then the profiling information may be in an inconsistent state. Not ideal, but there it is ๐
-fprofile-filter-files=regexโ Instrument only functions from files whose name matches any of the regular expressions (separated by semi-colons).
For example, -fprofile-filter-files=main\.c;module.*\.c will instrument only main.c and all C files starting with 'module' ๐
-fprofile-exclude-files=regexโ Instrument only functions from files whose name does not match any of the regular expressions (separated by semi-colons).
For example, -fprofile-exclude-files=/usr/.* will prevent instrumentation of all files that are located in the /usr/ folder. Bye bye /usr/ ๐ฆ
-fprofile-reproducible=[multithreaded|parallel-runs|serial]โ Control the level of reproducibility of the profile gathered by-fprofile-generate. This makes it possible to rebuild a program with the same outcome, which is useful for, like, distribution packages and stuff ๐ฆ
With -fprofile-reproducible=serial the profile gathered by -fprofile-generate is reproducible provided the trained program behaves the same at each invocation of the train run, it's not multi-threaded, and profile data streaming is always done in the same order. Note that profile streaming happens at the end of the program run but also before "fork" function is invoked.
Note that it's quite common for the execution counts of some part of a program to depend on, for example, the length of temporary file names or memory space randomization (which may affect hash-table collision rate). Such non-reproducible parts of programs may be annotated by the "no_instrument_function" function attribute. gcov-dump with -l can be used to dump the gathered data and verify that they are indeed reproducible ๐
With -fprofile-reproducible=parallel-runs, the collected profile stays reproducible regardless of the order of streaming of the data into gcda files. This setting makes it possible to run multiple instances of an instrumented program in parallel (such as with "make -j"). This reduces the quality of the gathered data, in particular of indirect call profiling. Trade-offs, bestie, trade-offs ๐ญ
-fsanitize=addressโ Enable 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 set to"help=1", the available options are shown at startup of the instrumented program. Seehttps://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flagsfor a list of supported options. The option cannot be combined with-fsanitize=threador-fsanitize=hwaddress. Note that the only targets-fsanitize=hwaddressis currently supported on are x86-64 (only with"-mlam=u48"or"-mlam=u57"options) and AArch64, in both cases only in ABIs with 64-bit pointers. Similarly,-fsanitize=memtag-stackis currently only supported on AArch64 ABIs with 64-bit pointers ๐
When compiling with -fsanitize=address, you should also use -g to produce more meaningful output. To get more accurate stack traces, it's possible to use options such as -O0, -O1, or -Og (which, for instance, prevent most function inlining), -fno-optimize-sibling-calls (which prevents optimizing sibling and tail recursive calls; this option is implicit for -O0, -O1, or -Og), or -fno-ipa-icf (which disables Identical Code Folding for functions). Using -fno-omit-frame-pointer also improves stack traces. Since multiple runs of the program may yield backtraces with different addresses due to ASLR (Address Space Layout Randomization), it may be desirable to turn ASLR off. On Linux, this can be achieved with setarch \uname -m` -R ./prog` โจ
-fsanitize=kernel-addressโ Enable AddressSanitizer for the Linux kernel. Seehttps://github.com/google/kernel-sanitizersfor more details ๐ง-fsanitize=hwaddressโ Enable Hardware-assisted AddressSanitizer, which uses a hardware ability to ignore the top byte of a pointer to allow the detection of memory errors with a low memory overhead. Memory access instructions are instrumented to detect out-of-bounds and use-after-free bugs. The option enables-fsanitize-address-use-after-scope. Seehttps://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.htmlfor more details. The run-time behavior can be influenced using theHWASAN_OPTIONSenvironment variable. When set to"help=1", the available options are shown at startup of the instrumented program. The option cannot be combined with-fsanitize=threador-fsanitize=address, and is currently only available on AArch64 ๐-fsanitize=kernel-hwaddressโ turns on Hardware-assisted AddressSanitizer for compiling the Linux kernel ๐ it's like-fsanitize=kernel-addressbut with a whole different instrumentation method, and like-fsanitize=hwaddressbut with the instrumentation differences you need to compile the Linux kernel. Those differences? Avoiding hwasan library initialization calls, and accounting for the stack pointer having a different value in its top byte. Iconic.
Note bestie: this option has different defaults than-fsanitize=hwaddress. Instrumenting the stack andallocacalls are not on by default, and using a random frame tag is not implemented for kernel instrumentation.
-fsanitize=memtag-stackโ uses Memory Tagging Extension instructions instead of instrumentation to let you detect memory errors โจ similar to HWASAN, it's also a probabilistic method. This option is available only on those AArch64 architectures that support Memory Tagging Extensions.-fsanitize=pointer-compareโ instruments comparison operations (<,<=,>,>=) with pointer operands. The option must be combined with either-fsanitize=kernel-addressor-fsanitize=address. The option cannot be combined with-fsanitize=thread.
Note: by default the check is disabled at run time. To enable it, add"detect_invalid_pointer_pairs=2"to the environment variableASAN_OPTIONS. Using"detect_invalid_pointer_pairs=1"detects invalid operation only when both pointers are non-null.
-fsanitize=pointer-subtractโ instruments subtraction with pointer operands. The option must be combined with either-fsanitize=kernel-addressor-fsanitize=address. The option cannot be combined with-fsanitize=thread.
Note: by default the check is disabled at run time. To enable it, add"detect_invalid_pointer_pairs=2"to the environment variableASAN_OPTIONS. Using"detect_invalid_pointer_pairs=1"detects invalid operation only when both pointers are non-null.
-fsanitize=shadow-call-stackโ enables ShadowCallStack, a security enhancement mechanism used to protect programs against return address overwrites (e.g. stack buffer overflows ๐ซถ). It works by saving a function's return address to a separately allocated shadow call stack in the function prologue, and restoring the return address from the shadow call stack in the function epilogue. Instrumentation only occurs in functions that need to save the return address to the stack. lowkey genius.
Currently it only supports the aarch64 platform. It is specifically designed for linux kernels that enable the CONFIG_SHADOW_CALL_STACK option. For user space programs, runtime support is not currently provided in libc and libgcc. Users who want to use this feature in user space need to provide their own support for the runtime. It should be noted that this may cause the ABI rules to be broken ๐.
On aarch64, the instrumentation makes use of the platform register "x18". This generally means that any code that may run on the same thread as code compiled with ShadowCallStack must be compiled with the flag -ffixed-x18, otherwise functions compiled without -ffixed-x18 might clobber "x18" and so corrupt the shadow stack pointer. not the vibe fr.
Also, because there is no userspace runtime support, code compiled with ShadowCallStack cannot use exception handling. Use -fno-exceptions to turn off exceptions.
See <https://clang.llvm.org/docs/ShadowCallStack.html> for more details.
-fsanitize=threadโ enables ThreadSanitizer, a fast data race detector ๐ Memory access instructions are instrumented to detect data race bugs. See <https://github.com/google/sanitizers/wiki#threadsanitizer> for more details. The run-time behavior can be influenced using theTSAN_OPTIONSenvironment variable; see <https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags> for a list of supported options. The option cannot be combined with-fsanitize=address,-fsanitize=leak.
When compiling with -fsanitize=thread, you should also use -g to produce more meaningful output ๐
Note that sanitized atomic builtins cannot throw exceptions when operating on invalid memory addresses with non-call exceptions (-fnon-call-exceptions).
-fsanitize=leakโ enables LeakSanitizer, a memory leak detector ๐ง This option only matters for linking of executables. The executable is linked against a library that overrides"malloc"and other allocator functions. See <https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer> for more details. The run-time behavior can be influenced using theLSAN_OPTIONSenvironment variable. The option cannot be combined with-fsanitize=thread.-fsanitize=undefinedโ enables UndefinedBehaviorSanitizer, a fast undefined behavior detector โญ Various computations are instrumented to detect undefined behavior at runtime. See <https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html> for more details. The run-time behavior can be influenced using theUBSAN_OPTIONSenvironment variable. Current suboptions are:-fsanitize=shiftโ this option enables checking that the result of a shift operation is not undefined. Note that what exactly is considered undefined differs slightly between C and C++, as well as between ISO C90 and C99, etc. This option has two suboptions,-fsanitize=shift-baseand-fsanitize=shift-exponent.-fsanitize=shift-exponentโ this option enables checking that the second argument of a shift operation is not negative and is smaller than the precision of the promoted first argument.-fsanitize=shift-baseโ if the second argument of a shift operation is within range, check that the result of a shift operation is not undefined. Note that what exactly is considered undefined differs slightly between C and C++, as well as between ISO C90 and C99, etc.-fsanitize=integer-divide-by-zeroโ detect integer division by zero. ๐-fsanitize=unreachableโ with this option, the compiler turns the"__builtin_unreachable"call into a diagnostics message call instead. When reaching the"__builtin_unreachable"call, the behavior is undefined.-fsanitize=vla-boundโ this option instructs the compiler to check that the size of a variable length array is positive.-fsanitize=nullโ this option enables pointer checking. Particularly, the application built with this option turned on will issue an error message when it tries to dereference aNULLpointer, or if a reference (possibly an rvalue reference) is bound to aNULLpointer, or if a method is invoked on an object pointed by aNULLpointer.-fsanitize=returnโ this option enables return statement checking. Programs built with this option turned on will issue an error message when the end of a non-void function is reached without actually returning a value. This option works in C++ only.-fsanitize=signed-integer-overflowโ this option enables signed integer overflow checking. We check that the result of"+","*", and both unary and binary"-"does not overflow in the signed arithmetics. This also detects"INT_MIN / -1"signed division. Note, integer promotion rules must be taken into account. That is, the following is not an overflow:
signed char a = SCHAR_MAX;
a++;
-fsanitize=boundsโ this option enables instrumentation of array bounds. Various out of bounds accesses are detected. Flexible array members, flexible array member-like arrays, and initializers of variables with static storage are not instrumented, with the exception of flexible array member-like arrays for which"-fstrict-flex-arrays"or"-fstrict-flex-arrays="options or"strict_flex_array"attributes say they shouldn't be treated like flexible array member-like arrays.-fsanitize=bounds-strictโ this option enables strict instrumentation of array bounds. Most out of bounds accesses are detected, including flexible array member-like arrays. Initializers of variables with static storage are not instrumented.-fsanitize=alignmentโ this option enables checking of alignment of pointers when they are dereferenced, or when a reference is bound to insufficiently aligned target, or when a method or constructor is invoked on insufficiently aligned object.-fsanitize=object-sizeโ this option enables instrumentation of memory references using the"__builtin_dynamic_object_size"function. Various out of bounds pointer accesses are detected.-fsanitize=float-divide-by-zeroโ detect floating-point division by zero ๐ Unlike other similar options,-fsanitize=float-divide-by-zerois not enabled by-fsanitize=undefined, since floating-point division by zero can be a legitimate way of obtaining infinities and NaNs. valid tbh.-fsanitize=float-cast-overflowโ this option enables floating-point type to integer conversion checking. We check that the result of the conversion does not overflow. Unlike other similar options,-fsanitize=float-cast-overflowis not enabled by-fsanitize=undefined. This option does not work well with"FE_INVALID"exceptions enabled.-fsanitize=nonnull-attributeโ this option enables instrumentation of calls, checking whether null values are not passed to arguments marked as requiring a non-null value by the"nonnull"function attribute.-fsanitize=returns-nonnull-attributeโ this option enables instrumentation of return statements in functions marked with"returns_nonnull"function attribute, to detect returning of null values from such functions.-fsanitize=boolโ this option enables instrumentation of loads from bool. If a value other than0/1is loaded, a run-time error is issued.-fsanitize=enumโ this option enables instrumentation of loads from an enum type. If a value outside the range of values for the enum type is loaded, a run-time error is issued.
-fsanitize=vptrโ this one instruments C++ member function calls, member accesses, and some conversions between pointers to base and derived classes, all so it can verify that the object you're pointing at actually has the correct dynamic type. no vibes-based type checking here, it's the real deal ๐-fsanitize=pointer-overflowโ instruments pointer arithmetic. if the pointer arithmetic overflows, a run-time error gets issued. ๐ซถ-fsanitize=builtinโ instruments the arguments to selected builtin functions. pass an invalid value to one of those arguments and you get a run-time error, periodt. e.g. passing0as the argument to__builtin_ctzor__builtin_clzinvokes undefined behavior, and this option diagnoses it. ๐
okay bestie, real talk: sanitizers tend to increase the rate of false positive warnings, most notably the ones hanging around-Wmaybe-uninitialized. We recommend against combining-Werrorand [the use of] sanitizers. don't do it, it's giving regret.
so here's the tea: while -ftrapv causes traps for signed overflows to be emitted, -fsanitize=undefined gives you a diagnostic message instead. this currently works only for the C family of languages. ๐
-fno-sanitize=allโ disables all the sanitizers you had previously enabled. and no,-fsanitize=allis not allowed, because some sanitizers literally cannot be used together. it's giving incompatible. ๐ซ-fasan-shadow-offset=*number*โ forces GCC to use a custom shadow offset in AddressSanitizer checks. super useful when you're experimenting with different shadow memory layouts in Kernel AddressSanitizer. โจ-fsanitize-sections=*s1,s2,...*โ sanitize global variables in selected user-defined sections.simay contain wildcards, slay. ๐-fsanitize-recover[=*opts*]โ this controls the error recovery mode for the sanitizers you name in a comma-separated list ofopts. turn it on for a sanitizer component and it will attempt to continue running the program as if no error happened. which means multiple runtime errors can get reported in a single program run, and the exit code of the program may indicate success even when errors have been reported. ๐ญ
the -fno-sanitize-recover= option can be used to alter this behavior: then only the first detected error is reported and 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 is also accepted, the former enables recovery for all sanitizers that support it, the latter disables recovery for all sanitizers that support it.
even if a recovery mode is turned on the compiler side, it needs to be also enabled on the runtime library side, otherwise the failures are still fatal. the runtime library defaults to halt_on_error=0 for ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for AddressSanitizer is halt_on_error=1. This can be overridden through setting the halt_on_error flag in the corresponding environment variable.
๐จ syntax without an explicitoptsparameter is deprecated. It is equivalent to specifying anoptslist 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. heads up: the option sets-fstack-reusetonone. ๐-fsanitize-trap[=*opts*]โ tells the compiler to report undefined behavior for the sanitizers named in the comma-separated list ofoptsusing__builtin_traprather than alibubsanlibrary routine. if this option is enabled for a certain sanitizer, it takes precedence over the-fsanitizer-recover=for that sanitizer โ__builtin_trapwill be emitted and be fatal regardless of whether recovery is enabled or disabled using-fsanitize-recover=. ๐ค
the advantage of this is that the libubsan library is not needed and is not linked in, so this is usable even in freestanding environments. iconic.
currently this feature works with -fsanitize=undefined (and its suboptions except for -fsanitize=vptr), -fsanitize=float-cast-overflow, -fsanitize=float-divide-by-zero and -fsanitize=bounds-strict. -fsanitize-trap=all can be also specified, which enables it for undefined suboptions, -fsanitize=float-cast-overflow, -fsanitize=float-divide-by-zero and -fsanitize=bounds-strict. If -fsanitize-trap=undefined or -fsanitize-trap=all is used and -fsanitize=vptr is enabled on the command line, the instrumentation is silently ignored as the instrumentation always needs libubsan support, -fsanitize-trap=vptr is not allowed. ๐
-fsanitize-undefined-trap-on-errorโ deprecated, bestie. it's the equivalent of-fsanitize-trap=all.-fsanitize-coverage=trace-pcโ enables coverage-guided fuzzing code instrumentation. inserts a call to__sanitizer_cov_trace_pcinto every basic block. every single one. ๐-fsanitize-coverage=trace-cmpโ enables dataflow guided fuzzing code instrumentation. it inserts a call to__sanitizer_cov_trace_cmp1,__sanitizer_cov_trace_cmp2,__sanitizer_cov_trace_cmp4or__sanitizer_cov_trace_cmp8for integral comparison with both operands variable, or__sanitizer_cov_trace_const_cmp1,__sanitizer_cov_trace_const_cmp2,__sanitizer_cov_trace_const_cmp4or__sanitizer_cov_trace_const_cmp8for integral comparison with one operand constant,__sanitizer_cov_trace_cmpfor__sanitizer_cov_trace_cmpdfor float or double comparisons, and__sanitizer_cov_trace_switchfor switch statements. the range of names? unreal. ๐ฎโ๐จ
-fcf-protection=[full|branch|return|none|check]-fcf-protectionโ enables code instrumentation to increase program security by checking that target addresses of control-flow transfer instructions (such as indirect function call, function return, indirect jump) are valid. This prevents diverting the flow of control to an unexpected target. This is intended to protect against such threats as Return-oriented Programming (ROP), and similarly call/jmp-oriented programming (COP/JOP). ๐ก๏ธ
the -fcf-protection= keywords are interpreted as follows.
- the value
branchtells the compiler to implement checking of validity of control-flow transfer at the point of indirect branch instructions, i.e. call/jmp instructions. - the value
returnimplements checking of validity at the point of returning from a function. - the value
fullis an alias for specifying bothbranchandreturn. - the value
checkis used for the final link with link-time optimization (LTO). An error is issued if LTO object files are compiled with different-fcf-protectionvalues. The valuecheckis ignored at the compile time. - the value
noneturns off instrumentation.
-fcf-protection is an alias for -fcf-protection=full. To override a previous -fcf-protection option on the command line, add -fcf-protection=none and then -fcf-protection=kind. ๐
the macro __CET__ is defined when -fcf-protection is used. The first bit of __CET__ is set to 1 for the value branch and the second bit of __CET__ is set to 1 for the return.
you can also use the nocf_check attribute to identify which functions and calls should be skipped from instrumentation. โจ
currently the x86 GNU/Linux target provides an implementation based on Intel Control-flow Enforcement Technology (CET) which works for i686 processor or newer.
-fharden-comparesโ for every logical test that survives gimple optimizations and is not the condition in a conditional branch (for example, conditions tested for conditional moves, or to store in boolean variables), emit extra code to compute and verify the reversed condition, and to call__builtin_trapif the results do not match. Use with-fharden-conditional-branchesto cover all conditionals. ๐ซถ-fharden-conditional-branchesโ for every non-vectorized conditional branch that survives gimple optimizations, emit extra code to compute and verify the reversed condition, and to call__builtin_trapif the result is unexpected. Use with-fharden-comparesto cover all conditionals. (yes they're besties, you use them together ๐)-fharden-control-flow-redundancyโ emit extra code to set booleans when entering basic blocks, and to verify and trap, at function exits, when the booleans do not form an execution path that is compatible with the control flow graph.
verification takes place before returns, before mandatory tail calls (see below) and, optionally, before escaping exceptions with -fhardcfr-check-exceptions, before returning calls with -fhardcfr-check-returning-calls, and before noreturn calls with -fhardcfr-check-noreturn-calls).
tail call optimization takes place too late to affect control flow redundancy, but calls annotated as mandatory tail calls by language front-ends, and any calls marked early enough as potential tail calls would also have verification issued before the call, but these possibilities are merely theoretical, as these conditions can only be met when using custom compiler plugins. ๐ค
-fhardcfr-skip-leafโ disables-fharden-control-flow-redundancyin leaf functions. leaf functions get to chill. ๐-fhardcfr-check-exceptionsโ when-fharden-control-flow-redundancyis active, check the recorded execution path against the control flow graph at exception escape points, as if the function body was wrapped with a cleanup handler that performed the check and reraised. This option is enabled by default; use-fno-hardcfr-check-exceptionsto disable it. โจ-fhardcfr-check-returning-callsโ when-fharden-control-flow-redundancyis active, check the recorded execution path against the control flow graph before any function call immediately followed by a return of its result, if any, so as to not prevent tail-call optimization, whether or not it is ultimately optimized to a tail call.
this option is enabled by default whenever sibling call optimizations are enabled (see -foptimize-sibling-calls), but it can be enabled (or disabled, using its negated form) explicitly, regardless of the optimizations. ๐
-fhardcfr-check-noreturn-calls=[always|no-xthrow|nothrow|never]โ okay so when-fharden-control-flow-redundancyis switched on, this one decides whether we check the recorded execution path against the control flow graph before"noreturn"calls ๐ . Your options are: literally all of them (always), the ones that aren't expected to hand control back to the caller through an exception (no-xthrow, and yes bestie that's the default), the ones that may not return control to the caller through an exception either (nothrow), or none of them at all (never) ๐.
Now here's the tea โ โ checking before a "noreturn" function that may return control to the caller through an exception can make the check happen more than once, if that exception gets caught in the caller, whether by a handler or a cleanup. And when -fhardcfr-check-exceptions is also enabled, the compiler will dodge associating a "noreturn" call with the implicitly-added cleanup handler, because that'd just be redundant with the check that already happened before the call ๐ซถ. But other handlers or cleanups in the function, if they get activated, will change the recorded execution path and check it again whenever another checkpoint gets hit. And the checkpoint might even be another "noreturn" call, so yeah โ the checking can absolutely end up running multiple times ๐ญ.
Also, various optimizers may cause calls to get marked as "noreturn" and/or "nothrow", even when the corresponding attributes aren't there, which can mess with where checks land before calls, plus the addition of implicit cleanup handlers for them ๐. That unpredictability โ combined with the fact that raising and reraising exceptions frequently amounts to implicitly calling "noreturn" functions โ is exactly why no-xthrow is the default here: it excludes from the "noreturn" treatment only internal functions used to (re)raise exceptions, which aren't affected by those optimizations โจ.
-fhardenedโ turns on a whole set of flags for C and C++ that level up the security of the generated code without touching its ABI ๐ฅ. The exact flags may shift between major GCC releases, but currently they're:
-D_FORTIFY_SOURCE=3 -D_GLIBCXX_ASSERTIONS
-ftrivial-auto-var-init=zero -fPIE -pie -Wl,-z,relro,-z,now
-fstack-protector-strong -fstack-clash-protection
-fcf-protection=full (x86 GNU/Linux only)
You can get the list of what -fhardened turns on using the --help=hardened option ๐.
If your system glibc is older than 2.35, then -D_FORTIFY_SOURCE=2 gets used instead.
This one is meant for production builds, bestie โ not just debug builds ๐ .
Currently, -fhardened is only supported on GNU/Linux targets.
And it only enables a particular option if it wasn't already specified anywhere on the command line ๐. Like, -fhardened -fstack-protector will only enable -fstack-protector, but not -fstack-protector-strong.
-fstack-protectorโ emits extra code to check for buffer overflows, like stack smashing attacks ๐ฅ. It does this by adding a guard variable to functions with vulnerable objects โ and that includes functions that callalloca, plus functions with buffers larger than or equal to8bytes. The guards get initialized when a function is entered and then checked when the function exits. If a guard check fails? Error message printed, program exits, bye ๐. Only variables actually allocated on the stack count, so optimized-away variables or variables allocated in registers don't get counted ๐.-fstack-protector-allโ like-fstack-protectorexcept all functions are protected ๐ก๏ธ.-fstack-protector-strongโ like-fstack-protectorbut it also includes extra functions to protect โ namely those that have local array definitions, or have references to local frame addresses โจ. Only variables actually allocated on the stack are considered, so optimized-away variables or variables allocated in registers don't count ๐ธ.-fstack-protector-explicitโ like-fstack-protectorbut it only protects those functions that have the"stack_protect"attribute ๐.-fstack-checkโ generates code to verify that you don't go beyond the boundary of the stack ๐ง. You should specify this flag if you're running in an environment with multiple threads, but you only rarely need it in a single-threaded environment, since stack overflow gets automatically detected on nearly all systems when there's only one stack.
Heads up bestie: this switch doesn't actually cause checking to happen โ the operating system or the language runtime has to do that. The switch just generates code so that they see the stack being extended ๐.
You can additionally specify a string parameter: no means no checking, generic means force the use of old-style checking, specific means use the best checking method and is equivalent to bare -fstack-check ๐
.
Old-style checking is a generic mechanism that needs no specific target support in the compiler, but it comes with these drawbacks:
- Modified allocation strategy for large objects: they're always allocated dynamically if their size exceeds a fixed threshold. Note this may change the semantics of some code ๐ฌ.
- Fixed limit on the size of the static frame of functions: when it's topped by a particular function, stack checking isn't reliable and a warning gets issued by the compiler.
- Inefficiency: because of both the modified allocation strategy and the generic implementation, code performance is hampered ๐ญ.
Note that old-style stack checking is also the fallback method for specific if no target support has been added in the compiler.
-fstack-check= is designed for Ada's needs to detect infinite recursion and stack overflows ๐. specific is an excellent choice when compiling Ada code. It's not generally sufficient to protect against stack-clash attacks though โ for 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 stops allocations from jumping over any stack guard page that the operating system provides ๐ก๏ธ.
Most targets don't fully support stack clash protection. However, on those targets -fstack-clash-protection will still protect dynamic stack allocations. And it may also give limited protection for static stack allocations if the target supports -fstack-check=specific โจ.
-fstack-limit-register=reg-fstack-limit-symbol=sym-fno-stack-limitโ generates code to 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 gets raised at run time. For most targets, that 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 ๐งต. Currently this is 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 โจ.
-fstrub=disableโ disables stack scrubbing entirely, ignoring any"strub"attributes ๐.-fstrub=strictโ functions default to"strub"mode"disabled", and it applies strictly the restriction that only functions associated with"strub"-"callable"modes ("at-calls","callable"and"always_inline""internal") are"callable"by functions with"strub"-enabled modes ("at-calls"and"internal") ๐.-fstrub=relaxedโ restores the default stack scrub ("strub") setting, meaning"strub"is only enabled as required by"strub"attributes associated with function and data types ๐ธ. "Relaxed" means strub contexts are only prevented from calling functions explicitly associated with"strub"mode"disabled". This option is only useful to override other-fstrub=*options that come before it on the command line ๐ .-fstrub=at-callsโ enables"at-calls""strub"mode where viable โจ. The primary use of this option is for testing ๐งช. It exercises the"strub"machinery in scenarios strictly local to a translation unit. This"strub"mode modifies function interfaces, so any function that's visible to other translation units, or that has its address taken, will not be affected by this option ๐. Optimization options may also affect viability. See the"strub"attribute documentation for the deets on viability and eligibility requirements ๐.-fstrub=internalโ enables"internal""strub"mode where viable ๐. The primary use of this option is for testing ๐งช. It's intended to thoroughly exercise the parts of the"strub"machinery that implement the less efficient, but interface-preserving,"strub"mode. Functions that wouldn't be affected by this option are quite uncommon ๐ฎ.-fstrub=allโ enables some"strub"mode where viable ๐. When both strub modes are viable,"at-calls"is preferred.-fdump-ipa-strubmadds function attributes that tell you which mode was selected for each function ๐. The primary use of this option is for testing, to exercise the"strub"machinery thoroughly ๐.-fvtable-verify=[std|preinit|none]โ okay so this one is C++ only, bestie, and it toggles a whole security feature on or off (off =-fvtable-verify=none). What it does is at run time, for every single virtual call, check that the vtable pointer the call goes through is actually valid for the type of the object and hasn't been corrupted or overwritten ๐ . If an invalid vtable pointer shows up at run time? error reported, program immediately halted, no cap. ๐
This option makes run-time data structures get built at program startup, and those are what verify the vtable pointers. The std and preinit values control when those data structures get built โ both build them before execution reaches main, but: -fvtable-verify=std builds them after shared libraries have been loaded and initialized, while -fvtable-verify=preinit builds them before shared libraries have been loaded and initialized.
If this option shows up multiple times on the command line with different values, priority goes: none beats both std and preinit; and preinit beats std. periodt.
-fvtv-debugโ when you use this alongside-fvtable-verify=stdor-fvtable-verify=preinit, it calls debug versions of the runtime functions for the vtable verification feature โจ. It also makes the compiler log which vtable pointers it finds for each class, written to a file namedvtv_set_ptr_data.log, in 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. Want a fresh log file? Delete any existing one first, bestie ๐.
-fvtv-countsโ debugging flag, lowkey. Used with-fvtable-verify=stdor-fvtable-verify=preinit, it makes the compiler keep track of the total number of virtual calls it encounters and the number of verifications it inserts ๐. It also counts the number of calls to certain run-time library functions that it inserts and logs this for each compilation unit. Where does it write? A file namedvtv_count_data.log, in the directory named byVTV_LOGS_DIRif defined, else the current working directory. And it counts the size of the vtable pointer sets for each class, writing that tovtv_class_set_sizes.login the same directory ๐ฆ.
Note: this feature appends data to the log files. For fresh log files, delete any existing ones ๐.
-finstrument-functionsโ generates instrumentation calls for entry and exit to functions. Just after function entry and just before function exit, these profiling functions get called with the address of the current function and its call site ๐. (On some platforms,__builtin_return_addressdoesn't work beyond the current function, so the call site info might not be available to the profiling functions otherwise.)
void __cyg_profile_func_enter (void *this_fn,
void *call_site);
void __cyg_profile_func_exit (void *this_fn,
void *call_site);
The first argument is the address of the start of the current function, which you can look up exactly in the symbol table ๐.
This instrumentation also happens for functions expanded inline in other functions. The profiling calls indicate where, conceptually, the inline function is entered and exited. Which means addressable versions of those functions must exist. If all your uses of a function get expanded inline, this may mean extra code size expansion ๐ญ. If you use extern inline in your C code, an addressable version of those functions must be provided. (Normally that's the case anyway, but if you get lucky and the optimizer always expands the functions inline, you might have gotten away without providing static copies. ๐)
A function can be given the attribute no_instrument_function, in which case this instrumentation isn't done. Use it for, like, the profiling functions listed above, high-priority interrupt routines, and any functions from which the profiling functions can't safely be called (maybe signal handlers, if the profiling routines generate output or allocate memory) ๐ซถ.
-finstrument-functions-onceโ similar to-finstrument-functions, but the profiling functions are called only once per instrumented function. Like: the first profiling function is called after the first entry into the instrumented function, and the second profiling function is called before the exit corresponding to this first entry โจ.
The definition of "once" here is a little vague because the implementation isn't protected against data races ๐ซ . So the implementation only guarantees the profiling functions are called at least once per process and at most once per thread, but the calls are always paired โ meaning if a thread calls the first function, then it will call the second function, unless it never reaches the exit of the instrumented function. fr fr.
-finstrument-functions-exclude-file-list=file,file,...โ sets the list of functions excluded from instrumentation (see the description of-finstrument-functions). If the file containing a function definition matches one of file, that function isn't instrumented ๐ซ. The match is done on substrings: if the file parameter is a substring of the file name, it counts as a match.
For example:
-finstrument-functions-exclude-file-list=/bits/stl,include/sys
excludes any inline function defined in files whose pathnames contain /bits/stl or include/sys ๐.
If, for some reason, you want to include the letter , in one of sym, write ,. For example, -finstrument-functions-exclude-file-list=',,tmp' (note the single quote surrounding the option) ๐.
-finstrument-functions-exclude-function-list=sym,sym,...โ similar to-finstrument-functions-exclude-file-list, but this one sets the list of function names to exclude from instrumentation. The function name matched is its user-visible name, likevector<int> blah(const vector<int> &), not the internal mangled name (e.g.,_Z4blahRSt6vectorIiSaIiEE) ๐. The match is on substrings: if the sym parameter is a substring of the function name, it's a match. For C99 and C++ extended identifiers, the function name must be given in UTF-8, not using universal character names ๐ธ.-fpatchable-function-entry=N[,M]โ generatesNNOPs right at the beginning of each function, with the function entry point before the Mth NOP ๐. If M is omitted, it defaults to0, so the function entry points to the address just at the first NOP. These NOP instructions reserve extra space that can be used to patch in whatever instrumentation you want at run time โ provided the code segment is writable ๐. The amount of space is controllable indirectly via the number of NOPs; the NOP instruction used corresponds to the instruction emitted by the internal GCC back-end interfacegen_nop. This behavior is target-specific and may also depend on the architecture variant and/or other compilation options ๐ง.
For run-time identification, the starting addresses of these areas โ which correspond to their respective function entries minus M โ are additionally collected in the __patchable_function_entries section of the resulting binary โจ.
Note that the value of__attribute__ ((patchable_function_entry (N,M)))takes precedence over the command-line option-fpatchable-function-entry=N,M. This can be used 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 ๐. On PowerPC with the ELFv2 ABI, for a function with dual entry points, the local entry point is this function entry address by default. See the -msplit-patch-nops option to change this.
The maximum value of N and M is 65535 ๐ฅ. On PowerPC with the ELFv2 ABI, for a function with dual entry points, the supported values for M are 0, 2, 6 and 14 when not using -msplit-patch-nops.
โจ Options Controlling the Preprocessor โจ
okay this section is so underrated ๐ These options control the C preprocessor, which runs on each C source file before actual compilation.
If you use the -E option, nothing is done except preprocessing ๐ธ. Some of these options only make sense together with -E, because they make the preprocessor output unsuitable for actual compilation ๐.
On top of the options listed here, there are a bunch of options controlling search paths for include files documented in Directory Options ๐ฆ. And options to control preprocessor diagnostics are listed in Warning Options.
-D name/--define-macro=name/--define-macro nameโ predefine name as a macro, with definition1. simple as that ๐-D name=definition/--define-macro=name=definition/--define-macro name=definitionโ the contents of definition are tokenized and processed as if they appeared during translation phase three in a#definedirective ๐. In particular, the definition is truncated by embedded newline characters.
If you're invoking the preprocessor from a shell or shell-like program, you may need to use the shell's quoting syntax to protect characters such as spaces that have a meaning in the shell syntax ๐ธ.
Wanna 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.
-U name/--undefine-macro=name/--undefine-macro nameโ cancel any previous definition of name, either built in or provided with a-Doption ๐ซ๐-includefile<br>--include=file<br>--include fileโ okay so this one is giving "sneaky first line" energy โจ It processes file as if#include "file"were literally the very first line of your primary source file. BUT (and this is the twist) the first directory it searches for file is the preprocessor's working directory, not the directory that holds the main source file. If it's not chilling there, it gets searched in the rest of the#include "..."search chain like normal, no biggie ๐
And bestie, if you hand it multiple -include options, the files get included in the order they show up on the command line. Order matters, periodt.
-imacrosfile<br>--imacros=file<br>--imacros fileโ literally exactly like-include, except any output produced by scanning file just gets thrown away ๐๏ธ The macros it defines stay defined though. So this is the move when you want to steal all the macros from a header without also dragging its declarations along. Iconic.
Also: all files specified by -imacros get processed before all files specified by -include. That's the rules, no cap.
-undefโ don't predefine any system-specific or GCC-specific macros. The standard predefined macros stay defined though, so don't panic ๐ธ-pthreadโ defines the extra macros you need for using the POSIX threads library. You should use this option consistently for both compilation and linking, okay? Both. Don't be shady about it ๐ This one's supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets.-M<br>--dependenciesโ instead of outputting the result of preprocessing, this outputs a rule suitable for make describing the dependencies of the main source file ๐ฅ The preprocessor spits out one make rule containing the object file name for that source file, a colon, and the names of all the included files โ including the ones coming from-includeor-imacroscommand-line options.
Unless you specify it explicitly (with -MT or -MQ), the object file name is the name of the source file with any suffix replaced with the object file suffix, and with any leading directory parts removed. If there are many included files, the rule gets split into several lines using \-newline. The rule has no commands, so don't go looking for any ๐
This option does not suppress the preprocessor's debug output, like -dM. To avoid mixing that debug output with your dependency rules you should explicitly specify the dependency output file with -MF, or use an environment variable like DEPENDENCIES_OUTPUT. Debug output still goes to the regular output stream as normal.
Passing -M to the driver implies -E, and suppresses warnings with an implicit -w. Sneaky but slay.
-MM<br>--user-dependenciesโ like-Mbut it does not mention header files found in system header directories, nor header files that are included, directly or indirectly, from such a header. So system stuff stays in its lane ๐
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. Noted, bestie.
-MFfile โ when used with-Mor-MM, this specifies a file to write the dependencies to. If no-MFswitch is given, the preprocessor sends the rules to the same place it would send preprocessed output.
When used with the driver options -MD or -MMD, -MF overrides the default dependency output file.
And if file is -, then the dependencies are written to stdout. Cute.
-MG<br>--print-missing-file-dependenciesโ in conjunction with an option like-Mthat requests dependency generation,-MGassumes missing header files are generated files and adds them to the dependency list without raising an error ๐ฆ The dependency filename is taken directly from the#includedirective without prepending any path.-MGalso suppresses preprocessed output, since a missing header file renders that useless anyway.
This feature is used in automatic updating of makefiles. Very demure, very mindful.
-Mno-modulesโ disables dependency generation for compiled module interfaces. Simple as that ๐ธ-MPโ this option instructs CPP to add a phony target for each dependency other than the main file, causing each to depend on nothing. These dummy rules work around the errors make gives you if you remove header files without updating the Makefile to match ๐ญ
This is the typical output:
test.o: test.c test.h
test.h:
-MTtarget โ changes the target of the rule emitted by dependency generation. By default CPP takes the name of the main input file, deletes any directory components and any file suffix like.c, and appends the platform's usual object suffix. That result is the target.
An -MT option sets the target to be exactly the string you specify. Want multiple targets? You can specify them as a single argument to -MT, or use multiple -MT options. Your call, main character ๐
For example, -MT '$(objpfx)foo.o' might give
$(objpfx)foo.o: foo.c
-MQtarget โ same as-MT, but it quotes any characters which are special to Make. So-MQ '$(objpfx)foo.o'gives
$$(objpfx)foo.o: foo.c
The default target is automatically quoted, as if it were given with -MQ. Automatic. Iconic.
-MD<br>--write-dependenciesโ-MDis equivalent to-M -MF file, except that-Eis not implied. The driver determines file based on whether an-ooption is given. If it is, the driver uses its argument but with a suffix of.d; otherwise it takes the name of the input file, removes any directory components and suffix, and applies a.dsuffix.
If -MD is used in conjunction with -E, any -o switch is understood to specify the dependency output file. But if it's used without -E, each -o is understood to specify a target object file. Context is everything, bestie ๐
Since -E is not implied, -MD can be used to generate a dependency output file as a side effect of the compilation process. Multitasking queen.
-MMD<br>--write-user-dependenciesโ like-MDexcept it mentions only user header files, not system header files. Keeping it user-only, as it should be ๐-fpreprocessedโ tells the preprocessor that the input file has already been preprocessed. This suppresses things like macro expansion, trigraph conversion, escaped newline splicing, and processing of most directives. The preprocessor still recognizes and removes comments, so you can pass a file preprocessed with-Cto the compiler without problems ๐ซถ In this mode the integrated preprocessor is little more than a tokenizer for the front ends.
-fpreprocessed is implicit if the input file has one of the extensions .i, .ii or .mi. These are the extensions that GCC uses for preprocessed files created by -save-temps. iykyk.
-fdirectives-onlyโ when preprocessing, this handles directives but does not expand macros. Its behavior depends on the-Eand-fpreprocessedoptions, so listen up:- With
-E, preprocessing is limited to the handling of directives such as#define,#ifdef, and#error. Other preprocessor operations, like macro expansion and trigraph conversion, are not performed. In addition, the-dDoption is implicitly enabled. - With
-fpreprocessed, predefinition of command line and most builtin macros is disabled. Macros such as__LINE__, which are contextually dependent, are handled normally. This enables compilation of files previously preprocessed with-E -fdirectives-only. - With both
-Eand-fpreprocessed, the rules for-fpreprocessedtake precedence. This enables full preprocessing of files previously preprocessed with-E -fdirectives-only.
- With
Okay that was a lot but you got this ๐
-fdollars-in-identifiersโ accept$in identifiers. That's it. That's the whole thing. Slay ๐-fextended-identifiersโ accept universal character names and extended characters in identifiers. This option is enabled by default for C99 (and later C standard versions) and C++. Default behavior, no notes ๐-fno-canonical-system-headersโ when preprocessing, do not shorten system header paths with canonicalization. Leave those paths long, bestie.- *
-fmax-include-depth=depth* โ set the maximum depth of the nested#include. The default is200. Don't go nesting past that, or you'll find out ๐ญ -fsearch-include-path[=kind]โ look for input files on the#includepath, not just the current directory. This is particularly useful with C++20 modules, for which both header units and module interface units need to be compiled directly:
g++ -c -std=c++20 -fmodules -fsearch-include-path bits/stdc++.h bits/std.cc
kind defaults to user, which looks on the #include "..." search path; you can also explicitly specify system for the #include <...> search path. Choose your fighter โจ
-ftabstop=width โ 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. Boundaries matter, periodt.-ftrack-macro-expansion[=level]โ tracks locations of tokens across macro expansions. This lets the compiler emit a diagnostic about the current macro expansion stack when a compilation error happens inside a macro expansion ๐ Using this option makes the preprocessor and the compiler consume more memory, so heads up.
The level parameter chooses the level of precision of token location tracking, so you can dial down the memory consumption if you need to:
- Value
0of level de-activates this option. - Value
1tracks token locations in a degraded mode for the sake of minimal memory overhead. In this mode, all tokens resulting from the expansion of an argument of a function-like macro have the same location. - Value
2tracks token locations completely. This value is the most memory hungry.
When this option is given no argument, the default parameter value is 2.
Note that -ftrack-macro-expansion=2 is activated by default. So it's already on, bestie ๐
- *
-fmacro-prefix-map=old*=new โ when preprocessing files residing in directory old, this expands the__FILE__and__BASE_FILE__macros as if the files resided in directory new instead. This can be used to change an absolute path to a relative path by using.for new, which can result in more reproducible builds that are location independent ๐ธ This option also affects__builtin_FILE()during compilation. See also-ffile-prefix-mapand-fcanon-prefix-map. - *
-fexec-charset=charset* โ 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. Go off with your encoding choices, bestie ๐ -fwide-exec-charset=charsetโ sets the wide execution character set, the one used for wide string and character constants. default? it's one ofUTF-32BE,UTF-32LE,UTF-16BE, orUTF-16LEโ whichever matches the width ofwchar_tand the big-endian/little-endian byte order you're generating code for ๐ง. just like-fexec-charset, charset can be any encoding your system'siconvlibrary routine supports. BUT ๐ โ if the encoding doesn't fit exactly inwchar_t, you will have problems. no cap.-finput-charset=charsetโ sets the input character set, used to translate from the charset of the input file into the source character set GCC uses. default isUTF-8. charset can be any encoding supported by the system'siconvlibrary routine โจ
okay so if the input charset is UTF-8, warnings about ill-formed code unit sequences get issued if -Winvalid-utf8 is enabled. otherwise, no diagnostics at all when the input charset matches the execution character set. but if they're different? ill-formed code unit sequences become an error during transcoding to the execution character set ๐ญ
-fpch-depsโ when you're using precompiled headers, this flag makes the dependency-output flags also list the files from the precompiled header's dependencies. if you don't specify it, only the precompiled header gets listed, and not the files used to create it โ because those files aren't consulted when a precompiled header is used. periodt.-fpch-preprocessโ this one lets you use a precompiled header together with-E๐ซถ. it inserts a special#pragma,#pragma GCC pch_preprocess "filename", into the output to mark where the precompiled header was found, plus its filename. when-fpreprocessedis in use, GCC recognizes this#pragmaand loads the PCH. iconic.
this option is off by default, because the resulting preprocessed output is only really suitable as input to GCC. it gets switched on by -save-temps.
bestie do NOT write this #pragma in your own code ๐. it is safe to edit the filename if the PCH file lives somewhere else though. the filename can be absolute, or relative to GCC's current directory.
-fworking-directoryโ turns on generation of linemarkers in the preprocessor output that let the compiler know the current working directory at the time of preprocessing ๐ . when it's enabled, the preprocessor emits, after the initial linemarker, a second linemarker with the current working directory followed by two slashes. GCC uses that directory โ when it's present in the preprocessed input โ as the directory emitted as the current working directory in some debugging information formats. it's implicitly enabled if debugging information is enabled, but you can inhibit that with the negated form-fno-working-directory. and if-Pis on the command line, this option has no effect, since no#linedirectives are emitted whatsoever.-C,--commentsโ do not discard comments ๐. all comments get passed through to the output file, except for comments in processed directives, which get deleted along with the directive.
be prepared for side effects when using-Cโ ๏ธ โ it makes the preprocessor treat comments as tokens in their own right. for example, comments appearing at the start of what would be a directive line turn that line into an ordinary source line, since the first token on the line is no longer a#.
-CC,--comments-in-macrosโ do not discard comments, including during macro expansion โจ. this is like-C, except comments contained within macros also get passed through to the output file where the macro is expanded.
on top of all the side effects of -C, -CC also converts all C++-style comments inside a macro into C-style comments ๐. why? to prevent later use of that macro from inadvertently commenting out the rest of the source line. slay.
-CC is generally used to support lint comments.
-P,--no-line-commandsโ inhibit generation of linemarkers in the preprocessor output. useful when you're running the preprocessor on something that isn't C code and it's headed to a program that might get confused by linemarkers ๐ฆ.-traditional,--traditional,-traditional-cpp,--traditional-cppโ try to imitate the behavior of pre-standard C preprocessors, as opposed to ISO C preprocessors. see the GNU CPP manual for details ๐.
heads up: GCC does not otherwise attempt to emulate a pre-standard C compiler, and these options are only supported with the -E switch, or when invoking CPP explicitly.
-trigraphs,--trigraphsโ support ISO C trigraphs ๐. these are three-character sequences, all starting with??, that ISO C defines to stand for single characters. for example,??/stands for\, so'??/n'is a character constant for a newline.
the nine trigraphs and their replacements are:
Trigraph: ??( ??) ??< ??> ??= ??/ ??' ??! ??-
Replacement: [ ] { } # \ ^ | ~
by default, GCC ignores trigraphs, but in standard-conforming modes it converts them. see the -std and -ansi options ๐
.
-remapโ enables special code to work around file systems that only permit very short file names, like MS-DOS ๐ญ.-H,--trace-includesโ prints the name of each header file used, on top of all the other normal activities ๐. each name is indented to show how deep in the#includestack it is. precompiled header files get printed too, even if they turn out to be invalid โ an invalid precompiled header file prints with...xand a valid one with...!.-dletters,--dump=letters,--dump lettersโ says to make debugging dumps during compilation as specified by letters. the flags documented here are the ones relevant to the preprocessor โจ. other letters get interpreted by the compiler proper, or reserved for future versions of GCC, and so are silently ignored. and if you specify letters whose behavior conflicts? the result is undefined ๐.-dM,--dump=Mโ instead of the normal output, generate a list of#definedirectives for all the macros defined during the execution of the preprocessor, including predefined macros. this is how you find 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.
-dD,--dump=Dโ like-dMexcept it outputs both the#definedirectives and the result of preprocessing ๐. both kinds of output go to the standard output file.-dN,--dump=Nโ like-dD, but emits only the macro names, not their expansions.-dI,--dump=Iโ outputs#includedirectives in addition to the result of preprocessing.-dU,--dump=Uโ like-dDexcept only macros that are expanded, or whose definedness is tested in preprocessor directives, get output ๐ซถ. the output is delayed until the use or test of the macro, and#undefdirectives are also output for macros tested but undefined at the time.
-fdebug-cppโ this option is only useful for debugging GCC, fr fr. when used from CPP or with-E, it dumps debugging information about location maps. every token in the output is preceded by the dump of the map its location belongs to ๐บ๏ธ.
when used from GCC without -E, this option has no effect.
-Wp,optionโ you can use-Wp,optionto bypass the compiler driver and pass option directly through to the preprocessor โก. if option contains commas, it gets split into multiple options at the commas. HOWEVER โ many options are modified, translated or interpreted by the compiler driver before being passed to the preprocessor, and-Wpforcibly bypasses that phase. the preprocessor's direct interface is undocumented and subject to change, so whenever possible you should avoid-Wpand let the driver handle the options instead ๐.-Xpreprocessor optionโ pass option as an option to the preprocessor. use this to supply system-specific preprocessor options that GCC doesn't recognize ๐ธ.
if you want to pass an option that takes an argument, you must use -Xpreprocessor twice โ once for the option and once for the argument ๐
.
-no-integrated-cpp,--no-integrated-cppโ perform preprocessing as a separate pass before compilation. by default, GCC does preprocessing as an integrated part of input tokenization and parsing. if this option is provided, 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 may be useful together with the-Bor-wrapperoptions to specify an alternate preprocessor, or to 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โ pass option as an option to the assembler. if option contains commas, it gets split into multiple options at the commas โ๏ธ.-Xassembler option,--for-assembler=option,--for-assembler optionโ pass 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โ okay so if a filename doesn't end in one of those special recognized suffixes, GCC just goes "yep that's an object file or a library bestie" ๐ซถ (the linker tells object files and libraries apart by peeking at the actual file contents, nosey much). And if linking is happening, those object files get fed straight into the linker as input.-c,-S,-Eโ if you use any of these, the linker does not run, and pls do not pass object file names as arguments, it's giving pointless ๐ธ-flink-libatomicโ turns on linking oflibatomicif your target supports it, and it's on by default, no cap โจ. The negative form-fno-link-libatomicexists so you can explicitly tell it no thank you ๐-flinker-output=typeโ this one controls code generation of the link-time optimizer. By default the linker output is automatically determined by the linker plugin (auto-pilot energy ๐). But for debugging the compiler, or if you want incremental linking with a non-LTO object file, manually controlling thetypecan be useful.- If
typeisexec, code generation produces a static binary. In this case-fpicand-fpieare both disabled. - If
typeisdyn, code generation produces a shared library. In this case-fpicor-fPICis preserved, but not enabled automatically. This allows building shared libraries without position-independent code on architectures where that's possible, i.e. on x86. - If
typeispie, code generation produces an-fpieexecutable. This gives similar optimizations asexecexcept that-fpieis not disabled if specified at compilation time. - If
typeisrel, the compiler assumes incremental linking is being done. The sections containing intermediate code for link-time optimization are merged, pre-optimized, and output to the resulting object file. Plus, if-ffat-lto-objectsis specified, binary code is produced for future non-LTO linking. The object file produced by incremental linking is smaller than a static library produced from the same object files. At link time the result of incremental linking also loads faster than a static library, assuming the majority of objects in the library are used. - Finally,
nolto-relconfigures the compiler for incremental linking where code generation is forced, a final binary is produced, and the intermediate code for later link-time optimization is stripped. When multiple object files are linked together, the resulting code is better optimized than with link-time optimizations disabled (like, cross-module inlining happens, slay), but most of the benefits of whole-program optimizations are lost ๐ญ
- If
During the incremental link (by -r) the linker plugin defaults to rel. GNU Binutils 2.44 or later is needed to incrementally link LTO objects and non-LTO objects into a single mixed object file. If any of the object files in an incremental link cannot be used for link-time optimization, the linker plugin issues a warning and uses nolto-rel. To maintain whole-program optimization, link such objects into a static library instead. noted ๐
-fuse-ld=bfdโ use thebfdlinker instead of the default linker.-fuse-ld=goldโ use thegoldlinker instead of the default linker.-fuse-ld=lldโ use the LLVMlldlinker instead of the default linker.-fuse-ld=moldโ use the Modern Linker (mold) instead of the default linker. iconic name fr ๐-fuse-ld=wildโ use the Wild linker (wild) instead of the default linker.-llibrary,-l libraryโ searches the library named library when linking. (That second form, with the library as a separate argument, exists only for POSIX compliance and is not recommended, okay bestie? we don't do that here ๐)
The -l option is passed directly to the linker by GCC, so refer to your linker documentation for the exact details. The general description below applies to the GNU linker.
The linker searches a standard list of directories for the library. Those directories include several standard system directories plus any you specify with -L.
Static libraries are archives of object files, and have file names like liblibrary.a. Some targets also support shared libraries, which typically have names like liblibrary.so. If both static and shared libraries are found, the linker gives preference to linking with the shared library unless -static is used.
It genuinely makes a difference where in the command you write this option โ the linker searches and processes libraries and object files in the order they are specified. So foo.o -lz bar.o searches library z after file foo.o but before bar.o. And if bar.o refers to functions in z, those functions may not be loaded ๐ order matters, periodt.
-lobjcโ you need this special case of the-loption 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 get passed to the linker, and options specifying linkage of the system libraries โ like-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. no skipping that step ๐ซก
-nolibcโ do not use the C library, or system libraries tightly coupled with it, when linking. It still links with the startup files,libgcc, or toolchain-provided language support libraries such aslibgnat,libgfortranorlibstdc++, unless options preventing their inclusion are used as well. This typically removes-lcfrom the link command line, along with system libraries that normally go with it and become meaningless when the absence of a C library is assumed โ for example-lpthreador-lmin some configurations. This is intended for bare-board targets when there is indeed no C library available ๐ฑ-nostdlib,--no-standard-librariesโ do not use the standard system startup files or libraries when linking. No startup files, and only the libraries you specify are passed to the linker, and options specifying linkage of the system libraries โ such as-static-libgccor-shared-libgccโ are ignored.
The compiler may generate calls to memcmp, memset, memcpy and memmove. These entries are usually resolved by entries in libc. These entry points should be supplied through some other mechanism when this option is specified.
One of the standard libraries bypassed by -nostdlib and -nodefaultlibs is libgcc.a, a library of internal subroutines which GCC uses to overcome shortcomings of particular machines, or special needs for some languages.
In most cases, you need libgcc.a even when you want to avoid other standard libraries. In other words, when you specify -nostdlib or -nodefaultlibs you should usually specify -lgcc as well. This ensures that you have no unresolved references to internal GCC library subroutines. (An example of such an internal subroutine is __main, used to ensure C++ constructors are called.) ๐
-nostdlib++โ do not implicitly link with standard C++ libraries.-e entry,--entry=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.-pie,--pieโ produce a dynamically linked position independent executable on targets that support it. For predictable results, you must also specify the same set of options used for compilation (-fpie,-fPIE, or model suboptions) when you specify this linker option. match your outfits bestie, consistency is everything โจ-no-pieโ don't produce a dynamically linked position independent executable.-static-pie,--static-pieโ produce a static position independent executable on targets that support it. A static position independent executable is similar to a static executable, but can be loaded at any address without a dynamic linker. For predictable results, you must also specify the same set of options used for compilation (-fpie,-fPIE, or model suboptions) when you specify this linker option.-pthreadโ link with the POSIX threads library ๐งต. This option is supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets. On some targets this option also sets flags for the preprocessor, so it should be used consistently for both compilation and linking โ don't half-do it ๐-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 ofdlopen, or to allow obtaining backtraces from within a program.-sโ remove all symbol table and relocation information from the executable. bye bye debug info ๐-static,--staticโ on systems that support dynamic linking, this overrides-pieand prevents linking with the shared libraries. On other systems, this option has no effect.-shared,--sharedโ produce a shared object which can then be linked with other objects to form an executable. Not all systems support this option. For predictable results, you must also specify the same set of options used for compilation (-fpic,-fPIC, or model suboptions) when you specify this linker option.[1]-shared-libgcc,-static-libgccโ on systems that providelibgccas a shared library, these options force the use of either the shared or static version, respectively. If no shared version oflibgccwas 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.
Okay so because of all that, the G++ driver just automatically adds -shared-libgcc whenever you build a shared library or a main executable, because C++ programs typically use exceptions, so this is literally the right thing to do. ๐
But bestie, if you use the GCC driver to create shared libraries instead, you might find they're not always linked with the shared libgcc. If GCC finds at its configuration time that you have a non-GNU linker, or a GNU linker that doesn't support the --eh-frame-hdr option, it links the shared version of libgcc into shared libraries by default. Otherwise, it's like, 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 lets exceptions 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, so that it's linked with the shared libgcc. No cap. ๐ซถ
-static-libasanโ When the-fsanitize=addressoption is used to link a program, the GCC driver automatically links againstlibasan. Iflibasanis available as a shared library, and the-staticoption is not used, then this links against the shared version oflibasan. The-static-libasanoption directs the GCC driver to linklibasanstatically, without necessarily linking other libraries statically. ๐-static-libhwasanโ When the-fsanitize=hwaddressoption is used to link a program, the GCC driver automatically links againstlibhwasan. Iflibhwasanis available as a shared library, and the-staticoption is not used, then this links against the shared version oflibhwasan. The-static-libhwasanoption directs the GCC driver to linklibhwasanstatically, without necessarily linking other libraries statically. โจ-static-liblsanโ When the-fsanitize=leakoption is used to link a program, the GCC driver automatically links againstliblsan. Ifliblsanis available as a shared library, and the-staticoption is not used, then this links against the shared version ofliblsan. The-static-liblsanoption directs the GCC driver to linkliblsanstatically, without necessarily linking other libraries statically. ๐-static-libtsanโ When the-fsanitize=threadoption is used to link a program, the GCC driver automatically links againstlibtsan. Iflibtsanis available as a shared library, and the-staticoption is not used, then this links against the shared version oflibtsan. The-static-libtsanoption directs the GCC driver to linklibtsanstatically, without necessarily linking other libraries statically. ๐ฆ-static-libubsanโ When the-fsanitize=undefinedoption is used to link a program, the GCC driver automatically links againstlibubsan. Iflibubsanis available as a shared library, and the-staticoption is not used, then this links against the shared version oflibubsan. The-static-libubsanoption directs the GCC driver to linklibubsanstatically, without necessarily linking other libraries statically. ๐ธ-static-libstdc++โ When theg++program is used to link a C++ program, it normally automatically links againstlibstdc++. Iflibstdc++is available as a shared library, and the-staticoption is not used, then this links against the shared version oflibstdc++. That is normally fine. However, it is sometimes useful to freeze the version oflibstdc++used by the program without going all the way to a fully static link. The-static-libstdc++option directs theg++driver to linklibstdc++statically, without necessarily linking other libraries statically. ๐-symbolic,--symbolicโ Bind references to global symbols when building a shared object. Warn about any unresolved references (unless overridden by the link editor option-Xlinker -z -Xlinker defs). Only a few systems support this option. ๐-Tscript โ Use script as the linker script. This option is supported by most systems using the GNU linker. On some targets, such as bare-board targets without an operating system, the-Toption may be required when linking to avoid references to undefined symbols. ๐-Xlinkeroption โ Pass option as an option to the linker. You can use this to supply system-specific linker options that GCC does not recognize.
If you want to pass an option that takes a separate argument, you must use -Xlinker twice, once for the option and once for the argument. For example, to pass -assert definitions, you must write -Xlinker -assert -Xlinker definitions. It does not work to write -Xlinker "-assert definitions", because this passes the entire string as a single argument, which is not what the linker expects. ๐ญ
When using the GNU linker, it is usually more convenient to pass arguments to linker options using the option=value syntax than as separate arguments. For example, you can specify -Xlinker -Map=output.map rather than -Xlinker -Map -Xlinker output.map. Other linkers may not support this syntax for command-line options. ๐
-Wl,option,--for-linker=option,--for-linkeroption โ Pass option as an option to the linker. If option contains commas, it is split into multiple options at the commas. You can use this syntax to pass an argument to the option. For example,-Wl,-Map,output.mappasses-Map output.mapto the linker. When using the GNU linker, you can also get the same effect with-Wl,-Map=output.map. ๐-usymbol,--force-link=symbol,--force-linksymbol โ Pretend the symbol symbol is undefined, to force linking of library modules to define it. You can use-umultiple times with different symbols to force loading of additional library modules. ๐ฅ-Tbss=addr,-Tdata=addr,-Ttext=addr,-N,-n,-t,-Z,-zkeyword โ These options are passed through to the linker without interpretation by GCC. Refer to your linker documentation for the meanings of these options. ๐ง
๐ธ Options for Directory Search ๐ธ
These options specify directories to search for header files, for libraries and for parts of the compiler: ๐
-Idir,-iquotedir,-isystemdir,-idirafterdir,--include-directory-after=dir,--include-directory-afterdir,--include-directory=dir,--include-directorydir โ Add the directory dir to the list of directories to be searched for header files during preprocessing.--include-directoryis an alias for-I, while--include-directory-afteris an alias for-idirafter. If dir begins with=or$SYSROOT, then the=or$SYSROOTis replaced by the sysroot prefix; see--sysrootand-isysroot. ๐ธ
Directories specified with -iquote apply only to the quote form of the directive, #include "file". Directories specified with -I, -isystem, or -idirafter apply to lookup for both the #include "file" and #include <file> directives.
You can specify any number or combination of these options on the command line to search for header files in several directories. The lookup order is as follows:
- For the quote form of the include directive, the directory of the current file is searched first.
- For the quote form of the include directive, the directories specified by
-iquoteoptions are searched in left-to-right order, as they appear on the command line. - Directories specified with
-Ioptions are scanned in left-to-right order. - Directories specified with
-isystemoptions are scanned in left-to-right order. - Standard system directories are scanned.
- Directories specified with
-idirafteroptions are scanned in left-to-right order.
You can use -I to override a system header file, substituting your own version, since these directories are searched before the standard system header file directories. However, you should not use this option to add directories that contain vendor-supplied system header files; use -isystem for that. ๐
The -isystem and -idirafter options also mark the directory as a system directory, so that it gets the same special treatment that is applied to the standard system directories.
If a standard system include directory, or a directory specified with -isystem, is also specified with -I, the -I option is ignored. The directory is still searched but as a system directory at its normal position in the system include chain. This is to ensure that GCC's procedure to fix buggy system headers and the ordering for the #include_next directive are not inadvertently changed. If you really need to change the search order for system directories, use the -nostdinc and/or -isystem options. ๐ญ
-I-,--include-barrierโ Split the include path. This option has been deprecated. Please use-iquoteinstead for-Idirectories before the-I-and remove the-I-option. ๐ซ
Any directories specified with -I options before -I- are searched only for headers requested with #include "file"; they are not searched for #include <file>. If additional directories are specified with -I options after the -I-, those directories are searched for all #include directives.
In addition, -I- inhibits the use of the directory of the current file directory as the first search directory for #include "file". There is no way to override this effect of -I-. ๐
-iprefixprefix,--include-prefix=prefix,--include-prefixprefix โ Specify prefix as the prefix for subsequent-iwithprefixoptions. If the prefix represents a directory, you should include the final/. ๐-iwithprefixdir,-iwithprefixbeforedir,--include-with-prefix=prefix,--include-with-prefixprefix,--include-with-prefix-after=prefix,--include-with-prefix-afterprefix,--include-with-prefix-before=prefix,--include-with-prefix-beforeprefix โ Append dir to the prefix specified previously with-iprefix, and add the resulting directory to the include search path.-iwithprefixbeforeputs it in the same place-Iwould;-iwithprefixputs it where-idirafterwould. โจ
--include-with-prefix and --include-with-prefix-after are both aliases for -iwithprefix, while --include-with-prefix-before is an alias for -iwithprefixbefore. ๐
-isysroot dirโ bestie this is literally the--sysrootoption's sibling ๐ but it only applies to header files (except on Darwin targets, where it applies to both header files and libraries, slay). Go read the--sysrootoption for the full tea.-imultilib dirโ use dir as a subdirectory of the directory that contains target-specific C++ headers. โจ-imultiarch dirโ use dir as a subdirectory of the directory that contains architecture-specific C++ headers. ๐-nostdinc,--no-standard-includesโ do NOT go searching the standard system directories for header files, periodt. Only the directories you explicitly named with-I,-iquote,-isystem, and/or-idirafterget searched (plus the directory of the current file, if that's appropriate). ๐ฆ-nostdinc++โ don't search for header files in the C++-specific standard directories, but you DO still search all the other standard directories. (This one gets used when building the C++ library, iykyk.) ๐--embed-dir=dir,--embed-directory=dir,--embed-directory dirโ append the dir directory to the list of searched directories for the"#embed"preprocessing directive or the"__has_embed"macro. Heads up: there are no default directories for"#embed". ๐ญ
If dir begins with = or $SYSROOT, then that = or $SYSROOT gets replaced by the sysroot prefix โ see --sysroot and -isysroot. ๐ธ
-iplugindir=dirโ set the directory to search for plugins that are passed by-fplugin=nameinstead of-fplugin=path/name.so. Lowkey not for you though: this option is not meant to be used by the user, but only passed by the driver. ๐-Ldir,--library-directory=dir,--library-directory dirโ add the directory dir to the list of directories to be searched for-l. ๐ฅ-Bprefix,--prefix=prefix,--prefix prefixโ this option specifies where to find the executables, libraries, include files, and data files of the compiler itself. ๐
The compiler driver program runs one or more of the subprograms 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,--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,--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. ๐
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. ๐ฅ-fwrapvโ this option instructs the compiler to assume that signed arithmetic overflow of addition, subtraction and multiplication wraps around using twos-complement representation. This flag enables some optimizations and disables others. The options-ftrapvand-fwrapvoverride each other, so using-ftrapv -fwrapvon the command-line results in-fwrapvbeing effective. Note that only active options override, so using-ftrapv -fwrapv -fno-wrapvon the command-line results in-ftrapvbeing effective. โจ-fwrapv-pointerโ this option instructs the compiler to assume that pointer arithmetic overflow on addition and subtraction wraps around using twos-complement representation. This flag disables some optimizations which assume pointer overflow is invalid. ๐-fstrict-overflowโ this option implies-fno-wrapv -fno-wrapv-pointerand when negated implies-fwrapv -fwrapv-pointer. ๐-fexceptionsโ enable exception handling. Generates extra code needed to propagate exceptions. For some targets, this implies GCC generates frame unwind information for all functions, which can produce significant data size overhead, although it does not affect execution. If you do not specify this option, GCC enables it by default for languages like C++ that normally require exception handling, and disables it for languages like C that do not normally require it. However, you may need to enable this option when compiling C code that needs to interoperate properly with exception handlers written in C++. You may also wish to disable this option if you are compiling older C++ programs that don't use exception handling. ๐ฆ-fnon-call-exceptionsโ generate code that allows trapping instructions to throw exceptions. Note that this requires platform-specific runtime support that does not exist everywhere. Moreover, it only allows trapping instructions to throw exceptions, i.e. memory references or floating-point instructions. It does not allow exceptions to be thrown from arbitrary signal handlers such as"SIGALRM". This enables-fexceptions. ๐-fdelete-dead-exceptionsโ okay so this one says: instructions that might throw exceptions but literally don't do anything else useful for the program? Yeah, they can be optimized away, gone, deleted, bye ๐ . Important caveat though bestie: this does not affect calls to functions โ except the ones with thepureorconstattributes, those are fair game. This option is enabled by default for the Ada and C++ compilers, since the language specs permit it. And the optimization passes that actually remove dead exceptions? They get enabled independently at different optimization levels. So like, the vibe is per-level, not all-or-nothing. โจ-funwind-tablesโ basically-fexceptions's chill cousin. It just generates whatever static data is needed, and does not touch the generated code in any other way. You normally don't need to turn this on yourself โ instead, a language processor that needs this handling enables it on your behalf. So like, not your job, let the toolchain handle it ๐ซถ-fasynchronous-unwind-tablesโ generates an unwind table in DWARF format, if the target machine supports it. The table is exact at each instruction boundary, which means it can be used for stack unwinding from asynchronous events โ think debugger or garbage collector just showing up unannounced ๐ญ. Very precise, very demure, very useful.-fno-gnu-uniqueโ okay this one is a whole situation, let me explain. On systems with a recent GNU assembler and C library, the C++ compiler uses theSTB_GNU_UNIQUEbinding to make sure that definitions of template static data members and static local variables in inline functions stay unique even whenRTLD_LOCALis in the picture. Why does that matter? Because it avoids problems with a library used by two differentRTLD_LOCALplugins depending on a definition in one of them, and therefore disagreeing with the other one about the binding of the symbol. Drama avoided โจ. BUT โ and it's a big but โ this causesdlcloseto be ignored for affected DSOs. So if your program relies on reinitialization of a DSO viadlcloseanddlopen, you can use-fno-gnu-unique. That's the escape hatch, bestie ๐ช-fpcc-struct-returnโ returnsshortstructandunionvalues in memory like the longer ones, rather than in registers. This convention is less efficient, but it has one glow-up: it allows intercallability between GCC-compiled files and files compiled with other compilers โ particularly the Portable C Compiler (pcc). The precise convention for returning structures in memory depends on the target configuration macros. And "short structures and unions" means those whose size and alignment match that of some integer type.
Warning: code compiled with the-fpcc-struct-returnswitch is not binary compatible with code compiled with the-freg-struct-returnswitch. Use it to conform to a non-default application binary interface. No cap, pick a lane ๐จ
-freg-struct-returnโ returnsstructandunionvalues in registers when possible. This is more efficient for small structures than-fpcc-struct-return. If you specify neither-fpcc-struct-returnnor-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 tbh ๐
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. Again: pick a lane ๐
-fshort-enumsโ allocates to anenumtype only as many bytes as it needs for the declared range of possible values. Specifically, theenumtype is equivalent to the smallest integer type that has enough room. So economical, so efficient, it's giving minimalism ๐ . This option has no effect for an enumeration type with a fixed underlying type.
Warning: the -fshort-enums switch causes GCC to generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface.
-fshort-wcharโ overrides the underlying type forwchar_tto beshort unsigned intinstead of the default for the target. This option is useful for building programs to run under WINE ๐ท. Cute use case honestly.
Warning: the -fshort-wchar switch causes GCC to generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface.
-fcommonโ in C code, this option controls the placement of global variables defined without an initializer, known as tentative definitions in the C standard. Tentative definitions are distinct from declarations of a variable with theexternkeyword, which do not allocate storage. Okay so here's the tea:
The default is -fno-common, which specifies that the compiler places uninitialized global variables in the BSS section of the object file. This inhibits the merging of tentative definitions by the linker, so you get a multiple-definition error if the same variable is accidentally defined in more than one compilation unit. Surprise! ๐
The -fcommon option places uninitialized global variables in a common block. This allows the linker to resolve all tentative definitions of the same variable in different compilation units to the same object, or to a non-tentative definition. This behavior is inconsistent with C++, and on many targets implies a speed and code size penalty on global variable references. It is mainly useful to enable legacy code to link without errors. Grandpa code deserves love too ๐
-fno-ident-Qy-Qnโ-fno-identsuppresses emission of.identassembler directives and causes the#identpreprocessor directive to be ignored. And just so we're clear:-Qyand-Qnare obsolete synonyms for-fidentand-fno-ident, respectively. Old news, but they're still in the building ๐-finhibit-size-directiveโ don't output a.sizeassembler directive, or anything else that would cause trouble if the function is split in the middle and the two halves are placed at locations far apart in memory. This option is used when compilingcrtstuff.cโ you should not need to use it for anything else. Like, genuinely, leave this one alone, it's not for you bestie ๐-fverbose-asmโ puts extra commentary information in the generated assembly code to make it more readable. This option is generally only of use to those who actually need to read the generated assembly code โ perhaps while debugging the compiler itself. Niche but iconic ๐ฅ
-fno-verbose-asm, the default, causes the extra information to be omitted and is useful when comparing two assembler files.
The added comments include:
- information on the compiler version and command-line options,
- the source code lines associated with the assembly instructions, in the form
FILENAME:LINENUMBER:CONTENT OF LINE, - hints on which high-level expressions correspond to the various assembly instruction operands.
For example, given this C source file:
int test (int n)
{
int i;
int total = 0;
for (i = 0; i < n; i++)
total += i * i;
return total;
}
compiling to (x86_64) assembly via -S and emitting the result direct to stdout via -o -
gcc -S test.c -fverbose-asm -Os -o -
gives output similar to this:
.file "test.c"
# GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
[...snip...]
# options passed:
[...snip...]
.text
.globl test
.type test, @function
test:
.LFB0:
.cfi_startproc
# test.c:4: int total = 0;
xorl %eax, %eax # <retval>
# test.c:6: for (i = 0; i < n; i++)
xorl %edx, %edx # i
.L2:
# test.c:6: for (i = 0; i < n; i++)
cmpl %edi, %edx # n, i
jge .L5 #,
# test.c:7: total += i * i;
movl %edx, %ecx # i, tmp92
imull %edx, %ecx # i, tmp92
# test.c:6: for (i = 0; i < n; i++)
incl %edx # i
# test.c:7: total += i * i;
addl %ecx, %eax # tmp92, <retval>
jmp .L2 #
.L5:
# test.c:10: }
ret
.cfi_endproc
.LFE0:
.size test, .-test
.ident "GCC: (GNU) 7.0.0 20160809 (experimental)"
.section .note.GNU-stack,"",@progbits
The comments are intended for humans rather than machines and hence the precise format of the comments is subject to change. So don't go parsing them, bestie, they're just vibes โจ
-frecord-gcc-switchesโ this switch causes the command line used to invoke the compiler to be recorded into the object file that is being created. It's only implemented on some targets, and the exact format of the recording is target and binary file format dependent โ but it usually takes the form of a section containing ASCII text. This switch is related to the-fverbose-asmswitch, but that switch only records information in the assembler output file as comments, so it never reaches the object file. See also-grecord-gcc-switchesfor another way of storing compiler options into the object file. Receipts in the binary, love that for us ๐งพ-fpicโ generates position-independent code (PIC) suitable for use in a shared library, if supported for the target machine. Such code accesses all constant addresses through a global offset table (GOT). The dynamic loader resolves the GOT entries when the program starts โ and just so you know, the dynamic loader is not part of GCC, it's part of the operating system. If the GOT size for the linked executable exceeds a machine-specific maximum size, you get an error message from the linker indicating that-fpicdoes not work; in that case, recompile with-fPICinstead. The maximums, for the record: 8k on the SPARC, 28k on AArch64, and 32k on the m68k and RS/6000. The x86 has no such limit. Slay, x86 ๐
Position-independent code requires special support, and therefore works only on certain machines. For the x86, GCC supports PIC for System V but not for the Sun 386i. Code generated for the IBM RS/6000 is always position-independent.
When this flag is set, the macros __pic__ and __PIC__ are defined to 1.
-fPICโ okay so if the target machine supports it, this emits position-independent code, which is the vibe you need for dynamic linking and which avoids any limit on the size of the global offset table. It actually makes a difference on AArch64, m68k, PowerPC and SPARC ๐
Position-independent code needs special support from the machine, so it only works on certain ones. No cap.
When this flag is set, the macros __pic__ and __PIC__ get defined to 2.
-fpie,-fPIEโ these are like-fpicand-fPIC's cousins, but the position-independent code they generate can only be linked into executables (not shared libs, bestie, just executables). Usually you use them to compile code that'll be linked using the-pieGCC option.
Both -fpie and -fPIE define the macros __pie__ and __PIE__. The macros have the value 1 for -fpie and 2 for -fPIE. Slay.
-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 you 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 gives 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 that are marked to not use the PLT to use the GOT instead.
-fno-jump-tablesโ do not use jump tables for switch statements, even where it would be more efficient than other code generation strategies. This one is useful together with-fpicor-fPICfor building code that forms part of a dynamic linker and can't 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 ๐ซถ-fno-bit-testsโ do not use bit tests for switch statements, even where it would be more efficient than other code generation strategies.-ffixed-regโ treat the register named reg as a fixed register; generated code should never refer to it (except 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 does not have a negative form, because it specifies a three-way choice. It's giving "there are three doors and you picked the fixed one" ๐ช
-fcall-used-regโ treat the register named reg as an allocable register that gets clobbered by function calls. It may be allocated for temporaries or variables that don't live across a call. Functions compiled this way do not save and restore the register reg.
It is an error to use this flag with the frame pointer or stack pointer. And using this flag for other registers that have fixed pervasive roles in the machine's execution model produces disastrous results. ๐
This flag does not have a negative form, because it specifies a three-way choice.
-fcall-saved-regโ treat the register named reg as an allocable register saved by functions. It may be allocated even for temporaries or variables that live across a call. Functions compiled this way save and restore the register reg if they use it.
It is an error to use this flag with the frame pointer or stack pointer. And using this flag for other registers that have fixed pervasive roles in the machine's execution model produces disastrous results. ๐
A different sort of disaster results from using this flag for a register in which function values may be returned. Yeah. Two flavors of disaster, iconic.
This flag does not have a negative form, because it specifies a three-way choice.
-fpack-struct[=n]โ with no value specified, pack all structure members together without holes. When a value is specified (and it must be a small power of two), pack structure members according to this value, representing the maximum alignment โ that is, objects with default alignment requirements larger than this are output potentially unaligned at the next fitting location.
Warning: the -fpack-struct switch causes GCC to generate code that is not binary compatible with code generated without that switch. Additionally, it makes the code suboptimal. Use it to conform to a non-default application binary interface.
-fleading-underscoreโ this option and its counterpart,-fno-leading-underscore, forcibly change the way C symbols are represented in the object file. One use is to help link with legacy assembly code ๐
Warning: the -fleading-underscore switch causes GCC to generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface. Not all targets provide complete support for this switch.
-ftls-model=modelโ change up the thread-local storage model being used. The model argument should be one ofglobal-dynamic,local-dynamic,initial-execorlocal-exec. Note that the choice is subject to optimization: the compiler may use a more efficient model for symbols not visible outside of the translation unit, or if-fpicis not given on the command line.
The default without -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, say, HP-PA or IA-64 โ do nothing.
A trampoline is a small piece of code created at run time on the stack when the address of a nested function is taken, and it's used to call the nested function indirectly. So yeah, it requires the stack to be made executable for the program to work properly. ๐
-fno-trampolines is enabled by default on a language-by-language basis to let the compiler avoid generating them โ if it computes that this is safe โ and replace them with descriptors. Descriptors are made up of data only, but the generated code must be prepared to deal with them. As of this writing, -fno-trampolines is enabled by default only for Ada.
Moreover, code compiled with -ftrampolines and code compiled with -fno-trampolines are not binary compatible if nested functions are present. This option must therefore be used on a program-wide basis and be manipulated with extreme care.
For languages other than Ada, the -ftrampolines and -fno-trampolines options currently have no effect, and trampolines are always generated on platforms that need them for nested functions.
-ftrampoline-impl=[stack|heap]โ by default, trampolines are generated on the stack. But certain platforms (like the Apple M1) don't permit an executable stack. Compiling with-ftrampoline-impl=heapgenerates calls to__gcc_nested_func_ptr_createdand__gcc_nested_func_ptr_deletedin order to allocate and deallocate trampoline space on the executable heap. These functions are implemented in libgcc, and will only be provided on specific targets: x86_64 Darwin, x86_64 and aarch64 Linux.
PLEASE NOTE: Heap trampolines are not guaranteed to be correctly deallocated if yousetjmp, instantiate nested functions, and thenlongjmpback to a state prior to having allocated those nested functions. ๐
-fvisibility=[default|internal|hidden|protected]โ set the default ELF image symbol visibility to the specified option โ every symbol gets marked with this unless it's overridden within the code. Using this feature can very substantially improve linking and load times of shared object libraries, produce more optimized code, provide near-perfect API export and prevent symbol clashes. It is strongly recommended that you use this in any shared objects you distribute. Fr fr, do it.
Despite the nomenclature, default always means public โ like, available to be linked against from outside the shared object. protected and internal are pretty useless in real-world usage, so the only other commonly used option is hidden. The default if -fvisibility isn't specified is default, i.e., make every symbol public.
A good explanation of the benefits of making sure ELF symbols have the correct visibility is given by How To Write Shared Libraries by Ulrich Drepper (which can be found at <https://www.akkadia.org/drepper/>) โ however, a superior solution made possible by this option, to marking things hidden when the default is public, is to make the default hidden and mark things public. This is the norm with DLLs on Windows, and with -fvisibility=hidden and __attribute__ ((visibility("default"))) instead of __declspec(dllexport) you get almost identical semantics with identical syntax. This is a great boon to those working with cross-platform projects ๐
For those adding visibility support to existing code, you may find #pragma GCC visibility of use. This works by you enclosing the declarations you wish to set visibility for with (for example) #pragma GCC visibility push(hidden) and #pragma GCC visibility pop. Bear in mind that symbol visibility should be viewed as part of the API interface contract, and thus all new code should always specify visibility when it is not the default; i.e., declarations only for use within the local DSO should always be marked explicitly as hidden so as to avoid PLT indirection overheads โ making this abundantly clear also aids readability and self-documentation of the code. Note that due to ISO C++ specification requirements, operator new and operator delete must always be of default visibility.
Be aware that headers from outside your project โ in particular system headers and headers from any other library you use โ may not be expecting to be compiled with visibility other than the default. You may need to explicitly say #pragma GCC visibility push(default) before including any such headers ๐ซถ
okay so here's the tea on extern: those declarations are NOT affected by -fvisibility, which means a <em>ton</em> of code can just get recompiled with -fvisibility=hidden and literally zero modifications. ๐
But plot twist: that also means calls to extern functions with no explicit visibility end up going through the PLT. So the actually effective move is to use __attribute ((visibility)) and/or #pragma GCC visibility to tell the compiler which extern declarations should be treated as hidden. ๐ซถ
Also heads up โ -fvisibility does affect C++ vague linkage entities. So like, an exception class that gets thrown between DSOs has to be explicitly marked with default visibility, otherwise the type_info nodes won't get unified between the DSOs. no cap. ๐ญ
Want the whole overview of these techniques, their benefits and how to use them? It's at https://gcc.gnu.org/wiki/Visibility. ๐ฆ
-fstrict-volatile-bitfieldsโ bestie, use this one when accesses to volatile bit-fields (or other structure fields, though the compiler usually honors those types anyway) should be a single access of the width of the field's type, aligned to a natural alignment if possible. Think targets with memory-mapped peripheral registers that need every such access to be 16 bits wide โ with this flag you can declare all peripheral bit-fields asunsigned short(assuming short is 16 bits on those targets) and force GCC to use 16-bit accesses instead of, perhaps, a more efficient 32-bit access. โจ
If this option is disabled, the compiler just uses the most efficient instruction. In the previous example, that might be a 32-bit load instruction, even though that accesses bytes that don't contain any portion of the bit-field, or memory-mapped registers unrelated to the one being updated. ๐
In some cases โ like when the packed attribute is applied to a structure field โ it may not be possible to access the field with a single read or write that's correctly aligned for the target machine. In that case GCC falls back to generating multiple accesses rather than code that will fault or truncate the result at run time.
Note: due to restrictions of the C/C++11 memory model, write accesses are not allowed to touch non bit-field members. So it's recommended to define all bits of the field's type as bit-field members. fr fr.
The default value of this option is determined by the application binary interface for the target processor.
-fsync-libcallsโ this one controls whether any out-of-line instance of the__syncfamily of functions may be used to implement the C++11__atomicfamily of functions. ๐ง
The default value of this option is enabled, so the only useful form of the option is -fno-sync-libcalls. This option is used in the implementation of the libatomic runtime library.
-fzero-init-padding-bits=valueโ guarantees zero initialization of padding bits in automatic variable initializers. ๐
Certain languages guarantee zero initialization of padding bits in certain cases, e.g. C23 when using empty initializers ({}), or C++ when using zero-initialization, or C guarantees that fields not specified in an initializer have their padding bits zero initialized. This option lets you change when padding bits in initializers are guaranteed to be zero initialized.
The default is -fzero-init-padding-bits=standard, which makes no further guarantees than the corresponding standard. E.g.
struct A { char a; unsigned long long b; char c; };
union B { char a; unsigned long long b; };
struct A a = {}; // C23 guarantees padding bits are zero.
struct A b = { 1, 2, 3 }; // No guarantees.
union B c = {}; // C23 guarantees padding bits are zero.
union B d = { 1 }; // No guarantees.
-fzero-init-padding-bits=unions guarantees zero initialization of padding bits in unions on top of what the standards guarantee, if the initializer of an union is empty (then all bits of the union are zero initialized) or if the initialized member of the union is smaller than the size of the union (in that case guarantees padding bits outside of the initialized member to be zero initialized). This was the GCC behavior before GCC 15 and in the above example guarantees zero initialization of last sizeof (unsigned long long) - 1 bytes in the union. ๐
-fzero-init-padding-bits=all guarantees additionally zero initialization of padding bits of other aggregates, so the padding in between b.a and b.b (if any) and tail padding in the structure (if any). ๐ธ
๐ ๏ธ GCC Developer Options ๐ ๏ธ
Okay so this whole section is for the GCC devs themselves โ compiler testing, investigating compiler bugs, and hunting down compile-time performance problems. ๐ It includes options that produce debug dumps at various points in the compilation; options that print statistics like memory use and execution time; and options that print info about GCC's configuration, like where it searches for libraries. Lowkey 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, phase letter, and pass name. The base dump file name is the name of output file produced by the compiler if explicitly specified and not an executable; otherwise it is the source file name. The pass number is determined by the order passes are registered with the compiler's pass manager. This is generally the same as the order of execution, but passes registered by plugins, target-specific passes, or passes that are otherwise registered late are numbered higher than the pass named final, even if they are executed earlier. The phase letter is one of i (inter-procedural analysis), l (language-specific), r (RTL), or t (tree). The files are created in the directory of the output file. โจ
-fcallgraph-info-fcallgraph-info=MARKERSโ makes the compiler output callgraph information for the program, on a per-object-file basis. ๐ The information is generated in the common VCG format. It can be decorated with additional, per-node and/or per-edge information, if a list of comma-separated markers is additionally specified. When thesumarker is specified, the callgraph is decorated with stack usage information; it is equivalent to-fstack-usage. When thedamarker is specified, the callgraph is decorated with information about dynamically allocated objects. ๐ฆ
When compiling with -flto, no callgraph information is output along with the object file. At LTO link time, -fcallgraph-info may generate multiple callgraph information files next to intermediate LTO output files.
-dletters--dump=letters--dump letters-fdump-rtl-pass-fdump-rtl-pass-options-fdump-rtl-pass-options=filenameโ says to make debugging dumps during compilation at times specified by letters when using-dor by pass when using-fdump-rtl. This is used for debugging the RTL-based passes of the compiler. ๐ฅ
Some -dletters switches have different meaning when -E is used for preprocessing.
The -options form allows greater control over the details of the dump. See -fdump-tree.
Here are actual instances of command-line options following these patterns and their meanings โ get comfy, this is a long list bestie ๐:
-fdump-rtl-alignmentsโ dump after branch alignments have been computed.-fdump-rtl-asmconsโ dump after fixing rtl statements that have unsatisfied in/out constraints.-fdump-rtl-auto_inc_decโ dump after auto-inc-dec discovery. This pass is only run on architectures that have auto inc or auto dec instructions.-fdump-rtl-barriersโ dump after cleaning up the barrier instructions.-fdump-rtl-bbpartโ dump after partitioning hot and cold basic blocks.-fdump-rtl-bbroโ dump after block reordering.-fdump-rtl-btl1-fdump-rtl-btl2โ-fdump-rtl-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โ dumps the RTL after the machine dependent reorganization pass runs, but only if that pass even exists for your target. no pass, no dump, bestie ๐-fdump-rtl-mode_swโ dumps after those redundant mode switches get yeeted.-fdump-rtl-rnregโ dumps after register renumbering.-fdump-rtl-outof_cfglayoutโ dumps after converting out of cfglayout mode.-fdump-rtl-peephole2โ dumps after the peephole pass does its lil peek-a-boo.-fdump-rtl-postreloadโ dumps after post-reload optimizations.-fdump-rtl-pro_and_epilogueโ dumps after the function prologues and epilogues get generated.-fdump-rtl-sched1and-fdump-rtl-sched2โ these two enable dumping after the basic block scheduling passes. two passes, two dumps, we love a duo ๐ซถ-fdump-rtl-reeโ dumps after sign/zero extension elimination.-fdump-rtl-seqabstrโ dumps after common sequence discovery.-fdump-rtl-shortenโ dumps after shortening branches.-fdump-rtl-split1,-fdump-rtl-split2,-fdump-rtl-split3,-fdump-rtl-split4,-fdump-rtl-split5โ these enable dumping after five rounds of instruction splitting. five. whole. rounds.-fdump-rtl-smsโ dumps after modulo scheduling. heads up tho: this pass only runs on some architectures, so don't come for me if your dump is empty ๐-fdump-rtl-stackโ dumps after converting from GCC's "flat register file" registers over to the x87's stack-like registers. again: this pass is only run on x86 variants. x86 girlies only ๐-fdump-rtl-subreg1and-fdump-rtl-subreg2โ these enable dumping after the two subreg expansion passes.-fdump-rtl-vartrackโ dumps after variable tracking.-fdump-rtl-vregsโ dumps after converting virtual registers to hard registers.-fdump-rtl-webโ dumps after live range splitting.-fdump-rtl-regclass,-fdump-rtl-subregs_of_mode_init,-fdump-rtl-subregs_of_mode_finish,-fdump-rtl-dfinit,-fdump-rtl-dfinishโ okay so these dumps are defined but always produce empty files. yes literally. they exist, they do nothing, they're the group chat members who never type. iconic behaviour honestly ๐-da,--dump=a,-fdump-rtl-allโ produce all the dumps listed above. the whole collection, no crumbs left.-dA,--dump=Aโ annotates the assembler output with miscellaneous debugging information.-dD,--dump=Dโ dumps all macro definitions at the end of preprocessing, on top of the normal output.-dH,--dump=Hโ produces a core dump whenever an error occurs. like, an actual core dump. be so serious before you turn this one on bestie ๐ญ-dp,--dump=pโ annotates the assembler output with a comment telling you which pattern and alternative is used. the length and cost of each instruction get printed too.-dP,--dump=Pโ dumps the RTL in the assembler output as a comment before each instruction. also turns on the-dpannotation. two-for-one, we love it ๐-dx,--dump=xโ just generates RTL for a function instead of compiling it. usually you'd pair it with-fdump-rtl-expand.
-fdump-debugโ dumps the debugging information generated during the debug generation phase.-fdump-earlydebugโ dumps the debugging information generated during the early debug generation phase.-fdump-noaddrโ when doing debugging dumps, this suppresses address output. why do you care? because it makes it way more feasible to rundiffon debugging dumps from compiler invocations that used different compiler binaries and/or different text / bss / data / heap / stack / dso start locations. โจdiff-ableโจ-freport-bugโ collects and dumps debug information into a temporary file if an internal compiler error (ICE) occurs. basically it makes a lil receipt when things go wrong ๐ซถ-fdump-unnumberedโ when doing debugging dumps, suppresses instruction numbers and address output. this makesdiff-ing debugging dumps way more feasible across compiler invocations with different options โ especially with and without-g.-fdump-unnumbered-linksโ when doing debugging dumps (see the-doption above), suppresses instruction numbers for the links pointing to the previous and next instructions in a sequence.-fdump-internal-locationsโ dumps detailed information about GCC's internal representation of source code locations.-fdump-ipa-switch,-fdump-ipa-switch-optionsโ these control the dumping at various stages of inter-procedural analysis language tree, out to a file. the file name gets generated by appending a switch-specific suffix to the source file name, and the file lands in the same directory as the output file. here's what dumps you can get:allโ enables all inter-procedural analysis dumps.cgraphโ dumps information about call-graph optimization, unused function removal, and inlining decisions.inlineโ dumps after function inlining.strubmโ dumps after selecting "strub" modes, and recording those selections as function attributes.strubโ dumps "strub" transformations: interface changes, function wrapping, and insertion of builtin calls for stack scrubbing and watermarking.
on top of all that, the options -optimized, -missed, -note, and -all can be provided, with the same meaning as for -fopt-info, defaulting to -optimized.
so for example, -fdump-ipa-inline-optimized-missed will emit information on callsites that were inlined, along with callsites that were not inlined. the receipts, bestie ๐
by default, the dump contains messages about successful optimizations (equivalent to -optimized) together with low-level details about the analysis.
-fdump-ipa-clonesโ creates a dump file with information about the creation of call graph node clones and the removals of call graph nodes during inter-procedural optimizations and transformations. its main intended use is that tools that create live-patches can determine the set of functions that need to be live-patched to completely replace a particular function (see-flive-patching). the file name is generated by appending the suffix"ipa-clones"to the source file name, and the file is created in the same directory as the output file. every entry in the file sits on its own separate line containing semicolon separated fields.
in the case of call graph clone creation, the individual fields are:
- String
"Callgraph clone". - Name of the function being cloned as it is presented to the assembler.
- A number that uniquely represents the function being cloned in the call graph. note that the number is unique only within a compilation unit or within whole-program analysis but is likely to be different in the two phases.
- The file name of the source file where the function is defined.
- The line on which the function definition is located.
- The column where the function definition is located.
- Name of the new function clone as it is presented to the assembler.
- A number that uniquely represents the new function clone in the call graph. note that the number is unique only within a compilation unit or within whole-program analysis but is likely to be different in the two phases.
- The file name of the source file where the source code location of the new clone points to.
- The line to which the source code location of the new clone points to.
- The column to which the source code location of the new clone points to.
- A string that determines the reason for cloning.
in the case of call graph clone removal, the individual fields are:
- String
"Callgraph removal". - Name of the function being removed as it would be presented to the assembler.
- A number that uniquely represents the function being cloned in the call graph. note that the number is unique only within a compilation unit or within whole-program analysis but is likely to be different in the two phases.
- The file name of the source file where the function is defined.
- The line on which the function definition is located.
- The column where the function definition is located.
-fdump-langโ dumps language-specific information. the file name is made by appending.langto the source file name.-fdump-lang-all,-fdump-lang-switch,-fdump-lang-switch-options,-fdump-lang-switch-options=filenameโ these control the dumping of language-specific information. the options and filename portions behave as described in the-fdump-treeoption.-fdump-tree-allenables all language-specific dumps; other options vary with the language. for instance, see-fdump-passesโ prints onstderrthe list of optimization passes that are turned on and off by the current command-line options.-fdump-statistics-optionโ enables and controls dumping of pass statistics into a separate file. the file name is generated by appending a suffix ending in.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.-fdump-tree-all,-fdump-tree-switch,-fdump-tree-switch-options,-fdump-tree-switch-options=filenameโ these control the dumping at various stages of processing the intermediate language tree, out to a file. if the-optionsform is used, options is a list of-separated options which control the details of the dump. not all options are applicable to all dumps; the ones that aren't meaningful just get ignored. here's the menu:addressโ print the address of each node. usually this isn't meaningful because it changes according to the environment and source file. its primary use is for tying up a dump file with a debug environment.asmnameโ if"DECL_ASSEMBLER_NAME"has been set for a given decl, use that in the dump instead of"DECL_NAME". its primary use is ease of working backward from mangled names in the assembly file.
slimโ the "keep it cute and compact" modifier, lowkey does three different things depending on what you're dumping:- When you're dumping front-end intermediate representations, it stops GCC from dumping the members of a scope or the body of a function just because that scope got reached. Those items only get dumped when they're directly reachable by some other path.
- When you're dumping pretty-printed trees, it inhibits dumping the bodies of control structures.
- When you're dumping RTL, it prints the RTL in slim (condensed) form instead of the default LISP-like representation. condensed slay โจ
rawโ prints a raw representation of the tree. By default, trees get pretty-printed into a C-like representation instead. So this is the no-makeup, no-filter version ๐detailsโ turns on more detailed dumps (tho ngl, not every dump option honors it ๐). It also pulls in information from the optimization passes.statsโ dumps all sorts of statistics about the pass (again, not every dump option honors this one either).blocksโ shows basic block boundaries. Heads up: it's disabled in raw dumps.graphโ for each of the other indicated dump files (-fdump-rtl-pass), it dumps a representation of the control flow graph that's suitable for viewing with GraphViz, intofile.passid.pass.dot. Every function in the file gets pretty-printed as a subgraph, so GraphViz can render them all in a single plot. And RTL is always dumped in slim form here, no exceptions bestie.vopsโ shows virtual operands for every statement.linenoโ shows line numbers for statements.uidโ shows the unique ID (DECL_UID) for each variable.verboseโ shows the tree dump for each statement.ehโ shows the EH region number holding each statement.scevโ shows scalar evolution analysis details.optimizedโ shows optimization information (only available in certain passes).missedโ shows missed optimization information (only available in certain passes). the "you could've had it all" report ๐ญnoteโ shows other detailed optimization information (only available in certain passes).foldingโ dumps information about match-and-simplify (match.pd) patterns, when they get applied.allโ turns on all the options, exceptraw,slim,verboseandlineno.optallโ turns on all the optimization options, i.e.optimized,missed, andnote.
Okay so now, how do you even figure out which tree dumps exist, or find the dump for the pass you actually care about? Follow these steps bestie, it's giving treasure hunt ๐บ๏ธ
- Invoke GCC with
-fdump-passesand in the stderr output, look for a code that corresponds to the pass you're 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. So like, 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 it 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 get attached fr fr
-fopt-info-fopt-info-options-fopt-info-options=filename
Controls optimization dumps from various optimization passes. If the -options form is used, options is a list of - separated option keywords to select the dump details and optimizations.
The options can be divided into three groups:
- options describing what kinds of messages should be emitted,
- options describing the verbosity of the dump, and
- options describing which optimizations should be included.
The options from each group can be freely mixed as they are non-overlapping. However, in case of any conflicts, the later options override the earlier options on the command line. last one wins, that's the rule ๐
The following options control which kinds of messages should be emitted:
optimizedโ prints information when an optimization is successfully applied. It's up to a pass to decide which information is relevant. For example, the vectorizer passes print the source location of loops which are successfully vectorized. ate โจmissedโ prints information about missed optimizations. Individual passes control which information to include in the output.noteโ prints verbose information about optimizations, such as certain transformations, more detailed messages about decisions etc.allโ prints detailed optimization information. This includesoptimized,missed, andnote.
The following option controls the dump verbosity:
internalsโ by default, only "high-level" messages are emitted. This option enables additional, more detailed, messages, which are likely to only be of interest to GCC developers. 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 the optimization groups listed above.
If options is omitted, it defaults to optimized-optall, which means to dump messages about successful optimizations from all the passes, omitting messages that are treated as "internals".
If the filename is provided, then the dumps from all the applicable optimizations get concatenated into the filename. Otherwise the dump is output onto stderr. Though multiple -fopt-info options are accepted, only one of them can include a filename. If other filenames are provided then all but the first such option are ignored. ๐ซ
Note that the output filename is overwritten in case of multiple translation units. If a combined output from multiple translation units is desired, stderr should be used instead.
In the following example, the optimization info is output to stderr:
gcc -O3 -fopt-info
This example:
gcc -O3 -fopt-info-missed=missed.all
outputs missed optimization report from all the passes into missed.all, and this one:
gcc -O2 -ftree-vectorize -fopt-info-vec-missed
prints information about missed optimization opportunities from vectorization passes on stderr. Note that -fopt-info-vec-missed is equivalent to -fopt-info-missed-vec. The order of the optimization group names and message types listed after -fopt-info does not matter. order? never heard of her โจ
As another example,
gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
outputs information about missed optimizations as well as optimized locations from all the inlining passes into inline.txt.
Finally, consider:
gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
Here the two output filenames vec.miss and loop.opt are in conflict since only one output file is allowed. In this case, only the first option takes effect and the subsequent options are ignored. Thus only vec.miss is produced, which contains dumps from the vectorizer about missed opportunities. the second one is just gone bestie, rip ๐
-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 within the compressed JSON file is subject to change. don't build your whole personality on it ๐ญ
It's roughly equivalent to a machine-readable version of -fopt-info-all, as a collection of messages with source file, line number and column number, with the following additional data for each message:
- the execution count of the code being optimized, along with metadata about whether this was from actual profile data, or just an estimate, allowing consumers to prioritize messages by code hotness,
- the function name of the code being optimized, where applicable,
- the "inlining chain" for the code being optimized, so that when a function is inlined into several different places (which might themselves be inlined), the reader can distinguish between the copies,
- objects identifying those parts of the message that refer to expressions, statements or symbol-table nodes, which of these categories they are, and, when available, their source code location,
- the GCC pass that emitted the message, and
- the location in GCC's own code from which the message was emitted
Additionally, some messages are logically nested within other messages, reflecting implementation details of the optimization passes.
-fsched-verbose=nโ on targets that use instruction scheduling, this option controls 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 tea ๐
-fenable-kind-pass-fdisable-kind-pass=range-list
This is a set of options that are used to explicitly disable/enable optimization passes. These options are intended for use for debugging GCC. Compiler users should use regular options for enabling/disabling passes instead. ๐จ like, this is dev-only territory bestie, not your everyday vibe ๐จ
-fdisable-ipa-passโ say bye-bye ๐ to IPA pass pass. pass is the pass name. But heads up bestie โ if that same pass gets statically invoked in the compiler more than once, you gotta tack on a sequential number starting from1. Otherwise how's GCC supposed to know which one you mean ๐ญ-fdisable-rtl-pass,-fdisable-rtl-pass=range-listโ disables the RTL pass pass. Same deal as above: pass is the pass name, and if it's statically invoked multiple times you append a sequential number starting from1. Now range-list is a comma-separated list of function ranges or assembler names โ she's flexible like that ๐ Each range is a number pair separated by a colon, and it's inclusive on both ends. If a range is trivial you can just simplify the pair down to a single number, no drama. If the function's call graph node's uid falls inside one of your specified ranges, the pass gets disabled for that function. The uid shows up in the function header of a dump file, and you can dump the pass names with-fdump-passes. iykyk โจ-fdisable-tree-pass,-fdisable-tree-pass=range-listโ disables tree pass pass. For the description of the option arguments, go peek at-fdisable-rtl. It's giving "same energy, different pass" ๐-fenable-ipa-passโ enables IPA pass pass. pass is the pass name, and yes, if the same pass is statically invoked in the compiler multiple times, append a sequential number starting from1. Same rules, bestie ๐ซถ-fenable-rtl-pass,-fenable-rtl-pass=range-listโ enables RTL pass pass. See-fdisable-rtlfor the option argument description and examples. Iconic of her to share notes ๐-fenable-tree-pass,-fenable-tree-pass=range-listโ enables tree pass pass. Again,-fdisable-rtlhas the description of the option arguments. Reuse, recycle, slay โป๏ธ
Here are some examples showing uses of these options, so you can copy-paste and feel powerful ๐
# disable ccp1 for all functions
-fdisable-tree-ccp1
# disable complete unroll for function whose cgraph node uid is 1
-fenable-tree-cunroll=1
# disable gcse2 for functions at the following ranges [1,1],
# [300,400], and [400,1000]
# disable gcse2 for functions foo and foo2
-fdisable-rtl-gcse2=foo,foo2
# disable early inlining
-fdisable-tree-einline
# disable ipa inlining
-fdisable-ipa-inline
# enable tree full unroll
-fenable-tree-unroll
-fchecking,-fchecking=nโ turns on internal consistency checking ๐ The default depends on how the compiler was configured, so it's giving "it depends" energy. And-fchecking=2turns on further internal consistency checking that might affect code generation. Not a vibe to enable lightly, but do you boo โจ-frandom-seed=stringโ this one 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. And here's the slay: you can use-frandom-seedto produce reproducibly identical object files. Reproducible builds girlies rise ๐
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. Math is doing the heavy lifting fr fr ๐งฎ
The string should be different for every file you compile. Don't be lazy about this one bestie, it's literally the whole point ๐ญ
-save-temps,--save-tempsโ stores the usual "temporary" intermediate files permanently ๐ She names them as auxiliary output files, as specified described under-dumpbaseand-dumpdir. Now they're not temporary, they're committed ๐
When you use it in combination with the -x command-line option, -save-temps is sensible enough to avoid overwriting an input source file with the same extension as an intermediate file. She's thoughtful like that ๐ซถ The corresponding intermediate file may be obtained by renaming the source file before using -save-temps.
-save-temps=cwdโ equivalent to-save-temps -dumpdir ./. That's it, that's the whole thing ๐-save-temps=objโ equivalent to-save-temps -dumpdir outdir/, whereoutdir/is the directory of the output file specified after the-ooption, including any directory separators. And if you don't use the-ooption? Then the-save-temps=objswitch behaves like-save-temps=cwd. She adapts, she's flexible โจ-specs=file,--specs=file,--specs fileโ processes file after the compiler reads in the standard specs file, so it can override the defaults that thegccdriver program uses when 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, from left to right โก๏ธ Order matters, no cap.-time[=file]โ reports the CPU time taken by each subprocess in the compilation sequence โฑ๏ธ For C source files, this is the compiler proper and assembler (plus the linker if linking is done).
Without 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 is time spent executing the program itself. The second number is "system time", time spent executing operating system routines on behalf of the program. Both numbers are in seconds โณ
With the specification of an output file, the output is appended to the named file, and it looks like this:
0.12 0.01 cc1 <options>
0.00 0.01 as <options>
The "user time" and the "system time" get moved before the program name, and the options passed to the program are displayed, so that later you can tell what file was being compiled, and with which options. Receipts, preserved ๐๐
-fdump-final-insns[=file]โ dumps the final internal representation (RTL) to file ๐ค If the optional argument is omitted (or if file is.), the name of the dump file is determined by appending.gkdto the dump base name โ see-dumpbase. She names her own files, iconic ๐-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 the second compilation. Then dump the final internal representation in both compilations, and print an error if they differ ๐ It's giving "trust but verify".
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. She said "no more" ๐
To verify full coverage during -fcompare-debug testing, set GCC_COMPARE_DEBUG to say -fcompare-debug-not-overridden, which GCC rejects as an invalid option in any actual compilation (rather than preprocessing, assembly or linking). To get just a warning, setting GCC_COMPARE_DEBUG to -w%n-fcompare-debug not overridden will do. Sneaky little trick, but it works ๐
-fcompare-debug-secondโ this option is implicitly passed to the compiler for the second compilation requested by-fcompare-debug, along with options to silence warnings, and omitting other options that would cause the compiler to produce output to files or to standard output as a side effect. Dump files and preserved temporary files are renamed so as to contain the.gkadditional extension during the second compilation, to avoid overwriting those generated by the first ๐ท๏ธ
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. Niche use case, but respect ๐
-gtoggleโ turns off generation of debug info, if leaving out this option generates it, or turns it on at level 2 otherwise ๐ The position of this argument in the command line does not matter; it takes effect after all other options are processed, and it does so only once, no matter how many times it's given. One and done, bestie. This is mainly intended to be used with-fcompare-debug๐-fvar-tracking-assignments-toggleโ toggles-fvar-tracking-assignments, in the same way that-gtoggletoggles-g. Matchy matchy ๐-Qโ when used on the command line prior to--help=,-Qacts as a modifier to the help output. Context is everything โจ
Otherwise, this option makes the compiler print out each function name as it is compiled, and print some statistics about each pass when it finishes. Chatty queen ๐ฌ
-ftime-reportโ makes the compiler print some statistics to stderr about the time consumed by each pass when it finishes โฑ๏ธ
If SARIF output of diagnostics was requested via -fdiagnostics-format=sarif-file or -fdiagnostics-format=sarif-stderr then the -ftime-report information is instead emitted in JSON form as part of SARIF output ๐ The precise format of this JSON data is subject to change, and the values may not exactly match those emitted to stderr due to being written out at a slightly different place within the compiler. So like... don't build your whole pipeline on it, okay? ๐ญ
-ftime-report-detailsโ records the time consumed by infrastructure parts separately for each pass. Extra granularity, extra slay ๐-fira-verbose=nโ controls 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 to stderr using the same format as n minus10. Math again, sorry bestie ๐งฎ-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 โ she keeps it fresh, unpredictable, a little mysterious ๐ It is meant to be useful to GCC developers when processing object files in LTO mode (via-flto).
Disabled by default.
-flto-report-wpaโ like-flto-report, but only print for the WPA phase of link-time optimization. Same girl, smaller spotlight โจ-fmem-reportโ makes the compiler print some statistics about permanent memory allocation when it finishes ๐ง She's telling you where the memory went, bestie.-fmem-report-wpaโ makes the compiler print some statistics about permanent memory allocation for the WPA phase only. Just that phase, no extras ๐ฏ-fpre-ipa-mem-report,-fpost-ipa-mem-reportโ makes the compiler print some statistics about permanent memory allocation before or after interprocedural optimization. Pick your moment, both are valid ๐ธ-fmultiflagsโ this option enables multilib-aware "TFLAGS" to be used to build target libraries with options different from those the compiler is configured to use by default, through the use of specs set up by compiler internals, by the target, or by builders at configure time ๐ ๏ธ It's giving very "inside baseball" and honestly? We respect the builders fr fr ๐ซถ
okay so, just like TFLAGS, this is the whole build the target libs for a chill portable baseline environment vibe โ while the compiler itself defaults to the more demanding ones. Which is genuinely useful, bestie, because users can just... override the defaults the compiler was configured with to build their own programs? Easy. Whereas rebuilding the runtime libraries is usually not as easy or desirable. It's giving โจconvenienceโจ.
Unlike TFLAGS though, using specs means you can select different flags for different multilibs. The way to do that is to build with make TFLAGS=-fmultiflags, after configuring --with-specs=%{fmultiflags:...}. ๐
This option is discarded by the driver once it's done processing driver self spec. No cap.
It's also useful to check that TFLAGS are being used to build all target libraries, by configuring a non-bootstrap compiler --with-specs='%{!fmultiflags:%emissing TFLAGS}' and building the compiler and target libraries. ๐ฆ
-fprofile-reportโ makes the compiler print some stats about the consistency of the (estimated) profile and the effect of individual passes. Cute little report card fr fr.-fstack-usageโ makes the compiler output stack usage info for your program, per-function. The filename for the dump is made by appending.suto the auxname. And auxname is generated from the name of the output file (if explicitly specified and it's not an executable), otherwise it's the basename of the source file. An entry is made up of three fields:- The name of the function.
- A number of bytes.
- One or more qualifiers:
static,dynamic,bounded.
The qualifier static means the function manipulates the stack statically: a fixed number of bytes are allocated for the frame on function entry and released on function exit; no stack adjustments are otherwise made in the function. The second field is this fixed number of bytes.
The qualifier dynamic means the function manipulates the stack dynamically: in addition to the static allocation described above, stack adjustments are made in the body of the function, for example to push/pop arguments around function calls. If the qualifier bounded is also present, the amount of these adjustments is bounded at compile time and the second field is an upper bound of the total amount of stack used by the function. If it's not present, the amount of these adjustments is not bounded at compile time and the second field only represents the bounded part. ๐
-fstatsโ emit statistics about front-end processing at the end of the compilation. This option is supported only by the C++ front end, and ngl the info is generally only useful to the G++ development team. iykyk.-fdbg-cnt-listโ print the name and the counter upper bound for all debug counters.-fdbg-cnt=counter-value-listโ set the internal debug counter lower and upper bound. counter-value-list is a comma-separated list ofname:lower_bound1-upper_bound1 [:lower_bound2-upper_bound2...]tuples which sets the name of the counter and list of closed intervals. The lower_bound is optional and is zero initialized if not set. For example, with-fdbg-cnt=dce:2-4:10-11,tail_call:10,dbg_cnt(dce)returns true only for the second, third, fourth, tenth and eleventh invocation. Fordbg_cnt(tail_call)true is returned for the first 10 invocations. ๐ง-print-autofdo-gcov-version,--print-autofdo-gcov-versionโ print the current version of GCOV being used by the AutoFDO infrastructure. Just the version, nothing else, periodt.-print-file-name=library,--print-file-name=library,--print-file-namelibraryโ 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. King behavior honestly ๐-print-multi-directory,--print-multi-directoryโ print the directory name corresponding to the multilib selected by any other switches present in the command line. This directory is supposed to exist inGCC_EXEC_PREFIX.-print-multi-lib,--print-multi-libโ print the mapping from multilib directory names to compiler switches that enable them. The directory name is separated from the switches by;, and each switch starts with an@instead of the-, without spaces between multiple switches. This is supposed to ease shell processing. ๐-print-multi-os-directory,--print-multi-os-directoryโ print the path to OS libraries for the selected multilib, relative to somelibsubdirectory. If OS libraries are present in thelibsubdirectory and no multilibs are used, this is usually just.; if OS libraries are present inlibsuffix sibling directories this prints e.g.../lib64,../libor../lib32; or if OS libraries are present inlib/subdirsubdirectories it prints e.g.amd64,sparcv9orev6. So many flavors of path, we love options ๐-print-multiarch,--print-multiarchโ print the path to OS libraries for the selected multiarch, relative to somelibsubdirectory.-print-prog-name=program,--print-prog-name=program,--print-prog-nameprogramโ like-print-file-name, but searches for a program such ascpp.-print-libgcc-file-name,--print-libgcc-file-nameโ same as-print-file-name=libgcc.a.
This is useful when you use -nostdlib or -nodefaultlibs but you do want to link with libgcc.a. You can do:
gcc -nostdlib <files>... `gcc -print-libgcc-file-name`
-print-search-dirs,--print-search-dirsโ print the name of the configured installation directory and a list of program and library directoriesgccsearches โ and don't do anything else. ๐ซถ
This is useful when gcc prints the error message installation problem, cannot exec cpp0: No such file or directory. To resolve this you either need to put cpp0 and the other compiler components where gcc expects to find them, or you can set the environment variable GCC_EXEC_PREFIX to the directory where you installed them. Don't forget the trailing /. ๐ญ
-print-sysroot,--print-sysrootโ print the target sysroot directory that is used during compilation. This is the target sysroot specified either at configure time or using the--sysrootoption, possibly with an extra suffix that depends on compilation options. If no target sysroot is specified, the option prints nothing. Silently. Iconic.-print-sysroot-headers-suffix,--print-sysroot-headers-suffixโ print the suffix added to the target sysroot when searching for headers, or give an error if the compiler is not configured with such a suffix โ and don't do anything else.-dumpmachineโ print the compiler's target machine (for example,i686-pc-linux-gnu) โ and don't do anything else.-dumpversionโ print the compiler version (for example,3.0,6.3.0or7) โ and don't do anything else. This is the compiler version used in filesystem paths and specs. Depending on how the compiler has been configured it can be just a single number (major version), two numbers separated by a dot (major and minor version) or three numbers separated by dots (major, minor and patchlevel version). It's giving mystery box ๐-dumpfullversionโ print the full compiler version โ and don't do anything else. The output is always three numbers separated by dots: major, minor and patchlevel version.-dumpspecsโ print the compiler's built-in specs โ and don't do anything else. (This is used when GCC itself is being built.) โจ--paramname=value,--param=name=value** โ GCC by convention uses parameters that can be specified on the command line instead of hard-wired constants to represent arbitrary compiler limits or heuristics. Many parameters are related to optimization; for example, GCC does not inline functions that contain more than a certain number of instructions. The static analyzer similarly uses parameters to limit complexity, link-time optimization uses parameters to control partitioning, and so on. Other parameters control aspects of GCC that are completely internal, such as its memory allocation and garbage collection strategy. Still others control target-specific behavior.
The --param option provides a uniform interface for specifying values for these compiler parameters. However โ and listen closely bestie โ the names of specific parameters, and the meaning of the values, are tied to the internals of the compiler, and are subject to change without notice in future releases. You should not depend on parameter settings for correct compilation of your program. They are exposed via the command line for the convenience of developers in debugging compilation problems or, in some cases, to provide workarounds for compiler bugs. ๐
๐ฏ Target-Specific Options ๐ฏ
Each target machine supported by GCC can have its own options โ for example, to allow you to compile for a particular processor variant or ABI, or to control optimizations specific to that machine. Similarly, GCC also has options that are specific to particular operating systems or runtime environments on the target.
By convention, the names of machine-specific options start with -m. Some configurations of the compiler also support additional target-specific options, usually for compatibility with other compilers on the same platform. ๐
๐ธ AArch64 Options ๐ธ
These options are defined for AArch64 implementations:
-mabi=nameโ generate code for the specified data model. Permissible values areilp32for SysV-like data model whereint,long intand pointers are 32 bits, andlp64for SysV-like data model whereintis 32 bits, butlong intand pointers are 64 bits.
The default depends on the specific target configuration. Note that the LP64 and ILP32 ABIs are not link-compatible; you must compile your entire program with the same ABI, and link with a compatible set of libraries.
The ilp32 model is deprecated. ๐ซ
-mbig-endianโ generate big-endian code. This is the default when GCC is configured for anaarch64_be-*-*target.-mlittle-endianโ generate little-endian code. This is the default when GCC is configured for anaarch64-*-*but not anaarch64_be-*-*target.-menable-sysreg-checkingโ generates an error message if an attempt is made to access a system register which is not available on the target architecture. Vibe check: failed ๐-mgeneral-regs-onlyโ okay so this one tells the compiler to only ever touch the general-purpose registers. No floating-point, no Advanced SIMD registers, none of that ๐ . But bestie, it does not put any restrictions on the assembler, just so you know.-mcmodel=tinyโ generate code for the tiny code model. The program and its statically defined symbols have to be within 1MB of each other. Programs can be statically or dynamically linked, no cap.-mcmodel=smallโ generate code for the small code model. The program and its statically defined symbols must live within 4GB of each other. Statically or dynamically linked, both fine. This is the default code model, so if you do nothing, this is the vibe โจ.-mcmodel=largeโ generate code for the large code model. It makes no assumptions about addresses and sizes of sections. Programs can be statically linked only. And heads up ๐จ:-mcmodel=largeis incompatible with-mabi=ilp32,-fpicand-fPIC.-mtp=nameโ pick which system register to use as the thread pointer. The valid values aretpidr_el0,tpidrro_el0,tpidr_el1,tpidr_el2,tpidr_el3. For backwards compatibility the aliasesel0,el1,el2,el3are also accepted. The default setting istpidr_el0. And the recommendation ๐: compile all code that's meant to interoperate with the same value of this option, otherwise you'll be accessing a different thread pointer from the wrong exception level and that's a mess fr fr.-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. It's giving "boundaries matter" energy.-momit-leaf-frame-pointer,-mno-omit-leaf-frame-pointerโ omit or keep the frame pointer in leaf functions. The former behavior (omitting) is the default ๐.-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offsetโ generate stack protection code using a canary at guard. The supported locations areglobalfor a global canary, orsysregfor a canary in an appropriate system register.
With that latter choice, the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset also specify which system register to use as the base register for reading the canary, and what offset from that base register to read from. There's no default register or offset โ this is entirely for use within the Linux kernel, iykyk ๐.
-mtls-dialect=descโ use TLS descriptors as the thread-local storage mechanism for dynamic accesses of TLS variables. This is the default.-mtls-dialect=traditionalโ use traditional TLS as the thread-local storage mechanism for dynamic accesses of TLS variables.-mtls-size=sizeโ specify the bit size of immediate TLS offsets. Valid values are12,24,32,48. This option requires binutils 2.26 or newer โญ.-mfix-cortex-a53-835769,-mno-fix-cortex-a53-835769โ enable or disable the workaround for the ARM Cortex-A53 erratum number 835769. What it does is insert aNOPinstruction between memory instructions and 64-bit integer multiply-accumulate instructions. This flag gets ignored if an architecture or cpu is specified on the command line that doesn't need the workaround. She's selective ๐ .-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 only passes the corresponding flag to the linker. Same deal as above: this flag is ignored if an architecture or cpu is specified on the command line that doesn't need the workaround.-mlow-precision-recip-sqrt,-mno-low-precision-recip-sqrtโ enable or disable the reciprocal square root approximation. This option only does anything if-ffast-mathor-funsafe-math-optimizationsis used too. Enabling it reduces the precision of reciprocal square root results to about 16 bits for single precision and to 32 bits for double precision. So like, fast but blurry ๐ธ.-mlow-precision-sqrt,-mno-low-precision-sqrtโ enable or disable the square root approximation. Same catch: it only has an effect if-ffast-mathor-funsafe-math-optimizationsis used as well. Enabling it reduces precision of square root results to about 16 bits for single precision and to 32 bits for double precision. And if you enable it, it implies-mlow-precision-recip-sqrt.-mlow-precision-div,-mno-low-precision-divโ enable or disable the division approximation. Again, only works with-ffast-mathor-funsafe-math-optimizations. Enabling it 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 extra code to track speculative execution through conditional branches. That tracking state can then be used by the compiler when expanding calls to__builtin_speculation_safe_valueso it can generate a more efficient code sequence ๐.-moutline-atomics,-mno-outline-atomicsโ enable or disable calls to out-of-line helpers to implement atomic operations. These helpers will, at runtime, figure out whether the LSE instructions from ARMv8.1-A can be used; if they can't, they fall back to the load/store-exclusive instructions that are present in the base ARMv8.0 ISA. Adaptable queen ๐ .
This option is only applicable when compiling for the base ARMv8.0 instruction set. If you're on a later revision โ like -march=armv8.1-a or -march=armv8-a+lse โ the ARMv8.1-Atomics instructions get used directly. Same thing applies when using -mcpu= and the selected cpu supports the lse feature. This option is on by default.
-mmax-vectorization,-mno-max-vectorizationโ enable or disable an override to the vectorizer cost model that makes vectorization always appear profitable. You can combine this with-mautovec-preferenceto get precise control over which ISA gets used for auto-vectorization. And unlike-fno-vect-cost-modelor-fvect-cost-model=unlimited, this option does not turn off cost comparison between different vector modes ๐.-mautovec-preference=nameโ force an ISA selection strategy for auto-vectorization. The possible values of name are:defaultโ use the default heuristics.asimd-onlyโ use only Advanced SIMD for auto-vectorization.sve-onlyโ use only SVE for auto-vectorization.prefer-asimdโ use both Advanced SIMD and SVE. Prefer Advanced SIMD when the costs are deemed equal.prefer-sveโ use both Advanced SIMD and SVE. Prefer SVE when the costs are deemed equal.
For best performance it is highly recommended to use-mcpuor-mtuneinstead. This parameter should only be used for code exploration. Not me telling you to be careful ๐ญ.
-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 table below summarizes the permissible values for arch and the features that they enable by default (arch value : Architecture : Includes by default):
armv8-a: Armv8-A :+fp,+simdarmv8.1-a: Armv8.1-A :armv8-a,+crc,+lse,+rdmaarmv8.2-a: Armv8.2-A :armv8.1-aarmv8.3-a: Armv8.3-A :armv8.2-a,+pauth,+fcma,+jscvtarmv8.4-a: Armv8.4-A :armv8.3-a,+flagm,+fp16fml,+dotprod,+rcpc2armv8.5-a: Armv8.5-A :armv8.4-a,+sb,+ssbs,+predres,+frintts,+flagm2armv8.6-a: Armv8.6-A :armv8.5-a,+bf16,+i8mmarmv8.7-a: Armv8.7-A :armv8.6-a,+wfxt,+xsarmv8.8-a: Armv8.8-a :armv8.7-a,+mopsarmv8.9-a: Armv8.9-a :armv8.8-aarmv9-a: Armv9-A :armv8.5-a,+sve,+sve2armv9.1-a: Armv9.1-A :armv9-a,+bf16,+i8mmarmv9.2-a: Armv9.2-A :armv9.1-a,+wfxt,+xsarmv9.3-a: Armv9.3-A :armv9.2-a,+mopsarmv9.4-a: Armv9.4-A :armv9.3-a,+sve2p1armv9.5-a: Armv9.5-A :armv9.4-a,cpa,+faminmax,+lutarmv8-r: Armv8-R :armv8-r
The value native is available on native AArch64 GNU/Linux and causes the compiler to pick the architecture of the host system ๐. This option has no effect if the compiler is unable to recognize the architecture of the host system. When -march=native is given and no other -mcpu or -mtune is given, then GCC will pick the host CPU as the CPU to tune for as well as select the architecture features from. That is, -march=native is treated as -mcpu=native ๐.
The permissible values for feature are listed in the sub-section on aarch64-feature-modifiers,,-march and -mcpu Feature Modifiers. Where conflicting feature modifiers are specified, the right-most feature is used.
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. Versatile icon ๐
.
-mtune=nameโ specify the name of the target processor for which GCC should tune the performance of the code. The permissible values for this option are:generic,cortex-a35,cortex-a53,cortex-a55,cortex-a57,cortex-a72,cortex-a73,cortex-a75,cortex-a76,cortex-a76ae,cortex-a77,cortex-a65,cortex-a65ae,cortex-a34,cortex-a78,cortex-a78ae,cortex-a78c,ares,exynos-m1,emag,falkor,oryon-1,neoverse-512tvb,neoverse-e1,neoverse-n1,neoverse-n2,neoverse-v1,neoverse-v2,grace,neoverse-v3,neoverse-v3ae,armagicpu,neoverse-n3,olympus,rigel,cortex-a725,cortex-x925,qdf24xx,saphira,phecda,xgene1,vulcan,octeontx,octeontx81,octeontx83,octeontx2,octeontx2t98,octeontx2t96,octeontx2t93,octeontx2f95,octeontx2f95n,octeontx2f95mm,a64fx,fujitsu-monaka,thunderx,thunderxt88,thunderxt88p1,thunderxt81,tsv110,hip12,thunderxt83,thunderx2t99,thunderx3t110,zeus,cortex-a57.cortex-a53,cortex-a72.cortex-a53,cortex-a73.cortex-a35,cortex-a73.cortex-a53,cortex-a75.cortex-a55,cortex-a76.cortex-a55,cortex-r82,cortex-r82ae,cortex-x1,cortex-x1c,cortex-x2,cortex-x3,cortex-x4,cortex-a510,cortex-a520,cortex-a520ae,cortex-a710,cortex-a715,cortex-a720,cortex-a720ae,ampere1,ampere1a,ampere1b,ampere1c,cobalt-100,apple-m1,apple-m2,apple-m3,apple-m4,apple-m5,c1-nano,c1-pro,c1-premium,c1-ultraandnative. That's the whole roster bestie, not one of them skipped ๐.cortex-a57.cortex-a53,cortex-a72.cortex-a53,cortex-a73.cortex-a35,cortex-a73.cortex-a53,cortex-a75.cortex-a55,cortex-a76.cortex-a55,apple-m1,apple-m2,apple-m3,gb10โ bestie these all say "tune me for a big.LITTLE system" ๐ง๐ like GCC should tune for that whole hybrid setup, not just one core.
The value neoverse-512tvb says tune for Neoverse cores that (a) implement SVE and (b) have a total vector bandwidth of 512 bits per cycle โจ. Translation? The option 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 โ that's 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. iykyk ๐
Also โ on native AArch64 GNU/Linux systems, the value native tunes performance to the host system ๐ฅ๏ธโจ. But no cap: this option does nothing if the compiler can't recognize the processor of the host system. Not its fault, it just doesn't know. ๐
Where none of -mtune=, -mcpu= or -march= are specified, the code gets tuned to perform well across a range of target processors ๐.
Heads up: this option cannot be suffixed by feature modifiers. That's the rule, periodt. ๐
-mcpu=nameโ name the target processor, optionally suffixed by one or more feature modifiers ๐. It looks like-mcpu=cpu{+[no]feature}*, and the permissible values for cpu are literally the same ones available for-mtune. The permissible values for feature are documented in the sub-section on aarch64-feature-modifiers,,-march and -mcpu Feature Modifiers. When you hit conflicting feature modifiers, the right-most feature wins โ right-most takes it all, queen behavior ๐.
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 hangs out with -march or -mtune? Those options take precedence over the appropriate part of this option. Sorry bestie, they outrank it ๐
.
-mcpu=neoverse-512tvb is the special one โ 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 it's overridden by -march, -mcpu=neoverse-512tvb generates code that can run on a Neoverse V1 core, since Neoverse V1 is the first Neoverse core with these properties. And unless it's overridden by -mtune, -mcpu=neoverse-512tvb tunes code in the same way as -mtune=neoverse-512tvb. Iconic ๐
-moverride=stringโ override the tuning decisions the back-end makes in response to a-mtune=switch ๐ ๏ธ. Lowkey important caveat: the syntax, semantics, and accepted values for string here are not guaranteed to be consistent across releases. So like, don't get attached. ๐ญ This option is only intended to be useful when developing GCC โ it's a dev toy, not a vibe for your normal builds.-mpc-relative-literal-loads,-mno-pc-relative-literal-loadsโ turn PC-relative literal loads on or off โจ. With this option, literal pools get accessed using a single instruction and emitted after each function. The tradeoff? It limits the maximum size of functions to1MB. And ngl, this is enabled by default for-mcmodel=tiny๐ .-msign-return-address=scopeโ pick the function scope where return address signing gets applied ๐. Permissible values:noneโ disables return address signing.non-leafโ enables pointer signing for functions that are not leaf functions.allโ enables pointer signing for all functions.
The default value is none. And heads up bestie: this option has been deprecated by -mbranch-protection ๐.
-mbranch-protection=featuresโ pick which branch protection features to use ๐ก๏ธโจ. features can take one of these forms:noneโ the default, and it turns off all types of branch protection.standardโ turns on all types of branch protection features. If a feature has additional tuning options, thenstandardsets it to its standard level.pac-retโ turns on return address signing to its standard level: signing functions that save the return address to memory (non-leaf functions practically always do this) using the A-key ๐.pac-ret+leafโ extends thepac-retsigning to include leaf functions ๐.pac-ret+b-keyorpac-ret+leaf+b-keyโ can be used to sign the functions with the B-key instead of the A-key.btiโ turns on the branch target identification mechanism.gcsโ turns on guarded control stack compatible code generation ๐ง.
-mharden-sls=optsโ enable compiler hardening against straight line speculation (SLS) ๐ฅ. opts is a comma-separated list of the following options:retbrblr
In addition, -mharden-sls=all enables all SLS hardening while -mharden-sls=none disables all SLS hardening.
-mearly-ra=scopeโ decide when to enable an early register allocation pass ๐. This pass runs before instruction scheduling and tries to find a spill-free allocation of floating-point and vector code. It also tries to make use of strided multi-register instructions, like SME2's stridedLD1andST1.
The possible values of scope are:
allโ runs the pass on all functions.stridedโ runs the pass on functions that have access to strided multi-register instructions.noneโ disables the pass.
-mearly-ra=all is the default for -O2 and above, and for -Os. -mearly-ra=none is the default otherwise โจ.
-mearly-ldp-fusion,-mno-early-ldp-fusionโ enable the copy of the AArch64 load/store pair fusion pass that runs before register allocation ๐. Enabled by default at-Oand above.-mlate-ldp-fusion,-mno-late-ldp-fusionโ enable the copy of the AArch64 load/store pair fusion pass that runs after register allocation ๐ . Enabled by default at-Oand above.-mnarrow-gp-writesโ enable conversion of 64-bit general purpose register writes to equivalent 32-bit operations when the upper 32 bits are known to be zero โจ. This pass can be controlled with-mnarrow-gp-writesand is active at-O2and above, but it is not enabled by default, except for-mcpu=olympus. Sneaky exception, we love her ๐.-msve-vector-bits=bitsโ specify the number of bits in an SVE vector register ๐. This option only has an effect when SVE is enabled.
GCC supports two forms of SVE code generation: "vector-length agnostic" output that works with any size of vector register, and "vector-length specific" output that 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 for big-endian targets. All other values generate vector-length specific code. The behavior of these values may change in future releases, and no value except scalable should be relied on for producing code that is portable across different hardware SVE vector lengths. ๐ซถ
The default is -msve-vector-bits=scalable, which produces vector-length agnostic code.
โจ -march and -mcpu Feature Modifiers โจ
Feature modifiers used with -march and -mcpu can be any of the following, and their inverses nofeature ๐ฆ:
crcโ enable CRC extension. This is on by default for-march=armv8.1-a.cryptoโ enable Crypto extension. This also enables Advanced SIMD and floating-point instructions ๐.fpโ enable floating-point instructions. This is on by default for all possible values for options-marchand-mcpu.simdโ enable Advanced SIMD instructions. This also enables floating-point instructions. This is on by default for all possible values for options-marchand-mcpuโจ.sveโ enable Scalable Vector Extension instructions. This also enables Advanced SIMD and floating-point instructions.lseโ enable Large System Extension instructions. This is on by default for-march=armv8.1-a.rdmaโ enable Round Double Multiply Accumulate instructions. This is on by default for-march=armv8.1-a๐.fp16โ enable FP16 extension. This also enables floating-point instructions.fp16fmlโ enable FP16 fmla extension. This also enables FP16 extensions and floating-point instructions. This option is enabled by default for-march=armv8.4-a. Use of this option with architectures prior to Armv8.2-A is not supported ๐ซ.rcpcโ enable the RCpc extension. This enables the use of theLDAPRinstructions for load-acquire atomic semantics, and passes it on to the assembler, enabling inline asm statements to use instructions from the RCpc extension ๐ .dotprodโ enable the Dot Product extension. This also enables Advanced SIMD instructions.aesโ enable the Armv8-a aes and pmull crypto extension. This also enables Advanced SIMD instructions ๐.sha2โ enable the Armv8-a sha2 crypto extension. This also enables Advanced SIMD instructions.sha3โ enable the sha512 and sha3 crypto extension. This also enables Advanced SIMD instructions. Use of this option with architectures prior to Armv8.2-A is not supported ๐ซ.sm4โ enable the sm3 and sm4 crypto extension. This also enables Advanced SIMD instructions. Use of this option with architectures prior to Armv8.2-A is not supported ๐ซ.profileโ enable the Statistical Profiling extension. This option is only to enable the extension at the assembler level and does not affect code generation ๐.rngโ enable the Armv8.5-a Random Number instructions. This option is only to enable the extension at the assembler level and does not affect code generation ๐ฒ.memtagโ enable the Armv8.5-a Memory Tagging Extensions. Use of this option with architectures prior to Armv8.5-A is not supported ๐ซ.sbโ enable the Armv8-a Speculation Barrier instruction. This option is only to enable the extension at the assembler level and does not affect code generation. This option is enabled by default for-march=armv8.5-aโจ.ssbsโ enable the Armv8-a Speculative Store Bypass Safe instruction. This option is only to enable the extension at the assembler level and does not affect code generation. This option is enabled by default for-march=armv8.5-a๐ก๏ธ.predresโ turns on the Armv8-a Execution and Data Prediction Restriction instructions. โ ๏ธ ngl this one is only to flip the switch at the assembler level, it does not affect code generation, periodt. It's enabled by default for-march=armv8.5-a. ๐sve2โ Enable the Armv8-a Scalable Vector Extension 2. This also enables SVE instructions. ๐ฆsve2-bitpermโ Enable SVE2 bitperm instructions. This also enables SVE2 instructions. โจsve2-sm4โ Enable SVE2 sm4 instructions. This also enables SVE2 instructions.sve2-aesโ Enable SVE2 aes instructions. This also enables SVE2 instructions.sve2-sha3โ Enable SVE2 sha3 instructions. This also enables SVE2 instructions.sve2p1โ Enable SVE2.1 instructions. This also enables SVE2 instructions. ๐tmeโ Enable the Transactional Memory Extension.i8mmโ Enable 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions. Enabled by default for-march=armv8.6-a. ๐จ Use of this option with architectures prior to Armv8.2-A is not supported.f32mmโ Enable 32-bit Floating point Matrix Multiply instructions. This also enables SVE instructions. Also: use with architectures prior to Armv8.2-A is not supported. ๐ญf64mmโ Enable 64-bit Floating point Matrix Multiply instructions. This also enables SVE instructions. And yeah, same deal: use with architectures prior to Armv8.2-A is not supported.bf16โ Enable brain half-precision floating-point instructions. ๐ง This also enables Advanced SIMD and floating-point instructions. Enabled by default for-march=armv8.6-a. Use of this option with architectures prior to Armv8.2-A is not supported.ls64โ Enable the 64-byte atomic load and store instructions for accelerators.mopsโ Enable the instructions to accelerate memory operations likememcpy,memmove,memset. This one is enabled by default for-march=armv8.8-a๐ฅflagmโ Enable the Flag Manipulation instructions Extension.flagm2โ Enable the FlagM2 flag conversion instructions.pauthโ Enable the Pointer Authentication Extension. ๐csscโ Enable the Common Short Sequence Compression instructions.cmpbrโ Enable the shorter compare and branch instructions,cbb,cbhandcb. ๐smeโ Enable the Scalable Matrix Extension.sme-i16i64โ Enable the FEAT_SME_I16I64 extension to SME. This also enables SME instructions.sme-f64f64โ Enable the FEAT_SME_F64F64 extension to SME. This also enables SME instructions.sme2โ Enable the Scalable Matrix Extension 2. This also enables SME instructions.sme-f8f16โ Enable the FEAT_SME_F8F16 extension to SME. This also enables SME2 and FP8 instructions.sme-f8f32โ Enable the FEAT_SME_F8F32 extension to SME. This also enables SME2 and FP8 instructions.sme-b16b16โ Enable the FEAT_SME_B16B16 extension to SME. This also enables SME2 and SVE_B16B16 instructions.sme-f16f16โ Enable the FEAT_SME_F16F16 extension to SME. This also enables SME2 instructions.sme2p1โ Enable the Scalable Matrix Extension version 2.1. This also enables SME2 instructions. ๐fcmaโ Enable the complex number SIMD extensions.jscvtโ Enable thefjcvtzsJavaScript conversion instruction.frinttsโ Enable floating-point round to integral value instructions.wfxtโ Enablewfetandwfitinstructions.xsโ Enable the XS memory attribute extension.lse128โ Enable the LSE128 128-bit atomic instructions extension. This also enables LSE instructions.d128โ Enable support for 128-bit system register read/write instructions. This also enables the LSE128 extension.gcsโ Enable support for Armv9.4-a Guarded Control Stack extension.theโ Enable support for Armv8.9-a/9.4-a translation hardening extension.rcpc2โ Enable the RCpc2 extension.rcpc3โ Enable the RCpc3 (Release Consistency) extension.fp8โ Enable the fp8 (8-bit floating point) extension.fp8fmaโ Enable the fp8 (8-bit floating point) multiply accumulate extension.ssve-fp8fmaโ Enable the fp8 (8-bit floating point) multiply accumulate extension in streaming mode. ๐fp8dot4โ Enable the fp8 (8-bit floating point) to single-precision 4-way dot product extension.ssve-fp8dot4โ Enable the fp8 (8-bit floating point) to single-precision 4-way dot product extension in streaming mode. ๐fp8dot2โ Enable the fp8 (8-bit floating point) to half-precision 2-way dot product extension.ssve-fp8dot2โ Enable the fp8 (8-bit floating point) to half-precision 2-way dot product extension in streaming mode. ๐faminmaxโ Enable the Floating Point Absolute Maximum/Minimum extension.lutโ Enable the Lookup Table extension.sme-lutv2โ Enable the SME Lookup Table v2 (LUTv2) extension.cpaโ Enable the Checked Pointer Arithmetic instructions.sve-b16b16โ Enable the SVE non-widening brain floating-point (bf16) extension. Heads up: this only has an effect whensve2orsme2are also enabled, iykyk. ๐sve-bfscaleโ Enable the SVE_BFSCALE extension.poe2โ Enable the Permission Overlays Extension 2.tevโ Enable the TIndex Exception-like Vector Extension.tlbidโ Enable the TLBI Domains Extension.gcieโ Enable the GICv5 (Generic Interrupt Controller) CPU Interface Extension.lscpโ Enable the load acquire and store release pair extension.mops-goโ Enable tag only variants of MOPS instructions. This also enables the instructions to accelerate memory operations and Armv8.5-a Memory Tagging Extensions. ๐ท๏ธsve2p3โ Enable SVE2.3. This also enables SVE2.2 instructions.sme2p3โ Enable SME2.3. This also enables SME2.2 instructions.f16f32dotโ Enable Armv9.7-a f16f32dot instructions. This also enables Advanced SIMD, floating-point instructions and Armv8.2-a FP16 instructions.sve-b16mmโ Enable the SVE B16MM Extension. This also enables SVE instructions, Advanced SIMD and floating-point instructions.mtetcโ Enable Data cache tag block operations. This also enables Armv8.5-a Memory Tagging Extensions. ๐ท๏ธf16f32mmโ Enable Armv9.7-a f16f32mm instructions. This also enables Advanced SIMD, floating-point instructions and Armv8.2-a FP16 instructions.f16mmโ Enable f16mm instructions. This also enables Advanced SIMD, floating-point instructions and Armv8.2-a FP16 instructions.
okay so here's the lil implication web, bestie โ it's giving dominoes ๐ข๐ข๐ข
Feature crypto implies aes, sha2, and simd, which implies fp. Conversely, nofp implies nosimd, which implies nocrypto, noaes and nosha2.
๐ง Adapteva Epiphany Options ๐ง
These -m options are defined for Adapteva Epiphany:
-mhalf-reg-file,-mno-half-reg-fileโ Don't allocate any register in the ranger32...r63. That allows code to run on hardware variants that lack these registers. ๐-mprefer-short-insn-regs,-mno-prefer-short-insn-regsโ Preferentially allocate registers that allow short instruction generation. This can result in increased instruction count, so this may either reduce or increase overall code size. ๐ข-mbranch-cost=numโ Set the cost of branches to roughly num "simple" instructions. This cost is only a heuristic and is not guaranteed to produce consistent results across releases. ๐-mcmove,-mno-cmoveโ Enable the generation of conditional moves.-mnops=numโ Emit num NOPs before every other generated instruction.-mno-soft-cmpsf,-msoft-cmpsfโ For single-precision floating-point comparisons, emit anfsubinstruction and test the flags. This is faster than a software comparison, but can get incorrect results in the presence of NaNs, or when two different small numbers are compared such that their difference is calculated as zero. ๐ญ The default is-msoft-cmpsf, which uses slower, but IEEE-compliant, software comparisons.-mstack-offset=numโ Set the offset between the top of the stack and the stack pointer. E.g., a value of 8 means that the eight bytes in the rangesp+0...sp+7can be used by leaf functions without stack allocation. Values other than 8 or 16 are untested and unlikely to work. ๐จ Note also that this option changes the ABI; compiling a program with a different stack offset than the libraries have been compiled with generally does not work. This option can be useful if you want to evaluate if a different stack offset would give you better code, but to actually use a different stack offset to build working programs, it is recommended to configure the toolchain with the appropriate--with-stack-offset=numoption.-mno-round-nearest,-mround-nearestโ-mno-round-nearestmakes the scheduler assume that the rounding mode has been set to truncating. The default is-mround-nearest. ๐-mlong-callsโ If not otherwise specified by an attribute, assume all calls might be beyond the offset range of theb/blinstructions, and therefore load the function address into a register before performing a (otherwise direct) call. This is the default. ๐-mshort-callsโ If not otherwise specified by an attribute, assume all direct calls are in the range of theb/blinstructions, so use these instructions for direct calls.
The default is -mlong-calls. Note that -mlong-calls is equivalent to -mno-short-calls, and similarly -mno-long-calls is equivalent to -mshort-calls. โจ
-msmall16,-mno-small16โ Assume addresses can be loaded as 16-bit unsigned values. This does not apply to function addresses for which-mlong-callssemantics are in effect.-mfp-mode=modeโ Set the prevailing mode of the floating-point unit. This determines the floating-point mode that is provided and expected at function call and return time. Making this mode match the mode you predominantly need at function start can make your programs smaller and faster by avoiding unnecessary mode switches. ๐ธ
mode can be set to one the following values:
callerโ bestie, any mode at function entry is valid here, and it stays retained or gets restored when the function returns, and also when it calls other functions. This mode is the moment for compiling libraries or other compilation units you might want to tuck into different programs with different prevailing FPU modes, and honestly 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. And yes, 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
-mmay-round-for-trunc,-mno-may-round-for-truncโ this option lets floating point to integer truncation get replaced with rounding to save mode switching. It's disabled by default. ๐-mfp-iarith,-mno-fp-iarithโ this option enables use of the floating-point unit for integer add and subtract. Also disabled by default. ๐-msplit-lohi,-mno-split-lohi,-mpost-inc,-mno-post-inc,-mpost-modify,-mno-post-modifyโ code generation tweaks that control, respectively, splitting of 32-bit loads, generation of post-increment addresses, and generation of post-modify addresses. The defaults aremsplit-lohi,-mpost-inc, and-mpost-modify. ๐ง-mno-vect-doubleโ change the preferred SIMD mode to SImode. The default is-mvect-double, which uses DImode as preferred SIMD mode. โจ-max-vect-align=numโ the maximum alignment for SIMD vector mode types. num may be4or8. The default is8. Heads up bestie: note that this is an ABI change, even though many library function interfaces are unaffected if they don't use SIMD vector modes in places that affect size and/or alignment of relevant types. ๐ญ-msplit-vecmove-early,-mno-split-vecmove-earlyโ split vector moves into single word moves before reload. In theory this can give better register allocation, but so far the reverse seems to be generally the case. ๐-m1reg-regโ specify a register to hold the constant-1, which makes loading small negative constants and certain bitmasks faster. Allowable values for reg arer43andr63, 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:gfx900โ compile for GCN5 Vega 10 devices (gfx900).gfx902โ compile for GCN5 Vegagfx902devices. (Experimental)gfx904โ compile for GCN5 Vegagfx904devices. (Experimental)gfx906โ compile for GCN5 Vega 20 devices (gfx906).gfx908โ compile for CDNA1 Instinct MI100 series devices (gfx908).gfx909โ compile for GCN5 Vegagfx909devices. (Experimental)gfx90aโ compile for CDNA2 Instinct MI200 series devices (gfx90a).gfx90cโ compile for GCN5 Vega 7 devices (gfx90c).gfx942โ compile for CDNA3 Instinct MI300 series devices (gfx942). (Experimental)gfx950โ compile for the CDNA3gfx950devices. (Experimental)gfx9-genericโ compile generic code for Vega devices, executable on the following subset of GFX9 devices:gfx900,gfx902,gfx904,gfx906,gfx909andgfx90c.gfx9-4-genericโ compile generic code for CDNA3 devices, executable on the following subset of GFX9 devices:gfx942andgfx950. (Experimental)gfx1030โ compile for RDNA2gfx1030devices (GFX10 series).gfx1031โ compile for RDNA2gfx1031devices (GFX10 series). (Experimental)gfx1032โ compile for RDNA2gfx1032devices (GFX10 series). (Experimental)gfx1033โ compile for RDNA2gfx1033devices (GFX10 series). (Experimental)gfx1034โ compile for RDNA2gfx1034devices (GFX10 series). (Experimental)gfx1035โ compile for RDNA2gfx1035devices (GFX10 series). (Experimental)gfx1036โ compile for RDNA2gfx1036devices (GFX10 series).gfx10-3-genericโ compile generic code for GFX10-3 devices, executable ongfx1030,gfx1031,gfx1032,gfx1033,gfx1034,gfx1035, andgfx1036.gfx1100โ compile for RDNA3gfx1100devices (GFX11 series).gfx1101โ compile for RDNA3gfx1101devices (GFX11 series). (Experimental)gfx1102โ compile for RDNA3gfx1102devices (GFX11 series). (Experimental)gfx1103โ compile for RDNA3gfx1103devices (GFX11 series).gfx1150โ compile for RDNA3gfx1150devices (GFX11 series). (Experimental)gfx1151โ compile for RDNA3gfx1151devices (GFX11 series). (Experimental)gfx1152โ compile for RDNA3gfx1152devices (GFX11 series). (Experimental)gfx1153โ compile for RDNA3gfx1153devices (GFX11 series). (Experimental)gfx11-genericโ compile generic code for GFX11 devices, executable ongfx1100,gfx1101,gfx1102,gfx1103,gfx1150,gfx1151,gfx1152, andgfx1153.
-mgang-private-size=bytesโ set the amount of local data-share (LDS) memory to reserve for gang-private variables. The default is512. ๐-msram-ecc=on,-msram-ecc=off,-msram-ecc=anyโ compile binaries suitable for devices with the SRAM-ECC feature enabled, disabled, or either mode. This feature can be enabled per-process on some devices. The compiled code must match the device mode. The default isany, for devices that support it. ๐-mxnack=on,-mxnack=off,-mxnack=anyโ compile binaries suitable for devices with the XNACK feature enabled, disabled, or either mode. Some devices always require XNACK and some allow the user to configure XNACK. The compiled code must match the device mode. The default is-mxnack=anyon devices that support Unified Shared Memory, and-mxnack=nootherwise. ๐ญ-Wopenacc-dims,-Wno-openacc-dimsโ control warnings about invalid OpenACC dimensions. ๐
๐น ARC Options ๐น
The following options control the architecture variant for which code is being compiled: โจ
-mbarrel-shifterโ generate instructions supported by barrel shifter. This is the default unless-mcpu=ARC601or-mcpu=ARCEMis in effect. ๐ฅ-mjli-alwaysโ force to call a function usingjli_sinstruction. This option is valid only for ARCv2 architecture. ๐-mcpu=cpuโ set architecture type, register usage, and instruction scheduling parameters for cpu. There are also shortcut alias options available for backward compatibility and convenience. Supported values for cpu are:arc600โ compile for ARC600. Aliases:-mA6,-mARC600.arc601โ compile for ARC601. Alias:-mARC601.arc700โ compile for ARC700. Aliases:-mA7,-mARC700. This is the default when configured with--with-cpu=arc700.arcemโ compile for ARC EM.archsโ compile for ARC HS.emโ compile for ARC EM CPU with no hardware extensions.em4โ compile for ARC EM4 CPU.em4_dmipsโ compile for ARC EM4 DMIPS CPU.em4_fpusโ compile for ARC EM4 DMIPS CPU with the single-precision floating-point extension.em4_fpudaโ compile for ARC EM4 DMIPS CPU with single-precision floating-point and double assist instructions.hsโ compile for ARC HS CPU with no hardware extensions except the atomic instructions.hs34โ compile for ARC HS34 CPU.hs38โ compile for ARC HS38 CPU.hs38_linuxโ compile for ARC HS38 CPU with all hardware extensions on.hs4xโ compile for ARC HS4x CPU.hs4xdโ compile for ARC HS4xD CPU.hs4x_rel31โ compile for ARC HS4x CPU release 3.10a.arc600_normโ compile for ARC 600 CPU with "norm" instructions enabled.arc600_mul32x16โ compile for ARC 600 CPU with "norm" and 32x16-bit multiply instructions enabled.arc600_mul64โ compile for ARC 600 CPU with "norm" and "mul64"-family instructions enabled.arc601_normโ compile for ARC 601 CPU with "norm" instructions enabled.arc601_mul32x16โ compile for ARC 601 CPU with "norm" and 32x16-bit multiply instructions enabled.arc601_mul64โ compile for ARC 601 CPU with "norm" and "mul64"-family instructions enabled.nps400โ compile for ARC 700 on NPS400 chip.em_miniโ compile for ARC EM minimalist configuration featuring reduced register set.
-mdpfp,-mdpfp-compactโ generate double-precision FPX instructions, tuned for the compact implementation. ๐ฆ-mdpfp-fastโ generate double-precision FPX instructions, tuned for the fast implementation. โก-mno-dpfp-lrsr,-mdpfp-lrsrโ control whether "lr" and "sr" instructions use FPX extension aux registers. This is enabled by default. ๐-meaโ generate extended arithmetic instructions. Currently only "divaw", "adds", "subs", and "sat16" are supported. Only valid for-mcpu=ARC700. ๐ง-mmul32x16โ generate 32x16-bit multiply and multiply-accumulate instructions. โจ-mmul64โ generate "mul64" and "mulu64" instructions. Only valid for-mcpu=ARC600. ๐-mnormโ generate "norm" instructions. This is the default if-mcpu=ARC700is in effect. ๐-mspfp,-mspfp-compactโ generate single-precision FPX instructions, tuned for the compact implementation. ๐ธ-mspfp-fastโ generate single-precision FPX instructions, tuned for the fast implementation. ๐-msimdโ turns on generation of ARC SIMD instructions via target-specific builtins. Only valid for-mcpu=ARC700, bestie, don't try it anywhere else.-msoft-floatโ ok so this option is literally ignored ๐ญ it's just here for compatibility purposes only. Software floating-point code is emitted by default, and that default can be overridden by the FPX options:-mspfp,-mspfp-compact, or-mspfp-fastfor single precision, and-mdpfp,-mdpfp-compact, or-mdpfp-fastfor double precision.-mswapโ generate"swap"instructions. short and sweet, we love her โจ-matomicโ this enables use of the locked load/store conditional extension to implement atomic memory built-in functions. Not available for ARC 6xx or ARC EM cores.-mdiv-remโ enable"div"and"rem"instructions for ARCv2 cores.-mcode-density,-mno-code-densityโ enable code density instructions for ARC EM. This one is on by default for ARC HS btw, so you don't have to ask twice ๐-mll64โ enable double load/store operations for ARC HS cores.-mtp-regno=regnoโ specify thread pointer register number.-mbitopsโ enable use of NPS400 bit operations.-mcmemโ enable use of NPS400 xld/xst extension.-mmpy-option=multoโ compile ARCv2 code with a multiplier design option. You can specify the option using either a string or a numeric value formulto.wlh1is the default value. The recognized values are:0,noneโ no multiplier available. it's giving minimalism1,wโ 16x16 multiplier, fully pipelined. The following instructions are enabled:"mpyw"and"mpyuw".2,wlh1โ 32x32 multiplier, fully pipelined (1 stage). The following instructions are additionally enabled:"mpy","mpyu","mpym","mpymu", and"mpy_s".3,wlh2โ 32x32 multiplier, fully pipelined (2 stages). The following instructions are additionally enabled:"mpy","mpyu","mpym","mpymu", and"mpy_s".4,wlh3โ two 16x16 multipliers, blocking, sequential. The following instructions are additionally enabled:"mpy","mpyu","mpym","mpymu", and"mpy_s".5,wlh4โ one 16x16 multiplier, blocking, sequential. The following instructions are additionally enabled:"mpy","mpyu","mpym","mpymu", and"mpy_s".6,wlh5โ one 32x4 multiplier, blocking, sequential. The following instructions are additionally enabled:"mpy","mpyu","mpym","mpymu", and"mpy_s".7,plus_dmpyโ ARC HS SIMD support.8,plus_macdโ ARC HS SIMD support.9,plus_qmacwโ ARC HS SIMD support.
This option is only available for ARCv2 cores.
-mfpu=fpuโ enables support for specific floating-point hardware extensions for ARCv2 cores. Supported values forfpuare:fpusโ enables support for single-precision floating-point hardware extensions.fpudโ enables support for double-precision floating-point hardware extensions. The single-precision floating-point extension is also enabled. Not available for ARC EM.fpudaโ enables support for double-precision floating-point hardware extensions using double-precision assist instructions. The single-precision floating-point extension is also enabled. This option is only available for ARC EM.fpuda_divโ enables support for double-precision floating-point hardware extensions using double-precision assist instructions. The single-precision floating-point, square-root, and divide extensions are also enabled. This option is only available for ARC EM.fpuda_fmaโ enables support for double-precision floating-point hardware extensions using double-precision assist instructions. The single-precision floating-point and fused multiply and add hardware extensions are also enabled. This option is only available for ARC EM.fpuda_allโ enables support for double-precision floating-point hardware extensions using double-precision assist instructions. All single-precision floating-point hardware extensions are also enabled. This option is only available for ARC EM.fpus_divโ enables support for single-precision floating-point, square-root and divide hardware extensions.fpud_divโ enables support for double-precision floating-point, square-root and divide hardware extensions. This option includes optionfpus_div. Not available for ARC EM.fpus_fmaโ enables support for single-precision floating-point and fused multiply and add hardware extensions.fpud_fmaโ enables support for double-precision floating-point and fused multiply and add hardware extensions. This option includes optionfpus_fma. Not available for ARC EM.fpus_allโ enables support for all single-precision floating-point hardware extensions.fpud_allโ enables support for all single- and double-precision floating-point hardware extensions. Not available for ARC EM.
-mirq-ctrl-saved=register-range, blink, lp_countโ specifies general-purposes registers that the processor automatically saves/restores on interrupt entry and exit.register-rangeis specified as two registers separated by a dash. The register range always starts with"r0", the upper limit is the"fp"register.blinkandlp_countare optional. This option is only valid for ARC EM and ARC HS cores.-mrgf-banked-regs=numberโ specifies the number of registers replicated in the second register bank on entry to fast interrupt. Fast interrupts are interrupts with the highest priority level P0. These interrupts save only PC and STATUS32 registers to avoid memory transactions during interrupt entry and exit sequences. Use this option when you are using fast interrupts in an ARC V2 family processor. Permitted values are 4, 8, 16, and 32.-mlpc-width=widthโ specify the width of the"lp_count"register. Valid values forwidthare 8, 16, 20, 24, 28 and 32 bits. The default width is fixed to 32 bits. If the width is less than 32, the compiler does not attempt to transform loops in your program to use the zero-delay loop mechanism unless it is known that the"lp_count"register can hold the required loop-counter value. Depending on the width specified, the compiler and run-time library might continue to use the loop mechanism for various needs. This option defines macro"__ARC_LPC_WIDTH__"with the value ofwidth.-mrf16โ this option instructs the compiler to generate code for a 16-entry register file. This option defines the"__ARC_RF16__"preprocessor macro.-mbranch-indexโ enable use of"bi"or"bih"instructions to implement jump tables.
The following options are passed through to the assembler, and also define preprocessor macro symbols.
-mlockโ passed down to the assembler to enable the locked load/store conditional extension. Also sets the preprocessor symbol"__Xlock".-mswapeโ passed down to the assembler to enable the swap byte ordering extension instruction. Also sets the preprocessor symbol"__Xswape".-mxyโ passed down to the assembler to enable the XY memory extension. Also sets the preprocessor symbol"__Xxy".
The following options control how the assembly code is annotated:
-misizeโ annotate assembler instructions with estimated addresses.
The following options are passed through to the linker:
-marclinux,-mno-arclinuxโ passed through to the linker, to specify use of the"arclinux"emulation. This option is enabled by default in tool chains built for"arc-linux-uclibc"and"arceb-linux-uclibc"targets when profiling is not requested.-marclinux_prof,-mno-arclinux_profโ passed through to the linker, to specify use of the"arclinux_prof"emulation. This option is enabled by default in tool chains built for"arc-linux-uclibc"and"arceb-linux-uclibc"targets when profiling is requested.
The following options control the semantics of generated code:
-mlong-callsโ generate calls as register indirect calls, thus providing access to the full 32-bit address range. glow up fr-mmedium-calls,-mno-medium-callsโ don't use less than 25-bit addressing range for calls, which is the offset available for an unconditional branch-and-link instruction. Conditional execution of function calls is suppressed, to allow use of the 25-bit range, rather than the 21-bit range with conditional branch-and-link. This is the default for tool chains built for"arc-linux-uclibc"and"arceb-linux-uclibc"targets.-G numโ put definitions of externally-visible data in a small data section if that data is no bigger thannumbytes. The default value ofnumis 4 for any ARC configuration, or 8 when we have double load/store operations.-mno-sdataโ do not generate sdata references. This is the default for tool chains built for"arc-linux-uclibc"and"arceb-linux-uclibc"targets.-mvolatile-cache,-mno-volatile-cacheโ control how volatile references are accessed. The default is-mvolatile-cache, which uses ordinary cached memory accesses for volatile references. Use-mno-volatile-cacheto enable cache bypass for volatile references.
The following options fine tune code generation:
-mauto-modify-regโ enable the use of pre/post modify with register displacement.-mno-brcc,-mbrccโ this option controls a target-specific pass inarc_reorgto generate compare-and-branch ("brcc") instructions, which is enabled by default. It has no effect on generation of these instructions driven by the combiner pass.-mcase-vector-pcrelโ use PC-relative switch case tables to enable case table shortening. This is the default for-Os.-mno-cond-execโ disable the ARCompact-specific pass to generate conditional execution instructions.
Due to delay slot scheduling and interactions between operand numbers, literal sizes, instruction lengths, and the support for conditional execution, the target-independent pass to generate conditional execution is often lacking, so the ARC port has kept a special pass around that tries to find more conditional execution generation opportunities after register allocation, branch shortening, and delay slot scheduling have been done. This pass generally, but not always, improves performance and code size, at the cost of extra compilation time, which is why there is an option to switch it off. If you have a problem with call instructions exceeding their allowable offset range because they are conditionalized, you should consider using -mmedium-calls instead.
-mearly-cbranchsiโ turns on pre-reload use of thecbranchsipattern. โจ-mindexed-loadsโ lets the compiler use indexed loads. Heads up bestie ๐ this one can be a whole situation, because some optimizers then just assume indexed stores exist too โ and they do not. Not even a little.-mlra-priority-noneโ don't flag any priority for target registers. Zero opinions, main character neutrality ๐-mlra-priority-compactโ flags target register priority forr0..r3/r12..r15.-mlra-priority-noncompactโ lowers target register priority forr0..r3/r12..r15.-mmillicodeโ when you're optimizing for size (aka-Os), prologues and epilogues that have to save or restore a huge number of registers often get shortened by calling a special function insidelibgcc๐ and that's what we call a millicode call. But these calls can cause performance issues, and/or linking issues when you're linking in a nonstandard way, so this option exists to turn millicode call generation on or off. Slay, options.-mcode-density-frameโ lets the compiler emitenterandleaveinstructions. Warning tho: these instructions are only valid on CPUs with the code-density feature. Periodt.-msize-level=levelโ fine-tunes size optimization with regards to instruction lengths and alignment. The recognized values for level are:- No size optimization. This level is deprecated and gets treated like
1. - Short instructions are used opportunistically.
- In addition, alignment of loops and of code after barriers are dropped.
- In addition, optional data alignment is dropped, and the option
Osis enabled.
- No size optimization. This level is deprecated and gets treated like
This defaults to 3 when -Os is in effect. Otherwise, if this isn't set at all, the behavior is equivalent to level 1. ๐ฆ
-mtune=cpuโ sets instruction scheduling parameters for cpu, overriding anything implied by-mcpu=.
The supported values for cpu are:
ARC600โ tune for ARC600 CPU.ARC601โ tune for ARC601 CPU.ARC700โ tune for ARC700 CPU with the standard multiplier block.ARC700-xmacโ tune for ARC700 CPU with the XMAC block.ARC725Dโ tune for ARC725D CPU.ARC750Dโ tune for ARC750D CPU.core3โ tune for ARCv2 core3 type CPU. This option enables usage of thedbnzinstruction.release31aโ tune for ARC4x release 3.10a.
-mmultcost=numโ the cost to assume for a multiply instruction, with4being equal to a normal instruction.
๐ ARM Options ๐
These -m options are defined for the ARM port:
-mabi=nameโ generate code for the specified ABI. The permissible values are:apcs-gnu,atpcs,aapcsandaapcs-linux.-mapcs-frameโ generate a stack frame that's compliant with the ARM Procedure Call Standard for all functions, even when it isn't strictly necessary for the code to actually execute correctly. If you specify-fomit-frame-pointeralongside this option, stack frames won't be generated for leaf functions. The default is-mno-apcs-frame. This option is deprecated. ๐-mapcsโ this is just a synonym for-mapcs-frame, and it's deprecated.-mthumb-interworkโ generate code that supports calling between the ARM and Thumb instruction sets. Without this option, on pre-v5 architectures, the two instruction sets can't be reliably used inside one program. The default is-mno-thumb-interwork, because slightly larger code gets generated when-mthumb-interworkis specified. In AAPCS configurations this option is meaningless. ๐-msched-prolog/-mno-sched-prologโ allow or prevent the reordering of instructions in the function prologue, or the merging of those instructions with the instructions in the function's body. With-mno-sched-prolog, that means all functions start with a recognizable set of instructions (or, honestly, one of a choice from a small set of different function prologues), and this 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. The permissible values are:soft,softfpandhard.
Specifying soft makes GCC generate output containing library calls for floating-point operations. softfp allows the generation of code using hardware floating-point instructions, but still uses the soft-float calling conventions. hard allows generation of floating-point instructions and uses FPU-specific calling conventions.
The default depends on the specific target configuration. Note that the hard-float and soft-float ABIs are not link-compatible; you must compile your entire program with the same ABI, and link with a compatible set of libraries. No mixing, bestie, that's the rule ๐
-mgeneral-regs-onlyโ generate code that uses only the general-purpose registers. This stops the compiler from using floating-point and Advanced SIMD registers, but it does 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. This option has no effect for little-endian images and is ignored there. The default depends on the selected target architecture. For ARMv6 and later architectures the default is BE8, for older architectures the default is BE32. BE32 format has been deprecated by ARM. ๐ญ-march=name[+extension...]โ this specifies the name of the target ARM architecture. GCC uses this name to figure out what kind of instructions it can emit when generating assembly code. This option can be used together with, or instead of, the-mcpu=option.
The permissible names are: armv4t, armv5t, armv5te, armv6, armv6j, armv6k, armv6kz, armv6t2, armv6z, armv6zk, armv7, armv7-a, armv7ve, armv8-a, armv8.1-a, armv8.2-a, armv8.3-a, armv8.4-a, armv8.5-a, armv8.6-a, armv9-a, armv7-r, armv8-r, armv6-m, armv6s-m, armv7-m, armv7e-m, armv8-m.base, armv8-m.main, armv8.1-m.main, iwmmxt and iwmmxt2.
On top of that, the following architectures, which lack support for the Thumb execution state, are recognized โ but support is deprecated: armv4.
A whole bunch of these architectures support extensions. You add them by appending +extension to the architecture name. Extension options get processed in order and capabilities accumulate. An extension will also enable any necessary base extensions it depends on. For example, the +crypto extension will always enable the +simd extension. The one exception to this additive construction is extensions prefixed with +no...: these disable the specified option and any other extensions that might depend on that extension being present.
So like, 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. The way that order matters here?? Obsessed. ๐ฅ
Most extension names are generically named, but the effect depends on the architecture you apply them to. For example, the +simd option can be applied to both armv7-a and armv8-a architectures, but it enables the original ARMv7-A Advanced SIMD (Neon) extensions for armv7-a and the ARMv8-A variant for armv8-a.
The table below lists the supported extensions for each architecture. Architectures not mentioned don't support any extensions.
armv5te armv6 armv6j armv6k armv6kz armv6t2 armv6z armv6zk
+fpโ the VFPv2 floating-point instructions. The extension+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.
armv7veโ the extended ARMv7-A vibe, except now with virtualization support baked in. ๐ซ+fpโ the VFPv4 floating-point instructions, with 16 double-precision registers. And guess what, bestie: the extension+vfpv4-d16can be used as an alias for this one. โจ+simdโ the Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions, together. 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. (And no, it does not disable floating point. They're separate, okay? ๐)+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. All of them. Gone. ๐ญ+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.
๐ armv8.1-a
+simdโ the ARMv8.1-A Advanced SIMD and floating-point instructions.+cryptoโ the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions. ๐ฅ+nocryptoโ disable the cryptographic instructions.+nofpโ disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.
๐ armv8.2-a
๐ armv8.3-a
okay soarmv8.2-aandarmv8.3-aare sharing the exact same extension list here, and that's just how it is โ no cap, I'm not making this up. ๐
+fp16โ the half-precision floating-point data processing instructions. This also enables the Advanced SIMD and floating-point instructions. โจ+fp16fmlโ the half-precision floating-point fmla extension. This also enables the half-precision floating-point extension and Advanced SIMD and floating-point instructions.+simdโ the ARMv8.1-A Advanced SIMD and floating-point instructions.+cryptoโ the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions.+dotprodโ enable the Dot Product extension. This also enables Advanced SIMD instructions. ๐+nocryptoโ disable the cryptographic extension.+nofpโ disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.+i8mmโ 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions. ๐+bf16โ Brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions.
๐ 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. (yeah, that's a lot, it's giving overachiever ๐ )+simdโ the ARMv8.3-A Advanced SIMD and floating-point instructions as well as the Dot Product extension.+cryptoโ the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension. ๐+nocryptoโ disable the cryptographic extension.+nofpโ disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.+i8mmโ 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions.+bf16โ Brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions.
๐ armv8.5-a
+fp16โ the half-precision floating-point data processing instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension and the half-precision floating-point fmla extension.+simdโ the ARMv8.3-A Advanced SIMD and floating-point instructions as well as the Dot Product extension.+cryptoโ the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension.+nocryptoโ disable the cryptographic extension.+nofpโ disable the floating-point, Advanced SIMD and cryptographic instructions.+i8mmโ 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions.+bf16โ Brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions.
notice there's no+sband no+predresinarmv8.5-a's list up there ๐ โ that's not me being lazy, that's literally what the list says, and we don't invent options in this house. ๐
๐ armv8.6-a
+fp16โ the half-precision floating-point data processing instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension and the half-precision floating-point fmla extension.+simdโ the ARMv8.3-A Advanced SIMD and floating-point instructions as well as the Dot Product extension.+cryptoโ the cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension.+nocryptoโ disable the cryptographic extension.+nofpโ disable the floating-point, Advanced SIMD and cryptographic instructions.+i8mmโ 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions.+bf16โ Brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions.
๐ armv7-r
+fp.spโ the single-precision VFPv3 floating-point instructions. The extension+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. ๐ตโ๐ซ (say that five times fast)+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.1-m.main
+dspโ the DSP instructions. ๐ง+mveโ the M-Profile Vector Extension (MVE) integer instructions.+mve.fpโ the M-Profile Vector Extension (MVE) integer and single precision floating-point instructions.+fpโ the single-precision floating-point instructions.
okay so we're still deep in the extension-option buffet for this architecture, bestie, let's keep it moving ๐
+fp.dpโ the single- and double-precision floating-point instructions. both. like an overachiever โจ+nofpโ disable the floating-point extension. no float for u ๐+cdecp0,+cdecp1, ... ,+cdecp7โ Enable the Custom Datapath Extension (CDE) on selected coprocessors according to the numbers given in the options in the range 0 to 7. pick your coprocessor, 0 through 7, iykyk ๐+pacbtiโ Enable the Pointer Authentication and Branch Target Identification Extension. security queen behavior ๐
armv8-m.main
+dspโ The DSP instructions. ๐๏ธ+nodspโ Disable the DSP extension.+fpโ The single-precision floating-point instructions.+fp.dpโ The single- and double-precision floating-point instructions.+nofpโ Disable the floating-point extension.+cdecp0,+cdecp1, ... ,+cdecp7โ Enable the Custom Datapath Extension (CDE) on selected coprocessors according to the numbers given in the options in the range 0 to 7.
armv8-r
+crcโ The Cyclic Redundancy Check (CRC) instructions. checksums stay winning ๐งฎ+fp.spโ The single-precision FPv5 floating-point instructions.+simdโ The ARMv8-A Advanced SIMD and floating-point instructions.+cryptoโ The cryptographic instructions.+nocryptoโ Disable the cryptographic instructions.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions. all three, gone, periodt ๐
Now the tea on auto-detect:
-march=native causes the compiler to auto-detect the architecture of the build computer. At present, this feature is only supported on GNU/Linux, and not all architectures are recognized. If the auto-detect is unsuccessful the option has no effect.
-march=unset causes the compiler to ignore any -march=... options that appear earlier on the command line and behave as if the option was never passed. This is useful to avoid warnings about conflicting CPU and architecture options when the two produce different architecture specifications. basically it's the "nvm forget I said that" of flags ๐
-mtune=name
This option specifies the name of the target ARM processor for which GCC should tune the performance of the code. For some ARM implementations better performance can be obtained by using this option. Permissible names are: arm7tdmi, arm7tdmi-s, arm710t, arm720t, arm740t, strongarm, strongarm110, strongarm1100, strongarm1110, arm8, arm810, arm9, arm9e, arm920, arm920t, arm922t, arm946e-s, arm966e-s, arm968e-s, arm926ej-s, arm940t, arm9tdmi, arm10tdmi, arm1020t, arm1026ej-s, arm10e, arm1020e, arm1022e, arm1136j-s, arm1136jf-s, mpcore, mpcorenovfp, arm1156t2-s, arm1156t2f-s, arm1176jz-s, arm1176jzf-s, generic-armv7-a, cortex-a5, cortex-a7, cortex-a8, cortex-a9, cortex-a12, cortex-a15, cortex-a17, cortex-a32, cortex-a35, cortex-a53, cortex-a55, cortex-a57, cortex-a72, cortex-a73, cortex-a75, cortex-a76, cortex-a76ae, cortex-a77, cortex-a78, cortex-a78ae, cortex-a78c, cortex-a710, ares, cortex-r4, cortex-r4f, cortex-r5, cortex-r7, cortex-r8, cortex-r52, cortex-r52plus, cortex-m0, cortex-m0plus, cortex-m1, cortex-m3, cortex-m4, cortex-m7, cortex-m23, cortex-m33, cortex-m35p, cortex-m52, cortex-m55, cortex-m85, cortex-x1, cortex-x1c, cortex-m1.small-multiply, cortex-m0.small-multiply, cortex-m0plus.small-multiply, exynos-m1, marvell-pj4, neoverse-n1, neoverse-n2, neoverse-v1, xscale, iwmmxt, iwmmxt2, ep9312, fa526, fa626, fa606te, fa626te, fmp626, fa726te, star-mc1, xgene1. that's a LOT of names, she contains multitudes ๐
Additionally, this option can specify that GCC should tune the performance of the code for a big.LITTLE system. Permissible names are: cortex-a15.cortex-a7, cortex-a17.cortex-a7, cortex-a57.cortex-a53, cortex-a72.cortex-a53, cortex-a72.cortex-a35, cortex-a73.cortex-a53, cortex-a75.cortex-a55, cortex-a76.cortex-a55. big.LITTLE is giving "two moods, one chip" ๐ฆ
-mtune=generic-arch specifies that GCC should tune the performance for a blend of processors within architecture arch. The aim is to generate code that run well on the current most popular processors, balancing between optimizations that benefit some CPUs in the range, and avoiding performance pitfalls of other CPUs. The effects of this option may change in future GCC versions as CPU models come and go. models really do come and go, she's just keeping up โจ
-mtune permits the same extension options as -mcpu, but the extension options do not affect the tuning of the generated code. they're there, they're just not doing anything for the tuning. decorative. ๐
-mtune=native causes the compiler to auto-detect the CPU of the build computer. At present, this feature is only supported on GNU/Linux, and not all architectures are recognized. If the auto-detect is unsuccessful the option has no effect.
-mcpu=name[+extension...]
This specifies the name of the target ARM processor. GCC uses this name to derive the name of the target ARM architecture (as if specified by -march) and the ARM processor type for which to tune for performance (as if specified by -mtune). Where this option is used in conjunction with -march or -mtune, those options take precedence over the appropriate part of this option. so -march and -mtune are the main characters here and -mcpu knows its place ๐
Many of the supported CPUs implement optional architectural extensions. Where this is so the architectural extensions are normally enabled by default. If implementations that lack the extension exist, then the extension syntax can be used to disable those extensions that have been omitted. For floating-point and Advanced SIMD (Neon) instructions, the settings of the options -mfloat-abi and -mfpu must also be considered: floating-point and Advanced SIMD instructions will only be used if -mfloat-abi is not set to soft; and any setting of -mfpu other than auto will override the available floating-point and SIMD extension instructions.
For example, cortex-a9 can be found in three major configurations: integer only, with just a floating-point unit or with floating-point and Advanced SIMD. The default is to enable all the instructions, but the extensions +nosimd and +nofp can be used to disable just the SIMD or both the SIMD and floating-point instructions respectively.
Permissible names for this option are the same as those for -mtune.
The following extension options are common to the listed CPUs:
+nodspโ Disable the DSP instructions oncortex-m33,cortex-m35p,cortex-m52,cortex-m55andcortex-m85. Also disable the M-Profile Vector Extension (MVE) integer and single precision floating-point instructions oncortex-m52,cortex-m55andcortex-m85.+nopacbtiโ Disable the Pointer Authentication and Branch Target Identification Extension oncortex-m52andcortex-m85.+nomveโ Disable the M-Profile Vector Extension (MVE) integer and single precision floating-point instructions oncortex-m52,cortex-m55andcortex-m85.+nomve.fpโ Disable the M-Profile Vector Extension (MVE) single precision floating-point instructions oncortex-m52,cortex-m55andcortex-m85.+cdecp0,+cdecp1, ... ,+cdecp7โ Enable the Custom Datapath Extension (CDE) on selected coprocessors according to the numbers given in the options in the range 0 to 7 oncortex-m52,cortex-m55,cortex-m85andstar-mc1.+nofpโ Disables the floating-point instructions onarm9e,arm946e-s,arm966e-s,arm968e-s,arm10e,arm1020e,arm1022e,arm926ej-s,arm1026ej-s,cortex-r5,cortex-r7,cortex-r8,cortex-m4,cortex-m7,cortex-m33,cortex-m35p,cortex-m52,cortex-m55andcortex-m85. Disables the floating-point and SIMD instructions ongeneric-armv7-a,cortex-a5,cortex-a7,cortex-a8,cortex-a9,cortex-a12,cortex-a15,cortex-a17,cortex-a15.cortex-a7,cortex-a17.cortex-a7,cortex-a32,cortex-a35,cortex-a53andcortex-a55.+nofp.dpโ Disables the double-precision component of the floating-point instructions oncortex-r5,cortex-r7,cortex-r8,cortex-r52,cortex-r52plusandcortex-m7.+nosimdโ Disables the SIMD (but not floating-point) instructions ongeneric-armv7-a,cortex-a5,cortex-a7andcortex-a9.+cryptoโ Enables the cryptographic instructions oncortex-a32,cortex-a35,cortex-a53,cortex-a55,cortex-a57,cortex-a72,cortex-a73,cortex-a75,exynos-m1,xgene1,cortex-a57.cortex-a53,cortex-a72.cortex-a53,cortex-a73.cortex-a35,cortex-a73.cortex-a53andcortex-a75.cortex-a55.
Additionally the generic-armv7-a pseudo target defaults to VFPv3 with 16 double-precision registers. It supports the following extension options: mp, sec, vfpv3-d16, vfpv3, vfpv3-d16-fp16, vfpv3-fp16, vfpv4-d16, vfpv4, neon, neon-vfpv3, neon-fp16, neon-vfpv4. The meanings are the same as for the extensions to -march=armv7-a. reusing the lore, we love a consistent universe ๐ธ
-mcpu=generic-arch is also permissible, and is equivalent to -march=arch -mtune=generic-arch. See -mtune for more information.
-mcpu=native causes the compiler to auto-detect the CPU of the build computer. At present, this feature is only supported on GNU/Linux, and not all architectures are recognized. If the auto-detect is unsuccessful the option has no effect.
-mcpu=unset causes the compiler to ignore any -mcpu=... options that appear earlier on the command line and behave as if the option was never passed. This is useful to avoid warnings about conflicting CPU and architecture options when the two produce different architecture specifications. same "never mind bestie" energy as -march=unset ๐ซถ
-mfpu=name
This specifies what floating-point hardware (or hardware emulation) is available on the target. Permissible names are: auto, vfpv2, vfpv3, vfpv3-fp16, vfpv3-d16, vfpv3-d16-fp16, vfpv3xd, vfpv3xd-fp16, neon-vfpv3, neon-fp16, vfpv4, vfpv4-d16, fpv4-sp-d16, neon-vfpv4, fpv5-d16, fpv5-sp-d16, fp-armv8, neon-fp-armv8 and crypto-neon-fp-armv8. Note that neon is an alias for neon-vfpv3 and vfp is an alias for vfpv2. nicknames, iconic behavior โจ
The setting auto is the default and is special. It causes the compiler to select the floating-point and Advanced SIMD instructions based on the settings of -mcpu and -march. she's just reading the room and matching the vibe ๐
If the floating-point hardware you picked has the NEON extension in it (think -mfpu=neon), heads up bestie: GCC's auto-vectorization pass will not generate floating-point operations for you unless you also pass -funsafe-math-optimizations. Why? Because NEON hardware doesn't fully implement the IEEE 754 standard for floating-point arithmetic โ specifically, denormal values get treated as zero โ so using NEON instructions can literally lose you precision. ๐ Not a vibe, but that's the tradeoff.
You can also set the fpu name at function level by using the target("fpu=") function attributes or pragmas. โจ
-mfp16-format=nameโ picks the format of the__fp16half-precision floating-point type. The permissible names arenone,ieee, andalternative; the default isnone, and in that case the__fp16type just... isn't defined at all. ๐-mstructure-size-boundary=nโ rounds up the sizes of all structures and unions to a multiple of however many bits you set here. Permissible values are8,32and64. The default varies between toolchains, fr fr โ for the COFF targeted toolchain the default is8. And a value of64is only allowed if the underlying ABI supports it. ๐
Setting a bigger number can give you faster, more efficient code, but it can also bloat the size of your program. Also โ different values are potentially incompatible with each other. Code compiled with one value can't necessarily be expected to work with code or libraries compiled with another value if they exchange info using structures or unions. So pick one and stay loyal. ๐
This option is deprecated. Consider yourself warned, bestie.
-mabort-on-noreturnโ generates a call to the functionabortat the end of anoreturnfunction. It gets executed if the function tries to return anyway. Snitch behavior, honestly. ๐ญ-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 that register. You need this switch if the target function sits outside of the 64-megabyte addressing range of the offset-based version of the subroutine call instruction.
Even with this switch enabled, not all function calls become long calls. The heuristic: static functions, functions with the short_call attribute, functions inside the scope of a #pragma no_long_calls directive, and functions whose definitions have already been compiled within the current compilation unit โ those don't get turned into long calls. But the exceptions to the exception rule ๐ซถ: weak function definitions, functions with the long_call attribute or the section attribute, and functions within the scope of a #pragma long_calls directive are always turned into long calls.
This feature is not enabled by default. Specifying -mno-long-calls restores the default behavior, and so does placing the function calls within the scope of a #pragma long_calls_off directive. Note that these switches have no effect on how the compiler generates code to handle function calls via function pointers. Iykyk. ๐
-msingle-pic-baseโ treats the register used for PIC addressing as read-only, instead of 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, it's your job now, not GCC's. ๐-mpic-register=regโ specifies the register to be used for PIC addressing. For standard PIC base case, the default is any suitable register determined by the compiler. For single PIC base case, the default isR9if the target is EABI based or stack-checking is enabled; otherwise the default isR10. โจ-mpic-data-is-text-relativeโ assumes that 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 known to be in the data segment. For non-VxWorks RTP targets, this option is enabled by default. When it's disabled on such targets, it will enable-msingle-pic-baseby default. Sneaky little chain reaction. ๐ฆ-mpoke-function-nameโ writes the name of each function into the text section, directly preceding the function prologue. The generated code looks similar to this:
t0
.ascii "arm_poke_function_name", 0
.align
t1
.word 0xff000000 + (t1 - t0)
arm_poke_function_name
mov ip, sp
stmfd sp!, {fp, ip, lr, pc}
sub fp, ip, #4
When performing a stack backtrace, code can inspect the value of pc stored at fp + 0. If the trace function then looks at location pc - 12 and the top 8 bits are set, then we know that there's a function name embedded immediately preceding this location and it has length ((pc[-3]) & 0xff000000). Detective work, but make it assembly. ๐
-mthumb-marmโ selects between generating code that executes in ARM and Thumb states. The default for most configurations is to generate code that executes in ARM state, but the default can be changed by configuring GCC with the--with-mode=stateconfigure option.
You can also override the ARM and Thumb mode for each function by using the target("thumb") and target("arm") function attributes or pragmas. Per-function glow-ups, we love to see it. ๐
-mtpcs-frameโ generates a stack frame that's compliant with the Thumb Procedure Call Standard for all non-leaf functions. (A leaf function is one that does not call any other functions.) The default is-mno-tpcs-frame.-mtpcs-leaf-frameโ generates a stack frame that's compliant with the Thumb Procedure Call Standard for all leaf functions. (Again: a leaf function is one that does not call any other functions.) The default is-mno-apcs-leaf-frame. ๐-mcallee-super-interworkingโ gives all externally visible functions in the file being compiled an ARM instruction set header which switches to Thumb mode before executing the rest of the function. This lets these functions be called from non-interworking code. Not valid in AAPCS configurations, because interworking is enabled by default there. ๐ โโ๏ธ-mcaller-super-interworkingโ allows calls via function pointers (including virtual functions) to 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 option is enabled. Also not valid in AAPCS configurations, because again, interworking is enabled by default there. ๐-mtp=nameโ specifies the access model for the thread local storage pointer. The modelsoftgenerates calls to__aeabi_read_tp. Other accepted models aretpidrurw,tpidruroandtpidrprw, which fetch the thread pointer from the corresponding system register directly (supported from the arm6k architecture and later). These system registers are accessed through the CP15 co-processor interface, and the argumentcp15is also accepted as a convenience alias oftpidruro. The argumentautouses the best available method for the selected processor. The default setting isauto. โจ-mtls-dialect=dialectโ specifies 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 gives 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. Pick your dialect, bestie. ๐ฃ๏ธ-mword-relocationsโ only generates 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. They cannot both be the main character. ๐-mfix-cortex-m3-ldrdโ some Cortex-M3 cores can cause data corruption whenldrdinstructions with overlapping destination and base registers are used. This option avoids generating these instructions. Enabled by default when-mcpu=cortex-m3is specified. Crisis averted. ๐ซถ-mfix-cortex-a57-aes-1742098-mno-fix-cortex-a57-aes-1742098-mfix-cortex-a72-aes-1655431-mno-fix-cortex-a72-aes-1655431โ enable (disable) mitigation for an erratum on Cortex-A57 and Cortex-A72 that affects the AES cryptographic instructions. Enabled by default when either-mcpu=cortex-a57or-mcpu=cortex-a72is specified. Yes, the option names have CVE-style numbers in them, and yes, that's iconic. ๐ฅ-munaligned-access-mno-unaligned-accessโ enables (or disables) reading and writing of 16- and 32-bit values from addresses that are not 16- or 32-bit aligned. By default, unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for ARMv8-M Baseline architectures, and enabled for all other architectures. If unaligned access is not enabled, then words in packed data structures are accessed a byte at a time. Slow and steady, I guess. ๐ข
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. And if unaligned access is enabled, the preprocessor symbol __ARM_FEATURE_UNALIGNED is also defined. โจ
-mslow-flash-dataโ assumes loading data from flash is slower than fetching instructions. Therefore, literal loads are 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. Drama between flags, as always. ๐ญ-masm-syntax-unifiedโ assumes 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. Rules are rules. ๐-mpure-codeโ does not allow constant data to be placed in code sections. Additionally, when compiling for ELF object format, it gives 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. Keep your data and your code separated, bestie, it's giving healthy boundaries. ๐ฆ-mcmseโ bestie, this one generates secure code as per the "ARMv8-M Security Extensions: Requirements on Development Tools Engineering Specification" ๐ , which lives at <https://developer.arm.com/documentation/ecm0359818/latest/>.-mfix-cmse-cve-2021-35465โ mitigates a potential security issue with theVLLDMinstruction in some M-profile devices when you're using CMSE (CVE-2021-365465) ๐ญ. It's on by default when-mcpu=is used withcortex-m33,cortex-m35p,cortex-m52,cortex-m55,cortex-m85orstar-mc1. And if you wanna turn the mitigation off, the option-mno-fix-cmse-cve-2021-35465is right there for you ๐ซถ.-mstack-protector-guard=guard,-mstack-protector-guard-offset=offsetโ generates stack protection code using a canary at guard. Supported locations areglobalfor a global canary ortlsfor a canary accessible via the TLS register โจ. The option-mstack-protector-guard-offset=is for use with-fstack-protector-guard=tlsand not for use in user-land code, so don't try it ๐ซ.-mfdpic,-mno-fdpicโ selects the FDPIC ABI, which uses 64-bit function descriptors to represent pointers to functions ๐. When the compiler is configured forarm-*-uclinuxfdpiceabitargets, this option is on by default and implies-fPIEif none of the PIC/PIE-related options is provided. On other targets, it only enables the FDPIC-specific code generation features, and you should explicitly provide the PIC/PIE-related options as needed.
Heads up bestie ๐ โ static linking is not supported here, because it would still involve the dynamic linker when the program self-relocates. If such behavior is acceptable, use-staticand-Wl,-dynamic-linkeroptions.
The opposite -mno-fdpic option is useful (and required) to build the Linux kernel using the same (arm-*-uclinuxfdpiceabi) toolchain as the one used to build the userland programs ๐ธ.
-mbranch-protection=featuresโ enables branch protection features (armv8.1-m.main only) ๐.
features can have one of the following forms:
noneโ generates code without branch protection or return address signing.standardโ generates code with all branch protection features enabled at their standard level.pac-retโ generates code with return address signing set to its standard level, which is to sign all functions that save the return address to memory.pac-ret+leafโ extends thepac-retsigning to include leaf functions even if they do not write the return address to memory.btiโ adds landing-pad instructions at the permitted targets of indirect branch instructions.
If support for the +pacbti architecture extension is not enabled (e.g. via -march=), then all branch protection and return address signing operations are constrained to use only the instructions defined in the architectural-NOP space ๐ฎ. The generated code remains backwards-compatible with earlier versions of the architecture, but the additional security can be enabled at run time on processors that support the PACBTI extension.
Branch target enforcement using BTI can only be enabled at runtime if all code in the application has been compiled with at least -mbranch-protection=bti ๐.
Any setting other than none is supported only on armv8-m.main or later.
The default is to generate code without branch protection or return address signing.
-mvectorize-with-neon-quad,-mvectorize-with-neon-doubleโ controls whether vectorization uses NEON quad-word or double-word registers ๐. The default is-mvectorize-with-neon-quad.
๐ AVR Options ๐
These options are defined for AVR implementations, bestie, so listen up ๐:
-mmcu=mcuโ specify the AVR instruction set architecture (ISA) or device type ๐ฆ. The default for this option isavr2.
The following AVR devices and ISAs are supported. Note: a complete device support consists of startup code crtmcu.o, a device header avr/io*.h, a device library libmcu.a and a device-specs (https://gcc.gnu.org/wiki/avr-gcc#spec-files) file specs-mcu. Only the latter is provided by the compiler according the supported mcus below. The rest is supported by AVR-LibC (https://github.com/avrdudes/avr-libc/), or by means of atpack (https://gcc.gnu.org/wiki/avr-gcc#atpack) files from the hardware manufacturer โญ.
avr2โ "Classic" devices with up to 8 KiB of program memory. mcu =attiny22,attiny26,at90s2313,at90s2323,at90s2333,at90s2343,at90s4414,at90s4433,at90s4434,at90c8534,at90s8515,at90s8535.avr25โ "Classic" devices with up to 8 KiB of program memory and with theMOVWinstruction. mcu =attiny13,attiny13a,attiny24,attiny24a,attiny25,attiny261,attiny261a,attiny2313,attiny2313a,attiny43u,attiny44,attiny44a,attiny45,attiny48,attiny441,attiny461,attiny461a,attiny4313,attiny84,attiny84a,attiny85,attiny87,attiny88,attiny828,attiny841,attiny861,attiny861a,ata5272,ata6616c,at86rf401.avr3โ "Classic" devices with 16 KiB up to 64 KiB of program memory. mcu =at76c711,at43usb355.avr31โ "Classic" devices with 128 KiB of program memory. mcu =atmega103,at43usb320.avr35โ "Classic" devices with 16 KiB up to 64 KiB of program memory and with theMOVWinstruction. mcu =attiny167,attiny1634,atmega8u2,atmega16u2,atmega32u2,ata5505,ata6617c,ata664251,at90usb82,at90usb162.avr4โ "Enhanced" devices with up to 8 KiB of program memory. mcu =atmega48,atmega48a,atmega48p,atmega48pa,atmega48pb,atmega8,atmega8a,atmega8hva,atmega88,atmega88a,atmega88p,atmega88pa,atmega88pb,atmega8515,atmega8535,ata5795,ata6285,ata6286,ata6289,ata6612c,at90pwm1,at90pwm2,at90pwm2b,at90pwm3,at90pwm3b,at90pwm81.avr5โ "Enhanced" devices with 16 KiB up to 64 KiB of program memory. mcu =atmega16,atmega16a,atmega16hva,atmega16hva2,atmega16hvb,atmega16hvbrevb,atmega16m1,atmega16u4,atmega161,atmega162,atmega163,atmega164a,atmega164p,atmega164pa,atmega165,atmega165a,atmega165p,atmega165pa,atmega168,atmega168a,atmega168p,atmega168pa,atmega168pb,atmega169,atmega169a,atmega169p,atmega169pa,atmega32,atmega32a,atmega32c1,atmega32hvb,atmega32hvbrevb,atmega32m1,atmega32u4,atmega32u6,atmega323,atmega324a,atmega324p,atmega324pa,atmega324pb,atmega325,atmega325a,atmega325p,atmega325pa,atmega328,atmega328p,atmega328pb,atmega329,atmega329a,atmega329p,atmega329pa,atmega3250,atmega3250a,atmega3250p,atmega3250pa,atmega3290,atmega3290a,atmega3290p,atmega3290pa,atmega406,atmega64,atmega64a,atmega64c1,atmega64hve,atmega64hve2,atmega64m1,atmega64rfr2,atmega640,atmega644,atmega644a,atmega644p,atmega644pa,atmega644rfr2,atmega645,atmega645a,atmega645p,atmega649,atmega649a,atmega649p,atmega6450,atmega6450a,atmega6450p,atmega6490,atmega6490a,atmega6490p,ata5790,ata5790n,ata5791,ata6613c,ata6614q,ata5782,ata5831,ata8210,ata8510,ata5787,ata5835,ata5700m322,ata5702m322,at90pwm161,at90pwm216,at90pwm316,at90can32,at90can64,at90scr100,at90usb646,at90usb647,at94k,m3000.avr51โ "Enhanced" devices with 128 KiB of program memory. mcu =atmega128,atmega128a,atmega128rfa1,atmega128rfr2,atmega1280,atmega1281,atmega1284,atmega1284p,atmega1284rfr2,at90can128,at90usb1286,at90usb1287.avr6โ "Enhanced" devices with 3-byte PC, i.e. with more than 128 KiB of program memory. mcu =atmega256rfr2,atmega2560,atmega2561,atmega2564rfr2.avrxmega2โ "XMEGA" devices with more than 8 KiB and up to 64 KiB of program memory. mcu =atxmega8e5,atxmega16a4,atxmega16a4u,atxmega16c4,atxmega16d4,atxmega16e5,atxmega32a4,atxmega32a4u,atxmega32c3,atxmega32c4,atxmega32d3,atxmega32d4,atxmega32e5,avr64da28,avr64da28s,avr64da32,avr64da32s,avr64da48,avr64da48s,avr64da64,avr64da64s,avr64db28,avr64db32,avr64db48,avr64db64,avr64dd14,avr64dd20,avr64dd28,avr64dd32,avr64du28,avr64du32,avr64ea28,avr64ea32,avr64ea48,avr64sd28,avr64sd32,avr64sd48.
"avrxmega3"โ okay so these are the "XMEGA" girlies with up to 64 KiB of combined program memory and RAM, and with program memory visible in the RAM address space. Themcuroster is absolutely massive, so here it is in full, no skips:mcu = "attiny202", "attiny204", "attiny212", "attiny214", "attiny402", "attiny404", "attiny406", "attiny412", "attiny414", "attiny416", "attiny416auto", "attiny417", "attiny424", "attiny426", "attiny427", "attiny804", "attiny806", "attiny807", "attiny814", "attiny816", "attiny817", "attiny824", "attiny826", "attiny827", "attiny1604", "attiny1606", "attiny1607", "attiny1614", "attiny1616", "attiny1617", "attiny1624", "attiny1626", "attiny1627", "attiny3214", "attiny3216", "attiny3217", "attiny3224", "attiny3226", "attiny3227", "atmega808", "atmega809", "atmega1608", "atmega1609", "atmega3208", "atmega3209", "atmega4808", "atmega4809", "avr16dd14", "avr16dd20", "avr16dd28", "avr16dd32", "avr16du14", "avr16du20", "avr16du28", "avr16du32", "avr16ea28", "avr16ea32", "avr16ea48", "avr16eb14", "avr16eb20", "avr16eb28", "avr16eb32", "avr16la14", "avr16la20", "avr16la28", "avr16la32", "avr32da28", "avr32da28s", "avr32da32", "avr32da32s", "avr32da48", "avr32da48s", "avr32db28", "avr32db32", "avr32db48", "avr32dd14", "avr32dd20", "avr32dd28", "avr32dd32", "avr32du14", "avr32du20", "avr32du28", "avr32du32", "avr32ea28", "avr32ea32", "avr32ea48", "avr32eb14", "avr32eb20", "avr32eb28", "avr32eb32", "avr32la14", "avr32la20", "avr32la28", "avr32la32", "avr32sd20", "avr32sd28", "avr32sd32"."avrxmega4"โ "XMEGA" devices with more than 64 KiB and up to 128 KiB of program memory.mcu = "atxmega64a3", "atxmega64a3u", "atxmega64a4u", "atxmega64b1", "atxmega64b3", "atxmega64c3", "atxmega64d3", "atxmega64d4", "avr128da28", "avr128da28s", "avr128da32", "avr128da32s", "avr128da48", "avr128da48s", "avr128da64", "avr128da64s", "avr128db28", "avr128db32", "avr128db48", "avr128db64"."avrxmega5"โ "XMEGA" devices with more than 64 KiB and up to 128 KiB of program memory and more than 64 KiB of RAM.mcu = "atxmega64a1", "atxmega64a1u"."avrxmega6"โ "XMEGA" devices with more than 128 KiB of program memory.mcu = "atxmega128a3", "atxmega128a3u", "atxmega128b1", "atxmega128b3", "atxmega128c3", "atxmega128d3", "atxmega128d4", "atxmega192a3", "atxmega192a3u", "atxmega192c3", "atxmega192d3", "atxmega256a3", "atxmega256a3b", "atxmega256a3bu", "atxmega256a3u", "atxmega256c3", "atxmega256d3", "atxmega384c3", "atxmega384d3"."avrxmega7"โ "XMEGA" devices with more than 128 KiB of program memory and more than 64 KiB of RAM.mcu = "atxmega128a1", "atxmega128a1u", "atxmega128a4u"."avrtiny"โ the "Reduced Tiny" Tiny core devices, with only 16 general purpose registers and 512 B up to 4 KiB of program memory.mcu = "attiny4", "attiny5", "attiny9", "attiny10", "attiny102", "attiny104", "attiny20", "attiny40"."avr1"โ this ISA is implemented by the minimal AVR core and is supported for assembler only, bestie, that's it.mcu = "attiny11", "attiny12", "attiny15", "attiny28", "at90s1200".
-mabsdataโ assume that all data in static storage can be accessed by LDS / STS instructions. This option has only an effect on reduced Tiny devices like ATtiny40. See also the"absdata"AVR Attributes,variableattribute. ๐ซถ-mcvtโ use a compact vector table. Some devices support a CVT with only four entries: 0=Reset, 1=NMI, 2=Prio1 IRQ, 3=Prio0 IRQs. This option will link startup code fromcrtmcu-cvt.oinstead of the usualcrtmcu.o. Apart from providing a compact vector table, the startup code will set bitCPUINT_CTRLA.CPUINT_CVTwhich enables the CVT on the device.
When you do not want the startup code to set CPUINT_CTRLA.CPUINT_CVT, then you can satisfy symbol __init_cvt so that the respective code is no more pulled in from libmcu.a. For example, you can link with -Wl,--defsym,__init_cvt=0.
The CVT startup code is available since AVR-LibC v2.3 (https://github.com/avrdudes/avr-libc/issues/1010). โจ
-mdouble=bits-mlong-double=bitsโ set the size (in bits) of thedoubleorlong doubletype, respectively. Possible values for bits are 32 and 64. Whether or not a specific value for bits is allowed depends on the--with-double=and--with-long-double=configure options (https://gcc.gnu.org/install/configure.html#avr), and the same applies for the default values of the options. iykyk-mgas-isr-prologuesโ interrupt service routines (ISRs) may use the__gcc_isrpseudo instruction supported by GNU Binutils. If this option is on, the feature can still be disabled for individual ISRs by means of theAVR Attributes,,"no_gccisr"function attribute. This feature is activated per default if optimization is on (but not with-Og,@pxref{Optimize Options}), and if GNU Binutils support PR21683 (https://sourceware.org/PR21683).-mint8โ assumeintto be 8-bit integer. This affects the sizes of all the types: acharis 1 byte, anintis 1 byte, alongis 2 bytes, andlong longis 4 bytes. Please note that this option does not conform to the C standards, but it results in smaller code size. ๐-mmain-is-OS_taskโ do not save registers inmain. The effect is the same like attaching attributeAVR Attributes,,"OS_task"tomain. It is activated per default if optimization is on.-mno-call-mainโ don't runmainby means of
XCALL main
XJMP exit
Instead, put main in section .init9 (https://avrdudes.github.io/avr-libc/avr-libc-user-manual/mem_sections.html#sec_dot_init) so that no call is required. By setting this option the user asserts that main will not return.
This option can be used for devices with very limited resources in order to save a few bytes of code and stack space. It will work as expected since AVR-LibC v2.3 (https://github.com/avrdudes/avr-libc/issues/1012). With older versions, there will be no performance gain.
-mno-interruptsโ generated code is not compatible with hardware interrupts. Code size is smaller. ๐ญ (tradeoffs, am I right)-mrelaxโ try to replaceCALLresp.JMPinstruction by the shorterRCALLresp.RJMPinstruction if applicable. Setting-mrelaxjust adds the--mlink-relaxoption to the assembler's command line and the--relaxoption to the linker's command line.
Jump relaxing is performed by the linker because jump offsets are not known before code is located. Therefore, the assembler code generated by the compiler is the same, but the instructions in the executable may differ from instructions in the assembler code.
Relaxing must be turned on if linker stubs are needed, see the section on "EIND" and linker stubs below. โญ
-mpmem-wrap-aroundโ enable program counter wrap-around in linker relaxation.-mrodata-in-ram-mno-rodata-in-ramโ locate the.rodatasections for read-only data in RAM resp. in program memory. For most devices, there is no choice and this option acts rather like an assertion.
Since v14 and for the AVR64* and AVR128* devices, .rodata is located in flash memory per default, provided the required GNU Binutils support (PR31124 (https://sourceware.org/PR31124)) is available. In that case, -mrodata-in-ram can be used to return to the old layout with .rodata in RAM.
-mtiny-stackโ only change the lower 8 bits of the stack pointer.-mfract-convert-truncateโ allow to use truncation instead of rounding towards zero for fractional fixed-point types.-nodevicelibโ don't link against AVR-LibC's device specific librarylibmcu.a.
Notice that since AVR-LibC v2.3, that library contains code that is essential for the correct functioning of a program. In particular, it contains parts of the startup code like: __init_sp (https://github.com/avrdudes/avr-libc/issues/1011) to initialize the stack pointer with symbol __stack, __init_cvt (https://github.com/avrdudes/avr-libc/issues/1010) to set up the hardware to use a compact vector table with -mcvt, __call_main (https://github.com/avrdudes/avr-libc/issues/1012) to call main and exit, and __do_flmap_init (https://github.com/avrdudes/avr-libc/issues/931) to set up FLMAP according to symbol __flmap.
bestie, that's a lot of load-bearing startup code. proceed with intention. ๐
-nodevicespecsโ don't add-specs=device-specs/specs-mcuto the compiler driver's command line. The user takes responsibility for supplying the sub-processes like compiler proper, assembler and linker with appropriate command line options. This means that the user has to supply her private device specs file by means of-specs=path-to-specs-file. There is no more need for option-mmcu=mcu.
This option can also serve as a replacement for the older way of specifying custom device-specs files that needed -B some-path to point to a directory which contains a folder named device-specs which contains a specs file named specs-mcu, where mcu was specified by -mmcu=mcu.
-Waddr-space-convertโ warn about conversions between address spaces in the case where the resulting address space is not contained in the incoming address space.-Wmisspelled-isrโ warn if the ISR is misspelled, i.e. without__vectorprefix. Enabled by default. ๐
โจ AVR Optimization Options โจ
The following options are pure optimization options. Options -mgas-isr-prologues, -mmain-is-OS_task, -mno-call-main and -mrelax from above are only almost optimization options, since there are rare occasions where their different code generation matters. ๐ฆ
-maccumulate-argsโ accumulate outgoing function arguments and acquire/release the needed stack space for outgoing function arguments once in function prologue/epilogue. Without this option, outgoing arguments are pushed before calling a function and popped afterwards. See also the-fdefer-popOptimize Options,,optimizationoption.
Popping the arguments after the function call can be expensive on AVR so that accumulating the stack space might lead to smaller executables because arguments need not be removed from the stack after such a function call. ๐ฅ
This option can lead to reduced code size for functions that perform several calls to functions that get their arguments on the stack, like calls to printf-like functions. sneaky lil code-size win, love that for us ๐
-mbranch-cost=costโ sets the branch costs for conditional branch instructions to cost. Reasonable values for cost are small, non-negative integers, and the default branch cost is0. tiny number, big vibes-mcall-prologuesโ function prologues/epilogues get expanded as calls to the appropriate subroutines, which means the code size is smaller. ๐-mfuse-add,-mno-fuse-add,-mfuse-add=levelโ optimize indirect memory accesses on reduced Tiny devices. The default useslevel=1for optimizations-Ogand-O1, andlevel=2for higher optimizations. Valid values for level are0,1and2. โจ-mfuse-move,-mno-fuse-move,-mfuse-move=levelโ runs a post reload optimization pass that tries to fuse move instructions and to split multi-byte instructions into 8-bit operations. The default useslevel=3for optimization-O1, andlevel=23for higher optimizations. Valid values for level are in the range0 ... 23, which is a3:2:2:2mixed radix value โ each digit controls some aspect of the optimization. it's giving secret code, ngl-mfuse-move2โ runs a post combine optimization pass that tries to fuse move instructions. ๐ฆ-mstrict-Xโ uses the address registerXin a way proposed by the hardware. This means thatXis 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
-msplit-bit-shiftโ splits multi-byte shifts with a constant offset into a shift with a byte offset and a residual shift with a non-byte offset. This optimization is turned on per default for-O2and higher, including-Osbut excluding-Oz. Splitting of shifts with a constant offset that is a multiple of8is controlled by-mfuse-move. ๐-msplit-ldstโ splits multi-byte loads and stores into several byte loads and stores. This optimization is turned on per default for-O2and higher. ๐ฅ-muse-nonzero-bitsโ enables optimizations that are only possible when some bits in a register are always zero. This optimization is turned on per default for-O2and higher. โญ
๐ EIND and Devices with More Than 128 Ki Bytes of Flash ๐
Pointers in the implementation are 16 bits wide. The address of a function or label is represented as a word address so that indirect jumps and calls can target any code address in the range of 64 Ki words.
In order to facilitate indirect jump on devices with more than 128 Ki bytes of program memory space, there is a special function register called EIND that serves as the most significant part of the target address when EICALL or EIJMP instructions are used. she's the most significant part, literally ๐
Indirect jumps and calls on these devices are handled as follows by the compiler and are subject to some limitations:
- The compiler never sets
EIND. - The compiler uses
EINDimplicitly inEICALL/EIJMPinstructions, or might readEINDdirectly in order to emulate an indirect call/jump by means of aRETinstruction. - The compiler assumes that
EINDnever changes during the startup code or during the application. In particular,EINDis not saved/restored in function or interrupt service routine prologue/epilogue. ๐ - 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. no error message?? rude ๐ - The default linker script is arranged for code with
EIND = 0. If code is supposed to work for a setup withEIND != 0, a custom linker script has to be used in order to place the sections whose name start with.trampolinesinto the segment whereEINDpoints to. - The startup code from libgcc never sets
EIND. Notice that startup code is a blend of code from libgcc and AVR-LibC. For the impact of AVR-LibC onEIND, see the AVR-LibC user manual (https://avrdudes.github.io/avr-libc/avr-libc-user-manual/). - It is legitimate for user-specific startup code to set up
EINDearly, for example by means of initialization code located in section.init3. Such code runs prior to general startup code that initializes RAM and calls constructors, but after the bit of startup code from AVR-LibC that setsEINDto the segment where the vector table is located.
#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 the
-mcall-prologuescommand-line option. - Switch/case dispatch tables. If you do not want such dispatch tables you can specify the
-fno-jump-tablescommand-line option. - C and C++ constructors/destructors called during startup/shutdown.
- If the tools hit a
gs()modifier explained above.
- Jumping to non-symbolic addresses like so is not supported:
int main (void)
{
/* Call function at word address 0x2 */
return ((int(*)(void)) 0x2)();
}
Instead, a stub has to be set up, i.e. the function has to be called through a symbol (func_4 in the example):
int main (void)
{
extern int func_4 (void);
/* Call function at byte address 0x4 */
return func_4();
}
and the application be linked with -Wl,--defsym,func_4=0x4. Alternatively, func_4 can be defined in the linker script.
๐ง Handling of the RAMPD, RAMPX, RAMPY and RAMPZ Special Function Registers ๐ง
Some AVR devices support memories larger than the 64 KiB range that can be accessed with 16-bit pointers. To access memory locations outside this 64 KiB range, the content of a RAMP register is used as the high part of the address: the X, Y, Z address register is concatenated with the RAMPX, RAMPY, RAMPZ special function register, respectively, to get a wide address. Similarly, RAMPD is used together with direct addressing. stacking registers like a lil outfit, honestly iconic
- The startup code initializes the
RAMPspecial function registers with zero. - 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 the 16-bit address range and change one of theRAMPregisters, you must reset it to zero after the access. do NOT forget this one bestie, she will not forgive you ๐ญ
๐ 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", "avr25", "avr3", "avr31", "avr35", "avr4", "avr5", "avr51", "avr6",
respectively and
100, 102, 103, 104, 105, 106, 107
for mcu="avrtiny", "avrxmega2", "avrxmega3", "avrxmega4", "avrxmega5", "avrxmega6", "avrxmega7", respectively. If mcu specifies a device, this built-in macro is set accordingly. For example, with -mmcu=atmega8 the macro is defined to 4.
__AVR_Device__โ setting-mmcu=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 to"atmega8".
If device is not a device but only a core architecture like avr51, this macro is not defined.
__AVR_CVT__โ the code is being compiled with option-mcvtto use a compact vector table. compact queen ๐__AVR_XMEGA__โ the device / architecture is part of the XMEGA family of devices. family reunion energy โจ__AVR_HAVE_ADIW__โ this device ships with theADIWandSBIWinstructions.__AVR_HAVE_ELPM__โ it's got theELPMinstruction.__AVR_HAVE_ELPMX__โ and it's got theELPM Rn,ZandELPM Rn,Z+instructions too.__AVR_HAVE_LPMX__โ it has theLPM Rn,ZandLPM Rn,Z+instructions.__AVR_HAVE_MOVW__โ the device has theMOVWinstruction, which does 16-bit register-register moves. cute lil optimization bestie__AVR_HAVE_MUL__โ hardware multiplier? yeah, it has one. slay__AVR_HAVE_JMP_CALL__โ it has theJMPandCALLinstructions. That's the case for devices with more than 8 KiB of program memory.__AVR_HAVE_EIJMP_EICALL____AVR_3_BYTE_PC__โ the device has theEIJMPandEICALLinstructions. That's the case for devices with more than 128 KiB of program memory. It also means the program counter (PC) is 3 bytes wide.__AVR_2_BYTE_PC__โ the program counter (PC) is 2 bytes wide. This is the case for devices with up to 128 KiB of program memory.__AVR_HAVE_8BIT_SP____AVR_HAVE_16BIT_SP__โ the stack pointer (SP) register gets treated as an 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. mirror mirror on the wall__AVR_ERRATA_SKIP____AVR_ERRATA_SKIP_JMP_CALL__โ some AVR devices (AT90S8515,ATmega103) must not skip 32-bit instructions because of a hardware erratum. not a vibe, a genuine hardware bug The 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 than if they were addressed by an instruction that accesses 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. math girlies rise__AVR_SHORT_CALLS__โ the-mshort-callscommand line option is set.__AVR_PM_BASE_ADDRESS__=addrโ some devices support reading from flash memory by means ofLD*instructions. The flash memory is seen in the data address space at an offset of__AVR_PM_BASE_ADDRESS__. If this macro is not defined, this feature is not available. If it is defined, the address space is linear and there's no need to put.rodatainto RAM. This is handled by the default linker description file, and it's currently available foravrtinyandavrxmega3. Even more convenient: there's no need to use address spaces like__flashor features like attributeprogmemandpgm_read_*. quality of life upgrade fr fr__AVR_HAVE_FLMAP__โ this macro is defined provided the following conditions are met:- the device has the
NVMCTRL_CTRLB.FLMAPbitfield. This applies to the AVR64* and AVR128* devices. - it's not known at assembler-time which emulation will be used.
- the device has the
This implies the compiler was configured with GNU Binutils that implement PR31124 (https://sourceware.org/PR31124).
__AVR_RODATA_IN_RAM__โ this macro is undefined when the code is compiled for a core architecture.
When the code is compiled for a device, the macro is defined to 1 when the .rodata sections for read-only data is located in RAM; and defined to 0, otherwise.
__WITH_AVRLIBC__โ the compiler is configured to be used together with AVR-LibC. See the--with-avrlibcconfigure option.__HAVE_SIGNAL_N__โ the compiler supports thesignal(num)andinterrupt(num)AVR Attributes,,function attributes with an argumentnumthat specifies the number of the interrupt service routine.__HAVE_DOUBLE_MULTILIB__โ defined if-mdouble=acts as a multilib option.__HAVE_DOUBLE32____HAVE_DOUBLE64__โ defined if the compiler supports 32-bit double resp. 64-bit double. The actual layout is specified by option-mdouble=.__DEFAULT_DOUBLE__โ the size in bits ofdoubleif-mdouble=is not set. To test the layout ofdoublein a program, use the built-in macro__SIZEOF_DOUBLE__. iykyk__HAVE_LONG_DOUBLE32____HAVE_LONG_DOUBLE64____HAVE_LONG_DOUBLE_MULTILIB____DEFAULT_LONG_DOUBLE__โ same as above, but forlong doubleinstead ofdouble. the long long of floats, iconic__WITH_DOUBLE_COMPARISON__โ reflects the--with-double-comparison={tristate|bool|libf7}configure option (https://gcc.gnu.org/install/configure.html#avr) and is defined to 2 or 3.__WITH_LIBF7_LIBGCC____WITH_LIBF7_MATH____WITH_LIBF7_MATH_SYMBOLS__โ reflects the--with-libf7={libgcc|math|math-symbols}configure option (https://gcc.gnu.org/install/configure.html#avr).
๐ AVR Internal Options ๐
Okay so these next ones are internal โ the compiler uses them for itself and to talk back and forth between device specs files and the compiler proper. behind-the-scenes besties, the stage crew of this whole production You do not need to set these by hand, and in particular they are not optimization options.
Using these options in the wrong way may lead to sub-optimal or wrong code. do not freestyle this one, babe
They're documented for completeness, and so you can get a better understanding of device specs (https://gcc.gnu.org/wiki/avr-gcc#spec-files) files.
-mn-flash=numโ assume the flash memory has a size of num times 64 KiB. This determines which__flashNaddress spaces are available.-mflmapโ the device has theFLMAPbit field located in special function registerNVMCTRL_CTRLB.-mrmwโ assume the device supports the Read-Modify-Write instructionsXCH,LAC,LASandLAT.-mshort-callsโ assume thatRJMPandRCALLcan target the whole program memory. This option is used for multilib generation and selection for the devices from architectureavrxmega3.-mskip-bugโ generate code without skips (CPSE,SBRS,SBRC,SBIS,SBIC) over 32-bit instructions.-msp8โ treat the stack pointer register as an 8-bit register, i.e. assume the high byte of the stack pointer is zero. This option is used by the compiler to select and build multilibs for architecturesavr2andavr25. These architectures mix devices with and withoutSPH. chaos architecture energy tbh
๐ Blackfin Options ๐
-mcpu=cpu[-sirevision]โ specifies the name of the target Blackfin processor. Currently, 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 specifies the silicon revision of the target Blackfin processor. Any workarounds available for the targeted silicon revision are enabled. If sirevision is none, no workarounds are enabled. If sirevision is any, all workarounds for the targeted processor are enabled. The __SILICON_REVISION__ macro is defined to two hexadecimal digits representing the major and minor numbers in the silicon revision. If sirevision is none, the __SILICON_REVISION__ is not defined. If sirevision is any, the __SILICON_REVISION__ is defined to be 0xffff. If this optional sirevision is not used, GCC assumes the latest known silicon revision of the targeted Blackfin processor.
GCC defines a preprocessor macro for the specified cpu. For the bfin-elf toolchain, this option causes the hardware BSP provided by libgloss to be linked in if -msim is not given.
Without this option, bf532 is used as the processor by default.
Note that support for bf561 is incomplete. For bf561, only the preprocessor macro is defined. half-finished, we love a WIP
-msimโ specifies that the program will be run on the simulator. This causes the simulator BSP provided by libgloss to be linked in. This option has effect only forbfin-elftoolchain. Certain other options, such as-mid-shared-libraryand-mfdpic, imply-msim.-momit-leaf-frame-pointerโ don't keep the frame pointer in a register for leaf functions. This avoids the instructions to save, set up and restore frame pointers and makes an extra register available in leaf functions. free real estate โจ-mspecld-anomaly-mno-specld-anomalyโ when enabled, the compiler ensures that the generated code does not contain speculative loads after jump instructions. If this option is used,__WORKAROUND_SPECULATIVE_LOADSis defined.-mcsync-anomaly-mno-csync-anomalyโ when enabled, the compiler ensures that the generated code does not contain CSYNC or SSYNC instructions too soon after conditional branches. If this option is used,__WORKAROUND_SPECULATIVE_SYNCSis defined.-mlow64k-mno-low64kโ when enabled, the compiler is free to take advantage of the knowledge that the entire program fits into the low 64k of memory. The default behavior is to assume that the program is arbitrarily large (-mno-low64k).-mstack-check-l1โ do stack checking using information placed into L1 scratchpad memory by the uClinux kernel.-mid-shared-library-mno-id-shared-libraryโ generate code that supports shared libraries via the library ID method. This allows for execute in place and shared libraries in an environment without virtual memory management. This option implies-fPIC. With abfin-elftarget, this option implies-msim. The default is-mno-id-shared-library, to generate code that doesn't assume ID-based shared libraries are being used. no virtual memory? we making it work regardless, periodt-mleaf-id-shared-library-mno-leaf-id-shared-libraryโ generate code that supports shared libraries via the library ID method, but assumes that this library or executable won't link against any other ID shared libraries. That allows the compiler to use faster code for jumps and calls. speed demon behavior ๐
So yeah, if you don't pass that other flag, this is what you get. The default is -mno-leaf-id-shared-library, meaning GCC just assumes the code it's compiling is not gonna link against any ID shared libraries. Consequence? Slower code gets generated for jump and call instructions. It is what it is. ๐
-mshared-library-id=nโ tells GCC the identification number of the ID-based shared library you're compiling. Settingnto0gives you more compact code; any other value forces that number onto the current library but is genuinely no more space- or time-efficient than just not passing this option at all. So like, pick0or don't bother. ๐-msep-data,-mno-sep-dataโ generate code that lets the data segment live in a totally different area of memory than the text segment. This enables execute-in-place in an environment with no virtual memory management, because it eliminates relocations against the text section. The default is-mno-sep-data, which tells GCC to assume the data segment follows the text segment. ๐ซถ-mlong-calls,-mno-long-callsโ makes the compiler do function calls by first loading the function's address into a register, then doing a subroutine call on that register. You need this if the target function sits outside the 24-bit addressing range of the offset-based version of the subroutine call instruction. Not enabled by default, bestie. Passing-mno-long-callsrestores the default behavior. Heads up though: these switches do nothing about how the compiler generates code for calls made via function pointers.-mfast-fpโ links against the fast floating-point library. This library relaxes some of the IEEE floating-point standard's rules for checking inputs against Not-a-Number (NAN), all in the name of performance. ๐๏ธโจ-minline-pltโ enables inlining of PLT entries in function calls to functions that aren't known to bind locally. Also, it does absolutely nothing without-mfdpic.-mmulticoreโ builds a standalone application for multicore Blackfin processors. This pulls in the proper start files and link scripts that support multicore, and defines the macro"__BFIN_MULTICORE". It can only be used with-mcpu=bf561[-sirevision].
You can pair this with -mcorea or -mcoreb, which selects the one-application-per-core programming model. Without -mcorea or -mcoreb, you get the single-application/dual-core programming model instead. In that model, the main function of Core B should be named "coreb_main".
And if you just don't use this option at all? Then the single-core application programming model is what you get.
-mcoreaโ builds a standalone application for Core A of BF561 when you're on the one-application-per-core programming model. Proper start files and link scripts get used to support Core A, and the macro"__BFIN_COREA"is defined. This one can only be used together with-mmulticore.-mcorebโ builds a standalone application for Core B of BF561 when you're on the one-application-per-core programming model. Proper start files and link scripts support Core B, and the macro"__BFIN_COREB"is defined. When you use this,"coreb_main"should be used instead of"main". Again โ only with-mmulticore.-msdramโ builds a standalone application for SDRAM. Proper start files and link scripts put the application into SDRAM, and the macro"__BFIN_SDRAM"is defined. The loader is responsible for initializing SDRAM before loading the application. ๐-micplbโ assumes ICPLBs are enabled at run time. This affects certain anomaly workarounds. For Linux targets, the default is to assume ICPLBs are enabled; for standalone applications, the default is off.
๐ C6X Options ๐
-march=nameโ specifies the name of the target architecture. GCC uses this name to figure out what kind of instructions it's allowed to emit when generating assembly code. Permissible names are:c62x,c64x,c64x+,c67x,c67x+,c674x.-mbig-endianโ generate code for a big-endian target.-mlittle-endianโ generate code for a little-endian target. This is the default. โจ-msimโ choose startup files and a linker script suitable for the simulator.-msdata=defaultโ put small global and static data in the".neardata"section, which is pointed to by register"B14". Put small uninitialized global and static data in the".bss"section, which sits adjacent to the".neardata"section. Put small read-only data into the".rodata"section. The corresponding sections used for big chunks of data are".fardata",".far"and".const".-msdata=allโ put all data, not just small objects, into the sections reserved for small data, and use addressing relative to the"B14"register to access them.-msdata=noneโ make no use of the sections reserved for small data, and use absolute addresses to access all data. Put all initialized global and static data in the".fardata"section, all uninitialized data in the".far"section, and all constant data into the".const"section.-mdsbtโ compile for the DSBT shared library ABI. This option is required to compile with-fpicor-fPIC, and it implies-fpic.-mlong-callsโ avoid generating PC-relative calls; use indirection instead.
๐ CRIS Options ๐
These options are defined specifically for the CRIS ports. Iykyk.
-march=architecture-type,-mcpu=architecture-typeโ generate code for the specified architecture. Your choices for architecture-type arev3,v8andv10, for ETRAX 4, ETRAX 100, and ETRAX 100 LX respectively. Default isv0.-mtune=architecture-typeโ tune everything applicable about the generated code to architecture-type, except for the ABI and the set of available instructions. The choices for architecture-type are the same as for-march=architecture-type.-mmax-stackframe=nโ warn when the stack frame of a function exceeds n bytes. ๐-metrax4,-metrax100โ these two are synonyms for-march=v3and-march=v8respectively.-mmul-bug-workaround,-mno-mul-bug-workaroundโ work around a bug in the"muls"and"mulu"instructions, for CPU models where it applies. This option is disabled by default. ๐-mpdebugโ enable CRIS-specific verbose debug-related information in the assembly code. This option also has the effect of turning off the#NO_APPformatted-code indicator to the assembler at the beginning of the assembly file.-mcc-initโ don't use condition-code results from a previous instruction; always emit compare and test instructions before condition codes get used.-mno-side-effectsโ don't emit instructions with side effects in addressing modes other than post-increment.-mstack-align,-mno-stack-align,-mdata-align,-mno-data-align,-mconst-align,-mno-const-alignโ these options (and theirno-forms) arrange (or eliminate the arrangement) for the stack frame, individual data and constants to be aligned for the maximum single data access size of the chosen CPU model. The default is to arrange for 32-bit alignment. ABI details like structure layout are not affected by these options.-m32-bit,-m16-bit,-m8-bitโ similar to the stack-, data- and const-align options above, these arrange for the stack frame, writable data and constants to all be 32-bit, 16-bit or 8-bit aligned. The default is 32-bit alignment.-mno-prologue-epilogue,-mprologue-epilogueโ with-mno-prologue-epilogue, the normal function prologue and epilogue that set up the stack frame are omitted, and no return instructions or return sequences are generated in the code.
โ ๏ธ Only use this option 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. Fr fr, look before you leap. ๐ญ
-mbest-lib-options,-moverride-best-lib-optionsโ-mbest-lib-optionsselects the most feature-enabling options allowed by the other options. It has nono-form, but-moverride-best-lib-optionsdisables it regardless of the relative order of the two options on the command line.-mtrap-using-break8โ emit traps asbreak 8. This is the default for CRIS v3 and up. If disabled, calls to"abort"are used instead.-mtrap-unaligned-atomicโ emit checks that causebreak 8instructions to execute when atomic builtins get applied to misaligned memory.-munaligned-atomic-may-use-libraryโ handle atomic builtins that may be applied to unaligned data by calling library functions. This option overrides-mtrap-unaligned-atomic.-simโ arranges to link with input-output functions from a simulator library. Code, initialized data and zero-initialized data are all allocated consecutively.-sim2โ like-sim, but passes linker options to locate initialized data at0x40000000and zero-initialized data at0x80000000.
๐ฆ C-SKY Options ๐ฆ
GCC supports these options when compiling for C-SKY V2 processors.
-march=archโ specify the C-SKY target architecture. Valid values for arch are:ck801,ck802,ck803,ck807, andck810. The default isck810.-mcpu=cpuโ specify the C-SKY target processor. Valid values for cpu are:ck801,ck801t,ck802,ck802t,ck802j,ck803,ck803h,ck803t,ck803ht,ck803f,ck803fh,ck803e,ck803eh,ck803et,ck803eht,ck803ef,ck803efh,ck803ft,ck803eft,ck803efht,ck803r1,ck803hr1,ck803tr1,ck803htr1,ck803fr1,ck803fhr1,ck803er1,ck803ehr1,ck803etr1,ck803ehtr1,ck803efr1,ck803efhr1,ck803ftr1,ck803eftr1,ck803efhtr1,ck803s,ck803st,ck803se,ck803sf,ck803sef,ck803seft,ck807e,ck807ef,ck807,ck807f,ck810e,ck810et,ck810ef,ck810eft,ck810,ck810v,ck810f,ck810t,ck810fv,ck810tv,ck810ft, andck810ftv.-mbig-endian,-mlittle-endianโ select big- or little-endian code. The default is little-endian. โจ-mfloat-abi=nameโ specifies which floating-point ABI to use. Permissible values are:soft,softfpandhard.
Specifying soft makes GCC 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 the generation of floating-point instructions and uses FPU-specific calling conventions. Pick your fighter. ๐
-mdouble-float,-mno-double-floatโ when-mhard-floatis doing its thing, this lets you generate double-precision float instructions. It's the default, except when you're compiling for CK803, bestie.-mfdivdu,-mno-fdivduโ with-mhard-floatactive, this turns on generation of"frecipd","fsqrtd", and"fdivd"instructions. Default again, except for CK803. she's consistent โจ- *
-mfpu=fpu* โ pick your floating-point processor, periodt. Only usable with-mhard-float, no cap. Values for fpu are:fpv2_sfโ which is literally equivalent to-mno-double-float -mno-fdivdufpv2โ which is-mdouble-float -mno-divdufpv2_divdโ which is-mdouble-float -mdivdu
-melrw,-mno-elrwโ enables the extended"lrw"instruction. Defaults to on for CK801 and off otherwise.-mistack,-mno-istackโ enable interrupt stack instructions. Default is off. Also:-mistackis required to handle the"interrupt"and"isr"function attributes, so don't skip it if you need those ๐-mmp,-mno-mpโ enable multiprocessor instructions. Default is off.-mcp,-mno-cpโ enable coprocessor instructions. Default is off.-mcache,-mno-cacheโ enable coprocessor instructions. Default is off. (yes, it says the same thing as the one above โ that's the source, I don't make the rules ๐ )-msecurity,-mno-securityโ enable C-SKY security instructions. Default is off.-mtrust,-mno-trustโ enable C-SKY trust instructions. Default is off.-mdsp,-mno-dsp,-medsp,-mno-edsp,-mvdsp,-mno-vdspโ enable C-SKY DSP, Enhanced DSP, or Vector DSP instructions, respectively. All of these default to off.-mdiv,-mno-divโ generate divide instructions. Default is off.-msmart,-mno-smartโ generate code for Smart Mode, using only registers numbered0-7so you can use 16-bit instructions ๐ง This option gets ignored for CK801 (where this is just the required behavior anyway) and it defaults to on for CK802. For every other target, default is off.-mhigh-registers,-mno-high-registersโ generate code using the high registers numbered16-31. Not supported on CK801, CK802, or CK803, and it's enabled by default for the other processors.-manchor,-mno-anchorโ generate code using global anchor symbol addresses.-mpushpop,-mno-pushpopโ generate code using"push"and"pop"instructions. Defaults to on.-mmultiple-stld,-mno-multiple-stldโ generate code using"stm"and"ldm"instructions. Not supported on CK801, but it's enabled by default on the other processors.-mconstpool,-mno-constpoolโ create constant pools in the compiler instead of making the assembler do it. This one is the default and it's required for correct code generation on CK801 and CK802; optional on other processors.-mstack-size,-mno-stack-sizeโ emit".stack_size"directives for each function in the assembly output. Defaults to off.-mccrt,-mno-ccrtโ generate code for the C-SKY compiler runtime instead of libgcc. Defaults to off.- *
-mbranch-cost=n* โ set the branch costs to roughly n instructions. Default is1. -msched-prolog,-mno-sched-prologโ permit scheduling of function prologue and epilogue sequences.
โ ๏ธ Bestie, careful: using this can produce code that is not compliant with the C-SKY V2 ABI prologue requirements, and that means it cannot be debugged or backtraced. It's disabled by default for a reason ๐ญ
-msim,-mno-simโ links the librarylibsemi.a, which is in compatible with simulator. Applicable to ELF compiler only.
๐ช Cygwin and MinGW Options
These extra options are here for Microsoft Windows targets:
-mconsoleโ says a console application is to be generated, by telling the linker to set the PE header subsystem type that console apps need. Available for Cygwin and MinGW targets and enabled by default on those targets.- *
-mcrtdll=library* โ preprocess, compile or link with the specified C RunTime DLL library. This option adjusts the predefined macros"__CRTDLL__","__MSVCRT__","_UCRT"and"__MSVCRT_VERSION__"for the specified CRT library, picks the start file for the CRT library and links with the CRT library. Recognized CRT library names for the preprocessor are:"crtdll*","msvcrt10*","msvcrt20*","msvcrt40*","msvcr40*","msvcrtd*","msvcrt-os*","msvcr70*","msvcr71*","msvcr80*","msvcr90*","msvcr100*","msvcr110*","msvcr120*"and"ucrt*". If this option isn't specified, the default MinGW import library"msvcrt"is used for linking and no other adjustment for the preprocessor is done. MinGW import library"msvcrt"is just a symlink to (or a copy of) another MinGW CRT import library chosen during MinGW compilation. MinGW import library"msvcrt-os"is for the Windows system CRT DLL library"msvcrt.dll"and in most cases is the default MinGW import library. Generally speaking, changing the CRT DLL requires recompiling the entire MinGW CRT.
๐ซถ Heads up: this option is for experimental and testing purposes only. Available for MinGW targets.
-mdllโ available for Cygwin and MinGW targets. Says a DLL โ a dynamic link library โ is to be generated, which lets the compiler select the required runtime startup object and entry point.-mnop-fun-dllimportโ available for Cygwin and MinGW targets. Says the"dllimport"attribute should be ignored.-mthreadsโ support thread-safe exception handling on MinGW. Programs that rely on thread-safe exception handling have to compile and link all code with the-mthreadsoption. When compiling,-mthreadsdefines-D_MT; when linking, it links in a special thread helper library-lmingwthrdwhich cleans up per-thread exception-handling data. slay โจ-municodeโ available for MinGW-w64 targets. It causes the"UNICODE"preprocessor macro to be predefined, and chooses Unicode-capable runtime startup code.-mwin32โ available for Cygwin and MinGW targets. Says the typical Microsoft Windows predefined macros should be set in the pre-processor, but it does not influence the choice of runtime library/startup code.-mwindowsโ available for Cygwin and MinGW targets. Says a GUI application is to be generated, by telling the linker to set the PE header subsystem type appropriately.-fno-set-stack-executableโ available for MinGW targets. Says 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, since there the User32 API โ which is what's used to set executable privileges โ isn't available.-fwritable-relocated-rdataโ available for MinGW and Cygwin targets. Says relocated-data in a read-only section gets put into the".data"section. This is necessary for older runtimes that don't support modification of".rdata"sections for pseudo-relocation.-mpe-aligned-commonsโ available for Cygwin and MinGW targets. Says the GNU extension to the PE file format that permits correct alignment of COMMON variables should be used when generating code. It's enabled by default if GCC detects that the target assembler found during configuration supports the feature.-muse-libstdc-wrappersโ use Cygwin DLL wrappers to support C++ operators"new"and"delete".
See also under x86 Options for standard options.
๐ Darwin Options
These options are defined for all architectures running the Darwin operating system.
FSF GCC on Darwin does not create "fat" object files; it creates an object file for the single architecture that GCC was built to target. Apple's GCC on Darwin does create "fat" files if multiple -arch options are used; it does that by running the compiler or linker multiple times and joining the results together with lipo. <butterfly>iconic honestly ๐ฆ</butterfly>
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's generating, so you cannot put 64-bit instructions in appc750object 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 appc970object file in appc7400library). - The linker for executables,
ld, quietly gives the executable the most restrictive subtype of any of its input files. -Fdir โ add the framework directory dir to the head of the list of directories to be searched for header files. These directories are interleaved with those specified by-Ioptions and are scanned in a left-to-right order.
okay so picture this: a framework directory is literally just a directory that has frameworks living inside it. And a framework? That's a directory that has a Headers and/or PrivateHeaders directory sitting directly inside it, and its name ends in .framework. ๐
The name of a framework is the name of that directory minus the .framework part. Simple. The headers that belong to it hang out in one of those two directories, and Headers gets searched first (PrivateHeaders is the backup dancer ๐).
Now a subframework is a framework directory that lives inside a framework's Frameworks directory. And here's the rule, bestie: includes of subframework headers can only show up in a header of a framework that contains that subframework, or in a sibling subframework header. Two subframeworks are siblings if they occur in the same framework. ๐ซถ
A subframework should not have the same name as a framework โ if you violate this, a warning gets issued. Noted. ๐ Also, currently a subframework cannot have subframeworks; in the future the mechanism may be extended to support this. (not yet, babe.)
The standard frameworks can be found in /System/Library/Frameworks and /Library/Frameworks. And an example include looks like this:
#include <Framework/header.h>
where Framework denotes the name of the framework and header.h is found in the PrivateHeaders or Headers directory. โจ
-iframeworkdirโ like-Fexcept the directory is 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. This option is valid only for the C family of languages. ๐ฆ-archname โ generate output for architecture name. As described above, GCC generates output for the architecture it was configured for, using its usual options to select subarchitecture variants. The-archoption is accepted for compatibility, but an error is diagnosed if name is inconsistent with GCC's own idea of the target architecture. ๐-dependency-filefilename โ alias for the preprocessor option-MFfilename.-fapple-kextโ generate code for Darwin loadable kernel extensions.-gusedโ emit debugging information for symbols that are used. For stabs debugging format, this enables-feliminate-unused-debug-symbols. This is by default ON. โ-gfullโ emit debugging information for all symbols and types. (no skipping, we're thorough here ๐)-matt-stubs,-mno-att-stubsโ enable AT&T-style PIC stubs. This is the default when supported by the target architecture (currently x86 only).-mconstant-cfstrings,-fconstant-cfstringsโ when the NeXT runtime is being used (the default on these systems), override any-fconstant-string-classsetting and cause@"..."literals to be laid out as constant CoreFoundation strings.-fconstant-cfstringsis an alias for-mconstant-cfstrings. ๐-mdynamic-no-picโ generate code suitable for executables (not shared libraries). This option is incompatible with-fpic,-fPIC,-fpie, or-fPIE. โ ๏ธ-mfix-and-continue,-ffix-and-continue,-findirect-dataโ generate code suitable for fast turnaround development, such as to allow GDB to dynamically load.ofiles into already-running programs.-findirect-dataand-ffix-and-continueare provided for backwards compatibility.-mkernelโ enable kernel development mode. The-mkerneloption sets-static,-fno-common,-fno-use-cxa-atexit,-fno-exceptions,-fno-non-call-exceptions,-fapple-kext,-fno-weakand-fno-rttiwhere applicable. This mode also sets-mno-altivec,-msoft-float,-fno-builtinand-mlong-branchfor PowerPC targets. ๐ฅ-mmacosx-version-min=version,-asm_macosx_version_min=version โ the-mmacosx-version-minoption specifies the earliest version of MacOS X that this executable will run on is version. Typical values supported for version include12,10.12, and10.5.8. โจ
If the compiler was built to use the system's headers by default, then the default for this option is the system version on which the compiler is running, otherwise the default is to make choices that are compatible with as many systems and code bases as possible.
-asm_macosx_version_min=version is similar, but the GCC driver passes its version information only to the assembler.
-mone-byte-boolโ override the defaults forboolso thatsizeof(bool)==1. By defaultsizeof(bool)is 4 when compiling for Darwin/PowerPC and 1 when compiling for Darwin/x86, so this option has no effect on x86. ๐
Warning: The -mone-byte-bool switch causes GCC to generate code that is not binary compatible with code generated without that switch. Using this switch may require recompiling all other modules in a program, including system libraries. Use this switch to conform to a non-default data model. ๐ญ
-msymbol-stubs,-mno-symbol-stubsโ force generation of external symbol indirection stubs for PIC references. By default, this option is enabled automatically if the target linker version (-mtarget-linker) is old enough to require them.-mtarget-linker=version,-mtarget-linkerversion โ specify the target ld64 version, overriding any version specified in the GCC configuration. Newer linker versions support improved code generation in some cases, for example for PIC code. ๐ง-ObjCโ equivalent to-x objective-c; specifies that the input is is Objective-C source code.-ObjC++โ equivalent to-x objective-c++; specifies that the input is is Objective-C++ source code.-Wnonportable-cfstrings,-Wno-nonportable-cfstringsโ warn if constant CoreFoundation string objects contain non-portable characters. This warning is enabled by default. ๐-all_loadโ loads all members of static archive libraries. Seeman ld(1)for more information.-arch_errors_fatalโ cause the errors having to do with files that have the wrong architecture to be fatal. ๐-bind_at_loadโ causes the output file to be marked such that the dynamic linker will bind all undefined references when the file is loaded or launched.-bundleโ produce a Mach-o bundle format file. Seeman ld(1)for more information.-bundle_loaderexecutable โ this option specifies the executable that will load the build output file being linked. Seeman ld(1)for more information.-dynamiclibโ when passed this option, GCC produces a dynamic library instead of an executable when linking, using the Darwinlibtoolcommand.-force_cpusubtype_ALLโ this causes GCC's output file to have theALLsubtype, instead of one controlled by the-mcpuor-marchoption.-nodefaultrpathsโ do not add default run paths for the compiler library directories to executables, modules or dynamic libraries. On macOS 10.5 and later, the embedded runpath is added by default unless the user adds-nodefaultrpathsto the link line. Run paths are needed (and therefore enforced) to build on macOS version 10.11 or later. โญ-nodefaultexportโ do not add default symbol exports to modules or dynamic libraries.-allowable_clientclient_name,-client_name,-compatibility_version,-current_version,-dead_strip,-dylib_file,-dylinker,-dylinker_install_name,-dynamic,-exported_symbols_list,-filelist,-flat_namespace,-force_flat_namespace,-framework,-headerpad_max_install_names,-image_base,-initsymbol-name,-install_name,-keep_private_externs,-pagezero_size,-preload,-read_only_relocs,-sectalign,-sectcreate,-seg_addr_table,-seg1addr,-segaddr,-segprot,-segs_read_only_addr,-segs_read_write_addr,-sub_library,-sub_umbrella,-twolevel_namespace,-twolevel_namespace_hints,-umbrella,-undefined,-unexported_symbols_list,-weak_framework,-weak_reference_mismatches,-whatsloaded,-whyloadโ these options are passed to the Darwin linker. The Darwin linker man page describes them in detail. ๐ซถ
๐ DEC Alpha Options ๐
These -m options are defined for the DEC Alpha implementations:
-mno-soft-float,-msoft-floatโ use (do not use) the hardware floating-point instructions for floating-point operations. When-msoft-floatis specified, functions inlibgcc.aare used to perform floating-point operations. Unless they are replaced by routines that emulate the floating-point operations, or compiled in such a way as to call such emulations routines, these routines issue floating-point operations. If you are compiling for an Alpha without floating-point operations, you must ensure that the library is built so as not to call them.
Note that Alpha implementations without floating-point operations are required to have floating-point registers. (iconic honestly ๐ )
-mfp-regs,-mno-fp-regsโ generate code that uses (does not use) the floating-point register set.-mno-fp-regsimplies-msoft-float. If the floating-point register set is not used, floating-point operands are passed in integer registers as if they were integers and floating-point results are passed in$0instead of$f0. This is a non-standard calling sequence, so any function with a floating-point argument or return value called by code compiled with-mno-fp-regsmust also be compiled with that option. ๐ค
A typical use of this option is building a kernel that does not use, and hence need not save and restore, any floating-point registers.
-mieeeโ the Alpha architecture implements floating-point hardware optimized for maximum performance. It is mostly compliant with the IEEE floating-point standard. However, for full compliance, software assistance is required. This option generates code fully IEEE-compliant code except that the inexact-flag is not maintained (see below). If this option is turned on, the preprocessor macro_IEEE_FPis defined during compilation. The resulting code is less efficient but is able to correctly support denormalized numbers and exceptional IEEE values such as not-a-number and plus/minus infinity. Other Alpha compilers call this option-ieee_with_no_inexact. ๐-mieee-with-inexactโ okay so this is-mieeebut the generated code also keeps the IEEE inexact-flag. Turning this on means the code implements fully-compliant IEEE math โจ. On top of_IEEE_FP, it also defines_IEEE_FP_EXACTas a preprocessor macro. Heads up though bestie: on some Alpha implementations the resulting code may run significantly slower than the default code ๐ญ. And since there's very little code that actually depends on the inexact-flag, you should normally not specify this option. Other Alpha compilers call this one-ieee_with_inexact.- *
-mfp-trap-mode=trap-mode* โ this controls which floating-point related traps get enabled. Other Alpha compilers call it-fptmtrap-mode. The trap mode can be set to one of four values:nโ this is the default (normal) setting. The only traps enabled are the ones that can't be disabled in software, like the division by zero trap.uโ on top of everythingnenables, underflow traps are enabled too.suโ likeu, but the instructions are marked to be safe for software completion (peep the Alpha architecture manual for the deets).suiโ likesu, but inexact traps are enabled as well.
- *
-mfp-rounding-mode=rounding-mode* โ picks the IEEE rounding mode. Other Alpha compilers call it-fprmrounding-mode. The rounding-mode can be one of:nโ normal IEEE rounding mode. Floating-point numbers round towards the nearest machine number, or towards the even machine number when it's a tie.mโ round towards minus infinity.cโ chopped rounding mode. Floating-point numbers round towards zero.dโ dynamic rounding mode. A field in the floating-point control register (fpcr, see the Alpha architecture reference manual) controls the rounding mode in effect. The C library initializes this register for rounding towards plus infinity. So unless your program modifies thefpcr,dcorresponds to round towards plus infinity.
-mtrap-precision=trap-precision โ so in the Alpha architecture, floating-point traps are **imprecise. That means without software assistance it's impossible to recover from a floating trap, and program execution normally needs to be terminated ๐. GCC can generate code that assists operating system trap handlers in figuring out the exact location that caused a floating-point trap. Depending on what an application needs, you can pick different levels of precision:pโ program precision. This is the default, and it means a trap handler can only identify which program caused a floating-point exception.fโ function precision. The trap handler can determine the function that caused a floating-point exception.iโ instruction precision. The trap handler can determine the exact instruction that caused a floating-point exception.
Other Alpha compilers provide the equivalent options called -scope_safe and -resumption_safe.
-mieee-conformantโ this marks the generated code as IEEE conformant. > You must not use this option unless you also specify-mtrap-precision=iand either-mfp-trap-mode=suor-mfp-trap-mode=sui. Its only effect is to emit the line.eflag 48in the function prologue of the generated assembly file.-mbuild-constantsโ normally GCC looks at a 32- or 64-bit integer constant to see if it can construct it from smaller constants in two or three instructions. If it can't, it outputs the constant as a literal and generates code to load it from the data segment at run time. Use this option to require GCC to construct all integer constants using code, even if it takes more instructions (the max is six). You typically use this option to build a shared library dynamic loader โ itself a shared library, it must relocate itself in memory before it can find the variables and constants in its own data segment. ๐ซถ-mbwx-mno-bwx-mcix-mno-cix-mfix-mno-fix-mmax-mno-maxโ these say whether GCC should generate code to use the optional BWX, CIX, FIX and MAX instruction sets. The default is to use the instruction sets supported by the CPU type specified via the-mcpu=option, or that of the CPU on which GCC was built if none is specified. โจ-msafe-bwa-mno-safe-bwaโ says whether, in the absence of the optional BWX instruction set, GCC should generate multi-thread and async-signal safe code for byte and aligned word memory accesses.-msafe-partial-mno-safe-partialโ says whether GCC should generate multi-thread and async-signal safe code for partial memory accesses, including piecemeal accesses to unaligned data as well as block accesses to leading and trailing parts of aggregate types or other objects in memory that don't respectively start and end on an aligned 64-bit data boundary.-mfloat-vax-mfloat-ieeeโ generate code that uses (does not use) VAX F and G floating-point arithmetic instead of IEEE single and double precision.-mexplicit-relocs-mno-explicit-relocsโ older Alpha assemblers provided no way to generate symbol relocations except via assembler macros. Using those macros doesn't allow optimal instruction scheduling ๐. GNU Binutils as of version2.12supports 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's built and sets the default accordingly.-msmall-data-mlarge-dataโ when-mexplicit-relocsis in effect, static data is accessed via gp-relative relocations. When-msmall-datais used, objects 8 bytes long or smaller get placed in a small data area (the.sdataand.sbsssections) and are accessed via 16-bit relocations off of the$gpregister. This limits the size of the small data area to 64KB, but lets the variables be directly accessed via a single instruction ๐.
The default is -mlarge-data. With this option the data area is limited to just below 2GB. Programs that 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.
When generating code for shared libraries, -fpic implies -msmall-data and -fPIC implies -mlarge-data.
-msmall-text-mlarge-textโ when-msmall-textis used, the compiler assumes that the code of the entire program (or shared library) fits in 4MB, and is thus reachable with a branch instruction. When-msmall-datais used, the compiler can assume that all local symbols share the same$gpvalue, and thus reduce the number of instructions required for a function call from 4 to 1. The default is-mlarge-text.- *
-mcpu=cpu_type* โ sets the instruction set and instruction scheduling parameters for machine type cpu_type. You can specify either the EV style name or the corresponding chip number. GCC supports scheduling parameters for the EV4, EV5 and EV6 family of processors and chooses the default values for the instruction set from the processor you specify. If you don't specify a processor type, 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 doesn't recognize the processor.
-mtune=cpu_type โ sets *only the instruction scheduling parameters for machine type *cpu_type. The instruction set is not changed. Native toolchains also support the valuenative, which selects the best architecture option for the host processor.-mtune=nativehas no effect if GCC doesn't recognize the processor.-mmemory-latency=time โ sets the latency the scheduler should assume for typical memory references as seen by the application. This number is **highly dependent on the memory access patterns used by the application and the size of the external cache on the machine ๐ง .
Valid options for time are
numberโ a decimal number representing clock cycles.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.
-mtls-kernelโ emitrdvalinstead ofrduniqfor thread pointer.- *
-mtls-size=bitsize* โ specify bit size of immediate TLS offsets. Valid values for bitsize are16,32, and64; it defaults to32. -mlong-double-128-mlong-double-64โ specify the size of thelong doubletype. Note that-mlong-double-128is incompatible with VAX floating point. ๐
๐ eBPF Options ๐
- *
-mframe-limit=bytes* โ this specifies the hard limit for frame sizes, in bytes. Currently, the value that can be specified should be less than or equal to32767. Defaults to whatever limit is imposed by the version of the Linux kernel targeted. -mbig-endianโ generate code for a big-endian target.-mlittle-endianโ generate code for a little-endian target. This is the default. ๐-mjmpext-mno-jmpextโ enable or disable generation of extra conditional-branch instructions. Enabled for CPU v2 and above.-mjmp32-mno-jmp32โ enable or disable generation of 32-bit jump instructions. Enabled for CPU v3 and above. โญ-malu32,-mno-alu32โ turn the generation of 32-bit ALU instructions on or off. It's enabled for CPU v3 and above, no cap. ๐-mv3-atomics,-mno-v3-atomicsโ toggle the instructions for general atomic operations that got introduced in CPU v3. Enabled for CPU v3 and above. โจ-mbswap,-mno-bswapโ byte swap instructions: yes or no. Enabled for CPU v4 and above. ๐ฆ-msdiv,-mno-sdivโ signed division and modulus instructions, on or off. Enabled for CPU v4 and above. ๐ฅ-msmov,-mno-smovโ sign-extending move and memory load instructions, on or off. Enabled for CPU v4 and above. (Yes bestie, the disable flag really is spelled-mno-smovโ we don't make the rules, we just report them ๐)-mcpu=versionโ this is the "which version of the eBPF ISA are we targeting" knob. Newer versions may not be supported by all kernels. The default isv4.
The supported values for version are:
v1โ the first stable eBPF ISA, with literally no special features or extensions. The og. ๐v2โ supports the jump extensions, as in-mjmpext.v3โ all the features ofv2, plus:- 32-bit jump operations, as in
-mjmp32 - 32-bit ALU operations, as in
-malu32 - general atomic operations, as in
-mv3-atomics
- 32-bit jump operations, as in
v4โ all the features ofv3, plus:- Byte swap instructions, as in
-mbswap - Signed division and modulus instructions, as in
-msdiv - Sign-extending move and memory load instructions, as in
-msmov
- Byte swap instructions, as in
-mco-re,-mno-co-reโ enable or disable BPF Compile Once - Run Everywhere (CO-RE) support. BPF CO-RE support is enabled by default when generating BTF debug information for the BPF target (-gbtf). ๐ซถ-mxbpfโ generate code for an expanded version of BPF, which relaxes some of the restrictions imposed by the BPF architecture:- Save and restore callee-saved registers at function entry and exit, respectively.
-masm=dialectโ outputs assembly instructions using the selected eBPF dialect. The default ispseudoc.
The supported values for dialect are:
normalโ outputs normal assembly dialect.pseudocโ outputs pseudo-c assembly dialect.
-minline-memops-threshold=bytesโ specifies a size threshold in bytes at or below whichmemmove,memcpyandmemsetshall always be expanded inline. Operations dealing with sizes larger than this threshold would have to be implemented using a library call instead of being expanded inline, but since BPF doesn't allow libcalls, exceeding this threshold results in a compile-time error. The default is1024bytes.
Bestie. Read that again. Go over the threshold and your build just stops. Not a warning, not a vibe, an error. ๐ญ
-Wco-reโ enable warnings for scenarios where-mco-reis enabled, but it may not be possible to generate CO-RE compatible code.
๐ธ FR30 Options ๐ธ
These options are defined specifically for the FR30 port. Very niche, very iconic. ๐
-msmall-modelโ use the small address space model. This can produce smaller code, but it does assume that all symbolic values and addresses fit into a 20-bit range. ๐-mno-lsimโ assume that runtime support has been provided and so there is no need to include the simulator library (libsim.a) on the linker command line.
๐ฆ FRV Options ๐ฆ
-mgpr-32โ only use the first 32 general-purpose registers.-mgpr-64โ use all 64 general-purpose registers.-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,-mno-dwordโ control whether the ABI uses double-word instructions.-mdouble,-mno-doubleโ enable or disable use of floating-point double instructions.-mmedia,-mno-mediaโ enable or disable use of media instructions.-mmuladd,-mno-muladdโ enable or disable use of multiply and add/subtract instructions.-mfdpicโ 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.-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. (Case matters, bestie, they're two different flags and one letter apart ๐)-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.-mlinked-fpโ follow the EABI requirement of always creating a frame pointer whenever a stack frame is allocated. This option is enabled by default and can be disabled with-mno-linked-fp.-mlong-callsโ use indirect addressing to call functions outside the current compilation unit. This allows the functions to be placed anywhere within the 32-bit address space. ๐-malign-labelsโ try to align labels to an 8-byte boundary by inserting NOPs into the previous packet. This option only has an effect when VLIW packing is enabled. It doesn't create new packets; it merely adds NOPs to existing ones.-mlibrary-picโ generate position-independent EABI code.-macc-4โ use only the first four media accumulator registers.-macc-8โ use all eight media accumulator registers.-mpack,-mno-packโ enable or disable packing VLIW instructions.-mno-eflagsโ do not mark ABI switches ine_flags.-mcond-move,-mno-cond-moveโ enable or disable the use of conditional-move instructions; it is enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐
-mscc,-mno-sccโ enable or disable the use of conditional set instructions; it is enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐
-mcond-exec,-mno-cond-execโ enable or disable the use of conditional execution; it is enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐
-mvliw-branch,-mno-vliw-branchโ enable or disable an optimization pass to pack branches into VLIW instructions; it is enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐
-mmulti-cond-exec,-mno-multi-cond-execโ enable or disable optimization of&&and||in conditional execution; it is enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐
-mnested-cond-exec,-mno-nested-cond-execโ enable or disable nested conditional execution optimizations; it is enabled by default.
This switch is mainly for debugging the compiler and will likely be removed in a future version. ๐
-moptimize-membar,-mno-optimize-membarโ this switch removes redundantmembarinstructions from the compiler-generated code. It is enabled by default.-mtomcat-statsโ cause gas to print out tomcat statistics. ๐ฑ (not a drill, that's the whole description)-mcpu=cpuโ select the processor type for which to generate code. Possible values arefrv,fr550,tomcat,fr500,fr450,fr405,fr400,fr300andsimple.
๐ 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 must provide your own runtime library for whatever I/O functions are needed. Like, genuinely, do not. ๐ญ
-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.
๐ง GNU/Linux Options ๐ง
These -m options are defined for GNU/Linux targets:
-mglibcโ use the GNU C library. This is the default except on*-*-linux-*uclibc*,*-*-linux-*musl*and*-*-linux-*android*targets.-muclibcโ use uClibc C library. This is the default on*-*-linux-*uclibc*targets.-mmuslโ use the musl C library. This is the default on*-*-linux-*musl*targets.-mbionicโ use Bionic C library. This is the default on*-*-linux-*android*targets.-mandroid,-mno-androidโ compile code compatible with the Android platform. This is the default on*-*-linux-*android*targets.
When compiling, this option enables -mbionic, -fPIC, -fno-exceptions and -fno-rtti by default. When linking, this option makes the GCC driver pass Android-specific options to the linker. Finally, this option causes the preprocessor macro __ANDROID__ to be defined.
This option can be disabled completely with -mno-android.
-tno-android-ccโ disable compilation effects of-mandroid, i.e., do not enable-mbionic,-fPIC,-fno-exceptionsand-fno-rttiby default.-tno-android-ldโ disable linking effects of-mandroid, i.e., pass standard Linux linking options to the linker.
๐ธ H8/300 Options ๐ธ
okay so these are the -m options for the H8/300 family, bestie, let's go ๐
-mrelaxโ shortens some address references at link time whenever it can, using the linker option-relax๐-mhโ makes code for the H8/300H โจ-msโ makes code for the H8S ๐ฆ-mnโ makes code for the H8S and the H8/300H in normal mode. ngl this switch has to be used with either-mhor-ms, no solo runs ๐-msxโ generates H8SX code ๐ฅ-ms2600โ generates code for the H8S/2600. this one must be used with-ms, periodt-mquickcallโ uses registers for argument passing โญ-mslowbyteโ treats access to byte-sized memory as slow ๐-mexr,-mno-exrโ store extended registers on the stack before functions with the"monitor"attribute run. the default is-mexr. heads up: this option is only valid for H8S targets ๐-mint32โ makes"int"data 32 bits by default ๐-malign-300โ on the H8/300H and H8S, use the same alignment rules as the H8/300. the default for the H8/300H and H8S is to align longs and floats on 4-byte boundaries;-malign-300makes them align on 2-byte boundaries instead. this option does nothing at all on the H8/300 ๐
๐ HPPA Options ๐
and now the -m options for the HPPA family of computers, we're so back ๐ซถ
-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. peek at/usr/lib/sched.modelson an HP-UX system to figure out the right architecture option for your machine ๐ code compiled for lower-numbered architectures runs on higher-numbered ones, but not the other way around โ one-way street fr-mpa-risc-1-0,-mpa-risc-1-1,-mpa-risc-2-0โ synonyms for-march=1.0,-march=1.1, and-march=2.0, respectively โจ-matomic-libcalls,-mno-atomic-libcallsโ generate libcalls for atomic loads and stores when sync libcalls are disabled. this one's enabled by default. it only affects the generation of atomic libcalls by the HPPA backend ๐
both the sync and libatomic libcall implementations use locking. as a result, processor stores are not atomic with respect to other atomic operations. processor loads up to DImode are atomic with respect to other atomic operations, provided they're implemented as a single access ๐
the PA-RISC architecture doesn't support any atomic operations in hardware except for the "ldcw" instruction. so all atomic support is implemented using sync and atomic libcalls. sync libcall support lives in libgcc.a. atomic libcall support lives in libatomic ๐ฆ
this option generates "__atomic_exchange" calls for atomic stores. it also gives special handling for atomic DImode accesses on 32-bit targets โญ
-mcaller-copiesโ the caller copies function arguments passed by hidden reference. use this one with care, bestie, because it's not compatible with the default 32-bit runtime ๐ญ that said, only aggregates larger than eight bytes get passed by hidden reference, and the option gives better compatibility with OpenMP ๐-mcoherent-ldcwโ use the ldcw/ldcd coherent cache-control hint ๐ธ-mdisable-fpregsโ disables floating-point registers. equivalent to-msoft-float๐-mdisable-indexingโ stops the compiler from using indexing address modes. this avoids some pretty obscure problems when compiling MIG generated code under MACH ๐-mfast-indirect-callsโ generates code that assumes calls never cross space boundaries. this lets GCC emit code doing faster indirect calls ๐ฅ
heads up: this option does not work when shared libraries or nested functions are in the picture ๐
-mfixed-range=register-range โ generate code treating the given register range as fixed registers. a fixed register is one the register allocator can't use. super useful when you're compiling kernel code. a register range is two registers separated by a dash, and you can list multiple register ranges separated by a comma โจ-mgasโ enable the use of assembler directives that only GAS understands ๐-mgnu-ldโ use options specific to GNU ld. this passes-sharedto ld when building a shared library. it's the default when GCC is configured โ explicitly or implicitly โ with the GNU linker. note this option does not affect which ld gets called; it only changes what parameters get passed to that ld. the ld that gets called is determined by the--with-ldconfigure option, GCC's program search path, and finally by the user'sPATH. you can print the linker GCC uses withwhich gcc -print-prog-name=ld. this option is only available on the 64-bit HP-UX GCC, i.e. configured withhppa*64*-*-hpux*๐-mhp-ldโ use options specific to HP ld. this passes-bto ld when building a shared library, and passes+Accept TypeMismatchto ld on all links. it's the default when GCC is configured โ explicitly or implicitly โ with the HP linker. again, this option does not affect which ld gets called; it only changes what parameters get passed to that ld. the ld that gets called is determined by the--with-ldconfigure option, GCC's program search path, and finally by the user'sPATH. you can print the linker GCC uses withwhich gcc -print-prog-name=ld. this option is only available on the 64-bit HP-UX GCC, i.e. configured withhppa*64*-*-hpux*๐-mlinker-optโ enable the optimization pass in the HP-UX linker. note that this makes symbolic debugging impossible ๐-mlong-callsโ generate code that uses long call sequences. this makes sure a call can always reach linker generated stubs. the default is to generate long calls only when the distance from the call site to the beginning of the function or translation unit โ whichever applies โ exceeds a predefined limit set by the branch type being used. the limits for normal calls are 7,600,000 and 240,000 bytes, respectively for the PA 2.0 and PA 1.X architectures. sibling calls are always limited at 240,000 bytes ๐ธ
distances are measured from the beginning of functions when you use the -ffunction-sections option, or when you use the -mgas and -mno-portable-runtime options together under HP-UX with the SOM linker ๐ฆ
ngl it's normally not desirable to use this option since it degrades performance. however, it may be useful in large applications, particularly when partial linking is used to build the application ๐
the types of long calls used depend on the capabilities of the assembler and linker, and on the type of code being generated. the impact on systems supporting long absolute calls, and long PIC symbol-difference or PC-relative calls, should be relatively small. but an indirect call is used on 32-bit ELF systems in PIC code, and it's quite long ๐ญ
-mlong-load-storeโ generate 3-instruction load and store sequences, as sometimes required by the HP-UX 10 linker. this is equivalent to the+koption to the HP compilers โจ-mno-space-regsโ generate code that assumes the target has no space registers. this lets GCC generate faster indirect calls and use unscaled index address modes ๐
such code is suitable for level 0 PA systems and kernels ๐
-morderedโ assume memory references are ordered and barriers aren't needed โญ-mportable-runtimeโ use the portable calling conventions proposed by HP for ELF systems ๐-mschedule=cpu-type โ schedule code according to the constraints for the machine type cpu-type. the choices for cpu-type are7007100,7100LC,7200,7300and8000. peek at/usr/lib/sched.modelson an HP-UX system to figure out the right scheduling option for your machine. the default scheduling is8000๐ฅ-msio,-mwsioโ-msiogenerates the predefine"_SIO"for server IO. the default is-mwsio, which generates the predefines"__hp9000s700","__hp9000s700__"and"_WSIO"for workstation IO. these options are available under HP-UX and HI-UX ๐-msoft-floatโ generate output containing library calls for floating point.
โ ๏ธ warning: the requisite libraries aren't available for all HPPA targets. normally the facilities of the machine's usual C compiler are used, but this can't be done directly in cross-compilation. you must make your own arrangements to provide suitable library functions for cross-compilation, bestie ๐ซถ
-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 ๐
-msoft-multโ use software integer multiplication ๐ฆ
this disables the use of the "xmpyu" instruction ๐
-munix=unix-std โ generate compiler predefines and select a startfile for the specified UNIX standard. the choices for unix-std 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", plus the startfile unix95.o. -munix=98 provides additional predefines for "_XOPEN_UNIX", "_XOPEN_SOURCE_EXTENDED", "_INCLUDE__STDC_A1_SOURCE" and "_INCLUDE_XOPEN_SOURCE_500", plus the startfile unix98.o โจ
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 intended to operate with more than one UNIX standard must test, set and restore the variable "__xpg4_extended_mask" as appropriate. most GNU software doesn't provide this capability ๐
-nolibdldโ suppress the generation of link options to searchlibdld.slwhen the-staticoption is specified on HP-UX 10 and later ๐-staticโ the HP-UX C library implementation of"setlocale"has a dependency onlibdld.sl. there isn't an archive version oflibdld.sl. so when the-staticoption is specified, special link options are needed to resolve this dependency ๐
okay so on HP-UX 10 and later, the GCC driver goes ahead and adds all the necessary options to link with libdld.sl whenever you pass -static. iconic of it โ but heads up bestie, this makes the resulting binary dynamic. And on the 64-bit port? The linkers are already generating dynamic binaries by default anyway, so it's giving that either way. If you want to stop the GCC driver from adding these link options, the -nolibdld option is your girl. ๐
-threadsโ adds support for multithreading with thedcethread library under HP-UX. This option sets flags for both the preprocessor and the linker. no cap. ๐งต
๐ IA-64 Options ๐
These are the -m options defined for the Intel IA-64 architecture. very specific, very slay.
-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 volatileasmstatements.-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. we've all been there.-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.-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 does not always do so. manage your expectations bestie.-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-count-spec-in-critical-path,-msched-count-spec-in-critical-pathโ if enabled, speculative dependencies are considered during computation of the instructions priorities. This makes the use of the speculation a bit more conservative. The default setting is disabled.-msched-spec-ldc,-mno-sched-spec-ldcโ use a simple data speculation check. This option is on by default.-msched-control-spec-ldc,-mno-sched-control-spec-ldcโ use a simple check for control speculation. This option is on by default.-msched-stop-bits-after-every-cycle,-mno-sched-stop-bits-after-every-cycleโ place a stop bit after every cycle when scheduling. This option is on by default.-msched-fp-mem-deps-zero-cost,-mno-sched-fp-mem-deps-zero-costโ assume that floating-point stores and loads are not likely to cause a conflict when placed into the same instruction group. This option is disabled by default.-msel-sched-dont-check-control-spec,-mno-sel-sched-dont-check-control-specโ generate checks for control speculation in selective scheduling. This flag is disabled by default.-msched-max-memory-insns=max-insnsโ limit on the number of memory insns per instruction group, giving lower priority to subsequent memory insns attempting to schedule in the same instruction group. Frequently useful to prevent cache bank conflicts. The default value is1.-msched-max-memory-insns-hard-limit,-mno-sched-max-memory-insns-hard-limitโ makes the limit specified bymsched-max-memory-insnsa hard limit, disallowing more than that number in an instruction group. Otherwise, the limit is "soft", meaning that non-memory operations are preferred when the limit is reached, but memory operations may still be scheduled.
๐ฆ LM32 Options ๐ฆ
These -m options are defined for the LatticeMico32 architecture:
-mbarrel-shift-enabledโ enable barrel-shift instructions.-mdivide-enabledโ enable divide and modulus instructions.-mmultiply-enabledโ enable multiply instructions.-msign-extend-enabledโ enable sign extend instructions.-muser-enabledโ enable user-defined instructions.
๐ธ LoongArch Options ๐ธ
These command-line options are defined for LoongArch targets:
-march=arch-typeโ generate instructions for the machine type arch-type.-march=arch-typeallows GCC to generate code that may not run at all on processors other than the one indicated. โ ๏ธ
The choices for arch-type are:
nativeโ local processor type detected by the native compiler.loongarch64โ generic LoongArch 64-bit processor.la464โ LoongArch LA464-based processor with LSX, LASX.la664โ LoongArch LA664-based processor with LSX, LASX and all LoongArch v1.1 instructions.la64v1.0โ LoongArch64 ISA version 1.0.la64v1.1โ LoongArch64 ISA version 1.1.la32v1.0โ LoongArch32 ISA version 1.0.la32rv1.0โ LoongArch32 Reduced ISA version 1.0.
More information about LoongArch ISA versions can be found at https://github.com/loongson/la-toolchain-conventions.
-mtune=tune-typeโ optimize the generated code for the given processor target.
The choices for tune-type are:
nativeโ local processor type detected by the native compiler.genericโ generic LoongArch processor.loongarch64โ generic LoongArch 64-bit processor.la464โ LoongArch LA464 core.la664โ LoongArch LA664 core.loongarch32โ generic LoongArch 32-bit processor.
-mabi=base-abi-typeโ generate code for the specified calling convention. base-abi-type can be one of:lp64dโ uses 64-bit general purpose registers and 32/64-bit floating-point registers for parameter passing. Data model is LP64, whereintis 32 bits, whilelong intand pointers are 64 bits.lp64fโ uses 64-bit general purpose registers and 32-bit floating-point registers for parameter passing. Data model is LP64, whereintis 32 bits, whilelong intand pointers are 64 bits.lp64sโ uses 64-bit general purpose registers and no floating-point registers for parameter passing. Data model is LP64, whereintis 32 bits, whilelong intand pointers are 64 bits.
-mfpu=fpu-typeโ generate code for the specified FPU type, which can be one of:64โ bestie, this one says yes to hardware floating-point instructions for both 32-bit and 64-bit operations. double the float, double the fun ๐ซถ32โ same energy but only for 32-bit operations, no 64-bit action here โจnone,0โ absolutely not, we are preventing the use of hardware floating-point instructions entirely. it's giving austerity budget ๐
- *
-msimd=simd-type* โ turn on generation of LoongArch SIMD instructions for vectorization and via builtin functions. pick your fighter:lasxโ generate instructions from the 256-bit LoongArch Advanced SIMD Extension (LASX) and the 128-bit LoongArch SIMD Extension (LSX). the full package, no crumbs ๐lsxโ just the 128-bit LoongArch SIMD Extension (LSX), keeping it modest ๐ธnoneโ nope, no LoongArch SIMD instruction may be generated. periodt.
-msoft-floatโ forces-mfpu=noneand blocks floating-point registers from being used for parameter passing. > โ ๏ธ heads up bestie, this option may change the target ABI. not a casual little tweak, it's a whole vibe shift ๐ญ-msingle-floatโ forces-mfpu=32and lets 32-bit floating-point registers handle parameter passing. > โ ๏ธ also may change the target ABI. we stay warned ๐-mdouble-floatโ forces-mfpu=64and lets 32/64-bit floating-point registers do the parameter passing. > โ ๏ธ and yes, this one may change the target ABI too. the ABI drama is real ๐-mlasx,-mno-lasx,-mlsx,-mno-lsxโ these incrementally adjust the scope of the SIMD extensions (none / LSX / LASX) that the compiler is allowed to use for code generation. enabling LASX with-mlasxautomatically enables LSX, and disabling LSX with-mno-lsxautomatically disables LASX. these are driver-only options, and they act upon the final-msimdconfiguration state, making incremental changes in the order they appear on the GCC driver's command line, deriving the final / canonicalized-msimdoption that gets passed to the compiler proper. iykyk ๐ง- *
-mbranch-cost=n* โ set the cost of branches to roughly n instructions. - *
-maddr-reg-reg-cost=n* โ set the cost of ADDRESS_REG_REG to the value calculated by n. -mcheck-zero-division,-mno-check-zero-divisonโ trap (or do not trap) on integer division by zero. the default is-mcheck-zero-divisionfor-O0or-Og, and-mno-check-zero-divisionfor other optimization levels. (yes bestie, the second flag is spelled-mno-check-zero-divisonin the source, we do not fix it, we respect it ๐)- *
-mbreak-code=code* โ emit abreakcode instruction for irrecoverable traps from__builtin_trapor inserted by the compiler (for example an erroneous path isolated with-fisolate-erroneous-paths-dereference), or anamswap.w $r0, $r1, $r0instruction which will cause the hardware to trigger an Instruction Not-defined Exception if code is negative or greater than 32767. the default is-1, meaning to use theamswap.winstruction. lowkey cursed but that's the deal ๐ -mcond-move-int,-mno-cond-move-intโ conditional moves for integral data in general-purpose registers are enabled (disabled). the default is-mcond-move-int.-mcond-move-float,-mno-cond-move-floatโ conditional moves for floating-point registers are enabled (disabled). the default is-mcond-move-float.-mmemcpy,-mno-memcpyโ force (do not force) the use ofmemcpyfor non-trivial block moves. the default is-mno-memcpy, which lets GCC inline most constant-sized copies. setting the optimization level to-Osalso forces the use ofmemcpy, but-mno-memcpymay override this behavior if explicitly specified, regardless of the order these options appear on the command line. so yeah, order does not save you here ๐-mstrict-align,-mno-strict-alignโ avoid or allow generating memory accesses that may not be aligned on a natural object boundary as described in the architecture specification. the default is-mno-strict-align.- *
-G*numโ put global and static data smaller than num bytes into a small data section. the default value is0. - *
-mmax-inline-memcpy-size=n* โ inline all block moves (such as calls tomemcpyor structure copies) less than or equal to n bytes. the default value of n is1024. that's a chunky inline budget bestie ๐ - *
-mcmodel=code-model* โ set the code model to one of:tiny-staticโ (Not implemented yet) ๐งtinyโ (Not implemented yet) ๐งnormalโ the text segment must be within 128MB addressing space, and the data segment must be within 2GB addressing space.mediumโ the text segment and data segment must be within 2GB addressing space. this is the default code model unless GCC has been configured with--with-cmodel=specifying a different default code model.largeโ (Not implemented yet) ๐งextremeโ this mode does not limit the size of the code segment and data segment. > โ ๏ธ the-mcmodel=extremeoption is incompatible with-fpltand/or-mexplicit-relocs=none. pick a struggle, not both ๐ญ
-mexplicit-relocs=style,-mexplicit-relocs,-mno-explicit-relocsโ set when to use assembler relocation operators when dealing with symbolic addresses. the alternative is to use assembler macros instead, which may limit instruction scheduling but allow linker relaxation. with-mexplicit-relocs=none, the assembler macros are always used; with-mexplicit-relocs=always, the assembler relocation operators are always used; and with-mexplicit-relocs=auto, the compiler uses the relocation operators where linker relaxation is impossible to improve the code quality, and macros elsewhere. the way that this one picks and chooses... main character energy fr fr ๐
the default value for the option is determined with the assembler capability detected during GCC build-time and the setting of -mrelax: -mexplicit-relocs=none if the assembler does not support relocation operators at all, -mexplicit-relocs=always if the assembler supports relocation operators but -mrelax is not enabled, and -mexplicit-relocs=auto if the assembler supports relocation operators and -mrelax is enabled.
for backward compatibility, -mexplicit-relocs is equivalent to -mexplicit-relocs=always, while -mno-explicit-relocs is equivalent to -mexplicit-relocs=none.
-mdirect-extern-access,-mno-direct-extern-accessโ control use of the GOT to access external symbols. the default is-mno-direct-extern-access: the GOT is used for external symbols with default visibility, but not used for other external symbols. with-mdirect-extern-access, the GOT is not used and all external symbols are PC-relatively addressed. it is only suitable for environments where no dynamic link is performed, like firmwares, OS kernels, executables linked with-staticor-static-pie. > โ ๏ธ-mdirect-extern-accessis not compatible with-fPICor-fpic. do not try it bestie, it will not end well ๐-mrelax,-mno-relaxโ take (do not take) advantage of linker relaxations. if-mpass-mrelax-to-asis enabled, this option is also passed to the assembler. the default is determined during GCC build-time by detecting corresponding assembler support:-mrelaxif the assembler supports both the-mrelaxoption and the conditional branch relaxation (it's required or the.aligndirectives and conditional branch instructions in the assembly code outputted by GCC may be rejected by the assembler because of a relocation overflow), and-mno-relaxotherwise.-mpass-mrelax-to-as,-mno-pass-mrelax-to-asโ pass (do not pass) the-mrelaxor-mno-relaxoption to the assembler. the default is determined during GCC build-time by detecting corresponding assembler support:-mpass-mrelax-to-asif the assembler supports the-mrelaxoption, and-mno-pass-mrelax-to-asotherwise. this option is mostly useful for debugging, or interoperation with assemblers different from the build-time one. debugging girlies rise ๐-mrecipโ this one enables use of the reciprocal estimate and reciprocal square root estimate instructions with additional Newton-Raphson steps to increase precision, instead of doing a divide or square root and divide for floating-point arguments. these instructions are generated only when-funsafe-math-optimizationsis enabled together with-ffinite-math-onlyand-fno-trapping-math. this option is off by default. before you can use this option, you must be sure the target CPU supports thefrecipeandfrsqrteinstructions. note that while the throughput of the sequence is higher than the throughput of the non-reciprocal instruction, the precision of the sequence can be decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994). > โ ๏ธ so fast, yes, but the precision takes a little hit. tradeoffs are real bestie ๐ญ- *
-mrecip=opt* โ this option controls which reciprocal estimate instructions may be used. opt is a comma-separated list of options, which may be preceded by a!to invert the option:allโ enable all estimate instructions.defaultโ enable the default instructions, equivalent to-mrecip.noneโ disable all estimate instructions, equivalent to-mno-recip.divโ enable the approximation for scalar division.vec-divโ enable the approximation for vectorized division.sqrtโ enable the approximation for scalar square root.vec-sqrtโ enable the approximation for vectorized square root.rsqrtโ enable the approximation for scalar reciprocal square root.vec-rsqrtโ enable the approximation for vectorized reciprocal square root.
so, for example, -mrecip=all,!sqrt enables all of the reciprocal approximations, except for scalar square root. see, the ! is doing the most and we love her ๐
-mfrecipe,-mno-frecipeโ use (do not use)frecipe.{s/d}andfrsqrte.{s/d}instructions. when compiling with-march=la664, it is enabled by default. otherwise the default is-mno-frecipe.-mdiv32,-mno-div32โ use (do not use)div.w[u]andmod.w[u]instructions with input not sign-extended. when compiling with-march=la664, it is enabled by default. otherwise the default is-mno-div32.-mlam-bh,-mno-lam-bhโ use (do not use)am{swap/add}[_db].{b/h}instructions. when compiling with-march=la664, it is enabled by default. otherwise the default is-mno-lam-bh.-mlamcas,-mno-lamcasโ use (do not use)amcas[_db].{b/h/w/d}instructions. when compiling with-march=la664, it is enabled by default. otherwise the default is-mno-lamcas.-mld-seq-sa,-mno-ld-seq-saโ whether a same-address load-load barrier (dbar 0x700) is needed. when compiling with-march=la664, it is enabled by default. otherwise the default is-mno-ld-seq-sa, and the load-load barrier is needed.-mscq,-mno-scqโ use (do not use) the 16-byte conditional store instructionsc.q. the default is-mscqif the machine type specified with-march=supports this instruction, and-mno-scqotherwise.-mtls-dialect=optโ bestie, this one controls which TLS dialect is allowed to get used for the general dynamic and local dynamic TLS models ๐ . Theoptyou hand it can be one of these two:tradโ use traditional TLS. This is the default โจdescโ use TLS descriptors ๐
-mannotate-tablejump-mno-annotate-tablejumpโ this makes an annotation section called.discard.tablejump_annotateso you can correlate thejirlinstruction with the jump table whenever a jump table gets used to optimize aswitchstatement ๐. Some external tools โ likeobjtoolfrom the Linux kernel building system โ literally need that annotation to analyze the control flow. The default is-mno-annotate-tablejump๐ซถ
๐พ LynxOS Options ๐ธ
These options are available for LynxOS targets ๐
-msharedโ use shared libraries. The default is to link with static libraries โจ-mthreadsโ support multi-threading ๐งต-mlegacy-threadsโ support legacy multi-threading. Heads up: this option is incompatible with-mthreads๐
๐ M32C Options ๐ฆ
-mcpu=nameโ select 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 be run on the simulator ๐ฎ. This causes an alternate runtime library to get linked in, one that supports stuff like file I/O. You must not use this option when you're generating programs that will run on real hardware โ you have to provide your own runtime library for whatever I/O functions are needed ๐ญ-memregs=numberโ specifies the number of memory-based pseudo-registers GCC uses during code generation ๐ . These pseudo-registers are used like real registers, so there's a whole tradeoff between GCC's ability to fit the code into available registers and the performance penalty of using memory instead of registers. Note that all modules in a program must be compiled with the same value for this option. Because of that, you must not use this option with GCC's default runtime libraries ๐ซ
๐ M32R/D Options โจ
These -m options are defined for Renesas M32R/D architectures:
-m32r2โ generate code for the M32R/2 ๐ฅ-m32rxโ generate code for the M32R/X ๐ฅ-m32rโ generate code for the M32R. This is the default ๐-mmodel=smallโ assume all objects live in the lower 16MB of memory (so their addresses can be loaded with theld24instruction), and assume all subroutines are reachable with theblinstruction. This is the default โจ
The addressability of a particular object can be set with the model attribute.
-mmodel=mediumโ assume objects may be anywhere in the 32-bit address space (the compiler generatesseth/add3instructions to load their addresses), and assume all subroutines are reachable with theblinstruction ๐-mmodel=largeโ assume objects may be anywhere in the 32-bit address space (the compiler generatesseth/add3instructions to load their addresses), and assume subroutines may not be reachable with theblinstruction โ the compiler generates the much slowerseth/add3/jlinstruction sequence ๐ญ-msdata=noneโ disable use of the small data area ๐ซ. Variables 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 generate special instructions to reference them ๐-G numโ put global and static objects less than or equal to num bytes into the small data or BSS sections instead of the normal data or BSS sections ๐ฆ. The default value of num is 8. The-msdataoption must be set to one ofsdataorusefor this option to have any effect at all.
All modules should be compiled with the same -G num value. Compiling with different values of num may or may not work; if it doesn't, the linker gives an error message โ incorrect code is not generated ๐ซถ
-mdebugโ makes the M32R-specific code in the compiler display some statistics that might help in debugging programs ๐-malign-loops-mno-align-loopsโ align all loops to a 32-byte boundary. This option is disabled by default ๐ค-missue-rate=numberโ issue number instructions per cycle โก. number can only be 1 or 2.-mbranch-cost=numberโ number can only be 1 or 2. If it's 1 then branches are preferred over conditional code; if it's 2, then the opposite applies ๐-mflush-trap=numberโ specifies the trap number to use to flush the cache ๐งน. The default is 12. Valid numbers are between 0 and 15 inclusive.-mno-flush-trapโ specifies that the cache cannot be flushed by using a trap ๐ญ-mflush-func=nameโ specifies the name of the operating system function to call to flush the cache ๐งผ. The default is_flush_cache, but a function call is only used if a trap is not available.-mno-flush-funcโ indicates that there is no OS function for flushing the cache ๐
๐ M680x0 Options โญ
These are the -m options defined for M680x0 and ColdFire processors ๐. The default settings depend on which architecture was selected when the compiler was configured; the defaults for the most common choices are given below.
-march=archโ generate code for a specific M680x0 or ColdFire instruction set architecture โจ. Permissible values of arch for M680x0 architectures are:68000,68010,68020,68030,68040,68060andcpu32. ColdFire architectures are selected according to Freescale's ISA classification, and the permissible values are:isaa,isaaplus,isabandisac.
GCC defines a macro __mcfarch__ whenever it is generating code for a ColdFire target. The arch in this macro is one of the -march arguments given above.
When used together, -march and -mtune select code that runs on a family of similar processors but that is optimized for a particular microarchitecture ๐
-mcpu=cpuโ generate code for a specific M680x0 or ColdFire processor ๐. The M680x0 cpus are:68000,68010,68020,68030,68040,68060,68302,68332andcpu32. The ColdFire cpus are given by the table below, which also classifies the CPUs into families:51:5151ac51ag51cn51em51je51jf51jg51jm51mm51qe51qm5206:5202520452065206e:5206e5208:520752085211a:5210a5211a5213:5211521252135216:5214521652235:5223052231522325223352234522355225:5224522552259:5225252254522555225652258522595235:5232523352345235523x5249:52495250:52505271:527052715272:52725275:527452755282:528052815282528x53017:530115301253013530145301553016530175307:53075329:532753285329532x5373:53725373537x5407:54075475:547054715472547354745475547x548054815482548354845485
-mcpu=cpu overrides -march=arch if arch is compatible with cpu. Other combinations of -mcpu and -march are rejected ๐ซ
GCC defines the macro __mcf_cpu_cpu when ColdFire target cpu is selected. It also defines __mcf_family_family, where the value of family is given by the table above.
-mtune=tuneโ tune the code for a particular microarchitecture within the constraints set by-marchand-mcpu๐๏ธ. The M680x0 microarchitectures are:68000,68010,68020,68030,68040,68060andcpu32. The ColdFire microarchitectures are:cfv1,cfv2,cfv3,cfv4andcfv4e.
You can also use -mtune=68020-40 for code that needs to run relatively well on 68020, 68030 and 68040 targets. -mtune=68020-60 is similar but includes 68060 targets as well. These two options select the same tuning decisions as -m68020-40 and -m68020-60 respectively ๐ฏ
GCC defines the macros __mcarch and __mcarch__ when tuning for 680x0 architecture arch. It also defines mcarch unless either -ansi or a non-GNU -std option is used. If GCC is tuning for a range of architectures, as selected by -mtune=68020-40 or -mtune=68020-60, it defines the macros for every architecture in the range.
GCC also defines the macro __muarch__ when tuning for ColdFire microarchitecture uarch, where uarch is one of the arguments given above.
-m68000-mc68000โ generate output for a 68000 โจ. This is the default when the compiler is configured for 68000-based systems. It is equivalent to-march=68000.
Use this option for microcontrollers with a 68000 or EC000 core, including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356 ๐ซถ
-m68010โ generate output for a 68010. This is the default when the compiler is configured for 68010-based systems. It is equivalent to-march=68010๐-m68020-mc68020โ generate output for a 68020. This is the default when the compiler is configured for 68020-based systems. It is equivalent to-march=68020๐-m68030โ generate output for a 68030. This is the default when the compiler is configured for 68030-based systems. It is equivalent to-march=68030๐-m68040โ generate output for a 68040. This is the default when the compiler is configured for 68040-based systems. It is equivalent to-march=68040.
This option inhibits the use of 68881/68882 instructions that have to be emulated by software on the 68040 ๐ญ. Use this option if your 68040 does not have code to emulate those instructions.
-m68060โ generate output for a 68060. This is the default when the compiler is configured for 68060-based systems. It is equivalent to-march=68060.
This option inhibits the use of 68020 and 68881/68882 instructions that have to be emulated by software on the 68060 ๐ญ. Use this option if your 68060 does not have code to emulate those instructions.
-m68302โ generate code for a 68302 ๐-m68332โ generate code for a 68332 ๐-m68851โ the 68851 was an external MMU for the 68020 processor. GCC accepts this option bestie, but it literally does not use it. It's giving decorative. ๐-mcpu32โ generate output for a CPU32. This is the default when the compiler is configured for CPU32-based systems, and it's equivalent to-march=cpu32.
Use this one for microcontrollers with a CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334, 68336, 68340, 68341, 68349 and 68360. ๐
-mfidoaโ generate code for a Fido A.-m5200โ generate output for a 520X ColdFire CPU. This is the default when the compiler is configured for 520X-based systems. It is equivalent to-mcpu=5206, and it's now deprecated in favor of that option. ๐
Use this option for microcontroller with a 5200 core, including the MCF5202, MCF5203, MCF5204 and MCF5206.
-m5206eโ generate output for a 5206e ColdFire CPU. The option is now deprecated in favor of the equivalent-mcpu=5206e.-m528xโ generate output for a member of the ColdFire 528X family. The option is now deprecated in favor of the equivalent-mcpu=528x.-m5307โ generate output for a ColdFire 5307 CPU. The option is now deprecated in favor of the equivalent-mcpu=5307.-m5407โ generate output for a ColdFire 5407 CPU. The option is now deprecated in favor of the equivalent-mcpu=5407.-mcfv4eโ generate output for a ColdFire V4e family CPU (e.g.547x/548x). This includes use of hardware floating-point instructions. The option is equivalent to-mcpu=547x, and it's now deprecated in favor of that option.-m68020-40โ generate output for a 68040, without using any of the new instructions. This results in code that can run relatively efficiently on either a 68020/68881 or a 68030 or a 68040. The generated code does use the 68881 instructions that are emulated on the 68040.
The option is equivalent to -march=68020 -mtune=68020-40.
-m68020-60โ generate output for a 68060, without using any of the new instructions. This results in code that can run relatively efficiently on either a 68020/68881 or a 68030 or a 68040. The generated code does use the 68881 instructions that are emulated on the 68060.
The option is equivalent to -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 (do not generate) ColdFire hardware divide and remainder instructions. If-marchis used without-mcpu, the default is"on"for ColdFire architectures and"off"for M680x0 architectures. Otherwise, the default is taken from the target CPU (either the default CPU, or the one specified by-mcpu). For example, the default is"off"for-mcpu=5206and"on"for-mcpu=5206e.
GCC defines the macro "__mcfhwdiv__" when this option is enabled. ๐
-mshort,-mno-short,-mnoshortโ consider type"int"to be 16 bits wide, like"short int". Additionally, parameters passed on the stack are also aligned to a 16-bit boundary even on targets whose API mandates promotion to 32-bit. This option is disabled by default.-mbitfield,-mno-bitfield,-mnobitfieldโ control use of the bit-field instructions. The-m68000,-mcpu32and-m5200options imply-mnobitfield; the-m68020option implies-mbitfield.-mrtd,-mno-rtd,-mnortdโ control use of a different function-calling convention, in which functions that take a fixed number of arguments return with the"rtd"instruction, which pops their arguments while returning. This saves one instruction in the caller since there is no need to pop the arguments there. ๐ซถ
This calling convention is incompatible with the one normally used on Unix, so you cannot use it if you need to call libraries compiled with the Unix compiler.
Also, you must provide function prototypes for all functions that take variable numbers of arguments (including "printf"); otherwise incorrect code is generated for calls to those functions.
In addition, seriously incorrect code results if you call a function with too many arguments. (Normally, extra arguments are harmlessly ignored.)
The "rtd" instruction is supported by the 68010, 68020, 68030, 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
The default is -mno-rtd.
-malign-int,-mno-align-intโ control whether GCC aligns"int","long","long long","float","double", and"long double"variables on a 32-bit boundary (-malign-int) or a 16-bit boundary (-mno-align-int). Aligning variables on 32-bit boundaries produces code that runs somewhat faster on processors with 32-bit busses at the expense of more memory.
Warning: if you use the -malign-int switch, GCC aligns structures containing the above types differently than most published application binary interface specifications for the m68k. ๐ญ
Use the pc-relative addressing mode of the 68000 directly, instead of using a global offset table. At present, this option implies -fpic, allowing at most a 16-bit offset for pc-relative addressing. -fPIC is not presently supported with -mpcrel, though this could be supported for 68020 and higher processors.
-mno-strict-align,-mstrict-alignโ do not (do) assume that unaligned memory references are handled by the system.-msep-data,-mno-sep-dataโ with-msep-data, generate code that allows the data segment to be located in a different area of memory from the text segment. This allows for execute-in-place in an environment without virtual memory management. This option implies-fPIC.
This option is disabled by default; GCC generates code that assumes that the data segment follows the text segment.
-mid-shared-library,-mno-id-shared-libraryโ if enabled, generate code that supports shared libraries via the library ID method. This allows for execute-in-place and shared libraries in an environment without virtual memory management. This option implies-fPIC.
This option is disabled by default.
-mshared-library-id=nโ specifies the identification number of the ID-based shared library being compiled. Specifying a value of0generates more compact code; specifying other values forces the allocation of that number to the current library, but is no more space- or time-efficient than omitting this option.-mxgot,-mno-xgotโ when generating position-independent code for ColdFire, generate code that works if the GOT has more than8192entries. This code is larger and slower than code generated without this option. On M680x0 processors, this option is not needed;-fPICsuffices.
GCC normally uses a single instruction to load values from the GOT. While this is relatively efficient, it only works if the GOT is smaller than about 64k. Anything larger causes the linker to report an error such as:
relocation truncated to fit: R_68K_GOT16O foobar
If this happens, you should recompile your code with -mxgot. It should then work with very large GOTs. However, code generated with -mxgot is less efficient, since it takes 4 instructions to fetch the value of a global symbol. ๐
Note that some linkers, including newer versions of the GNU linker, can create multiple GOTs and sort GOT entries. If you have such a linker, you should only need to use -mxgot when compiling a single object file that accesses more than 8192 GOT entries. Very few do. ๐
These options have no effect unless GCC is generating position-independent code.
-mxtlsโ support TLS segment larger than64K. The considerations for using this option are similar to those for-mxgotabove; the default 16-bit offset addressing for TLS is more efficient, but this may be inadequate for some programs.-mlong-jump-table-offsetsโ use 32-bit offsets in"switch"tables. The default is to use 16-bit offsets.
๐ MCore Options ๐
These are the -m options defined for the Motorola M*Core processors. โจ
-mhardlit,-mno-hardlitโ inline constants into the code stream if it can be done in two instructions or less.-mdiv,-mno-divโ use the divide instruction. (Enabled by default).-mrelax-immediates,-mno-relax-immediatesโ allow arbitrary-sized immediates in bit operations.-mwide-bitfields,-mno-wide-bitfieldsโ always treat bit-fields as"int"-sized.-m4byte-functions,-mno-4byte-functionsโ force all functions to be aligned to a 4-byte boundary.-mcallgraph-data,-mno-callgraph-dataโ emit callgraph information.-mslow-bytes,-mno-slow-bytesโ prefer word access when reading byte quantities.-mlittle-endian,-mbig-endianโ generate code for a little- or big-endian target, respectively. The default is big-endian. Little-endian code is supported only with-m340. ๐-m210โ generate code for the 210 processor.-m340โ generate code for the 340 processor.-mno-lsimโ assume that runtime support has been provided and so omit the simulator library (libsim.a) from the linker command line.-mstack-increment=sizeโ set the maximum amount for a single stack increment operation. Large values can increase the speed of programs that contain functions that need a large amount of stack space, but they can also trigger a segmentation fault if the stack is extended too much. The default value is0x1000.
๐ฆ MicroBlaze Options ๐ฆ
-msoft-floatโ use software emulation for floating point (default).-mhard-floatโ use hardware floating-point instructions.-mmemcpyโ do not optimize block moves, use"memcpy".-mcpu=cpu-typeโ use features of, and schedule code for, the given CPU. Supported values are in the formatvX.YY.Z, whereXis a major version,YYis the minor version, andZis compatibility code. Example values arev3.00.a,v4.00.b,v5.00.a,v5.00.b,v6.00.a. ๐-mxl-soft-mul,-mno-xl-soft-mulโ turn on software multiply emulation. bestie it's on by default, so unless you're actively turning it off, it's already doing the thing ๐-mxl-soft-div,-mno-xl-soft-divโ software emulation for divides. also enabled by default, no cap.-mxl-barrel-shiftโ use the hardware barrel shifter. giving hardware, not vibes.-mxl-pattern-compareโ use pattern compare instructions.-msmall-dividesโ table lookup optimization for small signed integer divisions. tiny numbers, big efficiency energy โจ-mxl-gp-optโ use GP-relative.sdata/.sbsssections.-mxl-multiply-highโ use multiply high instructions for the high part of a 32x32 multiply.-mxl-float-convertโ use hardware floating-point conversion instructions.-mxl-float-sqrtโ use the hardware floating-point square root instruction.-mbig-endianโ generate code for a big-endian target.-mlittle-endianโ generate code for a little-endian target.-mxl-reorderโ use reorder instructions (swap and byte reversed load/store).-mxl-mode-app-modelโ pick your application model, app-model. the valid models are:executableโ normal executable (default), uses startup codecrt0.o. the classic ๐xmdstubโ for use with the Xilinx Microprocessor Debugger (XMD) based software intrusive debug agent calledxmdstub. This uses startup filecrt1.oand sets the start address of the program to0x800.bootstrapโ for applications that are loaded using a bootloader. This model uses startup filecrt2.owhich does not contain a processor reset vector handler. This is suitable for transferring control on a processor reset to the bootloader rather than the application.novectorsโ for applications that do not require any of the MicroBlaze vectors. This option may be useful for applications running within a monitoring application. This model usescrt3.oas a startup file.
-mxl-prefetchโ enable insertion of prefetch (wic) instructions at call sites. sneak preview energy ๐-mpic-data-is-text-relativeโ assume that the displacement between the text and data segments is fixed at static link time. This allows data to be referenced by offset from start of text address instead of GOT since PC-relative addressing is not supported.
๐ MIPS Options ๐
-EB,-mebโ generate big-endian code.-EL,-melโ generate little-endian code. This is the default formips*el-*-*configurations.-march=arch โ generate code that runs on arch, which can be the name of a generic MIPS ISA, or the name of a particular processor. The ISA names are:mips1,mips2,mips3,mips4,mips32,mips32r2,mips32r3,mips32r5,mips32r6,mips64,mips64r2,mips64r3,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.allegrex, The special valuefrom-abiselects the most compatible architecture for the selected ABI (that is,mips1for 32-bit ABIs andmips3for 64-bit ABIs).
The native Linux/GNU toolchain also supports the value native, which selects the best architecture option for the host processor. -march=native has no effect if GCC does not recognize the processor.
In processor names, a final 000 can be abbreviated as k (for example, -march=r2k). Prefixes are optional, and vr may be written r.
Names of the form *n*f2_1 refer to processors with FPUs clocked at half the rate of the core, names of the form *n*f1_1 refer to processors with FPUs clocked at the same rate as the core, and names of the form *n*f3_2 refer to processors with FPUs clocked a ratio of 3:2 with respect to the core. For compatibility reasons, *n*f is accepted as a synonym for *n*f2_1 while *n*x and *n*bfx are accepted as synonyms for *n*f1_1.
GCC defines two macros based on the value of this option. The first is _MIPS_ARCH, which gives the name of target architecture, as a string. The second has the form _MIPS_ARCH_foo, where foo is the capitalized value of _MIPS_ARCH. For example, -march=r2000 sets _MIPS_ARCH to "r2000" and defines the macro _MIPS_ARCH_R2000.
ngl the_MIPS_ARCHmacro uses the processor names given above. In other words, it has the full prefix and does not abbreviate000ask. In the case offrom-abi, the macro names the resolved architecture (either"mips1"or"mips3"). It names the default architecture when no-marchoption is given.
-mtune=arch โ optimize for arch. Among other things, this option controls the way instructions are scheduled, and the perceived cost of arithmetic operations. The list of arch values is the same as for-march.
When this option is not used, GCC optimizes for the processor specified by -march. By using -march and -mtune together, it is possible to generate code that runs on a family of processors, but optimize the code for one particular member of that family.
-mtune defines the macros _MIPS_TUNE and _MIPS_TUNE_foo, which work in the same way as the -march ones described above. โจ
-mips1โ equivalent to-march=mips1.-mips2โ equivalent to-march=mips2.-mips3โ equivalent to-march=mips3.-mips4โ equivalent to-march=mips4.-mips32โ equivalent to-march=mips32.-mips32r3โ equivalent to-march=mips32r3.-mips32r5โ equivalent to-march=mips32r5.-mips32r6โ equivalent to-march=mips32r6.-mips64โ equivalent to-march=mips64.-mips64r2โ equivalent to-march=mips64r2.-mips64r3โ equivalent to-march=mips64r3.-mips64r5โ equivalent to-march=mips64r5.-mips64r6โ equivalent to-march=mips64r6.-mips16,-mno-mips16โ generate (do not generate) MIPS16 code. If GCC is targeting a MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE.
MIPS16 code generation can also be controlled on a per-function basis by means of mips16 and nomips16 attributes.
-mmips16e2,-mno-mips16e2โ use (do not use) the MIPS16e2 ASE. This option modifies the behavior of the-mips16option such that it targets the MIPS16e2 ASE.-mflip-mips16,-mflip-mips16โ generate MIPS16 code on alternating functions. This option is provided for regression testing of mixed MIPS16/non-MIPS16 code generation, and is not intended for ordinary use in compiling user code.
not me saying this twice ๐ it's literally listed twice in the original. regression testing only, bestie, do not ship this.
-minterlink-compressed,-mno-interlink-compressedโ require (do not require) that code using the standard (uncompressed) MIPS ISA be link-compatible with MIPS16 and microMIPS code, and vice versa.
For example, code using the standard ISA encoding cannot jump directly to MIPS16 or microMIPS code; it must either use a call or an indirect jump. -minterlink-compressed therefore disables direct jumps unless GCC knows that the target of the jump is not compressed.
-minterlink-mips16,-mno-interlink-mips16โ aliases of-minterlink-compressedand-mno-interlink-compressed. These options predate the microMIPS ASE and are retained for backwards compatibility. nostalgic little icons ๐ซถ-mabi=32,-mabi=o64,-mabi=n32,-mabi=64,-mabi=eabiโ generate code for the given ABI.
Note that the EABI has a 32-bit and a 64-bit variant. GCC normally generates 64-bit code when you select a 64-bit architecture, but you can use -mgp32 to get 32-bit code instead.
For information about the O64 ABI, see <https://gcc.gnu.org/projects/mipso64-abi.html>.
GCC supports a variant of the o32 ABI in which floating-point registers are 64 rather than 32 bits wide. You can select this combination with -mabi=32 -mfp64. This ABI relies on the mthc1 and mfhc1 instructions and is therefore only supported for MIPS32R2, MIPS32R3 and MIPS32R5 processors.
The register assignments for arguments and return values remain the same, but each scalar value is passed in a single 64-bit register rather than a pair of 32-bit registers. For example, scalar floating-point values are returned in $f0 only, not a $f0/$f1 pair. The set of call-saved registers also remains the same in that the even-numbered double-precision registers are saved.
Two additional variants of the o32 ABI are supported to enable a transition from 32-bit to 64-bit registers. These are FPXX (-mfpxx) and FP64A (-mfp64 -mno-odd-spreg). The FPXX extension mandates that all code must execute correctly when run using 32-bit or 64-bit registers. The code can be interlinked with either FP32 or FP64, but not both. The FP64A extension is similar to the FP64 extension but forbids the use of odd-numbered single-precision registers. This can be used in conjunction with the FRE mode of FPUs in MIPS32R5 processors and allows both FP32 and FP64A code to interlink and run in the same process without changing FPU modes.
-mabicalls,-mno-abicallsโ generate (do not generate) code that is suitable for SVR4-style dynamic objects.-mabicallsis the default for SVR4-based systems.-mshared,-mno-sharedโ generate (do not generate) code that is fully position-independent, and that can therefore be linked into shared libraries. This option only affects-mabicalls.
All -mabicalls code has traditionally been position-independent, regardless of options like -fPIC and -fpic. However, as an extension, the GNU toolchain allows executables to use absolute accesses for locally-binding symbols. It can also use shorter GP initialization sequences and generate direct calls to locally-defined functions. This mode is selected by -mno-shared.
lowkey important:-mno-shareddepends on binutils 2.16 or higher and generates objects that can only be linked by the GNU linker. However, the option does not affect the ABI of the final executable; it only affects the ABI of relocatable objects. Using-mno-sharedgenerally makes executables both smaller and quicker. smaller AND quicker?? ate ๐
-mshared is the default. periodt.
-mplt,-mno-pltโ bestie, this one's asking whether to assume (or not assume, with the-mno-version) that your static and dynamic linkers can handle PLTs and copy relocations. Heads up tho: this option only does anything when you've got-mno-sharedand-mabicallsgoing on. And for the n64 ABI? It literally does nothing unless-msym32is also there. ๐ Want-mpltto just be the default always? Configure GCC with--with-mips-plt. Otherwise the default is-mno-plt, no cap.-mxgot,-mno-xgotโ lifts (or doesn't lift) the usual restrictions on how big the global offset table can be. โจ
So normally GCC loads values from the GOT with a single instruction. Super efficient, love that for us ๐ โ but it only works if the GOT is smaller than about 64k. Go bigger than that and the linker throws a fit, something like:
relocation truncated to fit: R_MIPS_GOT16 foobar
If that happens to you, recompile with -mxgot. It plays nice with very large GOTs, but the code gets less efficient (it takes three instructions to fetch a global symbol's value instead of one ๐ญ).
Little note: some linkers can create multiple GOTs. If yours does, you should only need -mxgot when a single object file accesses more than 64k's worth of GOT entries. And honestly, very few do.
These options do nothing at all unless GCC is generating position independent code. fr fr.
-mgp32โ assume general-purpose registers are 32 bits wide.-mgp64โ assume general-purpose registers are 64 bits wide.-mfp32โ assume floating-point registers are 32 bits wide.-mfp64โ assume floating-point registers are 64 bits wide.-mfpxxโ don't assume any width for the floating-point registers. mystery mode ๐ฆ-mhard-floatโ use floating-point coprocessor instructions.-msoft-floatโ do not use floating-point coprocessor instructions. Floating-point math gets done with library calls instead.-mno-floatโ same energy as-msoft-float, but it additionally asserts that the program being compiled does zero floating-point operations, like, at all. Right now this is only supported by some bare-metal MIPS configurations, where it might pick a special set of libraries that have no floating-point support whatsoever (including, for example, the floating-point"printf"formats ๐ณ). And if code compiled with-mno-floataccidentally contains floating-point operations? It's probably gonna fail at link time or run time. not a vibe.-msingle-floatโ assume the floating-point coprocessor only supports single-precision operations.-mdouble-floatโ assume the floating-point coprocessor supports double-precision operations. This is the default. ๐-modd-spreg,-mno-odd-spregโ enables using odd-numbered single-precision floating-point registers for the o32 ABI. This is the default for processors known to support these registers. But when you're on the o32 FPXX ABI,-mno-odd-spregis set by default instead.-mabs=2008,-mabs=legacyโ these two control how the special not-a-number (NaN) IEEE 754 floating-point data gets treated with the"abs.fmt"and"neg.fmt"machine instructions. ๐ง
By default, or when you use -mabs=legacy, the legacy treatment is selected. In that case these instructions count as arithmetic, so they get avoided wherever correct operation is required and the input operand might be a NaN. Instead, GCC uses a longer sequence of instructions that manually manipulate the sign bit of the floating-point datum โ unless you also passed -ffinite-math-only, that is.
The -mabs=2008 option selects the IEEE 754-2008 treatment instead. Now these instructions count as non-arithmetic, meaning they operate correctly in all cases, including specifically when the input operand is a NaN. So they're always used for the respective operations. slay.
-mnan=2008,-mnan=legacyโ these control the encoding of the special not-a-number (NaN) IEEE 754 floating-point data.
-mnan=legacy selects the legacy encoding. Here quiet NaNs (qNaNs) are denoted by the first bit of their trailing significand field being 0, while signaling NaNs (sNaNs) are denoted by the first bit of their trailing significand field being 1.
-mnan=2008 selects the IEEE 754-2008 encoding. Now it's flipped: qNaNs are denoted by the first bit of their trailing significand field being 1, while sNaNs are denoted by the first bit of their trailing significand field being 0. ๐
The default is -mnan=legacy, unless GCC was configured with --with-nan=2008.
-mllsc,-mno-llscโ use (or don't use)ll,sc, andsyncinstructions to implement atomic memory built-in functions. When neither option is specified, GCC uses the instructions if the target architecture supports them.
-mllsc is useful when the runtime environment can emulate those instructions, and -mno-llsc can be useful when you're compiling for nonstandard ISAs. You can make either one the default by configuring GCC with --with-llsc or --without-llsc respectively. --with-llsc is the default for some configurations โ peep the installation documentation for the deets. ๐
-mdsp,-mno-dspโ use (or don't use) revision 1 of the MIPS DSP ASE. This option defines the preprocessor macro"__mips_dsp". It also defines"__mips_dsp_rev"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โ use (or don't use) the MIPS SmartMIPS ASE.-mpaired-single,-mno-paired-singleโ use (or don't use) paired-single floating-point instructions. Heads up: this option requires hardware floating-point support to be enabled. ๐ซถ-mdmx,-mno-mdmxโ use (or don't use) MIPS Digital Media Extension instructions. This one can only be used when generating 64-bit code, and it also requires hardware floating-point support to be enabled.-mips3d,-mno-mips3dโ use (or don't use) the MIPS-3D ASE. The option-mips3dimplies-mpaired-single.-mmicromips,-mno-micromipsโ generate (or don't generate) microMIPS code.
MicroMIPS code generation can also be controlled on a per-function basis using the "micromips" and "nomicromips" attributes. cute, right? ๐
-mmt,-mno-mtโ use (or don't use) MT Multithreading instructions.-mmcu,-mno-mcuโ use (or don't use) the MIPS MCU ASE instructions.-meva,-mno-evaโ use (or don't use) the MIPS Enhanced Virtual Addressing instructions.-mvirt,-mno-virtโ use (or don't use) the MIPS Virtualization (VZ) instructions.-mxpa,-mno-xpaโ use (or don't use) the MIPS eXtended Physical Address (XPA) instructions.-mcrc,-mno-crcโ use (or don't use) the MIPS Cyclic Redundancy Check (CRC) instructions.-mginv,-mno-ginvโ use (or don't use) the MIPS Global INValidate (GINV) instructions.-mmsa,-mno-msaโ use (or don't use) the MIPS MSA extension instructions.-mloongson-mmi,-mno-loongson-mmiโ use (or don't use) the MIPS Loongson MultiMedia extensions Instructions (MMI).-mloongson-ext,-mno-loongson-extโ use (or don't use) the MIPS Loongson EXTensions (EXT) instructions.-mloongson-ext2,-mno-loongson-ext2โ use (or don't use) the MIPS Loongson EXTensions r2 (EXT2) instructions.-mlong64โ force"long"types to be 64 bits wide. Wanna know about the default and how pointer size gets determined? See-mlong32.-mlong32โ force"long","int", and pointer types to be 32 bits wide.
The default size of "int"s, "long"s and pointers depends on the ABI. All the supported ABIs use 32-bit "int"s. The n64 ABI uses 64-bit "long"s, and so does the 64-bit EABI; the others use 32-bit "long"s. Pointers are the same size as "long"s, or the same size as integer registers โ whichever is smaller. ๐
-msym32,-mno-sym32โ assume (or don't assume) that all symbols have 32-bit values, regardless of the selected ABI. This one's a bop 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 โ peep-mgpoptfor the details.
The default -G option depends on the configuration.
-mlocal-sdata,-mno-local-sdataโ extend (or don't extend) the-Gbehavior to local data too, like static variables in C.-mlocal-sdatais the default for all configurations.
If the linker starts complaining that an application is using too much small data, you might wanna try rebuilding the less performance-critical parts with -mno-local-sdata. You might also wanna build large libraries with -mno-local-sdata so the libraries leave more room for the main program. ๐
-mextern-sdata,-mno-extern-sdataโ assume (or don't assume) that externally-defined data is in a small data section if the size of that data is within the-Glimit.-mextern-sdatais the default for all configurations.
Okay so this is the part where it gets specific. If you compile a module Mod with -mextern-sdata -G num -mgpopt, and Mod references a variable Var that's no bigger than num bytes, you must make sure 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. ๐ฎโ๐จ
The easiest way to satisfy all these restrictions is to compile and link every module with the same -G option. But maybe you wanna build a library that supports several different small data limits โ you can do that by compiling the library with the highest supported -G setting and additionally using -mno-extern-sdata to stop the library from making assumptions about externally-defined data. iykyk ๐
-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 the move for when that $gp register might not be holding the value of "_gp". Like, imagine the code is part of a library that might get used inside a boot monitor โ programs calling boot monitor routines are passing an unknown value in $gp. (And in those situations, the boot monitor itself is usually compiled with -G0 anyway, so.)
Heads up bestie:-mno-gpoptimplies-mno-local-sdataand-mno-extern-sdata. Package deal. ๐
-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, and otherwise in data. This gives slightly slower code than the default, but it reduces how much RAM you need while executing โ so some embedded systems are literally obsessed with it. โจ-muninit-const-in-rodata,-mno-uninit-const-in-rodataโ Put uninitialized"const"variables in the read-only data section. This option is only meaningful when you pair it with-membedded-dataโ it does nothing on its own, no cap.-mcode-readable=settingโ Tells GCC whether it's allowed to generate code that reads from executable sections. There are three possible settings, and they're giving very different vibes:-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 every other instruction must not do that. This 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 with a dual instruction/data SRAM interface and that, like the M4K, automatically redirect PC-relative loads to the instruction RAM. Iconic behaviour tbh.-mcode-readable=noโ Instructions must not access executable sections. Useful on targets configured with a dual instruction/data SRAM interface but that (unlike the M4K) do not automatically redirect PC-relative loads to the instruction RAM.
On SDE targets, -mcode-data-in-code is available as a traditional alias for -mcode-readable=no, and -mcode-xonly for -mcode-readable=pcrel.
-msplit-addresses,-mno-split-addressesโ Enable (or disable) use of the%hi()and%lo()assembler relocation operators. This option has been superseded by-mexplicit-relocsbut is retained for backwards compatibility โ it's the elder, still hanging around, we respect it. ๐-mexplicit-relocs=none,-mexplicit-relocs=base,-mexplicit-relocs=pcrel,-mexplicit-relocs,-mno-explicit-relocsโ These control whether explicit relocs (like%gp_rel) get used. The default value depends on which version of GAS was around when GCC itself was built. ๐ ๏ธ
The "base" explicit-relocs support landed in GAS in 2001. The "pcrel" explicit-relocs support landed in GAS in 2014, and it supports %pcrel_hi and %pcrel_lo.
-mcheck-zero-division,-mno-check-zero-divisionโ Trap (or do not trap) on integer division by zero. ๐
The default is -mcheck-zero-division.
-mdivide-traps,-mdivide-breaksโ MIPS systems check for division by zero by generating either a conditional trap or a break instruction. Using traps results in smaller code, but it's only supported on MIPS II and later. Also, some versions of the Linux kernel have a bug that prevents trap from generating the proper signal ("SIGFPE"). Use-mdivide-trapsto allow conditional traps on architectures that support them, and-mdivide-breaksto force the use of breaks.
The default is usually -mdivide-traps, but this can be overridden at configure time using --with-divide=breaks. And divide-by-zero checks can be completely disabled using -mno-check-zero-division. Gone. Poof. โจ
-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 it only takes effect when the selected architecture is known to support bonding โ otherwise it's just sitting there, main character energy with no audience. ๐-mstrict-align,-mno-strict-align,-munaligned-access,-mno-unaligned-accessโ Disable (or enable) direct unaligned access for MIPS Release 6. MIPSr6 requires load/store unaligned-access support, either by hardware or by trapping and emulation. In that latter case,-mstrict-alignmay be needed by the operating system kernel. The options-munaligned-accessand-mno-unaligned-accessare obsolete, and only provided for backward compatibility. โ ๏ธ-mmemcpy,-mno-memcpyโ Force (or do not force) the use of"memcpy"for non-trivial block moves. The default is-mno-memcpy, which lets GCC inline most constant-sized copies. Slay.-mlong-calls,-mno-long-callsโ Disable (or do not disable) use of the"jal"instruction. Calling functions with"jal"is more efficient, but it requires the caller and callee to be in the same 256 megabyte segment. So like... stay in your lane, literally.
This option has no effect on abicalls code. The default is -mno-long-calls.
-mmad,-mno-madโ Enable (or disable) use of the"mad","madu"and"mul"instructions, as provided by the R4650 ISA.-mimadd,-mno-imaddโ Enable (or disable) use of the"madd"and"msub"integer instructions. The default is-mimaddon architectures that support"madd"and"msub"โ except for the 74k architecture, where it was found to generate slower code. Not it. ๐ซ-mfused-madd,-mno-fused-maddโ Enable (or disable) use of the floating-point multiply-accumulate instructions, when they're available. The default is-mfused-madd.
On the R8000 CPU, when multiply-accumulate instructions are used, the intermediate product is calculated to infinite precision and is not subject to the FCSR Flush to Zero bit. This may be undesirable in some circumstances. On other processors, the result is numerically identical to the equivalent computation using separate multiply, add, subtract and negate instructions.
-nocppโ Tell the MIPS assembler to not run its preprocessor over user assembler files (with a.ssuffix) when assembling them.-mfix-24k,-mno-fix-24kโ Work around the 24K E48 errata (lost data on stores during refill). The workarounds are implemented by the assembler rather than by GCC. ๐ฉน-mfix-r4000,-mno-fix-r4000โ Work around certain R4000 CPU errata:- A double-word or a variable shift may give an incorrect result if executed immediately after starting an integer division.
- A double-word or a variable shift may give an incorrect result if executed while an integer multiplication is in progress.
- An integer division may give an incorrect result if started in a delay slot of a taken branch or a jump.
-mfix-r4400,-mno-fix-r4400โ Work around certain R4400 CPU errata:- A double-word or a variable shift may give an incorrect result if executed immediately after starting an integer division.
-mfix-r10000,-mno-fix-r10000โ Work around certain R10000 errata:"ll"/"sc"sequences may not behave atomically on revisions prior to 3.0. They may deadlock on revisions 2.6 and earlier. ๐
This option can only be used if the target architecture supports branch-likely instructions. -mfix-r10000 is the default when -march=r10000 is used; -mno-fix-r10000 is the default otherwise.
-mfix-r5900,-mno-fix-r5900โ Do not attempt to schedule the preceding instruction into the delay slot of a branch instruction placed at the end of a short loop of six instructions or fewer, and always schedule a"nop"instruction there instead. The short loop bug, under certain conditions, causes loops to execute only once or twice, due to a hardware bug in the R5900 chip. The workaround is implemented by the assembler rather than by GCC.-mfix-rm7000,-mno-fix-rm7000โ Work around the RM7000"dmult"/"dmultu"errata. The workarounds are implemented by the assembler rather than by GCC.-mfix-vr4120,-mno-fix-vr4120โ Work around certain VR4120 errata:"dmultu"does not always produce the correct result."div"and"ddiv"do not always produce the correct result if one of the operands is negative.
The workarounds for the division errata rely on special functions in libgcc.a. At present, these functions are only provided by the "mips64vr*-elf" configurations.
Other VR4120 errata require a NOP to be inserted between certain pairs of instructions. These errata are handled by the assembler, not by GCC itself.
-mfix-vr4130,-mno-fix-vr4130โ Work around the VR4130"mflo"/"mfhi"errata. The workarounds are implemented by the assembler rather than by GCC, although GCC avoids using"mflo"and"mfhi"if the VR4130"macc","macchi","dmacc"and"dmacchi"instructions are available instead. Swapping one for the other, we love to see it. ๐-mfix-sb1,-mno-fix-sb1โ Work around certain SB-1 CPU core errata. (This flag currently works around the SB-1 revision 2"F1"and"F2"floating-point errata.)-mfix4300,-mno-fix4300โ Work around a bug in early VR4300 silicon that causes multiplies with certain operands to corrupt immediately following multiplies. Rude of the silicon, honestly. ๐ญ-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's literally the kernel's whole job to make sure speculative accesses to these regions are actually safe, bestie. Like, that's on them, not you. ๐
So if your input program has a function declaration like:
void foo (void);
then whatever implements foo has to let j foo and jal foo be executed speculatively. GCC is a good citizen and honors this restriction for functions it compiles itself, but it expects non-GCC functions (looking at you, hand-written assembly code ๐) to do the same.
This option comes in three flavors:
-mr10k-cache-barrier=load-storeโ drops a cache barrier before a load or store that might get speculatively executed and might have side effects even if it gets aborted. ๐-mr10k-cache-barrier=storeโ same deal, but only before a store that might be speculatively executed and might have side effects even if aborted.-mr10k-cache-barrier=noneโ turns the whole cache-barrier thing off. This is the default, so it's what you get if you don't say anything.-mflush-func=*func*and-mno-flush-funcโ tells GCC which function to call to flush the I and D caches, or tells it to call no such function at all. If it does get called, that function has to take the same arguments as the common_flush_func, which means: the address of the memory range being flushed, the size of that memory range, and the number3(because 3 = flush both caches ๐งนโจ). The default depends on the target GCC was configured for, but it's commonly either_flush_funcor__cpu_flush.-mbranch-cost=*num*โ sets the cost of branches to roughly num "simple" instructions. Heads up though: this cost is only a heuristic and it is not guaranteed to give you consistent results across releases. A zero cost redundantly selects the default, which is based on the-mtunesetting.-mbranch-likelyand-mno-branch-likelyโ enable or disable use of Branch Likely instructions, no matter what the default is for the architecture you picked. By default, Branch Likely instructions may be generated if your selected architecture supports them. The exception: MIPS32 and MIPS64 architectures, plus the processors that implement those architectures, don't generate Branch Likely instructions by default, because MIPS32 and MIPS64 specifically deprecate their use. ๐ซ-mcompact-branches=never,-mcompact-branches=optimal,-mcompact-branches=alwaysโ these control which form of branches get generated. The default is-mcompact-branches=optimal.-mcompact-branches=nevermakes sure compact branch instructions are never generated. Never ever. Periodt.-mcompact-branches=alwaysmakes sure a compact branch instruction gets generated if one is available for MIPS Release 6 onwards. If no compact branch instruction is available (or you're pre-R6), a delay slot form of the branch is used instead.- If you use it for MIPS16/microMIPS targets, it just gets ignored right now. The behavior for MIPS16/microMIPS might change in the future though, since they do have some compact branch instructions. ๐ฎ
-mcompact-branches=optimalcauses a delay slot branch to be used if one is available in the current ISA and the delay slot gets successfully filled. If the delay slot doesn't get filled, a compact branch is chosen if one is available.
-mfp-exceptionsand-mno-fp-exceptionsโ says whether FP exceptions are enabled. This affects how FP instructions get scheduled for some processors. The default is that FP exceptions are enabled. For example, on the SB-1, if FP exceptions are disabled and we're emitting 64-bit code, then we can use both FP pipes. Otherwise, we can only use one FP pipe. ๐-mvr4130-alignand-mno-vr4130-alignโ the VR4130 pipeline is two-way superscalar, but it can only issue two instructions together if the first one is 8-byte aligned. When this option is on, GCC aligns pairs of instructions that it thinks should execute in parallel. This only does anything when optimizing for the VR4130. It normally makes code faster, but at the cost of making it bigger. It's enabled by default at optimization level-O3.-msynciand-mno-synciโ enable (or disable) generation ofsynciinstructions on architectures that support them. Thesynciinstructions (when enabled) get generated when__builtin___clear_cacheis compiled. This option defaults to-mno-synci, but that default can be overridden by configuring GCC with--with-synci.
When compiling code for single processor systems, it's generally safe to use synci. But on many multi-core (SMP) systems, it does not invalidate the instruction caches on all cores and may lead to undefined behavior. Be careful, bestie. ๐ญ
-mrelax-pic-callsand-mno-relax-pic-callsโ try to turn PIC calls that are normally dispatched via register$25into direct calls. This is only possible if the linker can resolve the destination at link time and if the destination is within range for a direct call.-mrelax-pic-callsis the default if GCC was configured to use an assembler and a linker that support the.relocassembly directive and-mexplicit-relocsis in effect. With-mno-explicit-relocs, this optimization can be performed by the assembler and the linker alone, no compiler help needed. ๐ซถ-mmcount-ra-addressand-mno-mcount-ra-addressโ emit (or don't emit) code that lets_mcountmodify the calling function's return address. When enabled, this option extends the usual_mcountinterface with a new ra-address parameter, which has typeintptr_t *and is passed in register$12._mcountcan then modify the return address by doing both of these things:- Returning the new address in register
$31. - Storing the new address in
*ra-address, if ra-address is nonnull.
- Returning the new address in register
The default is -mno-mcount-ra-address.
-mframe-header-optand-mno-frame-header-optโ enable (or disable) frame header optimization in the o32 ABI. When you're using the o32 ABI, calling functions allocate 16 bytes on the stack so the called function can write out register arguments. When enabled, this optimization suppresses the allocation of the frame header if it can be determined that it's unused. This optimization is off by default at all optimization levels. ๐ซ-mlxc1-sxc1and-mno-lxc1-sxc1โ when applicable, enable (or disable) the generation oflwxc1,swxc1,ldxc1,sdxc1instructions. Enabled by default. โจ-mmadd4and-mno-madd4โ when applicable, enable (or disable) the generation of 4-operandmadd.s,madd.dand related instructions. Enabled by default. โจ
๐ MMIX Options ๐
These options are defined for the MMIX, bestie:
-mlibfuncsand-mno-libfuncsโ specify that intrinsic library functions are being compiled, passing all values in registers, no matter the size.-mepsilonand-mno-epsilonโ generate floating-point comparison instructions that compare with respect to therEepsilon register.-mabi=mmixwareand-mabi=gnuโ generate code that passes function parameters and return values that (in the called function) are seen as registers$0and up, as opposed to the GNU ABI which uses global registers$231and up.-mzero-extendand-mno-zero-extendโ when reading data from memory in sizes shorter than 64 bits, use (or don't use) zero-extending load instructions by default, rather than sign-extending ones.-mknuthdivand-mno-knuthdivโ make the result of a division that yields a remainder have the same sign as the divisor. With the default,-mno-knuthdiv, the sign of the remainder follows the sign of the dividend. Both methods are arithmetically valid, but the latter is almost exclusively used.-mtoplevel-symbolsand-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, rather than the default mmo format used by the mmix simulator.-mbranch-predictand-mno-branch-predictโ use (or don't use) the probable-branch instructions, when static branch prediction indicates a probable branch.-mbase-addressesand-mno-base-addressesโ generate (or don't generate) code that uses base addresses. Using a base address automatically generates a request (handled by the assembler and the linker) for a constant to be set up in a global register. That register is used for one or more base address requests within the range0to255from the value held in the register. This generally leads to short and fast code, but the number of different data items that can be addressed is limited. Which means a program that uses lots of static data may require-mno-base-addresses. ๐-msingle-exitand-mno-single-exitโ force (or don't force) generated code to have a single exit point in each function.-mset-data-start=*address*โ when linking, set the start of the data section to address.-mset-program-start=*address*and-mno-set-program-startโ when linking, set the program start address to address. It defaults to0x100unless-mno-set-program-startis used to suppress this option entirely.
๐ธ MN10300 Options ๐ธ
These -m options are defined for Matsushita MN10300 architectures:
-mmult-bugand-mno-mult-bugโ when enabled, generate code to avoid bugs in the multiply instructions for the MN10300 processors. This is the default.-mam33and-mno-am33โ generate code using features specific to the AM33 processor. The default is-mno-am33.-mam33-2and-mno-am33-2โ generate code using features specific to the AM33/2.0 processor. The default is-mno-am33-2.-mam34and-mno-am34โ generate code using features specific to the AM34 processor. The default is-mno-am34.-mtune=*cpu-type*โ use the timing characteristics of the indicated CPU type when scheduling instructions. This does not change the targeted processor type. The CPU type must be one ofmn10300,am33,am33-2oram34.-mreturn-pointer-on-d0,-mno-return-pointer-on-d0โ okay so when you're generating a function that returns a pointer, you can have it hand that pointer back in botha0andd0. If you don't do that, the pointer only comes back ina0, and then any attempt to call those functions without a prototype just errors out on you ๐ญ. And bestie, heads up โ this one is on by default, so if you want it gone you gotta say-mno-return-pointer-on-d0to turn it off.-mno-crt0โ don't link in the C run-time initialization object file. That's it, that's the whole vibe ๐.-mrelaxโ tells the linker "hey go do a relaxation optimization pass" so it can shorten branches, calls, and absolute memory addresses ๐ฆ. Lowkey important: this only does anything when you use it on the command line for the final link step.
Warning bestie ๐ โ this option makes symbolic debugging impossible. Not "hard", not "annoying". Impossible. Choose wisely.
-mliw,-mno-liwโ lets the compiler generate Long Instruction Word instructions when the target is the AM33 or later โจ. Enabled by default, no cap.-mliwdefines the preprocessor macro__LIW__;-mno-liwdefines the preprocessor macro__NO_LIW__.-msetlb,-mno-setlbโ lets the compiler generate the SETLB and Lcc instructions when the target is the AM33 or later ๐ . Also enabled by default.-msetlbdefines the preprocessor macro__SETLB__;-mno-setlbdefines 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,-mno-mul.xโ generatemul.xandumul.xinstructions ๐ฅ. This one is enabled by default formoxiebox-*-*configurations.-mno-crt0โ do not link in the C run-time initialization object file ๐.
๐ธ MSP430 Options ๐ธ
These options are defined for the MSP430, bestie:
-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 ๐ . Aesthetic purposes. She gets it.-mmcu=nameโ select the MCU to target ๐. Here's the tea: this is used to create a C preprocessor symbol based on the MCU name, converted to upper case and pre- and post-fixed with__. That symbol then gets used by themsp430.hheader file to pick 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's what gets selected โ otherwise the 430X ISA is selected. You can also use the generic MCU name msp430 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 makes the linker go looking for a script called xxx.ld.
The ISA and hardware multiply supported for the different MCUs is hard-coded into GCC. However, an external devices.csv file can be used to extend device support beyond the ones that have been hard-coded ๐.
GCC searches for the devices.csv file using the following methods in the given precedence order โ first one beats the second, second beats the third:
- Include path specified with
-Iand-Lโdevices.csvis searched for in each of the directories specified by include paths and linker library search paths ๐. - Path specified by the environment variable
MSP430_GCC_INCLUDE_DIRโ set the value of the global environment variableMSP430_GCC_INCLUDE_DIRto the full path of the directory containingdevices.csv, and GCC will search that directory fordevices.csv๐. Ifdevices.csvis found, this directory is also registered as an include path and linker library path. So header files and linker scripts in this directory can be used without you manually slapping-Iand-Lon the command line. Iconic. - The
msp430-elf{,bare}/include/devicesdirectory โ finally, GCC checksmsp430-elf{,bare}/include/devicesfrom the toolchain root directory ๐. This directory does not exist in a default installation, but if you've created it and copieddevices.csvin there, then the MCU data gets read. Same as above โ this directory is also registered as an include path and linker library path.
If none of the above search methods find devices.csv, then the hard-coded MCU data is used ๐.
-mwarn-mcu,-mno-warn-mcuโ this enables or disables warnings about conflicts between the MCU name you gave with-mmcuand the ISA set by-mcpuand/or the hardware multiply support set by-mhwmult๐. It also toggles warnings about unrecognized MCU names. This option is on by default.-msimโ link to the simulator runtime libraries and linker script ๐ง. Overrides any scripts that would've been selected by the-mmcu=option.-mlargeโ use large-model addressing (20-bit pointers, 20-bitsize_t) ๐.-msmallโ use small-model addressing (16-bit pointers, 16-bitsize_t) ๐.-mrelaxโ this option gets passed to the assembler and linker, and lets the linker perform certain optimizations that cannot be done until the final link โจ.mhwmult=typeโ describes the type of hardware multiply supported by the target ๐ฅ. (Yes bestie, it's written without a leading dash, that's just how it is.) Accepted values for type are:noneโ for no hardware multiply16bitโ for the original 16-bit-only multiply supported by early MCUs32bitโ for the 16/32-bit multiply supported by later MCUsf5seriesโ for the 16/32-bit multiply supported by F5-series MCUsautoโ you can give this value too, and it 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 ๐
. This saves space in the generated code. But โ when compiling at -O3 or higher, the hardware multiplier is invoked inline. This makes for bigger, but faster, code ๐ฅ.
The hardware multiply routines disable interrupts while running and restore the previous interrupt state when they finish โ . This makes them safe to use inside interrupt handlers as well as in normal code. Slay.
-minrtโ enable the use of a minimum runtime environment without support for static initializers or constructors ๐. This is intended for memory-constrained devices. The compiler includes special symbols in some objects that tell the linker and runtime which code fragments are required.-mtiny-printfโ enable reduced code sizeprintfandputslibrary functions ๐ธ. The tiny implementations of these functions are not reentrant, so they must be used with caution in multi-threaded applications ๐.
Support for streams has been removed, and the string to be printed is always sent to stdout via the write syscall. The string is not buffered before it's sent to write.
This option requires Newlib Nano IO, so GCC must be configured with --enable-newlib-nano-formatted-io ๐.
-mmax-inline-shift=nโ this option takes an integer n between0and64inclusive, and sets the maximum number of inline shift instructions that should be emitted to perform a shift operation by a constant amount โจ. When this value needs to be exceeded, anmspabihelper function is used instead. The default value is4.
This only affects cases where a shift by multiple positions cannot be completed with a single instruction (e.g. all shifts >1 on the 430 ISA) ๐ฆ.
Shifts of a 32-bit value are at least twice as costly, so the value you pass for this option gets divided by 2 and the resulting value is used instead. Math. ๐
-mcode-region=where,-mdata-region=whereโ these options tell the compiler where to place functions and data that don't have one of thelower,upper,eitherorsectionattributes ๐. Possible values for where arelower,upper,eitherorany. The first three behave like the corresponding attribute. The fourth possible value,any, is the default โ it leaves placement entirely up to the linker script and how it assigns the standard sections (.text,.data, etc) to the memory regions ๐.-muse-lower-region-prefixโ add the.lowerprefix to section names when compiling with-mcode-region=loweror-mdata-region=lower๐. Disabled by default.-msilicon-errata=name[,name...]โ this option passes on a request to the assembler to enable the fixes for the named silicon errata ๐ง. Refer to the assembler documentation for details.-msilicon-errata-warn=name[,name...]โ this option passes on a request to the assembler to enable warning messages when a named silicon errata might need to be applied โ ๏ธ. Refer to the assembler documentation for details.-mwarn-devices-csv,-mno-warn-devices-csvโ warn ifdevices.csvis not found or there are problems parsing it (default:on) ๐.
๐ NDS32 Options ๐
These options are defined for NDS32 implementations:
-mbig-endian,-EBโ generate code in big-endian mode ๐.-mlittle-endian,-ELโ generate code in little-endian mode ๐ฆ.-mabi=2,-mfloat-abi=softโ use the soft floating-point ABI ๐ธ.-mabi=2fp+,-mfloat-abi=hardโ use the hard floating-point ABI ๐ฅ.-mreduced-regsโ use reduced-set registers for register allocation ๐.-mfull-regsโ use full-set registers for register allocation โจ.-malways-alignโ always align function entry, jump targets, and return address ๐.-malign-functionsโ align function entry to 4 bytes ๐ .-mfp-as-gp,-mno-fp-as-gpโ enable/disable fp-as-gp optimization ๐ง.-mcmov,-mno-cmovโ enable/disable generation of conditional move instructions ๐.-mhw-abs,-mno-hw-absโ enable/disable generation of hardware abs instructions ๐.-mext-perf,-mno-ext-perfโ enable/disable generation of performance extension instructions ๐.-mext-perf2,-mno-ext-perf2โ enable/disable generation of performance extension 2 instructions โญ.-mext-string,-mno-ext-stringโ enable/disable generation of string extension instructions ๐.-mext-dsp,-mno-ext-dspโ enable/disable generation of DSP extension instructions ๐.-mext-fpu-fma,-mno-ext-fpu-fmaโ enable/disable generation of floating-point multiply-accumulation instructions ๐ฅ.-mext-fpu-sp,-mno-ext-fpu-spโ turn generation of single-precision floating-point instructions on/off. ๐ซถ-mext-fpu-dp,-mno-ext-fpu-dpโ turn generation of double-precision floating-point instructions on/off. โจ-mv3push,-mno-v3pushโ turn generation of v3push25/pop25instructions on/off.-m16-bit,-mno-16-bitโ turn generation of 16-bit instructions on/off.-mvh,-mno-vhโ turn Virtual Hosting support on/off.-misr-vector-size=numโ set the size of each interrupt vector. It has to be4or16, no in-between bestie.-misr-secure=numโ set the security level ofc-isrfor the whole file.-mcache-block-size=numโ set the size of each cache block. Gotta be a power of 2, somewhere between4and512. ๐ฅ-march=archโ pick the target architecture. arch can be one ofv2,v3,v3j,v3m,v3f, orv3s.-mcpu=cpuโ pick the CPU you're compiling for. cpu can be one ofn6,n650,n7,n705,n8,n801,sn8,sn801,s8,s801,e8,e801,n820,s830,e830,n9,n903,n903a,n968,n968a,n10,n1033,n1033a,n1033-fpu,n1033-spu,n1068,n1068a,n1068-fpu,n1068a-fpu,d10,d1088,d1088-fpu,d1088-spu,n15,d15,n15s,d15s,n15f,d15f,n12,n1213,n1233,n1233-fpu,n1233-spu,n13,n1337,n1337-fpu,n1337-spu, orsimple. Like, the whole roster fr fr. ๐-mconfig-fpu=numโ set an FPU configuration value from0to7;0--3is as the FPU spec says, and4--7correspond to0--3.-mconfig-mul=typeโ set the configuration for the multiply instruction. type can be one offast,fast1(equivalent tofast),fast2, orslow. The default isfast1. ๐-mconfig-register-ports=kindโ set the numbers of read/write ports for n9/n10 cores. The value should be3r2wor2r1w.-mcmodel=code-modelโ set the code model to one of:smallโ all the data and read-only data segments have to live within 512KB addressing space. The text segment has to be within 16MB addressing space.mediumโ the data segment has to be within 512KB, while the read-only data segment can be within 4GB addressing space. The text segment should still be within 16MB addressing space.largeโ all the text and data segments can be within 4GB addressing space.
The default is large on GNU/Linux targets and medium on other ELF targets. ๐
-mctor-dtor,-mno-ctor-dtorโ turn the constructor/destructor feature on/off.-mrelax,-mno-relaxโ turn the linker option to relax instructions on/off.-mrelax-hint,-mno-relax-hintโ turn insertion of hints for the linker to do relaxation on/off.-msched-prolog-epilog,-mno-sched-prolog-epilogโ turn scheduling of a function's prologue and epilogue sequence on/off.-mret-in-naked-func,-mno-ret-in-naked-funcโ turn generation of return instructions in naked functions on/off. This option is enabled by default, bestie, it's already on.-malways-save-lp,-mno-always-save-lpโ turn always saving$lpon the stack on/off.-munaligned-access,-mno-unaligned-accessโ turn unaligned word and halfword accesses to packed data on/off.-minline-asm-r15,-mno-inline-asm-r15โ allow/disallow use ofr15for inline asm.
๐ Nvidia PTX Options ๐
These options are defined for Nvidia PTX:
-m64โ ignored, but preserved for backward compatibility. Only the 64-bit ABI is supported, so like, don't stress about it. ๐-march=architecture-stringโ generate code for the specified PTX ISA target architecture. Valid architecture strings aresm_30,sm_35,sm_37,sm_50,sm_52,sm_53,sm_61,sm_70,sm_75,sm_80, andsm_89. The default depends on how the compiler has been configured, see--with-arch.
This option sets the value of the preprocessor macro "__PTX_SM__"; for instance, for sm_35, it has the value 350. โจ
-misa=architecture-stringโ alias of-march=.-march-map=architecture-stringโ select the closest available-march=value that is not more capable. For instance, for-march-map=sm_50select-march=sm_37, and for-march-map=sm_53select-march=sm_53.-mptx=version-stringโ generate code for the specified PTX ISA version. Valid version strings are3.1,4.0,4.1,4.2,5.0,6.0,6.3,7.0,7.3, and7.8. The default PTX ISA version is the one that added support for the selected PTX ISA target architecture, see-march=, but at least6.3, or7.3for-march=sm_52and higher.
This option sets the values of the preprocessor macros "__PTX_ISA_VERSION_MAJOR__" and "__PTX_ISA_VERSION_MINOR__"; for instance, for 3.1 the macros have the values 3 and 1, respectively.
-mmainkernelโ link in code for a__mainkernel. This is for stand-alone instead of offloading execution.-moptimize,-mno-optimizeโ turn partitioned execution optimizations on/off. This option is enabled by default when any level of optimization is selected. ๐ฆ-msoft-stack,-mno-soft-stackโ for-mno-soft-stack(the default, unless-mgomphas been specified), use PTX "native" stacks, that is, generate code that uses".local"memory or PTX "alloca" directly for stack storage. Unless-mptx=7.3or higher and-march=sm_52or higher are active, variable-length arrays and dynamically allocating memory on the stack with "alloca" are not supported.
For -msoft-stack (implied by -mgomp), generate code that does not use ".local" memory or PTX "alloca" directly for stack storage. Instead, a per-warp stack pointer is maintained explicitly. This enables variable-length stack allocation (with variable-length arrays or "alloca"), and when global memory is used for underlying storage, makes it possible to access automatic variables from other threads, or with atomic instructions. This code generation variant is used for OpenMP offloading, but the option is exposed on its own for the purpose of testing the compiler; to generate code suitable for linking into programs using OpenMP offloading, use option -mgomp. ๐ซถ
-msoft-stack-reserve-local=sizeโ set the size of".local"memory used for the stack when the exact amount is not known. It defaults to128.-muniform-simt,-mno-uniform-simtโ turn on/off the code generation variant that allows execution of all threads in each warp, while maintaining memory state and side effects as if only one thread in each warp was active outside of OpenMP SIMD regions. All atomic operations and calls to runtime ("malloc","free","vprintf") are conditionally executed (iff current lane index equals the master lane index), and the register being assigned is copied via a shuffle instruction from the master lane. Outside of SIMD regions lane 0 is the master; inside, each thread sees itself as the master. Shared memory array"int __nvptx_uni[]"stores all-zeros or all-ones bitmasks for each warp, indicating current mode (0outside of SIMD regions). Each thread can bitwise-and the bitmask at position"tid.y"with current lane index to compute the master lane index. ๐-mgomp,-mno-gompโ turn generation of code for use in OpenMP offloading on/off.-mgompenables-msoft-stackand-muniform-simtoptions, and selects a corresponding multilib variant.
๐ธ OpenRISC Options ๐ธ
These options are defined for OpenRISC:
-mboard=nameโ configure a board specific runtime. This is passed to the linker for newlib board library linking. The default is"or1ksim".-msoft-div,-mhard-divโ select software or hardware divide ("l.div","l.divu") instructions. This default is hardware divide. ๐ฅ-msoft-mul,-mhard-mulโ select software or hardware multiply ("l.mul","l.muli") instructions. This default is hardware multiply.-msoft-float,-mhard-floatโ select software or hardware for floating point operations. The default is software.-mdouble-floatโ when-mhard-floatis selected, enables generation of double-precision floating point instructions. By default functions from libgcc are used to perform double-precision floating point operations.-munordered-floatโ when-mhard-floatis selected, enables generation of unordered floating point compare and set flag ("lf.sfun*") instructions. By default functions from libgcc are used to perform unordered floating point compare and set flag operations.-mcmovโ enable generation of conditional move ("l.cmov") instructions. By default the equivalents are generated using set and branch.-mrorโ enable generation of rotate right ("l.ror") instructions. By default functions from libgcc are used to perform rotate right operations.-mroriโ enable generation of rotate right with immediate ("l.rori") instructions. By default functions from libgcc are used to perform rotate right with immediate operations.-msextโ enable generation of sign extension ("l.ext*") instructions. By default memory loads are used to perform sign extension.-msfimmโ enable generation of compare and set flag with immediate ("l.sf*i") instructions. By default extra instructions are generated to store the immediate to a register first.-mshftimmโ enable generation of shift with immediate ("l.srai","l.srli","l.slli") instructions. By default extra instructions are generated to store the immediate to a register first.-mcmodel=smallโ generate OpenRISC code for the small model: The GOT is limited to 64k and function call jumps are limited to 64M offsets. This is the default model.-mcmodel=largeโ generate OpenRISC code for the large model: The GOT may grow up to 4G in size and function call jumps can target the full 4G address space. ๐
โญ PDP-11 Options โญ
These options are defined for the PDP-11:
-mfpuโ use hardware FPP floating point. This is the default. (FIS floating point on the PDP-11/40 is not supported.) Implies-m45. ๐-msoft-floatโ do not use hardware floating point.-mac0,-mno-ac0โ with-mac0, return floating-point results in ac0 (fr0 in Unix assembler syntax). The default,-mno-ac0, is to return floating-point results in memory.-m40โ generate code for a PDP-11/40. Implies-msoft-float -mno-split.-m45โ generate code for a PDP-11/45. This is the default.-m10โ generate code for a PDP-11/10. Implies-msoft-float -mno-split.-mint16,-mno-int32โ bestie, this makesint16 bits. And it's the default, so that's just... the vibe you get for free โจ-mint32,-mno-int16โ ok nowintis 32 bits. Big int energy ๐ซถ-msplitโ tells GCC the target has split instruction and data space. Fun fact it also implies-m45๐-munix-asmโ use Unix assembler syntax ๐ง-mdec-asmโ use DEC assembler syntax ๐-mgnu-asmโ use GNU assembler syntax. This one's the default ๐-mlraโ use the new LRA register allocator. By default tho, the oldreloadallocator is what's running. no cap ๐
๐ธ Picolibc Options ๐ธ
These ones are in charge of compilation and linking whenever you're using Picolibc, ok? Obsessed ๐
--oslib=libraryโ go search the library literally named library after the C library, so that any symbols the C library left undefined can get defined by this one instead. And listen โ the C library,libgcc, and this library all get placed between--start-groupand--end-groupflags so each one can refer to symbols in the others. It's giving teamwork ๐ซถ For lots of targets, Picolibc ships a semihost variant (you ask for it with--oslib=semihost) which brings enough basic OS functionality to support console and file I/O when it's running in an emulator or when you're using an in-circuit debugger. iconic.--crt0=[none|minimal|hosted|semihost]โ this swaps the defaultcrt0.oname out forcrt0-variant.o. Let me break the variants down because the way they all differ is so real:nonegives you no startup code at all, so you get to supply your own. main character energy, honestly.minimaldoes basic memory setup but does not invoke any constructors.- when you pass no
-crt0option at all, the default initialization code adds calls to all constructors. hostedadds a call toexitwhenevermainreturns.semihostaccesses a command-line parameter supplied via the semihosting interface and splits that into arguments at whitespace boundaries, passing the resulting array of strings tomaininargcandargv. And on some targets โ including AArch64, ARC, ARM, LoongArch, M680x0, RISC-V, SH, and x86 โsemihostalso traps hardware exceptions and prints info to the console ๐ฅ
ngl,--crt0=semihostdepends upon APIs provided by--oslib=semihost. Don't forget the pair, bestie ๐ญ
--printf=[d|f|l|i|m]โ picks yourprintfvariant. Picolibc serves up five differentprintfvariants, and they go from most functionality to least while the code size goes down and down ๐dis the default level, offering full C17 and POSIX.1-2024 conformance.fgives the same feature set, but it supportsfloatvalues instead ofdouble, which get passed using theprintf_floatmacro.lelides all floating-point and POSIX positional parameter support.ilimits integers to those no larger thanlong.mremoves support for most formatting options including width and precision. The formats and arguments are still parsed correctly, but the output just... does not respect those parameters ๐
--scanf=[d|f|l|i|m]โ same deal but forscanf. Five variants, decreasing functionality, decreasing code size, you know the drill ๐dis the default level, offering full C17 and POSIX.1-2024 conformance.fremoves support fordoublevalues.lelides all floating point support.ilimits integers to those no larger thanlong.mremoves support for%[conversion specifiers.
๐ PowerPC Options ๐
These are listed under ๐ฆ
๐ PRU Options ๐
These command-line options are defined for the PRU target, periodt:
-minrtโ link with a minimum runtime environment. This can significantly reduce the size of the final ELF binary, but some standard C runtime features are removed ๐ญ
This option disables support for static initializers and constructors. And beware, bestie โ the compiler could still generate code with static initializers and constructors. It's up to the programmer to make sure the source program doesn't use those features. no pressure ๐
The minimal startup code does not pass argc and argv arguments to main, so the latter must be declared as int main (void). This is already the norm for most firmware projects, so slay.
-mmcu=mcuโ specify the PRU hardware variant to use. A correspondingly-named spec file gets loaded, passing the memory region sizes to the linker and defining hardware-specific C macros โจ
Newlib only provides the sim spec, intended for running regression tests using a simulator. Specs for real hardware can be obtained by installing the GnuPruMcu (https://github.com/dinuxbg/gnuprumcu/) package ๐
-mno-relaxโ makes GCC pass the--no-relaxcommand-line option to the linker instead of the--relaxoption.-mloop,-mno-loopโ allow (or do not allow) GCC to use the LOOP instruction ๐-mmul,-mno-mulโ allow (or do not allow) GCC to use the PRU multiplier unit โ๏ธ-mfillzero,-mno-fillzeroโ allow (or do not allow) GCC to use the FILL and ZERO instructions ๐ซถ-mabi=variantโ specify the ABI variant to output code for.-mabi=tiselects the unmodified TI ABI, while-mabi=gnuselects a GNU variant that copes more naturally with certain GCC assumptions. Here's the tea on the differences โ:- Function Pointer Size โ TI ABI specifies that function (code) pointers are 16-bit, whereas GNU supports only 32-bit data and code pointers.
- Optional Return Value Pointer โ function return values larger than 64 bits are passed by using a hidden pointer as the first argument of the function. TI ABI, though, mandates that the pointer can be NULL in case the caller is not using the returned value. GNU always passes and expects a valid return value pointer.
- Size Of Struct Containing Bit-fields โ TI ABI mandates that struct size is determined by the bit-field type, if it contains any. On the other hand, GNU allocates the smallest amount of bytes which would fit the bit-field.
For example, TI ABI reserves 4 bytes for this struct, whereas GNU reserves a single byte:
struct S { int i:1; };
- Access Size For Volatile Bit-fields โ TI ABI mandates that volatile bit-fields are accessed using their type. In contrast, GNU ABI uses the smallest integer type fitting the bit-field.
For example, TI ABI requires a single load of 4 bytes for the following bit-field. GNU generates a load of 1 byte:
struct S { volatile int i:1; };
The current -mabi=ti implementation simply raises a compile error when any of the above code constructs is detected. As a consequence the standard C library cannot be built and it is omitted when linking with -mabi=ti ๐ญ
Relaxation is a GNU feature and for safety reasons is disabled when using -mabi=ti. The TI toolchain does not emit relocations for QBBx instructions, so the GNU linker cannot adjust them when shortening adjacent LDI32 pseudo instructions.
๐ฆ RISC-V Options ๐ฆ
These command-line options are defined for RISC-V targets, bestie:
-mbranch-cost=nโ set the cost of branches to roughly n instructions ๐ฟ-mabi=ABI-stringโ specify integer and floating-point calling convention. The ABI-string contains two parts: the size of integer types and the registers used for floating-point types. So like, for example-march=rv64ifd -mabi=lp64dmeans that long and pointers are 64-bit (implicitly definingintto be 32-bit), and that floating-point values up to 64 bits wide are passed in F registers. Contrast that with-march=rv64ifd -mabi=lp64f, which still lets the compiler generate code that uses the F and D extensions but only allows floating-point values up to 32 bits long to be passed in registers; or-march=rv64ifd -mabi=lp64, in which no floating-point arguments are passed in registers ๐
The default for this argument is system dependent; if you want a specific calling convention you should specify one explicitly. The valid calling conventions are: ilp32, ilp32f, ilp32d, lp64, lp64f, and lp64d. Some calling conventions are impossible to implement on some ISAs: for example, -march=rv32if -mabi=ilp32d is invalid because the ABI requires 64-bit values be passed in F registers, but F registers are only 32 bits wide ๐ซ There are also the ilp32e ABI that can only be used with the rv32e architecture and the lp64e ABI that can only be used with the rv64e. Those ABIs are not well-specified at present, and are subject to change.
-mfdiv,-mno-fdivโ do or don't use hardware floating-point divide and square root instructions. This requires the F or D extensions for floating-point registers. The default is to use them if the specified architecture has these instructions โ-mfence-tso,-mno-fence-tsoโ do or don't use thefence.tsoinstruction, which is unimplemented on some processors (including those from T-Head). If thefence.tsoinstruction is not available then a stronger fence is used instead. safety first bestie ๐ง-mdiv,-mno-divโ do or don't use hardware instructions for integer division. This requires the M extension. The default is to use them if the specified architecture has these instructions.-misa-spec=ISA-spec-stringโ specify the version of the RISC-V Unprivileged (formerly User-Level) ISA specification generated code should conform to. The possibilities for ISA-spec-string are:2.2โ produce code conforming to version 2.2.20190608โ produce code conforming to version 20190608.20191213โ produce code conforming to version 20191213.
The default is -misa-spec=20191213 unless GCC has been configured with --with-isa-spec= specifying a different default version ๐
-march=[ISA|Profile|Profile_ISA|processor-string]โ generate code for given RISC-V ISA or profile or a combination of them (e.g.rv64im rvi20u64 rvi20u64_zbb). The names of ISAs and profiles must be lower case. Examples includerv64i,rv32g,rv32e,rv32imaf,rva22u64andrva23u64. To combine a named profile with optional RISC-V ISA extensions, give the profile first and then append the extension name(s) using an underscore as a delimiter (e.g.rvi20u64_zca_zcb rva23u64_zacas). Additionally, a special value help (-march=help) is accepted to list all supported extensions โจ
-march=unset causes the compiler to ignore any -march=... options that appear earlier on the command line, behaving as if the option was never passed. This is useful for ensuring that the architecture is taken from the -mcpu option, and an error results if no -mcpu option is given when -march=unset is used ๐จ
The syntax of the ISA string is defined as follows:
- the string has to start with
rv32orrv64, and then right after that comesi,e, orgโ that bit is what we call the base ISA. periodt. โจ- the next chunk is a whole list of extension names. and bestie, these come in two flavors: multi-letter (like
zba) and single-letter (likev). the single-letter girlies can be stacked back to back no problem, but the multi-letter ones must be separated by underscores, no exceptions ๐ - an underscore can show up anywhere after the base ISA. it doesn't actually do anything mechanically โ it's purely for readability, lowkey just a separator so your eyes don't die ๐ซถ
- extension names can also carry an optional version number, using the syntax
<major>p<minor>or just<major>โ likem2p1orm2๐
- the next chunk is a whole list of extension names. and bestie, these come in two flavors: multi-letter (like
โจ the supported extensions, in all their glory โจ
okay bestie, here's the full roster. format is: name โ supported version โ what it does ๐
gโ supported version:-โ General-purpose computing base extension;gexpands toi,m,a,f,d,zicsrandzifencei. (it's giving bundle deal ๐)eโ supported version:2.0โ Reduced base integer extensioniโ supported version:2.02.1โ Base integer extensionmโ supported version:2.0โ Integer multiplication and division extensionaโ supported version:2.02.1โ Atomic extensionfโ supported version:2.02.2โ Single-precision floating-point extensiondโ supported version:2.02.2โ Double-precision floating-point extensioncโ supported version:2.0โ Compressed extensionbโ supported version:1.0โ Standard extension for bit manipulation functionsvโ supported version:1.0โ Vector extensionhโ supported version:1.0โ Hypervisor extensionzic64bโ supported version:1.0โ Cache block size is 64 byteszicbomโ supported version:1.0โ Cache-block management extensionzicbopโ supported version:1.0โ Cache-block prefetch extensionzicbozโ supported version:1.0โ Cache-block zero extensionziccamoaโ supported version:1.0โ Main memory supports all atomics in Aziccifโ supported version:1.0โ Main memory supports instruction fetch with atomicity requirementzicclsmโ supported version:1.0โ Main memory supports misaligned loads/storesziccrseโ supported version:1.0โ Main memory supports forward progress on LR/SC sequenceszicfilpโ supported version:1.0โ Control-flow integrity landing pad extensionzicfissโ supported version:1.0โ Control-flow integrity shadow stack extensionzicntrโ supported version:2.0โ Standard extension for base counters and timerszicondโ supported version:1.0โ Integer conditional operations extensionzicsrโ supported version:2.0โ Control and status register access extensionzifenceiโ supported version:2.0โ Instruction-fetch fence extensionzihintntlโ supported version:1.0โ Non-temporal locality hints extensionzihintpauseโ supported version:2.0โ Pause hint extensionzihpmโ supported version:2.0โ Standard extension for hardware performance counterszimopโ supported version:1.0โ May-be-operations extensionzilsdโ supported version:1.0โ Load/store pair instructions extensionzmmulโ supported version:1.0โ Integer multiplication extensionza128rsโ supported version:1.0โ Reservation set size of 128 bytesza64rsโ supported version:1.0โ Reservation set size of 64 byteszaamoโ supported version:1.0โ Atomic memory operations extensionzabhaโ supported version:1.0โ Byte and halfword atomic memory operations extensionzacasโ supported version:1.0โ Atomic compare-and-swap instructions extensionzalrscโ supported version:1.0โ Load-reserved/store-conditional subset of the A extensionzawrsโ supported version:1.0โ Wait-on-reservation-set extensionzama16bโ supported version:1.0โ Misaligned loads, stores, and AMOs that are fully contained within a naturally-aligned 16-byte boundary are atomiczfaโ supported version:1.0โ Additional floating-point extensionzfbfminโ supported version:1.0โ Minimal BF16 support extensionzfhโ supported version:1.0โ Half-precision floating-point extensionzfhminโ supported version:1.0โ Minimal half-precision floating-point extensionzfinxโ supported version:1.0โ Single-precision floating-point in integer registers extensionzdinxโ supported version:1.0โ Double-precision floating-point in integer registers extensionzcaโ supported version:1.0โ Integer compressed instruction extensionzcbโ supported version:1.0โ Simple compressed instruction extensionzcdโ supported version:1.0โ Compressed double-precision floating point loads and stores extensionzceโ supported version:1.0โ Compressed instruction extensions for embedded processorszcfโ supported version:1.0โ Compressed single-precision floating point loads and stores extensionzcmopโ supported version:1.0โ Compressed may-be-operations extensionzcmpโ supported version:1.0โ Compressed push pop extensionzcmtโ supported version:1.0โ Table jump instruction extensionzclsdโ supported version:1.0โ Compressed load/store pair instructions extensionzbaโ supported version:1.0โ Address calculation extensionzbbโ supported version:1.0โ Basic bit manipulation extensionzbcโ supported version:1.0โ Carry-less multiplication extensionzbkbโ supported version:1.0โ Cryptography bit-manipulation extensionzbkcโ supported version:1.0โ Cryptography carry-less multiply extensionzbkxโ supported version:1.0โ Cryptography crossbar permutation extensionzbsโ supported version:1.0โ Single-bit operation extensionzkโ supported version:1.0โ Standard scalar cryptography extensionzknโ supported version:1.0โ NIST algorithm suite extensionzkndโ supported version:1.0โ AES Decryption extensionzkneโ supported version:1.0โ AES Encryption extensionzknhโ supported version:1.0โ Hash function extensionzkrโ supported version:1.0โ Entropy source extensionzksโ supported version:1.0โ ShangMi algorithm suite extensionzksedโ supported version:1.0โ SM4 block cipher extensionzkshโ supported version:1.0โ SM3 hash function extensionzktโ supported version:1.0โ Data independent execution latency extensionztsoโ supported version:1.0โ Total store ordering extensionzvbbโ supported version:1.0โ Vector basic bit-manipulation extensionzvbcโ supported version:1.0โ Vector carry-less multiplication extensionzve32fโ supported version:1.0โ Vector extensions for embedded processorszve32xโ supported version:1.0โ Vector extensions for embedded processorszve64dโ supported version:1.0โ Vector extensions for embedded processorszve64fโ supported version:1.0โ Vector extensions for embedded processorszve64xโ supported version:1.0โ Vector extensions for embedded processorszvfbfminโ supported version:1.0โ Vector BF16 converts extensionzvfbfwmaโ supported version:1.0โ Vector BF16 widening multiply/add extensionzvfhโ supported version:1.0โ Vector half-precision floating-point extensionzvfhminโ supported version:1.0โ Vector minimal half-precision floating-point extensionzvkbโ supported version:1.0โ Vector cryptography bit-manipulation extensionzvkgโ supported version:1.0โ Vector GCM/GMAC extensionzvknโ supported version:1.0โ Vector NIST Algorithm Suite extension,zvknwill expand tozvkncโ supported version:1.0โ Vector NIST Algorithm Suite with carry-less multiply extension,zvknczvknedโ supported version:1.0โ Vector AES block cipher extensionzvkngโ supported version:1.0โ Vector NIST Algorithm Suite with GCM extension,zvkngwill expandzvknhaโ supported version:1.0โ Vector SHA-2 secure hash extensionzvknhbโ supported version:1.0โ Vector SHA-2 secure hash extensionzvksโ supported version:1.0โ Vector ShangMi algorithm suite extension,zvkswill expandzvkscโ supported version:1.0โ Vector ShangMi algorithm suite with carry-less multiplication extension,zvksedโ supported version:1.0โ Vector SM4 block cipher extensionzvksgโ supported version:1.0โ Vector ShangMi algorithm suite with GCM extensionzvkshโ supported version:1.0โ Vector SM3 secure hash extensionzvktโ supported version:1.0โ Vector data independent execution latency extensionzvl1024bโ supported version:1.0โ Minimum vector length standard extensionszvl128bโ supported version:1.0โ Minimum vector length standard extensionszvl16384bโ supported version:1.0โ Minimum vector length standard extensionzvl2048bโ supported version:1.0โ Minimum vector length standard extensionszvl256bโ supported version:1.0โ Minimum vector length standard extensionszvl32768bโ supported version:1.0โ Minimum vector length standard extensionzvl32bโ supported version:1.0โ Minimum vector length standard extensionszvl4096bโ supported version:1.0โ Minimum vector length standard extensionszvl512bโ supported version:1.0โ Minimum vector length standard extensionszvl64bโ supported version:1.0โ Minimum vector length standard extensionszvl65536bโ supported version:1.0โ Minimum vector length standard extensionzvl8192bโ supported version:1.0โ Minimum vector length standard extensionzhinxโ supported version:1.0โ Half-precision floating-point in integer registers extensionzhinxminโ supported version:1.0โ Minimal half-precision floating-point in integer registers extensionsdtrigโ supported version:1.0โ Debug triggers extensionshaโ supported version:1.0โ The augmented hypervisor extensionshcounterenwโ supported version:1.0โ Support writeable enables for any supported countershgatpaโ supported version:1.0โ SvNNx4 mode supported for all modes supported bysatpshlcofidelegโ supported version:1.0โ Delegating LCOFI interrupts to VS-modeshtvalaโ supported version:1.0โ Thehtvalregister provides all needed valuesshvstvalaโ supported version:1.0โ Thevstvalregister provides all needed valuesshvstvecdโ supported version:1.0โ Thevstvecregister supports direct modeshvsatpaโ supported version:1.0โ Thevsatpregister supports all modes supported bysatpsmaiaโ supported version:1.0โ Advanced interrupt architecture extensionsmcntrpmfโ supported version:1.0โ Cycle and instret privilege mode filteringsmcsrindโ supported version:1.0โ Machine-level indirect CSR access
okay and we're still going, bestie โ this list is not done with us yet ๐ฅ keep scrolling, there's more incoming ๐
smepmpโ1.0โ PMP enhancements for memory access and execution prevention on machine mode ๐smmpmโ1.0โ Supervisor-mode pointer masking extensionsmnpmโ1.0โ Supervisor-mode pointer masking extensionsmrnmiโ1.0โ Resumable non-maskable interruptssmstateenโ1.0โ State enable extensionsmdbltrpโ1.0โ Double trap extensionsssaiaโ1.0โ Advanced interrupt architecture extension for supervisor modessccptrโ1.0โ Main memory supports page table readssscofpmfโ1.0โ Count overflow and filtering extensionsscounterenwโ1.0โ Support writeable enables for any supported countersscsrindโ1.0โ Supervisor-mode indirect CSR accessssnpmโ1.0โ Supervisor-mode pointer masking extensionsspmโ1.0โ Supervisor-mode pointer masking extensionssstateenโ1.0โ Supervisor-mode state-enable extensionsstcโ1.0โ Supervisor-mode timer interrupts extensionsstvalaโ1.0โ Stval provides all needed valuessstvecdโ1.0โ Stvec supports direct modessstrictโ1.0โ Unimplemented reserved encodings raise illegal instruction exceptions and no non-conforming extensions are presentssdbltrpโ1.0โ Double trap extensionsssu64xlโ1.0โ UXLEN=64 must be supportedsupmโ1.0โ User-mode pointer masking extensionsvinvalโ1.0โ Fine-grained address-translation cache invalidation extensionsvnapotโ1.0โ NAPOT translation contiguity extensionsvpbmtโ1.0โ Page-based memory types extensionsvvptcโ1.0โ Extension for obviating memory-management instructions after marking PTEs validsvaduโ1.0โ Hardware updating of A/D bits extensionsvadeโ1.0โ Cause exception when hardware updating of A/D bits is disabledsvbareโ1.0โ Satp mode bare is supportedxcvaluโ1.0โ Core-V miscellaneous ALU extensionxcvbiโ1.0โ Core-V immediate branch extensionxcvelwโ1.0โ Core-V event load word extensionxcvmacโ1.0โ Core-V multiply-accumulate extensionxcvsimdโ1.0โ Core-V SIMD extensionxsfceaseโ1.0โ SiFive CEASE instruction extensionxsfvcpโ1.0โ SiFive VCIX vector coprocessor extensionxsfvfnrclipxfqfโ1.0โ SiFive FP32-to-int8 ranged clip instructionsxsfvqmaccdodโ1.0โ SiFive int8 matrix multiplication extensionxsfvqmaccqoqโ1.0โ SiFive int8 matrix multiplication extensionxtheadbaโ1.0โ T-head address calculation extensionxtheadbbโ1.0โ T-head basic bit-manipulation extensionxtheadbsโ1.0โ T-head single-bit instructions extensionxtheadcmoโ1.0โ T-head cache management operations extensionxtheadcondmovโ1.0โ T-head conditional move extensionxtheadfmemidxโ1.0โ T-head indexed memory operations for floating-point registers extensionxtheadfmvโ1.0โ T-head double floating-point high-bit data transmission extensionxtheadintโ1.0โ T-head acceleration interruption extensionxtheadmacโ1.0โ T-head multiply-accumulate extensionxtheadmemidxโ1.0โ T-head indexed memory operation extensionxtheadmempairโ1.0โ T-head two-GPR memory operation extensionxtheadsyncโ1.0โ T-head multi-core synchronization extensionxtheadvectorโ1.0โ T-head vector extensionxventanacondopsโ1.0โ Ventana integer conditional operations extensionxmipscmovโ1.0โ Mips conditional move extensionxmipscbopโ1.0โ Mips prefetch extensionxandesperfโ5.0โ Andes performace extensionxandesbfhcvtโ5.0โ Andes bfloat16 conversion extensionxandesvbfhcvtโ5.0โ Andes vector bfloat16 conversion extensionxandesvsintloadโ5.0โ Andes vector INT4 load extensionxandesvpackfphโ5.0โ Andes vector packed FP16 extensionxandesvdotโ5.0โ Andes vector dot product extensionxsmtvdotโ1.0โ SpacemiT vector dot product extension
When -march= is not specified, GCC uses the setting from -mcpu.
If both -march and -mcpu= are not specified, the default for this argument is system dependent; if you want a specific architecture extension, you should specify one explicitly. no vibes-based guessing, bestie, be specific ๐
When the RISC-V specifications define an extension as depending on other extensions, GCC implicitly adds the dependent extensions to the enabled extension set if they weren't added explicitly. it just quietly brings the whole friend group along, iconic behavior ๐ซถ
Core Name
๐ -mcpu=processor-string
Use architecture of and optimize the output for the given processor, specified by particular CPU name. Permissible values for this option are:
sifive-e20,sifive-e21,sifive-e24,sifive-e31,sifive-e34,sifive-e76,sifive-s21,sifive-s51,sifive-s54,sifive-s76,sifive-u54,sifive-u74,sifive-x280,sifive-p450,sifive-p670,thead-c906,xt-c908,xt-c908v,xt-c910,xt-c910v2,xt-c920,xt-c920v2,tt-ascalon-x,tt-ascalon-d8,xiangshan-nanhu,xiangshan-kunminghu,mips-p8700,andes-n22,andes-n25,andes-a25,andes-nx25,andes-ax25,andes-a27,andes-ax27,andes-n225,andes-d23,andes-n45,andes-nx45,andes-a45,andes-ax45,spacemit-x60.
Note that -mcpu does not override -march or -mtune. it knows its lane and stays in it, periodt โจ
Tune Name
๐ฆ -mtune=processor-string
Optimize the output for the given processor, specified by microarchitecture or particular CPU name. Permissible values for this option are:
generic,rocket,sifive-3-series,sifive-5-series,sifive-7-series,sifive-p400-series,sifive-p600-series,tt-ascalon-x,tt-ascalon-d8,thead-c906,xt-c908,xt-c908v,xt-c910,xt-c910v2,xt-c920,xt-c920v2,xiangshan-nanhu,xiangshan-kunminghu,spacemit-x60,generic-ooo,size,mips-p8700,andes-25-series,andes-23-series,andes-45-series,- and all valid options for
-mcpu=.
When -mtune= is not specified, GCC uses the setting from -mcpu. The default is generic if neither is specified.
The size choice is not intended for use by end-users. This is used when -Os is specified. It overrides the instruction cost info provided by -mtune=, but does not override the pipeline info. This helps reduce code size while still giving good performance. little internal main-character move, don't touch it unless you know what you're doing ๐
๐ -mpreferred-stack-boundary=num
Attempt to keep the stack boundary aligned to a 2 raised to num byte boundary. If -mpreferred-stack-boundary is not specified, the default is 4 (16 bytes or 128-bits).
Warning: 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 or none of them, or the whole thing falls apart ๐ญ
๐ -msmall-data-limit=n
Put global and static data smaller than n bytes into a special section (on some targets).
๐ธ -msave-restore
-mno-save-restore
Do or don't use smaller but slower prologue and epilogue code that uses library function calls. The default is to use fast inline prologues and epilogues.
๐ -mmovcc
-mno-movcc
Do or don't produce branchless conditional-move code sequences even with targets that do not have specific instructions for conditional operations. If enabled, sequences of ALU operations are produced using base integer ISA instructions where profitable.
๐ง -minline-atomics
-mno-inline-atomics
Do or don't use smaller but slower subword atomic emulation code that uses libatomic function calls. The default is to use fast inline subword atomics that do not require libatomic.
๐ -minline-strlen
-mno-inline-strlen
Do or do not attempt to inline "strlen" calls if possible. Inlining can only be done if the string is properly aligned and instructions for accelerated processing are available. The default is to inline "strlen" calls.
โญ -minline-strcmp
-mno-inline-strcmp
Do or do not attempt to inline "strcmp" calls if possible. Inlining can only be done if the strings are properly aligned and instructions for accelerated processing are available. The default is to inline "strcmp" calls.
๐ -minline-strncmp
-mno-inline-strncmp
Do or do not attempt to inline "strncmp" calls if possible. Inlining can only be done if the strings are properly aligned and instructions for accelerated processing are available. The default is to inline "strncmp" calls.
๐ฅ -mstringop-strategy=strategy
Specify a particular strategy for inlining string and memory operations. strategy may be one of auto, libcall, scalar, or vector.
๐
-mshorten-memrefs
-mno-shorten-memrefs
Do or do not attempt to make more use of compressed load/store instructions by replacing a load/store of 'base register + large offset' with a new load/store of 'new base + small offset'. If the new base gets stored in a compressed register, then the new load/store can be compressed. Currently targets 32-bit integer load/stores only. glow-up for your instruction size, no cap โจ
-mstrict-align,-mno-strict-alignโ do not, or do, generate unaligned memory accesses ๐ the default is picked based on whether the processor we're optimizing for supports fast unaligned access or not.-mscalar-strict-align,-mno-scalar-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. and bestie, this one is literally just an alias for-mstrict-align. same energy, different name โจ-mvector-strict-align,-mno-vector-strict-alignโ do not, or do, generate unaligned vector memory accesses ๐ the default is off, unless the processor we're optimizing for explicitly supports element-misaligned vector memory access.-mmax-vectorization,-mno-max-vectorizationโ turn on or off an override to the vectorizer cost model that makes vectorization always look profitable ๐ and no, it is not the same as-fno-vect-cost-modelor-fvect-cost-model=unlimited, because unlike those it does not turn off the cost comparison between different vector modes. it's giving "profitable but still picky" ๐-mcmodel=medlowโ generate code for the medium-low code model. the program and its statically defined symbols must lie within a single 2 GiB address range, and must lie between absolute addresses -2 GiB and +2 GiB ๐ซถ programs can be statically or dynamically linked. this is the default code model unless GCC has been configured with--with-cmodel=specifying a different default code model.-mcmodel=medanyโ generate code for the medium-any code model. the program and its statically defined symbols must be within any single 2 GiB address range ๐ธ programs can be statically or dynamically linked.
the code generated by the medium-any code model is position-independent, but it is not guaranteed to function correctly when linked into position-independent executables or libraries ๐ญ noted, fr fr.
-mcmodel=largeโ generate code for a large code model, which has no restrictions on size or placement of symbols ๐ฆ unlimited. we love freedom.-mexplicit-relocs,-mno-explicit-relocsโ use, or do not use, assembler relocation operators when dealing with symbolic addresses โจ the alternative is to use assembler macros instead, which may limit optimization ๐-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.-mriscv-attribute,-mno-riscv-attributeโ emit (or do not emit) the RISC-V attribute to record extra info into ELF objects ๐ heads up: this feature requires at least binutils 2.32.-mcsr-check,-mno-csr-checkโ enables or disables the CSR checking ๐-momit-leaf-frame-pointerโ don't keep the frame pointer in a register for leaf functions ๐ง this avoids the instructions to save, set up and restore frame pointers, and makes an extra register available in leaf functions. little win, big vibe.- *
-malign-data=type* โ control how GCC aligns variables and constants of array, structure, or union types. supported values for type arexlen, which uses x register width as the alignment value, andnatural, which uses natural alignment ๐xlenis the default. -mbig-endianโ generate big-endian code ๐ฆ this is the default when GCC is configured for ariscv64be-*-*orriscv32be-*-*target.
โ ๏ธ support for RISC-V big-endian is experimental. the ABI is not yet stable and could change in incompatible ways in future releases ๐ญ do not build your whole life on it.
-mlittle-endianโ generate little-endian code ๐ธ this is the default when GCC is configured for ariscv64-*-*orriscv32-*-*but not ariscv64be-*-*orriscv32be-*-*target.- *
-mstack-protector-guard=guard* โ generate stack protection code using a canary at guard ๐ supported locations areglobalfor a global canary, ortlsfor a per-thread canary in the TLS block. - *
-mstack-protector-guard-reg=reg* โ with thetlschoice above, this specifies which register to use as the base register for reading the canary ๐ -mstack-protector-guard-offset=offset โ and this one says from what offset from that base register ๐ there is **no default register or offset, because this is entirely for use within the Linux kernel. iykyk.-mtls-dialect=descโ use TLS descriptors as the thread-local storage mechanism for dynamic accesses of TLS variables โจ-mtls-dialect=tradโ use traditional TLS as the thread-local storage mechanism for dynamic accesses of TLS variables ๐ธ this is the default.-mrvv-vector-bits=value โ specify how the number of bits for an RVV vector register, as taken from the-march=option, is interpreted ๐ฆ the value parameter is specified as a string keyword and may be one ofscalableorzvl. the default isscalable, which tells GCC to interpret the number as a **minimum, whilezvltells GCC to use exactly the number of bits specified. no cap, it's the difference between "at least this much" and "this, periodt" ๐- *
-mrvv-max-lmul=value* โ this option allows explicit control over the maximum length multiplier (LMUL) used when generating code for the RISC-V Vector Extensions (RVV) ๐ the value parameter is specified as a string keyword and may be one ofm1,m2,m4,m8, ordynamic. the default ism1for compatibility with existing hardware that does not support the other options ๐ -madjust-lmul-cost,-mno-adjust-lmul-costโ this option adjusts the cost model used to schedule vector instructions, so it multiplies the latency of instructions by the RVV length multiplier, LMUL ๐ it is disabled by default.-mautovec-segment,-mno-autovec-segmentโ enable or disable generation of vector segment load/store instructions ๐ฆ this option is enabled by default.
โจ RL78 Options โจ
-msimโ links in additional target libraries to support operation within a simulator ๐ง-mmul=none,-mmul=g10,-mmul=g13,-mmul=g14,-mmul=rl78โ specifies the type of hardware multiplication and division support to be used ๐ the simplest is"none", which uses software for both multiplication and division. this is the default. the"g13"value is for the hardware multiply/divide peripheral found on the RL78/G13 (S2 core) targets. the"g14"value selects the use of the multiplication and division instructions supported by the RL78/G14 (S3 core) parts. the value"rl78"is an alias for"g14"and the value"mg10"is an alias for"none"๐
in addition, a C preprocessor macro is defined, based upon the setting of this option โจ possible values are: __RL78_MUL_NONE__, __RL78_MUL_G13__ or __RL78_MUL_G14__.
-mcpu=g10,-mcpu=g13,-mcpu=g14,-mcpu=rl78โ specifies the RL78 core to target ๐ the default is the G14 core, also known as an S3 core or just RL78. the G13 or S2 core does not have multiply or divide instructions โ instead it uses a hardware peripheral for these operations. the G10 or S1 core does not have register banks, so it uses a different calling convention ๐ฆ
if this option is set it also selects the type of hardware multiply support to use, unless this is overridden by an explicit -mmul=none option on the command line ๐ธ thus specifying -mcpu=g13 enables the use of the G13 hardware multiply peripheral and specifying -mcpu=g10 disables the use of hardware multiplications altogether.
note, although the RL78/G14 core is the default target, specifying -mcpu=g14 or -mcpu=rl78 on the command line does change the behavior of the toolchain since it also enables G14 hardware multiply support ๐ if these options are not specified on the command line, then software multiplication routines are used even though the code targets the RL78 core. this is for backward compatibility with older toolchains which did not have hardware multiply and divide support. the lore is real.
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 registersr24..r31are reserved for use in interrupt handlers. with this option enabled these registers can be used in ordinary functions as well ๐ซถ-mrelax,-mno-relaxโ enable/disable assembler and linker relaxation ๐ฆ this is enabled by default at-Os.-mes0โ assumeESis zero throughout program execution, and use it to address read-only data โจ-msave-mduc-in-interrupts,-mno-save-mduc-in-interruptsโ specifies that interrupt handler functions should preserve the MDUC registers ๐ this is only necessary if normal code might use the MDUC registers, for example because it performs multiplication and division operations. the default is to ignore the MDUC registers, as this makes the interrupt handlers faster ๐ the target option-mg13needs to be passed for this to work, as this feature is only available on the G13 target (S2 core). the MDUC registers are only saved if the interrupt handler performs a multiplication or division operation, or it calls another function.
๐ IBM RS/6000 and PowerPC Options ๐
these -m options are defined for the IBM RS/6000 and PowerPC:
- *
-mcpu=cpu_type* โ set architecture type, register usage, and instruction scheduling parameters for machine type cpu_type ๐ supported values for cpu_type are401,403,405,405fp,440,440fp,464,464fp,476,476fp,505,601,602,603,603e,604,604e,620,630,740,7400,7450,750,801,821,823,860,970,8540,a2,e300c2,e300c3,e500mc,e500mc64,e5500,e6500,ec603e,G3,G4,G5,titan,power3,power4,power5,power5+,power6,power6x,power7,power8,power9,power10,power11,future,powerpc,powerpc64,powerpc64le,rs64, andnative. that's a whole alphabet of CPUs bestie, slay ๐ฆ
-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. rip ๐ญ
ok so like, the other options are the ones that name one specific processor, and the code they make runs best on that processor โ and lowkey might not run at all on any other one. ๐
The -mcpu options automatically enable or disable the following options:
-maltivec -mfprnd -mhard-float -mmfcrf -mmultiple -mpopcntb
-mpopcntd -mpowerpc64 -mpowerpc-gpopt -mpowerpc-gfxopt -mmulhw
-mdlmzb -mmfpgpr -mvsx -mcrypto -mhtm -mpower8-fusion
-mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware
-mprefixed -mpcrel -mmma -mdense-math -mrop-protect
The exact set of options that gets flipped for any particular CPU changes between compiler versions, based on whatever setting seems to spit out the most optimal code for that CPU โ so it does not necessarily reflect what the actual hardware can do, bestie. It's giving โจvibes-based tuningโจ, not a spec sheet. If you want to force one individual option to a particular value, just say it after the -mcpu option, like -mcpu=970 -mno-altivec. ๐
On AIX, the -maltivec and -mpowerpc64 options are not enabled or disabled by -mcpu right now, because AIX doesn't fully support them. You can still turn them on or off individually if you're sure it'll work in your environment. ๐ซถ
In other cases, we recommend you use the -mcpu=cpu_type option rather than the options that control generation of specific instructions. fr fr.
-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 values of cpu_type work here as for-mcpu. If you give both, the code generated uses the architecture and registers from-mcpu, but the scheduling parameters from-mtune. ๐-mpowerpc64,-mno-powerpc64โ the-mpowerpc64option lets GCC generate the extra 64-bit instructions that live in the full PowerPC64 architecture, and treat GPRs as 64-bit doubleword quantities. GCC defaults to-mno-powerpc64.-mcmodel=smallโ generate PowerPC64 code for the small model: the TOC is limited to 64k.-mcmodel=mediumโ generate PowerPC64 code for the medium model: the TOC and other static data may be up to a total of 4G in size. This is the default for 64-bit Linux.-mcmodel=largeโ generate PowerPC64 code for the large model: the TOC may be up to 4G in size. Other data and code is only limited by the 64-bit address space.-mprofile-kernelโ available on PowerPC64 GNU/Linux targets. When you use it with-pg, it causes calls tomcountto be inserted before the function prologue instead of after it. ๐-maltivec,-mno-altivecโ generate code that uses (or does not use) AltiVec instructions, and also enable the use of built-in functions that allow more direct access to the AltiVec instruction set. You may also need to set-mabi=altivecto adjust the current ABI with AltiVec ABI enhancements.
When -maltivec is used, the element order for AltiVec intrinsics such as vec_splat, vec_extract, and vec_insert matches array element order corresponding to the endianness of the target. That is, element zero identifies the leftmost element in a vector register when targeting a big-endian platform, and identifies the rightmost element in a vector register when targeting a little-endian platform. ๐ฆ
-mpowerpc-gpopt,-mno-powerpc-gpoptโ specifying-mpowerpc-gpoptallows GCC to use the optional PowerPC architecture instructions in the General Purpose group, including floating-point square root. Specifying-mpowerpc-gfxopt,-mno-powerpc-gfxoptโ-mpowerpc-gfxoptallows GCC to use the optional PowerPC architecture instructions in the Graphics group, including floating-point select.-mmfcrf,-mno-mfcrfโ the-mmfcrfoption allows GCC to generate the move from condition register field instruction implemented on the POWER4 processor and other processors that support the PowerPC V2.01 architecture.-mpopcntb,-mno-popcntbโ the-mpopcntboption allows GCC to generate the popcount and double-precision FP reciprocal estimate instruction implemented on the POWER5 processor and other processors that support the PowerPC V2.02 architecture.-mpopcntd,-mno-popcntdโ the-mpopcntdoption allows GCC to generate the popcount instruction implemented on the POWER7 processor and other processors that support the PowerPC V2.06 architecture.-mfprnd,-mno-fprndโ the-mfprndoption allows GCC to generate the FP round to integer instructions implemented on the POWER5+ processor and other processors that support the PowerPC V2.03 architecture.-mcmpb,-mno-cmpbโ the-mcmpboption allows GCC to generate the compare bytes instruction implemented on the POWER6 processor and other processors that support the PowerPC V2.05 architecture.-mhard-dfp,-mno-hard-dfpโ the-mhard-dfpoption allows GCC to generate the decimal floating-point instructions implemented on some POWER processors.-mvrsave,-mno-vrsaveโ generate VRSAVE instructions when generating AltiVec code.-msecure-pltโ generate code that allowsldandld.soto build executables and shared libraries with non-executable.pltand.gotsections. This is a PowerPC 32-bit SYSV ABI option. ๐-mbss-pltโ generate code that uses a BSS.pltsection thatld.sofills in, and requires.pltand.gotsections that are both writable and executable. This is a PowerPC 32-bit SYSV ABI option.
heads up bestie โ writable + executable sections is a whole security vibe ๐, but that's literally what this option does.
-msplit-patch-nopsโ when adding NOPs for a patchable area via the-fpatchable-function-entryoption, emit the "before" NOPs in front of the global entry point and the "after" NOPs after the local entry point. This makes the sequence of NOPs not consecutive when a global entry point is generated. Without this option the NOPs are emitted directly before and after the local entry point, making them consecutive but moving global and local entry point further apart. If only a single entry point is generated this option has no effect.-misel,-mno-iselโ this switch enables or disables the generation of ISEL instructions.-mvsx,-mno-vsxโ generate code that uses (does not use) vector/scalar (VSX) instructions, and also enable the use of built-in functions that allow more direct access to the VSX instruction set. โจ-mcrypto,-mno-cryptoโ enable the use (disable) of the built-in functions that allow direct access to the cryptographic instructions that were added in version 2.07 of the PowerPC ISA. ๐-mhtm,-mno-htmโ enable (disable) the use of the built-in functions that allow direct access to the Hardware Transactional Memory (HTM) instructions that were added in version 2.07 of the PowerPC ISA.-mpower8-fusion,-mno-power8-fusionโ generate code that keeps (does not keep) some integer operations adjacent so that the instructions can be fused together on power8 and later processors.-mquad-memory,-mno-quad-memoryโ generate code that uses (does not use) the non-atomic quad word memory instructions. The-mquad-memoryoption requires use of 64-bit mode.-mquad-memory-atomic,-mno-quad-memory-atomicโ generate code that uses (does not use) the atomic quad word memory instructions. The-mquad-memory-atomicoption requires use of 64-bit mode.-mfloat128,-mno-float128โ enable/disable the__float128keyword for IEEE 128-bit floating point, and use either software emulation for IEEE 128-bit floating point or hardware instructions.
The VSX instruction set (-mvsx) must be enabled to use the IEEE 128-bit floating point support. The IEEE 128-bit floating point is only supported on Linux. ๐ง
The default for -mfloat128 is enabled on PowerPC Linux systems using the VSX instruction set, and disabled on other systems.
If you use the ISA 3.0 instruction set (-mcpu=power9) on a 64-bit system, the IEEE 128-bit floating point support also enables the generation of ISA 3.0 IEEE 128-bit floating point instructions. Otherwise, if you do not specify generation of ISA 3.0 instructions or you are targeting a 32-bit big-endian system, IEEE 128-bit floating point is handled with software emulation.
-mfloat128-hardware,-mno-float128-hardwareโ enable/disable using ISA 3.0 hardware instructions to support the__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 says 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โ okay bestie, this is the AIX ABI glow-up โจ-maix64turns on the 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bitlongtype, and all the infrastructure that has to show up for them to work. Specifying-maix64implies-mpowerpc64, while-maix32disables the 64-bit ABI and implies-mno-powerpc64. GCC defaults to-maix32, no cap. ๐-mxl-compat,-mno-xl-compatโ produce code that conforms more closely to IBM XL compiler semantics when using AIX-compatible ABI. It passes floating-point arguments to prototyped functions beyond the register save area (RSA) on the stack in addition to argument FPRs. It also tells GCC not to assume that the most significant double in a 128-bitlong doublevalue is properly rounded when comparing values and converting todouble. And it uses XL symbol names forlong doublesupport 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. iykyk ๐ญ
-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-poweris 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. linker girlies, don't forget that part ๐-mmultiple,-mno-multipleโ generate code that uses (does not use) the load multiple word instructions and the store multiple word instructions. These instructions are generated by default on POWER systems, and not generated on PowerPC systems. Do not use-mmultipleon little-endian PowerPC systems, since those instructions do not work when the processor is in little-endian mode. The exceptions are PPC740 and PPC750 which permit these instructions in little-endian mode. ๐-mupdate,-mno-updateโ generate code that uses (does not use) the load or store instructions that update the base register to the address of the calculated memory location. These instructions are generated by default. If you use-mno-update, there is a small window between the time that the stack pointer is updated and the address of the previous frame is stored, which means code that walks the stack frame across interrupts or signals may get corrupted data. bestie, that's a yikes. ๐ญ-mavoid-indexed-addresses,-mno-avoid-indexed-addressesโ generate code that tries to avoid (not avoid) the use of indexed load or store instructions. These instructions can incur a performance penalty on Power6 processors in certain situations, such as when stepping through large arrays that cross a 16M boundary. This option is enabled by default when targeting Power6 and disabled otherwise. performance tea โโจ-mfused-madd,-mno-fused-maddโ generate code that uses (does not use) the floating-point multiply and accumulate instructions. These instructions are generated by default if hardware floating point is used. The machine-dependent-mfused-maddoption is now mapped to the machine-independent-ffp-contract=fastoption, and-mno-fused-maddis mapped to-ffp-contract=off. glow-up to a machine-independent era ๐-mmulhw,-mno-mulhwโ generate code that uses (does not use) the half-word multiply and multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors. These instructions are generated by default when targeting those processors. 405/440/464/476 stans rise ๐-mdlmzb,-mno-dlmzbโ generate code that uses (does not use) the string-searchdlmzbinstruction on the IBM 405, 440, 464 and 476 processors. This instruction is generated by default when targeting those processors. ๐ฆ-mno-bit-align,-mbit-alignโ on System V.4 and embedded PowerPC systems do not (do) force structures and unions that contain bit-fields to be aligned to the base type of the bit-field.
For example, by default a structure containing nothing but 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. tiny struct, huge vibe ๐
-mbit-word,-mno-bit-wordโ allow bit-fields to cross word boundaries. that's it, that's the whole serve. ๐-mno-strict-align,-mstrict-alignโ on System V.4 and embedded PowerPC systems do not (do) assume that unaligned memory references are handled by the system. the system said "not my job" ๐ญ-mrelocatable,-mno-relocatableโ generate code that allows (does not allow) a static executable to be relocated to a different address at run time. A simple embedded PowerPC system loader should relocate the entire contents of.got2and 4-byte locations listed in the.fixupsection, a table of 32-bit addresses generated by this option. For this to work, all objects linked together must be compiled with-mrelocatableor-mrelocatable-lib.-mrelocatablecode aligns the stack to an 8-byte boundary. stack alignment slay โจ-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 linking era ๐ซถ-mlittle,-mlittle-endianโ on System V.4 and embedded PowerPC systems compile code for the processor in little-endian mode. The-mlittle-endianoption is the same as-mlittle. little-endian besties, this one's for you ๐-mbig,-mbig-endianโ on System V.4 and embedded PowerPC systems compile code for the processor in big-endian mode. The-mbig-endianoption is the same as-mbig. big-endian energy ๐-mdynamic-no-picโ on Darwin / macOS systems, compile code so that it is not relocatable, but that its external references are relocatable. The resulting code is suitable for applications, but not shared libraries. ๐-msingle-pic-baseโ treat the register used for PIC addressing as read-only, rather than loading it in the prologue for each function. The runtime system is responsible for initializing this register with an appropriate value before execution begins. runtime system, you have one job ๐-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. scheduler drama, but make it numbered โจ-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. ABI lore unlocked ๐-mcall-sysv-eabi,-mcall-eabiโ specify both-mcall-sysvand-meabioptions. double option combo meal ๐-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. AIX girlies ๐-mcall-linuxโ on System V.4 and embedded PowerPC systems compile code for the Linux-based GNU system. GNU/Linux stans ๐ง-mcall-freebsdโ on System V.4 and embedded PowerPC systems compile code for the FreeBSD operating system. FreeBSD ๐-mcall-netbsdโ on System V.4 and embedded PowerPC systems compile code for the NetBSD operating system. NetBSD โจ-mcall-openbsdโ on System V.4 and embedded PowerPC systems compile code for the OpenBSD operating system. OpenBSD ๐ก-mtraceback=traceback_typeโ select the type of traceback table. Valid values for traceback_type arefull,part, andno. traceback table type check ๐ง-maix-struct-returnโ return all structures in memory (as specified by the AIX ABI). memory return, no shortcuts ๐-msvr4-struct-returnโ return structures smaller than 8 bytes in registers (as specified by the SVR4 ABI). tiny structs get the register treatment ๐-mabi=abi-typeโ extend the current ABI with a specific extension, or yeet one back off. Valid values are:altivec,no-altivec,ibmlongdouble,ieeelongdouble,elfv1,elfv2, and for AIX:vec-extabi,vec-default. pick wisely bestie ๐-mabi=ibmlongdoubleโ flips the current ABI over to using IBM extended-precisionlong double. lowkey this is not likely to work if your system defaults to IEEE extended-precisionlong double. and if you switch thelong doubletype away from IEEE extended-precision, the compiler WILL issue a warning unless you pass-Wno-psabi. also it requires-mlong-double-128to be enabled. no skipping steps ๐ซถ-mabi=ieeelongdoubleโ flips the current ABI over to using IEEE extended-precisionlong double. same deal: not likely to work if your system defaults to IBM extended-precisionlong double. switch thelong doubletype away from IBM extended-precision and the compiler warns unless you use-Wno-psabi. requires-mlong-double-128to be enabled. periodt โจ-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 needs special system support and is likely to fail in spectacular ways. like, catastrophic main-character meltdown energy ๐-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 also requires special system support and is likely to fail in spectacular ways. same drama, different ABI ๐ญ-mgnu-attribute/-mno-gnu-attributeโ emit (or don't emit).gnu_attributeassembly directives that set tag/value pairs in a.gnu.attributessection, specifying ABI variations in function parameters or return values. it's giving metadata slay โจ-mprototype/-mno-prototypeโ on System V.4 and embedded PowerPC systems, assume that all calls to variable argument functions are properly prototyped. otherwise the compiler has to insert an instruction before every non-prototyped call to set or clear bit 6 of the condition code register ("CR") to indicate whether floating-point values are passed in the floating-point registers in case the function takes variable arguments. with-mprototype, only calls to prototyped variable argument functions set or clear the bit. okay so it's the difference between "trust me bro, we're prototyped" and "we gotta check every single time" ๐-msimโ on embedded PowerPC systems, assume the startup module is calledsim-crt0.oand that the standard C libraries arelibsim.aandlibc.a. this is the default forpowerpc-*-eabisimconfigurations. icon behavior ๐-mmvmeโ on embedded PowerPC systems, assume the startup module is calledcrt0.oand the standard C libraries arelibmvme.aandlibc.a. yes bestie we love a themed lib name ๐ธ-madsโ on embedded PowerPC systems, assume the startup module is calledcrt0.oand the standard C libraries arelibads.aandlibc.a. cute โจ-myellowknifeโ on embedded PowerPC systems, assume the startup module is calledcrt0.oand the standard C libraries arelibyk.aandlibc.a. yellowknife is such a vibe ngl ๐-mvxworksโ on System V.4 and embedded PowerPC systems, say you're compiling for a VxWorks system. telling it like it is ๐ซถ-membโ on embedded PowerPC systems, set the"PPC_EMB"bit in the ELF flags header to indicate that eabi extended relocations are used. little flag, big meaning ๐-meabi/-mno-eabiโ on System V.4 and embedded PowerPC systems, do (or don't) adhere to the Embedded Applications Binary Interface (EABI), which is a set of modifications to the System V.4 specifications. picking-meabimeans the stack is 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-eabimeans the stack is 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.-meabiis on by default if you configured GCC using one of thepowerpc*-*-eabi*options. okay that was a lot but every detail matters bestie ๐-msdata=eabiโ on System V.4 and embedded PowerPC systems, put small initialized"const"global and static data in the.sdata2section, which is pointed to by register"r2". put small initialized non-"const"global and static data in the.sdatasection, pointed to by register"r13". put small uninitialized global and static data in the.sbsssection, which is adjacent to the.sdatasection. heads up:-msdata=eabiis incompatible with the-mrelocatableoption. also-msdata=eabisets the-memboption. two birds one flag ๐ฆ-msdata=sysvโ on System V.4 and embedded PowerPC systems, put small global and static data in the.sdatasection, pointed to by register"r13". put small uninitialized global and static data in the.sbsssection, which is adjacent to the.sdatasection.-msdata=sysvis incompatible with the-mrelocatableoption. no cap ๐-msdata=default/-msdataโ on System V.4 and embedded PowerPC systems, if-meabiis used, compile code the same as-msdata=eabi, otherwise compile code the same as-msdata=sysv. it's the "you decide" option ๐-msdata=dataโ on System V.4 and embedded PowerPC systems, put small global data in the.sdatasection. put small uninitialized global data in the.sbsssection. but do NOT use register"r13"to address small data. this is the default behavior unless other-msdataoptions are used. the factory setting, basically โญ-msdata=none/-mno-sdataโ on embedded PowerPC systems, put all initialized global and static data in the.datasection, and all uninitialized data in the.bsssection. clean, simple, classic ๐-mreadonly-in-sdataโ put read-only objects in the.sdatasection too. this is the default. obsessed ๐-mblock-move-inline-limit=numโ inline 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. slay the copy ๐ธ-mblock-compare-inline-limit=numโ generate non-looping inline code for all block compares (like calls to"memcmp"or structure compares) that are less than or equal to num bytes. if num is0, all inline expansion (both non-loop and loop) of block compare is disabled. the default value is target-specific. โจ-mblock-compare-inline-loop-limit=numโ generate an inline expansion using loop code for all block compares that are less than or equal to num bytes, but greater than the limit for non-loop inline block compare expansion. if the block length isn't constant, at most num bytes are compared before"memcmp"is called to compare the remainder of the block. the default value is target-specific. loop queen ๐-mstring-compare-inline-limit=numโ compare at most num string bytes with inline code. if the difference or end of 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 is8. the-G numswitch also gets passed to the linker. all modules should be compiled with the same-G numvalue โ consistency is key bestie, no cap ๐ซถ-mregnames/-mno-regnamesโ on System V.4 and embedded PowerPC systems, do (or don't) emit register names in the assembly language output using symbolic forms. cute and symbolic ๐-mlongcall/-mno-longcallโ by default, assume that all calls are far away, so a longer and more expensive calling sequence is required. this is required for calls farther than 32 megabytes (33,554,432 bytes) from the current location. a short call 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, and so can the GNU linker for PowerPC/64. it's planned to add this feature to the GNU linker for 32-bit PowerPC systems too.
on PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, GCC can generate long calls using an inline PLT call sequence (see -mpltseq). PowerPC with -mbss-plt and PowerPC64 ELFv1 (big-endian) do not support inline PLT calls.
on Darwin/PPC systems, #pragma longcall generates "jbsr callee, L42", plus a branch island (glue code). the two target addresses represent the callee and the branch island. the Darwin/PPC linker prefers the first address and generates a "bl callee" if the PPC "bl" instruction reaches the callee directly; otherwise the linker generates "bl L42" to call the branch island. the branch island is appended to the body of the calling function; it computes the full 32-bit address of the callee and jumps to it.
on Mach-O (Darwin) systems, this option directs the compiler to emit glue for every direct call, and the Darwin linker decides whether to use it or discard it.
in the future, GCC may ignore all longcall specifications when the linker is known to generate glue. so like, watch this space ๐
-mpltseq/-mno-pltseqโ implement (or don't implement)-fno-pltand long calls using an inline PLT call sequence that supports lazy linking and long calls to functions in dlopen'd shared libraries. inline PLT calls are only supported on PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, and 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.-mpltseqcode and-mbss-plt32-bit PowerPC relocatable objects may not be linked together. โ ๏ธ noted bestie-mtls-markers/-mno-tls-markersโ mark (or don't mark) calls to"__tls_get_addr"with a relocation specifying the function argument. the relocation lets the linker reliably associate the function call with argument setup instructions for TLS optimization, which in turn lets GCC better schedule the sequence. teamwork makes the dream work fr fr ๐ซถ-mrecip,-mno-recipโ okay so this one turns on the reciprocal estimate + reciprocal square root estimate instructions, and then patches up the precision with extra Newton-Raphson steps instead of doing a whole actual divide or square root-and-divide for floating-point args. bestie, pls use-ffast-mathwhen you're using-mrecipโ or at minimum-funsafe-math-optimizations,-ffinite-math-only,-freciprocal-mathand-fno-trapping-math. and like, yes the throughput of this sequence is generally higher than the non-reciprocal instruction's throughput, but the precision can drop by up to 2 ulp (so the inverse of 1.0 comes out as 0.99999994 ๐ญ) for reciprocal square roots. it's giving tradeoff.-mrecip=optโ this controls which reciprocal estimate instructions are even allowed to be used.optis a comma-separated list of options, and any of them can be preceded by a"!"to invert it:allโ enable all estimate instructions.defaultโ enable the default instructions, equivalent to-mrecip.noneโ disable all estimate instructions, equivalent to-mno-recip.divโ enable the reciprocal approximation instructions for both single and double precision.divfโ enable the single-precision reciprocal approximation instructions.divdโ enable the double-precision reciprocal approximation instructions.rsqrtโ enable the reciprocal square root approximation instructions for both single and double precision.rsqrtfโ enable the single-precision reciprocal square root approximation instructions.rsqrtdโ enable the double-precision reciprocal square root approximation instructions.
so like, for example, -mrecip=all,!rsqrtd enables all of the reciprocal estimate instructions except the "FRSQRTE", "XSRSQRTEDP", and "XVRSQRTEDP" instructions โ those are the ones handling the double-precision reciprocal square root calculations. slay, targeted exclusion ๐
-mrecip-precision,-mno-recip-precisionโ assume (or don't assume, bestie) that the reciprocal estimate instructions give you higher-precision estimates than the PowerPC ABI mandates. picking-mcpu=power6,-mcpu=power7or-mcpu=power8automatically picks-mrecip-precisionfor you. on low-precision machines the double-precision square root estimate instructions just aren't generated by default, because they don't provide an estimate that converges after three steps. no convergence, no code, periodt.-mveclibabi=typeโ specifies the ABI type to use for vectorizing intrinsics using an external library. the only type supported rn ismass, which says: use IBM's Mathematical Acceleration Subsystem (MASS) libraries for vectorizing intrinsics via external libraries. GCC currently emits calls to"acosd2","acosf4","acoshd2","acoshf4","asind2","asinf4","asinhd2","asinhf4","atan2d2","atan2f4","atand2","atanf4","atanhd2","atanhf4","cbrtd2","cbrtf4","cosd2","cosf4","coshd2","coshf4","erfcd2","erfcf4","erfd2","erff4","exp2d2","exp2f4","expd2","expf4","expm1d2","expm1f4","hypotd2","hypotf4","lgammad2","lgammaf4","log10d2","log10f4","log1pd2","log1pf4","log2d2","log2f4","logd2","logf4","powd2","powf4","sind2","sinf4","sinhd2","sinhf4","sqrtd2","sqrtf4","tand2","tanf4","tanhd2", and"tanhf4"when generating code forpower7. both-ftree-vectorizeand-funsafe-math-optimizationshave to be enabled too. and the MASS libraries must be specified at link time, don't forget that part ๐-mfriz,-mno-frizโ generate (or don't) the"friz"instruction when-funsafe-math-optimizationsis used to optimize rounding of floating-point values to 64-bit integer and back to floating point. heads up tho: the"friz"instruction does not return the same value if the floating-point number is too large to fit in an integer. ๐-mpointers-to-nested-functions,-mno-pointers-to-nested-functionsโ generate (or don't) code to load up the static chain register ("r11") when calling through a pointer on AIX and 64-bit Linux systems where a function pointer points to a 3-word descriptor giving the function address, the TOC value to be loaded in register"r2", and the static chain value to be loaded in register"r11".-mpointers-to-nested-functionsis on by default. and listen: you cannot call through pointers to nested functions, or pointers to functions compiled in other languages that use the static chain, if you use-mno-pointers-to-nested-functions. so like, choose wisely ๐ซถ-msave-toc-indirect,-mno-save-toc-indirectโ generate (or don't) 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 right before the call through the pointer instead.-mno-save-toc-indirectis the default.-mcompat-align-parm,-mno-compat-align-parmโ generate (or don't) code to pass structure parameters with a maximum alignment of 64 bits, for compatibility with older versions of GCC.
so the lore here: older GCC (before 4.9.0) incorrectly did not align a structure parameter on a 128-bit boundary when that structure contained a member requiring 128-bit alignment. this got corrected in more recent GCC versions. this option lets you generate code that's compatible with functions compiled by those older GCCs. and -mno-compat-align-parm is the default.
-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offsetโ generate stack protection code using the canary at guard. supported locations areglobalfor global canary, ortlsfor per-thread canary in the TLS block (that's the default with GNU libc version 2.4 or later).
with the tls choice, -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset additionally tell you which register to use as the base register for reading the canary, and what offset from that base register to read from. the default for those is whatever the relevant ABI says. iykyk ๐
-mpcrel,-mno-pcrelโ generate (or don't) pc-relative addressing.-mpcrelrequires that the medium code model (-mcmodel=medium) and prefixed addressing (-mprefixed) options are enabled. prerequisites bestie, it's giving locked content ๐-mprefixed,-mno-prefixedโ generate (or don't) addressing modes using prefixed load and store instructions.-mprefixedrequires that-mcpu=power10(or later) is enabled.-mmma,-mno-mmaโ generate (or don't) the MMA instructions. the-mmaoption requires that-mcpu=power10(or later) is enabled.-mdense-math,-mno-dense-mathโ generate (or don't) Dense Math Facility (DMF) instructions.-mdense-mathrequires that-mcpu=future(or later) is enabled. yes,future. it's giving main character energy from the future โญ-mrop-protect,-mno-rop-protectโ generate (or don't) ROP protection instructions when the target processor supports them. currently this option disables the shrink-wrap optimization (-fshrink-wrap). noted, no cap.-mprivileged,-mno-privilegedโ generate (or don't) code that runs in privileged state. ๐-mblock-ops-unaligned-vsx,-mno-block-ops-unaligned-vsxโ generate (or don't) unaligned vsx loads and stores for inline expansion of"memcpy"and"memmove".-msplat-word-constant,-mno-splat-word-constantโ generate (or don't) code that uses the"XXSPLTIW"instruction. this option is enabled by default.-msplat-float-constant,-mno-splat-float-constantโ generate (or don't) code that uses the"XXSPLTIDP"instruction. this option is enabled by default.-mieee128-constant,-mno-ieee128-constantโ generate (or don't) code that uses the"LXVKQ"instruction. this option is enabled by default.-mwarn-altivec-long,-mno-warn-altivec-longโ enable or disable warnings about deprecated vector long ... Altivec type usage. this option is enabled by default. get your warnings bestie, they're here to help ๐ซถ
๐ RX Options ๐
these command-line options are defined for RX targets:
-m64bit-doubles,-m32bit-doublesโ make the"double"data type 64 bits (-m64bit-doubles) or 32 bits (-m32bit-doubles) in size. the default is-m32bit-doubles. note: RX floating-point hardware only works on 32-bit values, which is 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 tho, so the FPU hardware is not used for doubles if -m64bit-doubles is used.
note: if-fpuis enabled, then-funsafe-math-optimizationsis also enabled automatically. why? because the RX FPU instructions are themselves unsafe. it's giving chaos, fr fr ๐
-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 is RX600.
the only difference between RX600 and RX610 is that the RX610 does not support the "MVTIPL" instruction.
the RX200 series does not have a hardware floating-point unit, so -nofpu is enabled by default when this type is selected.
-mbig-endian-data,-mlittle-endian-dataโ store data (but not code!) in big-endian format. the default is-mlittle-endian-data, i.e. store data in little-endian format. code stays out of this drama entirely.-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 the programmer to make sure the area doesn't overflow. also, when the small data area is used, one of RX's registers (usually"r13") is reserved for pointing at this area, so it's no longer available for the compiler to use. this could result in slower and/or larger code if variables get pushed onto the stack instead of being held in that register. ๐ญ
note: common variables (variables that haven't been initialized) and constants are not placed into the small data area, because they're assigned to other sections in the output executable.
The default value is zero, which disables this feature. Heads up bestie: this feature is not enabled by default with higher optimization levels (-O2 etc) because reserving a register can lowkey be detrimental. It's up to you, the programmer, to experiment and figure out whether this feature actually helps your program. For the deets on how the actual register to hold the small data area pointer gets chosen, go read the description of the -mpid option. ๐
-msim-mno-simโ Use the simulator runtime. The default is to use the libgloss board-specific runtime.-mas100-syntax-mno-as100-syntaxโ When generating assembler output, use a syntax that's compatible with Renesas's AS100 assembler. โจ The GAS assembler can also handle this syntax, but it comes with some restrictions, so it is not generated by default.-mmax-constant-size=Nโ Specifies the max size, in bytes, of a constant that can be used as an operand in an RX instruction. So here's the tea: the RX instruction set does allow constants up to 4 bytes long in instructions, but a longer value equals a longer instruction. So sometimes it's genuinely 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 whole process where the linker tries to shrink your program by finding shorter versions of various instructions. Disabled by default. ๐-mint-register=Nโ Specify how many registers to reserve for fast interrupt handler functions. The value N can be between0and4. A value of1means register"r13"is reserved for the exclusive use of fast interrupt handlers. A value of2reserves"r13"and"r12". A value of3reserves"r13","r12"and"r11", and a value of4reserves"r13"through"r10". A value of0, the default, reserves no registers. ๐-msave-acc-in-interruptsโ Says that interrupt handler functions should preserve the accumulator register. This is only necessary if normal code might use the accumulator register, like, 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 generation of position-independent data. When it's on, any access to constant data happens via an offset from a base address held in a register. This lets the location of constant data be determined at run time without requiring the executable to be relocated โ which is a whole benefit for embedded applications with tight memory constraints. Data that can be modified is not affected by this option. ๐ฆ
Note: using this feature reserves a register, usually "r13", for the constant data base address. This can result in slower and/or larger code, especially in complicated functions. ๐ญ
The actual register chosen to hold the constant data base address depends on whether the -msmall-data-limit and/or the -mint-register command-line options are enabled. Starting with register "r13" and proceeding downwards, registers are allocated first to satisfy the requirements of -mint-register, then -mpid and finally -msmall-data-limit. So yes, it's totally possible for the small data area register to be "r8" if both -mint-register=4 and -mpid are specified on the command line. ๐
By default this feature is not enabled. The default can be restored via the -mno-pid command-line option.
-mno-warn-multiple-fast-interrupts-mwarn-multiple-fast-interruptsโ Stops GCC from issuing a warning message if it finds more than one fast interrupt handler while compiling a file. The default is to issue a warning for each extra fast interrupt handler found, since the RX only supports one such interrupt. ๐-mallow-string-insns-mno-allow-string-insnsโ Enables or disables use of the string manipulation instructions"SMOVF","SCMPU","SMOVB","SMOVU","SUNTIL","SWHILE"and also the"RMPA"instruction. โ ๏ธ These instructions may prefetch data, which is not safe if you're accessing an I/O register. (See section 12.2.7 of the RX62N Group User's Manual for more info.)
The default is to allow these instructions, but GCC can't reliably detect every circumstance where a string instruction might be used to access an I/O register, so their use can't be disabled automatically. Instead it relies on you, the programmer, to use the -mno-allow-string-insns option if your program accesses I/O space. ๐
When the instructions are enabled, GCC defines the C preprocessor symbol "__RX_ALLOW_STRING_INSNS__"; otherwise it defines the symbol "__RX_DISALLOW_STRING_INSNS__".
-mjsr-mno-jsrโ Use only (or not only)"JSR"instructions to access functions. You'd use this option when code size exceeds the range of"BSR"instructions. Note that-mno-jsrdoes not mean "don't useJSR" โ it means any type of branch may be used. ๐-mlraโ Use the new LRA register allocator. By default, the old"reload"allocator is used.
Note: the generic GCC command-line option-ffixed-reghas special significance to the RX port when used with the"interrupt"function attribute. This attribute indicates a function intended to process fast interrupts. GCC makes sure it only uses the registers"r10","r11","r12"and/or"r13"โ and only provided that the normal use of the corresponding registers has been restricted via the-ffixed-regor-mint-registercommand-line options. ๐
S/390 and zSeries Options ๐
These are the -m options defined for the S/390 and zSeries architecture.
-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 the"long double"type. A size of 64 bits makes the"long double"type equivalent to the"double"type. This is the default.-mbackchain-mno-backchainโ Store (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 don't 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 -mno-backchain; however, using 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 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 gets 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 isn't 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 the"bras"instruction to do subroutine calls. This only works reliably if the total executable size doesn't exceed 64k. The default is to use the"basr"instruction instead, which doesn't 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 lets GCC, in particular, generate 64-bit instructions. For the s390 targets, the default is-m31, while the s390x targets default to-m64. Note:-m31is deprecated and support will be removed. โ ๏ธ-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โ-mhtmturns on a whole lil family of builtins that use the instructions from the transactional execution facility, which showed up with the IBM zEnterprise EC12 machine generation S/390 System z Built-in Functions. And it's on by default when you're using-march=zEC12โจ-mvx,-mno-vxโ when you say-mvx, you get code that uses the instructions from the vector extension facility, which arrived with the IBM z13 machine generation. โ ๏ธ heads up bestie: this option changes the ABI for some vector type values when it comes to alignment and calling conventions. And if vector type values are being used in an ABI-relevant context, a GAS.gnu_attributecommand gets added to mark the resulting binary with the ABI that was used.-mvxis on by default when you use-march=z13๐-mzvector,-mno-zvectorโ-mzvectorenables vector language extensions and builtins using the instructions from the vector extension facility that came with the IBM z13 machine generation. It adds support forvectorto be used as a keyword to define vector type variables and arguments. ๐ฆvectoris only available when GNU extensions are enabled โ it does not get expanded when you're asking for strict standard compliance, like with-std=c99. On top of the GCC low-level builtins,-mzvectoralso enables a set of builtins added for compatibility with AltiVec-style implementations like Power and Cell. To use those, you gotta include the header filevecintrin.h. And-mzvectoris disabled by default, ngl.-mmvcle,-mno-mvcleโ generate (or don't generate) code that uses themvcleinstruction to do block moves. When you say-mno-mvcle, it uses anmvcloop instead. That's the default unless you're optimizing for size.-mdebug,-mno-debugโ print (or don't print) extra debug info while compiling. The default is to not print debug info.-march=cpu-typeโ generate code that runs on cpu-type, which is the name of a system representing a certain processor type. The possible values for cpu-type are:z900/arch5z990/arch6z9-109z9-ec/arch7z10/arch8z196/arch9zEC12z13/arch11z14/arch12z15/arch13z16/arch14z17/arch15native
The default is -march=z900. ๐ธ
Specifying native as the cpu type can be used to select the best architecture option for the host processor. But fr fr, -march=native has no effect if GCC doesn't recognize the processor.
-mtune=cpu-typeโ tune everything applicable about the generated code to cpu-type, except for the ABI and the set of available instructions. The list of cpu-type values is the same as for-march. The default is the value used for-march.-mtpf-trace,-mno-tpf-traceโ generate code that adds (or doesn't add) TPF OS specific branches to trace routines in the operating system. This option is off by default, even when you're compiling for the TPF OS.-mtpf-trace-skip,-mno-tpf-trace-skipโ generate code that changes (or doesn't change) the default branch targets enabled by-mtpf-traceso they point to specialized trace routines that give you the ability to selectively skip function trace entries for the TPF OS. This option is off by default, even when compiling for the TPF OS and specifying-mtpf-trace.-mmainโ for the TPF OS target, use this when linking to add the startup code and other linker options so you produce a main object. ๐ซถ-mfused-madd,-mno-fused-maddโ generate code that uses (or doesn't use) the floating-point multiply and accumulate instructions. These instructions get generated by default if hardware floating point is used.-mwarn-framesize=framesizeโ emit a warning if the current function exceeds the given frame size. Because this is a compile-time check, it doesn't need to be a real problem when the program runs. It's meant to identify functions that most probably cause a stack overflow. Super useful for environments with limited stack size, e.g. the Linux kernel. ๐ง A value of zero disables this warning, and that's the default.-mwarn-dynamicstack,-mno-warn-dynamicstackโ emit a warning if the function callsallocaor uses dynamically-sized arrays. Generally speaking? That's a bad idea when your stack size is limited. ๐ญ-mstack-guard=stack-guard,-mstack-size=stack-size,-mno-stack-guard,-mno-stack-sizeโ if these options are enabled, the S/390 back end emits additional instructions in the function prologue that trigger a trap if the stack size is stack-guard bytes above the stack-size (remember, the stack on S/390 grows downward). If thestack-guardoption is omitted, the smallest power of 2 larger than the frame size of the compiled function is chosen. โจ
These options are intended to help debug stack overflow problems. The additionally emitted code causes only a little overhead, so it can also be used in production-like systems without greater performance degradation.
The given values have to be exact powers of 2, and stack-size has to be greater than stack-guard without exceeding 64k. To be efficient, the extra code makes the assumption that the stack starts at an address aligned to the value given by stack-size.
โ ๏ธ The-mstack-guard=option can only be used in conjunction with-mstack-size=. You can override these options on the command line with-mno-stack-guardand-mno-stack-size, respectively.
-mhotpatch=pre-halfwords,post-halfwordsโ if the hotpatch option is enabled, a "hot-patching" function prologue is generated for all functions in the compilation unit. The function label is prepended with the given number of two-byte NOP instructions (pre-halfwords, maximum1000000). After the label,2 * post-halfwordsbytes are appended, using the largest NOP-like instructions the architecture allows (maximum1000000).
If both arguments are zero, hotpatching is disabled.
This option can be overridden for individual functions with the "hotpatch" attribute. ๐
-mpic-data-is-text-relative,-mno-pic-data-is-text-relativeโ when compiling for S/390 with-fpicor-fPIC, normally GCC emits code using relative addressing between code and data. But for hotpatching it might be required to introduce new.textparts while using the existing.dataand.bsssections. In that case, use-mno-pic-data-is-text-relativeto force addressing through the GOT instead.-mstack-protector-guard=guard,-mstack-protector-guard-recordโ generate stack protection code using a canary at guard. Supported locations areglobalfor a global canary, ortlsfor a per-thread canary in the TLS block (the default). ๐
Option -mstack-protector-guard-record results in the generation of section __stack_protector_loc containing pointers to all instructions which load the address of the global guard. So this option only has an effect in conjunction with -mstack-protector-guard=global. The intended use is for the Linux kernel.
-mindirect-branch=choice,-mindirect-branch-jump=choice,-mindirect-branch-call=choice,-mfunction-return=choice,-mfunction-return-mem=choice,-mfunction-return-reg=choiceโ this whole group of options deals with security vulnerabilities related to speculative execution and indirect branch prediction, by letting you replace indirect branches and function returns with direct branches to a thunk. ๐
Specifying a choice of keep causes generation of the default code. thunk triggers generation of out-of-line thunks and replaces the formerly indirect branch with a direct branch to the thunk. thunk-extern does the branch replacement like thunk but does not emit the thunks. thunk-inline is only available with -mindirect-branch-jump; it should be used in preference to thunk in user-space applications to support correct stack unwinding and exception handling.
-mindirect-branch sets the value of -mindirect-branch-jump and -mindirect-branch-call. -mfunction-return sets the value of -mfunction-return-reg and -mfunction-return-mem.
All of these options can also be set on a per-function basis using function attributes.
-mindirect-branch-table,-mno-indirect-branch-tableโ this one is useful in conjunction with the-mindirect-branchand-mfunction-returnoptions. When enabled, it causes generation of tables pointing to the branch locations which have been patched by those options. The tables are emitted in sections named.s390_indirect_jump,.s390_indirect_call,.s390_return_reg, and.s390_return_mem. Each section consists of an array of 32-bit elements; each entry holds the offset from the entry to the patched location. ๐-mfentry,-mno-fentryโ when used in conjunction with the-pgoption, emit profiling code using the__fentry__hook provided by GLIBC 2.29 or later. This is only available for 64-bit code. If this option is not enabled, profiling uses the less efficient_mcounthook instead. ๐-mrecord-mcount,-mno-record-mcountโ when enabled, generate a__mcount_locsection with the locations of all generated profiling calls to_mcountor__fentry__.mnop-mcount,mno-nop-mcountโ instead of generating calls to_mcountor__fentry__with-pg, insert a sequence of no-op instructions of the same length at the locations where the calls would have been inserted. This can be used in conjunction with the-mrecord-mcountoption to patch the call sequences into the object file without recompiling it. ๐-mpreserve-args,-mno-preserve-argsโ when enabled, save all argument registers to the stack, and generate corresponding CFI information. This is useful for applications that want to implement their own stack unwinding and need access to function arguments.-munaligned-symbols,-mno-unaligned-symbolsโ assume that external symbols with a natural alignment of 1 are potentially unaligned. By default, all symbols without explicit alignment are assumed to be aligned on a 2-byte boundary, as mandated by the IBM Z ABI. โจ
๐ธ SH Options ๐ธ
These -m options are defined for the SH implementations, bestie:
-m1โ generate code for the SH1. ๐-m2โ generate code for the SH2. ๐-m2eโ generate code for the SH2e. ๐-m2a-nofpuโ generate code for the SH2a with no FPU at all, or for an SH2a-FPU but in a way that the floating-point unit literally never gets touched ๐-m2a-single-onlyโ generate code for the SH2a-FPU in such a way that no double-precision floating-point operations are used. single precision only bestie, that's the vibe ๐-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 with no floating-point unit.-m4-single-onlyโ generate code for the SH4 with a floating-point unit that only supports single-precision arithmetic. no doubles here, she said what she said ๐-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). stripped down and thriving fr fr ๐ธ-m4-400โ generate code for SH4-400 (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. (so it's giving DSP energy without actually doing DSP, iconic ๐ญ)-mbโ compile code for the processor in big-endian mode.-mlโ compile code for the processor in little-endian mode.-mdalignโ align doubles at 64-bit boundaries. Note that this changes the calling conventions, and thus some functions from the standard C library do not work unless you recompile it first with-mdalign. โ ๏ธ bestie this one has consequences, read it twice-mrelaxโ shorten some address references at link time, when possible; uses the linker option-relax.-mbigtableโ use 32-bit offsets inswitchtables. The default is to use 16-bit offsets.-mbitopsโ enable the use of bit manipulation instructions on SH2A.-mfmovdโ enable the use of the instructionfmovd. Check-mdalignfor alignment constraints. ๐-mrenesas-mno-renesasโ comply with the calling conventions defined by Renesas. The default for all targets of the SH toolchain is-mno-renesas, which uses the calling conventions defined for GCC before the Renesas conventions were available.-mnomacsaveโ mark theMACregister as call-clobbered, even if-mrenesasis given.-mieee-mno-ieeeโ control the IEEE compliance of floating-point comparisons, which affects the handling of cases where the result of a comparison is unordered. By default-mieeeis implicitly enabled. If-ffinite-math-onlyis enabled-mno-ieeeis implicitly set, which results in faster floating-point greater-equal and less-equal comparisons. The implicit settings can be overridden by specifying either-mieeeor-mno-ieee.-minline-ic_invalidate-mno-inline-ic_invalidateโ inline code to invalidate instruction cache entries after setting up nested function trampolines. This option has no effect if-musermodeis in effect and the selected code generation option (e.g.-m4) does not allow the use of theicbiinstruction. If the selected code generation option does not allow the use of theicbiinstruction, and-musermodeis not in effect, the inlined code manipulates the instruction cache address array directly with an associative write. This not only requires privileged mode at run time, but it also fails if the cache line had been mapped via the TLB and has become unmapped. ๐ yeah that's a lot, it's a whole situation-misizeโ dump instruction size and location in the assembly code.-matomic-model=modelโ sets the model of atomic operations and additional parameters as a comma-separated list. For details on the atomic built-in functions see__atomic Builtins. The following models and parameters are supported:noneโ disable compiler generated atomic sequences and emit library calls for atomic operations. This is the default if the target is notsh*-*-linux*.soft-gusaโ generate GNU/Linux-compatible gUSA software atomic sequences for the atomic built-in functions. The generated atomic sequences require additional support from the interrupt/exception handling code of the system and are only suitable for SH3* and SH4* single-core systems. This option is enabled by default when the target issh*-*-linux*and SH3* or SH4*. When the target is SH4A, this option also partially utilizes the hardware atomic instructionsmovli.landmovco.lto create more efficient code, 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. don't forget it or it's over ๐soft-imaskโ generate software atomic sequences that temporarily disable interrupts by settingSR.IMASK = 1111. This model works only when the program runs in privileged mode and is only suitable for single-core systems. Additional support from the interrupt/exception handling code of the system is not required. This model is enabled by default when the target issh*-*-linux*and SH1* or SH2*.hard-llcsโ generate hardware atomic sequences using themovli.landmovco.linstructions only. This is only available on SH4A and is suitable for multi-core systems. Since the hardware instructions support only 32-bit atomic variables, access to 8- or 16-bit variables is emulated with 32-bit accesses. Code compiled with this option is also compatible with other software atomic model interrupt/exception handling systems if executed on an SH4A system. Additional support from the interrupt/exception handling code of the system is not required for this model.gbr-offset=โ this parameter specifies the offset in bytes of the variable in the thread control block structure that should be used by the generated atomic sequences when thesoft-tcbmodel has been selected. For other models this parameter is ignored. The specified value must be an integer multiple of four and in the range 0-1020.strictโ this parameter prevents mixed usage of multiple atomic models, even if they are compatible, and makes the compiler generate atomic sequences of the specified model only. no mixing, she's monogamous to one model periodt ๐
-mtasโ generate thetas.bopcode for__atomic_test_and_set. Notice that depending on the particular hardware and software configuration this can degrade overall performance due to the operand cache line flushes that are implied by thetas.binstruction. On multi-core SH4A processors thetas.binstruction must be used with caution since it can result in data corruption for certain cache configurations. ๐ณ data corruption is NOT the vibe, be careful-mprefergotโ when generating position-independent code, emit function calls using the Global Offset Table instead of the Procedure Linkage Table.-musermode-mno-usermodeโ don't allow (allow) the compiler to generate privileged mode code. Specifying-musermodealso implies-mno-inline-ic_invalidateif the inlined code would not work in user mode.-musermodeis the default when the target issh*-*-linux*. If the target is SH1* or SH2*-musermodehas no effect, since there is no user mode. (no user mode, no problem โจ)-multcost=numberโ set the cost to assume for a multiply instruction.-mdiv=strategyโ set the division strategy to be used for integer division operations. strategy can be one of:call-div1โ calls a library function that uses the single-step division instructiondiv1to perform the operation. Division by zero calculates an unspecified result and does not trap. This is the default except for SH4, SH2A and SHcompact.call-fpโ calls a library function that performs the operation in double precision floating point. Division by zero causes a floating-point exception. This is the default for SHcompact with FPU. Specifying this for targets that do not have a double-precision FPU defaults tocall-div1.
call-tableโ calls a library function that uses a lookup table for small divisors and the"div1"instruction with case distinction for larger divisors. Division by zero calculates an unspecified result and does not trap. This is the default for SH4. Specifying this for targets that do not have dynamic shift instructions defaults to"call-div1". periodt ๐
When a division strategy has not been specified, the default strategy is selected based on the current target. For SH2A the default strategy is to use the "divs" and "divu" instructions instead of library function calls. slay โจ
-maccumulate-outgoing-args,-mno-accumulate-outgoing-argsโ reserve space once for outgoing arguments in the function prologue rather than around each call. This is generally beneficial for performance and size, and also needed for unwinding to avoid changing the stack frame around conditional code.-maccumulate-outgoing-argsis enabled by default. iconic ๐ซถ-mdivsi3_libfunc=nameโ set the name of the library function used for 32-bit signed division to name. This only affects the name used in the call division strategies, and the compiler still expects the same sets of input/output/clobbered registers as if this option were not present.-mfixed-range=register-rangeโ generate code treating the given register range as fixed registers. A fixed register is one that the register allocator cannot use. This is useful when compiling kernel code. A register range is specified as two registers separated by a dash. Multiple register ranges can be specified separated by a comma.-mbranch-cost=numโ assume num to be the cost for a branch instruction. Higher numbers make the compiler try to generate more branch-free code if possible. If not specified the value is selected depending on the processor type that is being compiled for.-mzdcbranch,-mno-zdcbranchโ assume (do not assume) that zero displacement conditional branch instructions"bt"and"bf"are fast. If-mzdcbranchis specified, the compiler prefers zero displacement branch code sequences. This is enabled by default when generating code for SH4 and SH4A. It can be explicitly disabled by specifying-mno-zdcbranch.-mcbranch-force-delay-slotโ force the usage of delay slots for conditional branches, which stuffs the delay slot with a"nop"if a suitable instruction cannot be found. By default this option is disabled. It can be enabled to work around hardware bugs as found in the original SH7055.-mfsca,-mno-fscaโ allow or disallow the compiler to emit the"fsca"instruction for sine and cosine approximations. The option-mfscamust be used in combination with-funsafe-math-optimizations. It is enabled by default when generating code for SH4A. Using-mno-fscadisables sine and cosine approximations even if-funsafe-math-optimizationsis in effect.-mfsrra,-mno-fsrraโ allow or disallow the compiler to emit the"fsrra"instruction for reciprocal square root approximations. The option-mfsrramust be used in combination with-funsafe-math-optimizationsand-ffinite-math-only. It is enabled by default when generating code for SH4A. Using-mno-fsrradisables reciprocal square root approximations even if-funsafe-math-optimizationsand-ffinite-math-onlyare in effect.-mpretend-cmove,-mno-pretend-cmoveโ prefer or don't prefer zero-displacement conditional branches for conditional move instruction patterns. This can result in faster code on the SH4 processor.-mfdpic,-mno-fdpicโ generate code using the FDPIC ABI.-mlra,-mno-lraโ use the new LRA register allocator. By default, the old"reload"allocator is used.
๐ Solaris 2 Options ๐
These options are supported on Solaris 2: iykyk ๐
-mclear-hwcap,-mno-clear-hwcapโ-mclear-hwcaptells the compiler to remove the hardware capabilities generated by the Solaris assembler. This is only necessary when object files use ISA extensions not supported by the current machine, but check at runtime whether or not to use them.-mimpure-text,-mno-impure-textโ-mimpure-text, used in addition to-shared, tells the compiler to not pass-z textto the linker when linking a shared object. Using this option, you can link position-dependent code into a shared object.-mimpure-textsuppresses the"relocations remain against allocatable but non-writable sections"linker error message. However, the necessary relocations trigger copy-on-write, and the shared object is not actually shared across processes. Instead of using-mimpure-text, you should compile all source code with-fpicor-fPIC.-gsctfโ generate Solaris CTF. Needs to be used both for compilation and linking. Seectf(7)for more information. This is only supported since Solaris 11.4 SRU 84 where the necessary toolchain support was added.
๐ SPARC Options ๐
These -m options are supported on the SPARC: periodt ๐
-mno-app-regs,-mapp-regsโ specify-mapp-regsto generate output using the global registers 2 through 4, which the SPARC SVR4 ABI reserves for applications. Like the global register 1, each global register 2 through 4 is then treated as an allocable register that is clobbered by function calls. This is the default. To be fully SVR4 ABI-compliant at the cost of some performance loss, specify-mno-app-regs. You should compile libraries and system software with this option.-mflat,-mno-flatโ with-mflat, the compiler does not generate save/restore instructions and uses a"flat"or single register window model. This model is compatible with the regular register window model. The local registers and the input registers (0--5) are still treated as"call-saved"registers and are saved on the stack as needed. With-mno-flat(the default), the compiler generates save/restore instructions (except for leaf functions). This is the normal operating mode.-mfpu,-mhard-floatโ generate output containing floating-point instructions. This is the default.-mno-fpu,-msoft-floatโ generate output containing library calls for floating point. Warning: the requisite libraries are not available for all SPARC targets. Normally the facilities of the machine's usual C compiler are used, but this cannot be done directly in cross-compilation. You must make your own arrangements to provide suitable library functions for cross-compilation. The embedded targetssparc-*-aoutandsparclite-*-*do provide software floating-point support.-msoft-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.-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-floatoption is the default.-mno-unaligned-doubles,-munaligned-doublesโ assume that doubles have 8-byte alignment. This is the default. With-munaligned-doubles, GCC assumes that doubles have 8-byte alignment only if they are contained in another type, or if they have an absolute address. Otherwise, it assumes they have 4-byte alignment. Specifying this option avoids some rare compatibility problems with code generated by other compilers. It is not the default because it results in a performance loss, especially for floating-point code.-muser-mode,-mno-user-modeโ do not generate code that can only run in supervisor mode. This is relevant only for the"casa"instruction emitted for the LEON3 processor. This is the default.-mfaster-structs,-mno-faster-structsโ with-mfaster-structs, the compiler assumes that structures should have 8-byte alignment. This enables the use of pairs of"ldd"and"std"instructions for copies in structure assignment, in place of twice as many"ld"and"st"pairs. However, the use of this changed alignment directly violates the SPARC ABI. Thus, it's intended only for use on targets where the developer acknowledges that their resulting code is not directly in line with the rules of the ABI.-mstd-struct-return,-mno-std-struct-returnโ with-mstd-struct-return, the compiler generates checking code in functions returning structures or unions to detect size mismatches between the two sides of function calls, as per the 32-bit ABI. The default is-mno-std-struct-return. This option has no effect in 64-bit mode.-mcpu=cpu_typeโ set the instruction set, register set, and instruction scheduling parameters for machine type cpu_type. Supported values for cpu_type arev7,cypress,v8,supersparc,hypersparc,leon,leon3,leon3v7,leon5,sparclite,f930,f934,sparclite86x,sparclet,tsc701,v9,ultrasparc,ultrasparc3,niagara,niagara2,niagara3,niagara4,niagara7andm8. Native Solaris and GNU/Linux toolchains also support the valuenative, which selects the best architecture option for the host processor.-mcpu=nativehas no effect if GCC does not recognize the processor. Default instruction scheduling parameters are used for values that select an architecture and not an implementation. These arev7,v8,sparclite,sparclet,v9. Here is a list of each supported architecture and their supported implementations.v7โcypress,leon3v7v8โsupersparc,hypersparc,leon,leon3,leon5sparcliteโf930,f934,sparclite86xsparcletโtsc701v9โultrasparc,ultrasparc3,niagara,niagara2,niagara3,niagara4,niagara7,m8
By default (unless somebody configured your toolchain otherwise, which, rude), GCC generates code for the V7 variant of the SPARC architecture. And with -mcpu=cypress, the compiler additionally optimizes it for the Cypress CY7C602 chip, the one living inside the SPARCStation/SPARCServer 3xx series. It's also the right vibe 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. And 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 โ that's 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, it additionally optimizes for the Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips. With -mcpu=niagara, it additionally optimizes for Sun UltraSPARC T1 chips. With -mcpu=niagara2, it's Sun UltraSPARC T2 chips. With -mcpu=niagara3, Sun UltraSPARC T3 chips. With -mcpu=niagara4, Sun UltraSPARC T4 chips. With -mcpu=niagara7, Oracle SPARC M7 chips. And with -mcpu=m8, the compiler additionally optimizes it for Oracle M8 chips. the whole silicon family tree, fr fr ๐
-mtune=cpu_typeโ sets the instruction scheduling parameters for machine type cpu_type, but does NOT set the instruction set or register set the way-mcpu=cpu_typedoes.
The same values you'd pass to -mcpu=cpu_type can be used for -mtune=cpu_type, but the only useful values are the ones that select a particular CPU implementation. Those are: cypress, supersparc, hypersparc, leon, leon3, leon3v7, leon5, f930, f934, sparclite86x, tsc701, ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7 and m8. With native Solaris and GNU/Linux toolchains, native can also be used. ๐ซถ
-mv8plus,-mno-v8plusโ with-mv8plus, GCC generates code for the SPARC-V8+ ABI. The difference from the V8 ABI is that the global and out registers are considered 64 bits wide. This is enabled by default on Solaris in 32-bit mode for all SPARC-V9 processors. ๐ซ-mvis,-mno-visโ with-mvis, GCC generates code that takes advantage of the UltraSPARC Visual Instruction Set extensions. The default is-mno-vis.-mvis2,-mno-vis2โ with-mvis2, GCC generates code that takes advantage of version 2.0 of the UltraSPARC Visual Instruction Set extensions. The default is-mvis2when targeting a cpu that supports such instructions, such as UltraSPARC-III and later. Setting-mvis2also sets-mvis. โจ-mvis3,-mno-vis3โ with-mvis3, GCC generates code that takes advantage of version 3.0 of the UltraSPARC Visual Instruction Set extensions. The default is-mvis3when targeting a cpu that supports such instructions, such as niagara-3 and later. Setting-mvis3also sets-mvis2and-mvis.-mvis3b,-mno-vis3bโ with-mvis3b, GCC generates code that takes advantage of version 3.0 of the UltraSPARC Visual Instruction Set extensions, plus the additional VIS instructions introduced in the Oracle SPARC Architecture 2011. The default is-mvis3bwhen targeting a cpu that supports such instructions, such as niagara-7 and later. Setting-mvis3balso sets-mvis3,-mvis2and-mvis. ๐ฆ-mvis4,-mno-vis4โ with-mvis4, GCC generates code that takes advantage of version 4.0 of the UltraSPARC Visual Instruction Set extensions. The default is-mvis4when targeting a cpu that supports such instructions, such as niagara-7 and later. Setting-mvis4also sets-mvis3b,-mvis3,-mvis2and-mvis.-mvis4b,-mno-vis4bโ with-mvis4b, GCC generates code that takes advantage of version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus the additional VIS instructions introduced in the Oracle SPARC Architecture 2017. The default is-mvis4bwhen targeting a cpu that supports such instructions, such as m8 and later. Setting-mvis4balso sets-mvis4,-mvis3b,-mvis3,-mvis2and-mvis. ๐-mcbcond,-mno-cbcondโ with-mcbcond, GCC generates code that takes advantage of the UltraSPARC Compare-and-Branch-on-Condition instructions. The default is-mcbcondwhen targeting a CPU that supports such instructions, such as Niagara-4 and later.-mfmaf,-mno-fmafโ with-mfmaf, GCC generates code that takes advantage of the UltraSPARC Fused Multiply-Add Floating-point instructions. The default is-mfmafwhen targeting a CPU that supports such instructions, such as Niagara-3 and later. ๐ฅ-mfsmuld,-mno-fsmuldโ with-mfsmuld, GCC generates code that takes advantage of the Floating-point Multiply Single to Double (FsMULd) instruction. The default is-mfsmuldwhen targeting a CPU supporting the architecture versions V8 or V9 with FPU โ except-mcpu=leon. ๐-mpopc,-mno-popcโ with-mpopc, GCC generates code that takes advantage of the UltraSPARC Population Count instruction. The default is-mpopcwhen targeting a CPU that supports such an instruction, such as Niagara-2 and later.-msubxc,-mno-subxcโ with-msubxc, GCC generates code that takes advantage of the UltraSPARC Subtract-Extended-with-Carry instruction. The default is-msubxcwhen targeting a CPU that supports such an instruction, such as Niagara-7 and later.-mfix-at697fโ enables the documented workaround for the single erratum of the Atmel AT697F processor (which corresponds to erratum #13 of the AT697E processor). ๐ฉน-mfix-ut699โ enables the documented workarounds for the floating-point errata and the data cache nullify errata of the UT699 processor.-mfix-ut700โ enables the documented workaround for the back-to-back store errata of the UT699E/UT700 processor.-mfix-gr712rcโ enables 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. ๐-mptr32,-mptr64โ use 32- or 64-bit pointers, respectively. Unlike the-m32and-m64options, this affects only the pointer size and not the ABI.-mcmodel=whichโ set the code model to one of:medlowโ the Medium/Low code model: 64-bit addresses, programs must be linked in the low 32 bits of memory. Programs can be statically or dynamically linked.medmidโ the Medium/Middle code model: 64-bit addresses, programs must be linked in the low 44 bits of memory, the text and data segments must be less than 2GB in size and the data segment must be located within 2GB of the text segment.medanyโ the Medium/Anywhere code model: 64-bit addresses, programs may be linked anywhere in memory, the text and data segments must be less than 2GB in size and the data segment must be located within 2GB of the text segment.embmedanyโ the Medium/Anywhere code model for embedded systems: 64-bit addresses, the text and data segments must be less than 2GB in size, both starting anywhere in memory (determined at link time). The global register%g4points to the base of the data segment. Programs are statically linked and PIC is not supported. ๐
-mmemory-model=mem-modelโ set the memory model in force on the processor to one of:defaultโ the default memory model for the processor and operating system.rmoโ Relaxed Memory Orderpsoโ Partial Store Ordertsoโ Total Store Orderscโ Sequential Consistency
These memory models are formally defined in Appendix D of the SPARC-V9 architecture manual, as set in the processor's "PSTATE.MM" field. ๐
-mstack-bias,-mno-stack-biasโ with-mstack-bias, GCC assumes that the stack pointer, and frame pointer if present, are offset by -2047, which must be added back when making stack frame references. This is the default in 64-bit mode. Otherwise, assume no such offset is present.
๐ Options for System V ๐
These additional options are available on System V Release 4 for compatibility with other compilers on those systems:
-Gโ create a shared object. It is recommended that-symbolicor-sharedbe used instead. > bestie, take the hint โ this one's the old way ๐ซ-YP,dirsโ search the directories dirs, and no others, for libraries specified with-l.-Ym,dirโ look in the directory dir to find the M4 preprocessor. The assembler uses this option.
๐ฆ V850 Options ๐ฆ
These -m options are defined for V850 implementations:
-mlong-calls,-mno-long-callsโ treat all calls as being far away (near). If calls are assumed to be far away, the compiler always loads the function's address into a register, and calls indirect through the pointer. ๐-mno-ep,-mepโ bestie, this one's about optimizing basic blocks that use the same index pointer 4 or more times to copy that pointer into the"ep"register and then use the shorter"sld"and"sst"instructions. So-mep= do optimize,-mno-ep= don't. The-mepoption is on by default if you optimize. โจ-mno-prolog-function,-mprolog-functionโ do not use (or do use) external functions to save and restore registers at the prologue and epilogue of a function. The external functions are slower, but they 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. Tiny code, tiny vibe. ๐-mtda=nโ put static or global variables whose size is n bytes or less into the tiny data area that register"ep"points to. Heads up: the tiny data area can hold up to 256 bytes in total (128 bytes for byte references). ๐-msda=nโ put static or global variables whose size is n bytes or less into the small data area that register"gp"points to. The small data area can hold up to 64 kilobytes.-mzda=nโ put static or global variables whose size is n bytes or less into the first 32 kilobytes of memory.-mv850โ specify that the target processor is the V850. periodt.-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. (yes, same target, different name, it's giving sibling energy ๐ซถ)-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โ specify that the target processor is the V850E. The preprocessor constant__v850e__is defined if this option is used.
If neither -mv850 nor -mv850e nor -mv850e1 nor -mv850e2 nor -mv850e2v3 nor -mv850e3v5 are defined, then a default target processor is chosen and the relevant __v850*__ preprocessor constant is defined.
The preprocessor constants __v850 and __v851__ are always defined, regardless of which processor variant is the target. no cap. ๐
-mdisable-callt,-mno-disable-calltโ this option suppresses generation of the"CALLT"instruction for the v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850 architecture.
This option is enabled by default when the RH850 ABI is in use (see -mrh850-abi), and disabled by default when the GCC ABI is in use. If "CALLT" instructions are being generated then the C preprocessor symbol __V850_CALLT__ is defined.
-mrelax,-mno-relaxโ pass on (or do not pass on) the-mrelaxcommand-line option to the assembler. simple as that ๐-mlong-jumps,-mno-long-jumpsโ disable (or re-enable) the generation of PC-relative jump instructions.-msoft-float,-mhard-floatโ disable (or re-enable) the generation of hardware floating point instructions. This option is only significant when the target architecture is V850E2V3 or higher. If hardware floating point instructions are being generated then the C preprocessor symbol__FPU_OK__is defined, otherwise the symbol__NO_FPU__is defined. ๐งฎ-mloopโ enables the use of the e3v5 LOOP instruction. The use of this instruction is not enabled by default when the e3v5 architecture is selected, because its use is still experimental. ๐-mrh850-abi,-mghsโ enables support for the RH850 version of the V850 ABI. This is the default. With this version of the ABI the following rules apply:- Integer sized structures and unions are returned via a memory pointer rather than a register.
- Large structures and unions (more than 8 bytes in size) are passed by value.
- Functions are aligned to 16-bit boundaries.
- The
-m8byte-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 for"double"and"long long"types to be aligned on 8-byte boundaries. The default is to restrict the alignment of all objects to at most 4-bytes. When-m8byte-alignis in effect the C preprocessor symbol__V850_8BYTE_ALIGN__is defined.-mbig-switch,-mno-big-switchโ generate code suitable for big switch tables. Use this option only if the assembler/linker complain about out of range branches within a switch table. ๐จ-mapp-regs,-mno-app-regsโ-mapp-regscausesr2andr5to be used in the code generated by the compiler. This setting is the default.-mno-app-regscausesr2andr5to be treated as fixed registers.-msmall-sld,-mno-small-sldโ enable or disable the use of the short load instructions.-mno-strict-alignโ do not enforce strict data alignment.-mjump-tables-in-data-section,-mno-jump-tables-in-data-sectionโ enable or disable placement of jump tables for switch statements in the".data"section rather than the".code"section. The default is-mno-jump-tables-in-data-section.
โจ VAX Options โจ
These -m options are defined for the VAX, bestie, and they're a whole vintage moment ๐ฆ:
-munixโ do not output certain jump instructions ("aobleq"and so on) that the Unix assembler for the VAX cannot handle across long ranges.-mgnuโ do output those jump instructions, on the assumption that the GNU assembler is being used.-md,-md-floatโ use the D_floating data format for double-precision floating-point numbers instead of G_floating.-mg,-mg-floatโ use the G_floating data format for double-precision floating-point numbers instead of D_floating.-mlra,-mno-lraโ enable Local Register Allocation. This is still experimental for the VAX, so by default the compiler uses standard reload.-mvaxc-alignmentโ use VAXC conventions for alignment of structure members.-mqmath,-mno-qmathโ enable or disable new instruction patterns for 64-bit integer addition and subtraction.
๐ Visium Options ๐
-mdebugโ use this option when linking programs that perform file I/O and are destined to run on an MCM target. It causes the librarieslibc.aandlibdebug.ato be linked. You should run program on the the target under the control of the GDB remote debugging stub. ๐-msimโ use this option when linking programs that perform file I/O and are destined to run on the simulator. It causes the librarieslibc.aandlibsim.ato be linked.-mfpu,-mhard-floatโ generate code containing floating-point instructions. This is the default. ๐-mno-fpu,-msoft-floatโ generate code containing library calls for floating-point.
โ ๏ธ-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.
-mcpu=cpu_typeโ set the instruction set, register set, and instruction scheduling parameters for machine type cpu_type. Supported values for cpu_type aremcm,gr5andgr6.
mcm is a synonym of gr5 present for backward compatibility.
By default (unless configured otherwise), GCC generates code for the GR5 variant of the Visium architecture.
With -mcpu=gr6, GCC generates code for the GR6 variant of the Visium architecture. The only difference from GR5 code is that the compiler will generate block move instructions. ๐ฅ
-mtune=cpu_typeโ set the instruction scheduling parameters for machine type cpu_type, but do not set the instruction set or register set that the option-mcpu=cpu_typewould.-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 from"main". The default is to return POSIX-style condition (e.g. error) codes.-mdebug-main=prefixโ flag the first routine whose name starts with prefix as the main routine for the debugger.-mmalloc64โ default to 64-bit memory allocation routines.-mpointer-size=sizeโ set the default size of pointers. Possible options for size are32orshortfor 32 bit pointers,64orlongfor 64 bit pointers, andnofor supporting only 32 bit pointers. The later option disables"pragma pointer_size".
๐ธ VxWorks Options ๐ธ
The options in this section are defined for all VxWorks targets. Options specific to the target hardware are listed with the other options for that target. iykyk ๐ซถ
-mrtpโ bestie, GCC can build code for BOTH VxWorks kernels and real time processes (RTPs) ๐. This flag switches you from the former to the latter. It also defines the preprocessor macro__RTP__.-msmpโ picks SMP runtimes for linking. Not available on architectures other than PowerPC, and not on VxWorks version 7 or later, where the selection is part of the VxWorks build configuration and the library paths are the same for either choice. ๐-mvthreadsโ link against the VxWorks AE vThread runtime environment.-non-staticโ link an RTP executable against shared libraries rather than static libraries. The options-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 ๐ฆ
This section documents -m options available for the x86 family of computers. ๐
The following group of options allows compilation to target a specific processor.
-march=cpu-typeโ generate instructions for the machine type cpu-type. In contrast to-mtune=cpu-type, which merely tunes the generated code for the specified cpu-type,-march=cpu-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, except where noted otherwise. ๐ญ (yes this is the "it will crash on your friend's laptop" flag, no cap)
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, MMX, SSE, SSE2, and FXSR instruction set support.x86-64-v2x86-64-v3x86-64-v4โ these choices for cpu-type select the corresponding micro-architecture level from the x86-64 psABI. On ABIs other than the x86-64 psABI they select the same CPU features as the x86-64 psABI documents for the particular micro-architecture level.
Since these cpu-type values do not have a corresponding -mtune setting, using -march with these values enables generic tuning. Specific tuning can be enabled using the -mtune=other-cpu-type option with an appropriate other-cpu-type value.
i386โ original Intel i386 CPU.i486โ Intel i486 CPU. (No scheduling is implemented for this chip.)i586pentiumโ Intel Pentium CPU with no MMX support.lakemontโ Intel Lakemont MCU, based on Intel Pentium CPU.pentium-mmxโ Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.pentiumproโ Intel Pentium Pro CPU with no MMX support.i686โ when used with-march, the Pentium Pro instruction set is used, so the code runs on all i686 family chips. When used with-mtune, it has the same meaning asgeneric.pentium2โ Intel Pentium II CPU, based on Pentium Pro core with MMX and FXSR instruction set support.pentium3pentium3mโ Intel Pentium III CPU, based on Pentium Pro core with MMX, FXSR and SSE instruction set support.pentium-mโ Intel Pentium M; low-power version of Intel Pentium III CPU with MMX, SSE, SSE2 and FXSR instruction set support. Used by Centrino notebooks. ๐pentium4pentium4mโ Intel Pentium 4 CPU with MMX, SSE, SSE2 and FXSR instruction set support.prescottโ improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2, SSE3 and FXSR instruction set support.noconaโ improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, CX16 and FXSR instruction set support.core2โ Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, CX16, SAHF and FXSR instruction set support.nehalemcorei7โ Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF and FXSR instruction set support.westmereโ Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR and PCLMUL instruction set support.sandybridgecorei7-avxโ Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE and PCLMUL instruction set support.ivybridgecore-avx-iโ Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND and F16C instruction set support.haswellcore-avx2โ Intel Haswell CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE and HLE instruction set support.broadwellโ Intel Broadwell CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX and PREFETCHW instruction set support.skylakeโ Intel Skylake CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES and SGX instruction set support.skylake-avx512โ Intel Skylake Server CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.cascadelakeโ Intel Cascade Lake CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, CLWB, AVX512VL, AVX512BW, AVX512DQ, AVX512CD and AVX512VNNI instruction set support.cannonlakeโ Intel Cannon Lake Server CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA and SHA instruction set support.cooperlakeโ Intel Cooper Lake CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, CLWB, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VNNI and AVX512BF16 instruction set support.icelake-clientโ Intel Ice Lake Client CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2 , VPCLMULQDQ, AVX512BITALG, RDPID and AVX512VPOPCNTDQ instruction set support. ๐งicelake-serverโ Intel Ice Lake Server CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2 , VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD and CLWB instruction set support.tigerlakeโ Intel Tiger Lake CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, MOVDIRI, MOVDIR64B, CLWB, AVX512VP2INTERSECT and KEYLOCKER instruction set support.rocketlakeโ Intel Rocket Lake CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID and AVX512VPOPCNTDQ instruction set support.alderlake,raptorlake,meteorlake,gracemontโ Intel Alder Lake / Raptor Lake / Meteor Lake / Gracemont CPU, and bestie she comes with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL and AVX-VNNI instruction set support. โจarrowlakeโ Intel Arrow Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT and CMPCCXADD instruction set support. ๐arrowlake-s,lunarlakeโ Intel Arrow Lake S / Lunar Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3 and SM4 instruction set support. ๐ฆpantherlake,wildcatlakeโ Intel Panther Lake / Wildcat Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, AVX-VNNI, UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3 and SM4 instruction set support. ๐novalakeโ Intel Nova Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, AVX-VNNI, UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3, SM4, PREFETCHI, APX_F, AVX10.1, AVX10.2 and MOVRS instruction set support. ๐sapphirerapids,emeraldrapidsโ Intel Sapphire Rapids / Emerald Rapids CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512-FP16 and AVX512BF16 instruction set support. ๐graniterapidsโ Intel Granite Rapids CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512-FP16, AVX512BF16, AMX-FP16 and PREFETCHI instruction set support. ๐ชจgraniterapids-dโ Intel Granite Rapids D CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512FP16, AVX512BF16, AMX-FP16, PREFETCHI and AMX-COMPLEX instruction set support. ๐งdiamondrapidsโ Intel Diamond Rapids CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512FP16, AVX512BF16, AMX-FP16, PREFETCHI, AMX-COMPLEX, AVX10.1-512, AVX-IFMA, AVX-NE-CONVERT, AVX-VNNI-INT16, AVX-VNNI-INT8, CMPccXADD, SHA512, SM3, SM4, AVX10.2-512, APX_F, AMX-AVX512, AMX-FP8, MOVRS and AMX-MOVRS instruction set support. ๐
bonnell,atomโ Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3 and CX16 instruction set support. ๐silvermont,slmโ Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW and RDRND instruction set support. ๐ธgoldmontโ Intel Goldmont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW, RDRND, AES, SHA, RDSEED, XSAVE, XSAVEC, XSAVES, XSAVEOPT, CLFLUSHOPT and FSGSBASE instruction set support. โญgoldmont-plusโ Intel Goldmont Plus CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW, RDRND, AES, SHA, RDSEED, XSAVE, XSAVEC, XSAVES, XSAVEOPT, CLFLUSHOPT, FSGSBASE, PTWRITE, RDPID and SGX instruction set support. โจtremontโ Intel Tremont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW, RDRND, AES, SHA, RDSEED, XSAVE, XSAVEC, XSAVES, XSAVEOPT, CLFLUSHOPT, FSGSBASE, PTWRITE, RDPID, SGX, CLWB, GFNI-SSE, MOVDIRI, MOVDIR64B, CLDEMOTE and WAITPKG instruction set support. ๐ฆsierraforestโ Intel Sierra Forest CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, CLDEMOTE, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, ENQCMD and UINTR instruction set support. ๐ฒgrandridgeโ Intel Grand Ridge CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, CLDEMOTE, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, ENQCMD and UINTR instruction set support. โฐ๏ธclearwaterforestโ Intel Clearwater Forest CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, CLDEMOTE, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, AVX-VNNI, ENQCMD, UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3, SM4, USER_MSR and PREFETCHI instruction set support. ๐ง
And now we hop over to Team Red, because AMD girlies deserve their moment too ๐
k6โ AMD K6 CPU with MMX instruction set support.k6-2,k6-3โ Improved versions of AMD K6 CPU with MMX and 3DNow! instruction set support.athlon,athlon-tbirdโ AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow! and SSE prefetch instructions support.athlon-4,athlon-xp,athlon-mpโ Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow! and full SSE instruction set support.k8,opteron,athlon64,athlon-fxโ Processors based on the AMD K8 core with x86-64 instruction set support, including the AMD Opteron, Athlon 64, and Athlon 64 FX processors. (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow! and 64-bit instruction set extensions.) ๐ฅk8-sse3,opteron-sse3,athlon64-sse3โ Improved versions of AMD K8 cores with SSE3 instruction set support.amdfam10,barcelonaโ CPUs based on AMD Family 10h cores with x86-64 instruction set support. (This supersets CX16, MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit instruction set extensions.) ๐bdver1โ bestie this is for CPUs based on AMD Family 15h cores with x86-64 instruction set support. โจ This one supersets FMA4, AVX, XOP, LWP, AES, PCLMUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions. like, it's giving everything on the list, periodt.bdver2โ AMD Family 15h core based CPUs with x86-64 instruction set support. This supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCLMUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions. ๐bdver3โ AMD Family 15h core based CPUs with x86-64 instruction set support. This supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, PCLMUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions. ๐ฆbdver4โ AMD Family 15h core based CPUs with x86-64 instruction set support. This supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions. ๐ธznver1โ AMD Family 17h core based CPUs with x86-64 instruction set support. This supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit instruction set extensions. ๐znver2โ AMD Family 17h core based CPUs with x86-64 instruction set support. This supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, WBNOINVD, and 64-bit instruction set extensions. โจznver3โ AMD Family 19h core based CPUs with x86-64 instruction set support. This supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, WBNOINVD, PKU, VPCLMULQDQ, VAES, and 64-bit instruction set extensions. ๐ฅznver4โ AMD Family 19h core based CPUs with x86-64 instruction set support. This supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, WBNOINVD, PKU, VPCLMULQDQ, VAES, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, AVX512VNNI, AVX512BITALG, AVX512VPOPCNTDQ, GFNI and 64-bit instruction set extensions. ๐znver5โ AMD Family 1ah core based CPUs with x86-64 instruction set support. This supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, WBNOINVD, PKU, VPCLMULQDQ, VAES, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, AVX512VNNI, AVX512BITALG, AVX512VPOPCNTDQ, GFNI, AVXVNNI, MOVDIRI, MOVDIR64B, AVX512VP2INTERSECT, PREFETCHI and 64-bit instruction set extensions. ๐znver6โ AMD Family 1ah core based CPUs with x86-64 instruction set support. This supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, WBNOINVD, PKU, VPCLMULQDQ, VAES, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, AVX512VNNI, AVX512BITALG, AVX512VPOPCNTDQ, GFNI, AVXVNNI, MOVDIRI, MOVDIR64B, AVX512VP2INTERSECT, PREFETCHI, AVXVNNIINT8, AVXIFMA, AVX512FP16, AVXNECONVERT, AVX512BMM and 64-bit instruction set extensions. ๐btver1โ CPUs based on AMD Family 14h cores with x86-64 instruction set support. This supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit instruction set extensions. ๐btver2โ CPUs based on AMD Family 16h cores with x86-64 instruction set support. This one includes MOVBE, F16C, BMI, AVX, PCLMUL, AES, SSE4.2, SSE4.1, CX16, ABM, SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions. ๐ธwinchip-c6โ IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction set support. ngl it's giving vintage. ๐winchip2โ IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow! instruction set support. ๐ฆc3โ VIA C3 CPU with MMX and 3DNow! instruction set support. (No scheduling is implemented for this chip.) ๐ซถc3-2โ VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support. (No scheduling is implemented for this chip.) โจc7โ VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support. (No scheduling is implemented for this chip.) ๐samuel-2โ VIA Eden Samuel 2 CPU with MMX and 3DNow! instruction set support. (No scheduling is implemented for this chip.) ๐ธnehemiahโ VIA Eden Nehemiah CPU with MMX and SSE instruction set support. (No scheduling is implemented for this chip.) ๐งestherโ VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support. (No scheduling is implemented for this chip.) ๐eden-x2โ VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support. (No scheduling is implemented for this chip.) โญeden-x4โ VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and AVX2 instruction set support. (No scheduling is implemented for this chip.) ๐ฅnanoโ Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support. (No scheduling is implemented for this chip.) ๐nano-1000โ VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support. (No scheduling is implemented for this chip.) ๐nano-2000โ VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support. (No scheduling is implemented for this chip.) ๐nano-3000โ VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 instruction set support. (No scheduling is implemented for this chip.) ๐ฆnano-x2โ VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 instruction set support. (No scheduling is implemented for this chip.) ๐nano-x4โ VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 instruction set support. (No scheduling is implemented for this chip.) ๐lujiazuiโ ZHAOXIN lujiazui CPU with x86-64, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE, CX16, ABM, BMI, BMI2, FXSR, RDSEED instruction set support. > bestie heads up: while the CPUs do support AVX and F16C, these aren't enabled by-march=lujiazuifor performance reasons. so don't come for me when they're missing, it's intentional. ๐yongfengโ ZHAOXIN yongfeng CPU with x86-64, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE, CX16, ABM, BMI, BMI2, F16C, FXSR, RDSEED, AVX2, FMA, SHA, LZCNT instruction set support. โจshijidadaoโ ZHAOXIN shijidadao CPU with x86-64, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE, CX16, ABM, BMI, BMI2, F16C, FXSR, RDSEED, AVX2, FMA, SHA, LZCNT instruction set support. ๐geodeโ AMD Geode embedded processor with MMX and 3DNow! instruction set support. embedded girlies rise up ๐ซถc86-4g-m4โ HYGON c86-4g-m4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, CLFLUSHOPT, XSAVES, LZCNT, POPCNT instruction set support. ๐ธc86-4g-m6โ HYGON c86-4g-m6 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, CLFLUSHOPT, XSAVES, LZCNT, POPCNT instruction set support. ๐ฆc86-4g-m7โ HYGON c86-4g-m7 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, CLFLUSHOPT, XSAVES, LZCNT, POPCNT, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, GFNI, AVX512VNNI, VAES, AVX512BITALG, AVX512VPOPCNTDQ, AVX512VP2INTERSECT, AVXVNNI, VPCLMULQDQ, WBNOINVD instruction set support. ๐ฅc86-4g-m8โ HYGON c86-4g-m8 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, CLFLUSHOPT, XSAVES, LZCNT, POPCNT, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, GFNI, AVX512VNNI, VAES, AVX512BITALG, AVX512VPOPCNTDQ, AVX512VP2INTERSECT, AVXVNNI, VPCLMULQDQ, WBNOINVD instruction set support. ๐-mtune=cpu-typeโ tunes everything applicable about the generated code tocpu-type, except for the ABI and the set of available instructions. So like, picking a specificcpu-typeschedules stuff appropriately for that exact chip, but bestie listen: the compiler does not generate any code that can't run on the default machine type unless you also use a-march=cpu-typeoption. Example fr: if GCC is configured fori686-pc-linux-gnuthen-mtune=pentium4generates code that is tuned for Pentium 4 but still runs on i686 machines. ๐
The choices for cpu-type are the same as for -march. In addition, -mtune supports 2 extra choices for cpu-type:
genericโ 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 you should use this option. iykyk
As new processors are deployed in the marketplace, the behavior of this option will change. Therefore, if you upgrade to a newer version of GCC, code generation controlled by this option will change to reflect the processors that are most common at the time that version of GCC is released. not me getting a different binary from the same flags ๐
There is no -march=generic option because -march indicates the instruction set the compiler can use, and there is no generic instruction set applicable to all processors. In contrast, -mtune indicates the processor (or, in this case, collection of processors) for which the code is optimized. โจ
intelโ 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 performs better on both Diamond Rapids and Clearwater Forest, then you should use this option. ๐
As new Intel processors are deployed in the marketplace, the behavior of this option will change. Therefore, if you upgrade to a newer version of GCC, code generation controlled by this option will change to reflect the most current Intel processors at the time that version of GCC is released.
There is no -march=intel option because -march indicates the instruction set the compiler can use, and there is no common instruction set applicable to all processors. In contrast, -mtune indicates the processor (or, in this case, collection of processors) for which the code is optimized.
The following options allow more detailed control over which instruction set extensions are targeted by GCC. Each has a corresponding -mno-option to disable use of these instructions. ๐
These extensions are also available as built-in functions: see x86 Built-in Functions, for details of the functions enabled and disabled by these switches.
These options enable GCC to use these extended instructions in generated code. Applications that perform run-time CPU detection must compile separate files for each supported architecture, using the appropriate flags. In particular, the file containing the CPU detection code should be compiled without these options. ๐ซถ
To control whether 387 or SSE/AVX instructions are generated automatically for floating-point arithmetic, see -mfpmath=, below.
-mmmxโ Support MMX built-in functions.-msseโ Support MMX and SSE built-in functions and code generation.-msse2โ Support MMX, SSE and SSE2 built-in functions and code generation.-msse3โ Support MMX, SSE, SSE2 and SSE3 built-in functions and code generation.-mssse3โ Support MMX, SSE, SSE2, SSE3 and SSSE3 built-in functions and code generation.-msse4.1โ Support MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 built-in functions and code generation.-msse4.2โ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1 and SSE4.2 built-in functions and code generation.-msse4โ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1 and SSE4.2 built-in functions and code generation.
Note that-msse4enables both SSE4.1 and SSE4.2 support, while-mno-sse4turns off those features; neither form of the option affects SSE4A support, controlled separately by-msse4a. ๐จ
-msse4aโ Support MMX, SSE, SSE2, SSE3 and SSE4A built-in functions and code generation.-mavxโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2 and AVX built-in functions and code generation.-mavx2โ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and AVX2 built-in functions and code generation.-mavx512fโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2 and AVX512F built-in functions and code generation.-mavx512cdโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512CD built-in functions and code generation.-mavx512vlโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512VL built-in functions and code generation.-mavx512bwโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512BW built-in functions and code generation.-mavx512dqโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512DQ built-in functions and code generation.-mavx512ifmaโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512IFMA built-in functions and code generation.-mavx512vbmiโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512VBMI built-in functions and code generation.-mavx512vpopcntdqโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512VPOPCNTDQ built-in functions and code generation.-mavx512vp2intersectโ Support AVX512VP2INTERSECT built-in functions and code generation.-mavx512vnniโ Support AVX512VNNI built-in functions and code generation.-mavx512vbmi2โ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512VBMI2 built-in functions and code generation.-mavx512bf16โ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512BF16 built-in functions and code generation.-mavx512fp16โ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512-FP16 built-in functions and code generation.-mavx512bitalgโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and AVX512BITALG built-in functions and code generation.-mavx512bmmโ Support AVX512BMM built-in functions and code generation.-mavxvnniโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and AVXVNNI built-in functions and code generation.-mavxifmaโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and AVXIFMA built-in functions and code generation.-mavxvnniint8โ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2 and AVXVNNIINT8 built-in functions and code generation.-mavxneconvertโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and AVXNECONVERT built-in functions and code generation.-mavxvnniint16โ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2 and AVXVNNIINT16 built-in functions and code generation.-mavx10.1โ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and AVX10.1 built-in functions and code generation.-mavx10.2โ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX10.1 and AVX10.2 built-in functions and code generation.-mshaโ Support SHA1 and SHA256 built-in functions and code generation.-maesโ Support AES built-in functions and code generation.-mpclmulโ Support PCLMUL built-in functions and code generation.-mclflushoptโ Support CLFLUSHOPT instructions.-mclwbโ Support CLWB instruction.-mfsgsbaseโ Support FSGSBASE built-in functions and code generation.-mptwriteโ Support PTWRITE built-in functions and code generation.-mrdrndโ Support RDRND built-in functions and code generation.-mf16cโ Support F16C built-in functions and code generation.-mfmaโ Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and FMA built-in functions and code generation.-mfma4โ Support FMA4 built-in functions and code generation.-mpconfigโ Support PCONFIG built-in functions and code generation.-mwbnoinvdโ Support WBNOINVD built-in functions and code generation.-mprfchwโ Support PREFETCHW instruction.-mrdpidโ Support RDPID built-in functions and code generation.-mrdseedโ Support RDSEED instruction.-msgxโ Support SGX built-in functions and code generation.-mxopโ Support XOP built-in functions and code generation.-mlwpโ Support LWP built-in functions and code generation.-m3dnowโ Support 3DNow! built-in functions.-m3dnowaโ Support Athlon 3Dnow! built-in functions.-mpopcntโ Support code generation ofpopcntinstruction.-mabmโ Support code generation of Advanced Bit Manipulation (ABM) instructions.-madxโ Support flag-preserving add-carry instructions.-mbmiโ Support BMI built-in functions and code generation.-mbmi2โ Support BMI2 built-in functions and code generation.-mlzcntโ Support LZCNT built-in function and code generation.-mfxsrโ Support FXSAVE and FXRSTOR instructions.-mxsaveโ Support XSAVE and XRSTOR instructions.-mxsaveoptโ Support XSAVEOPT instruction.-mxsavecโ Support XSAVEC instructions.-mxsavesโ Support XSAVES and XRSTORS instructions.-mrtmโ Support RTM built-in functions and code generation.-mhleโ Support Hardware Lock Elision prefixes.-mtbmโ Support TBM built-in functions and code generation.-mmwaitxโ Support MWAITX and MONITORX built-in functions and code generation.-mclzeroโ Support CLZERO built-in functions and code generation.-mpkuโ Support PKU built-in functions and code generation.-mgfniโ Support GFNI built-in functions and code generation.-mvaesโ ok so this one turns on VAES built-in functions and code generation โจ-mwaitpkgโ supports WAITPKG built-in functions and code generation, bestie.-mvpclmulqdqโ supports VPCLMULQDQ built-in functions and code generation.-mmovdiriโ supports MOVDIRI built-in functions and code generation.-mmovdir64bโ supports MOVDIR64B built-in functions and code generation.-menqcmdโ supports ENQCMD built-in functions and code generation.-muintrโ supports UINTR built-in functions and code generation.-mtsxldtrkโ supports TSXLDTRK built-in functions and code generation.-mcldemoteโ supports CLDEMOTE built-in functions and code generation.-mserializeโ supports SERIALIZE built-in functions and code generation.-mamx-tileโ supports AMX-TILE built-in functions and code generation.-mamx-int8โ supports AMX-INT8 built-in functions and code generation.-mamx-bf16โ supports AMX-BF16 built-in functions and code generation.-mhresetโ supports HRESET built-in functions and code generation.-mklโ supports KL built-in functions and code generation.-mwideklโ supports WIDEKL built-in functions and code generation.-mcmpccxaddโ supports MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and CMPCCXADD build-in functions and code generation. (yes, the original really says "build-in", we're keeping it ๐)-mamx-fp16โ supports AMX-FP16 built-in functions and code generation.-mprefetchiโ supports PREFETCHI built-in functions and code generation.-mraointโ supports RAOINT built-in functions and code generation.-mamx-complexโ supports AMX-COMPLEX built-in functions and code generation.-msm3โ supports MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and SM3 built-in functions and code generation.-msm4โ supports MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and SM4 built-in functions and code generation.-msha512โ supports MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and SHA512 built-in functions and code generation.-mapxfโ supports code generation for APX features, including EGPR, PUSH2POP2, NDD, PPX, NF, CCMP and ZU. she's stacked, periodt ๐-musermsrโ supports USER_MSR built-in functions and code generation.-mamx-avx512โ supports MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX10.1, AVX10.2 and AMX-AVX512 built-in functions and code generation.-mamx-tf32โ supports AMX-TF32 built-in functions and code generation.-mamx-fp8โ supports AMX-FP8 built-in functions and code generation.-mmovrsโ supports MOVRS built-in functions and code generation.-mamx-movrsโ supports AMX-MOVRS built-in functions and code generation.
These additional options are available for the x86 processor family. ๐
-mfpmath=unitโ generate floating-point arithmetic for the selected unit. The choices for unit are:387โ use the standard 387 floating-point coprocessor that's on the majority of chips and emulated everywhere else. Code compiled with this runs almost everywhere, slay. The catch: temporary results get computed in 80-bit precision instead of the precision the type actually asked for, so you get slightly different results compared to most other chips. Peep-ffloat-storeif you want the whole story.
This is the default choice for non-Darwin x86-32 targets.
sseโ use the scalar floating-point instructions that live in the SSE instruction set. Pentium III and newer chips support this, and on the AMD side it's Athlon-4, Athlon XP and Athlon MP. The earlier version of SSE only supports single-precision arithmetic, so double and extended-precision arithmetic still get done with 387. A later version โ only on Pentium 4 and AMD x86-64 chips โ supports double-precision too.
For the x86-32 compiler you must use -march=cpu-type, -msse or -msse2 to enable SSE extensions and make this option actually do anything. For the x86-64 compiler these extensions are on by default.
The resulting code should be considerably faster in the majority of cases and dodges the numerical instability problems of 387 code, but it may break existing code that expects temporaries to be 80 bits. ๐ฌ
This is the default choice for the x86-64 compiler, Darwin x86-32 targets, and the default choice for x86-32 targets with the SSE2 instruction set when -ffast-math is enabled.
GCC depresses SSE instructions when -mavx (or another option enabling AVX extensions) is used. Instead, it generates new AVX instructions or AVX equivalents for all SSE instructions when needed.
sse,387sse+387bothโ attempt to utilize both instruction sets at once. This effectively doubles the available registers, and on chips with separate execution units for 387 and SSE it doubles the execution resources too. Use this one with care because it's still experimental โ the GCC register allocator doesn't model separate functional units well, so the performance is straight up unstable. ๐
-mieee-fp-mno-ieee-fpโ control whether the compiler uses IEEE floating-point comparisons or not. These correctly handle the case where the result of a comparison is unordered.-m80387-mhard-floatโ generate output containing 80387 instructions for floating point.-mno-80387-msoft-floatโ generate output containing library calls for floating point.
โ ๏ธ Warning: the requisite libraries are not part of GCC. Normally the facilities of the machine's usual C compiler get used, but that can't be done directly in cross-compilation. You have to make your own arrangements to provide suitable library functions for cross-compilation.
On machines where a function returns floating-point results in the 80387 register stack, some floating-point opcodes may be emitted even if -msoft-float is used.
-mno-fp-ret-in-387โ do not use the FPU registers for return values of functions.
The usual calling convention has functions return values of types float and double in an FPU register, even if there's no FPU. The idea is that the operating system should emulate an FPU.
The option -mno-fp-ret-in-387 causes such values to be returned in ordinary CPU registers instead.
-mno-fancy-math-387โ some 387 emulators don't support thesin,cosandsqrtinstructions for the 387. Specify this option to avoid generating those instructions. It gets overridden when-marchindicates that the target CPU always has an FPU and so the instruction doesn't need emulation. These instructions are not generated unless you also use the-funsafe-math-optimizationsswitch.-malign-double-mno-align-doubleโ control whether GCC alignsdouble,long double, andlong longvariables on a two-word boundary or a one-word boundary. Aligningdoublevariables on a two-word boundary produces code that runs somewhat faster on a Pentium, at the expense of more memory.
On x86-64, -malign-double is enabled by default.
โ ๏ธ Warning: if you use the -malign-double switch, structures containing the above types are aligned differently than the published application binary interface specifications for the x86-32 and are not binary compatible with structures in code compiled without that switch.
-m96bit-long-double-m128bit-long-doubleโ these switches control the size of thelong doubletype. The x86-32 application binary interface specifies the size to be 96 bits, so-m96bit-long-doubleis the default in 32-bit mode.
Modern architectures (Pentium and newer) prefer long double to be aligned to an 8- or 16-byte boundary. In arrays or structures conforming to the ABI, this isn't possible. So specifying -m128bit-long-double aligns long double to a 16-byte boundary by padding the long double with an additional 32-bit zero.
In the x86-64 compiler, -m128bit-long-double is the default choice since its ABI specifies that long double is aligned on a 16-byte boundary.
Notice that neither of these options enable any extra precision over the x87 standard of 80 bits for a long double.
โ ๏ธ Warning: if you override the default value for your target ABI, this changes the size of structures and arrays containinglong doublevariables, and it modifies the function calling convention for functions takinglong double. Hence they are not binary-compatible with code compiled without that switch.
-mlong-double-64-mlong-double-80-mlong-double-128โ these switches control the size 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, and it modifies the function calling convention for functions takinglong double. Hence they are not binary-compatible with code compiled without that switch.
-malign-data=typeโ control how GCC aligns variables. Supported values for type are:compatuses increased alignment value compatible with GCC 4.8 and earlier,abiuses alignment value as specified by the psABI, andcachelineuses increased alignment value to match the cache line size.compatis the default.-mlarge-data-threshold=thresholdโ when-mcmodel=mediumor-mcmodel=largeis specified, data objects larger than threshold are placed in large data sections. The default is65535.-mrtdโ use a different function-calling convention, in which functions that take a fixed number of arguments return with theret numinstruction, which pops their arguments while returning. This saves one instruction in the caller since there's no need to pop the arguments there. ๐
You can specify that an individual function is called with this calling sequence with the function attribute stdcall. You can also override the -mrtd option by using the function attribute cdecl.
โ ๏ธ bestie this calling convention is NOT vibing with the one Unix normally uses, so likeโฆ if you need to call libraries compiled with the Unix compiler, you literally cannot use it. periodt.
Also, you must provide function prototypes for all functions that take variable numbers of arguments (yes, including printf), otherwise GCC generates incorrect code for calls to those functions. it's giving chaos. ๐ญ
And on top of that? Seriously incorrect code results if you call a function with too many arguments. (Normally, extra arguments are harmlessly ignored. not here tho. ๐)
-mregparm=numโ controls how many registers get 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. no cap.
-msseregparmโ uses SSE register passing conventions forfloatanddoublearguments and return values. You can control this behavior for a specific function by using the function attributesseregparm.
๐จ Warning: if you use this switch then you must build all modules with the same value, including any libraries. This includes the system libraries and startup modules. (seeing a pattern? yeah. ๐ )
-mvect8-ret-in-memโ returns 8-byte vectors in memory instead of MMX registers. This is the default on VxWorks to match the ABI of the Sun Studio compilers until version 12. Only use this option if you need to remain compatible with existing code produced by those previous compiler versions or older versions of GCC. legacy behavior only, bestie ๐ซถ-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 is right, the name is not playing.
-mdaz-ftz-mno-daz-ftzโ the flush-to-zero (FTZ) and denormals-are-zero (DAZ) flags in the MXCSR register are used to control floating-point calculations. The-Ofast,-ffast-math, or-funsafe-math-optimizationsoptions normally link in startup code that sets these flags except when building a shared library (-shared). You can use the-mdaz-ftzand-mno-daz-ftzoptions to explicitly enable or disable setting these flags, regardless of other options passed to GCC. you're in control, queen ๐-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. old code meets new code, they hold hands ๐ซถ-mstack-arg-probeโ emit stack probing code in the function prologue. short king, gets straight to it.-mpreferred-stack-boundary=numโ attempt to keep the stack boundary aligned to a 2 raised tonumbyte boundary. If-mpreferred-stack-boundaryis not specified, the default is4(16 bytes or 128 bits).
๐จ Warning: When generating code for the x86-64 architecture with SSE extensions disabled,-mpreferred-stack-boundary=3can be used to keep the stack boundary aligned to 8 byte boundary. Since x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and intended to be used in controlled environment where stack space is important limitation. This option leads to wrong code when functions compiled with 16 byte stack alignment (such as functions from a standard library) are called with misaligned stack. In this case, SSE instructions may lead to misaligned memory access traps. In addition, variable arguments are handled incorrectly for 16 byte aligned objects (including x87long doubleand__int128), leading to wrong results. You must build all modules with-mpreferred-stack-boundary=3, including any libraries. This includes the system libraries and startup modules. ๐ read it twice, fr fr.
-mincoming-stack-boundary=numโ assume the incoming stack is aligned to a 2 raised tonumbyte boundary. If-mincoming-stack-boundaryis not specified, the one specified by-mpreferred-stack-boundaryis used.
On Pentium and Pentium Pro, double and long double values should be aligned to an 8-byte boundary (see -malign-double) or suffer significant run time performance penalties. On Pentium III, the Streaming SIMD Extension (SSE) data type __m128 may not work properly if it is not 16-byte aligned. ๐ญ
To ensure proper alignment of this values on the stack, the stack boundary must be as aligned as that required by any value stored on the stack. Further, every function must be generated such that it keeps the stack aligned. Thus calling a function compiled with a higher preferred stack boundary from a function compiled with a lower preferred stack boundary most likely misaligns the stack. It is recommended that libraries that use callbacks always use the default setting. โจ
This extra alignment does consume extra stack space, and generally increases code size. Code that is sensitive to stack space usage, such as embedded systems and operating system kernels, may want to reduce the preferred alignment to -mpreferred-stack-boundary=2. tiny stack energy, we respect it ๐
-mdump-tune-featuresโ this option instructs GCC to dump the names of the x86 performance tuning features and default settings. The names can be used in-mtune-ctrl=feature-list.-mtune-ctrl=feature-listโ this option is used to do fine-grain control of x86 code generation features.feature-listis a comma-separated list of feature names. See also-mdump-tune-features. When specified, the feature is turned on if it is not preceded with^; otherwise, it is turned off.-mtune-ctrl=feature-listis intended to be used by GCC developers. Using it may lead to code paths not covered by testing and can potentially result in compiler ICEs or runtime errors.
๐ bestie this one is dev-only. step away from the -mtune-ctrl. it's not for us.
-mno-defaultโ this option instructs GCC to turn off all tunable features. See also-mtune-ctrl=feature-listand-mdump-tune-features.-mcldโ this option instructs GCC to emit acldinstruction in the prologue of functions that use string instructions. String instructions depend on the DF flag to select between autoincrement or autodecrement mode. While the ABI specifies the DF flag to be cleared on function entry, some operating systems violate this specification by not clearing the DF flag in their exception dispatchers. The exception handler can be invoked with the DF flag set, which leads to wrong direction mode when string instructions are used. This option can be enabled by default on 32-bit x86 targets by configuring GCC with the--enable-cldconfigure option. Generation ofcldinstructions can be suppressed with the-mno-cldcompiler option in this case.-mvzeroupperโ this option instructs GCC to emit avzeroupperinstruction before a transfer of control flow out of the function to minimize the AVX to SSE transition penalty as well as remove unnecessaryzeroupperintrinsics. efficiency icon ๐-mstv-mno-stvโ enable/disable Scalar to Vectorization pass transforming 64-bit integer computation into vector ones. This optimization is restricted to-O2and higher.-mprefer-avx128โ this option instructs GCC to use 128-bit AVX instructions instead of 256-bit AVX instructions in the auto-vectorizer. smol but mighty ๐ธ-mprefer-vector-width=optโ this option instructs GCC to useopt-bit vector width in instructions instead of default on the selected platform.-mpartial-vector-fp-math-mno-partial-vector-fp-mathโ this option enables GCC to generate floating-point operations that might affect the set of floating-point status flags on partial vectors, where vector elements reside in the low part of the 128-bit SSE register. Unless-fno-trapping-mathis specified, the compiler guarantees correct behavior by sanitizing all input operands to have zeroes in the unused upper part of the vector register. Note that by using built-in functions or inline assembly with partial vector arguments, NaNs, denormal or invalid values can leak into the upper part of the vector, causing possible performance issues when-fno-trapping-mathis in effect. These issues can be mitigated by manually sanitizing the upper part of the partial vector argument register or by using-mdaz-ftzto set denormals-are-zero (DAZ) flag in the MXCSR register.
This option is enabled by default. ๐
-mmove-max=bitsโ this option instructs GCC to set the maximum number of bits can be moved from memory to memory efficiently tobits. The validbitsare128,256and512.-mstore-max=bitsโ this option instructs GCC to set the maximum number of bits can be stored to memory efficiently tobits. The validbitsare128,256and512.noneโ No extra limitations applied to GCC other than defined by the selected platform.128โ Prefer 128-bit vector width for instructions.256โ Prefer 256-bit vector width for instructions.512โ Prefer 512-bit vector width for instructions.-mnoreturn-no-callee-saved-registersโ okay so this one is doing some serious cleanup work. It optimizes functions that have the"noreturn"attribute or the"_Noreturn"specifier by simply not saving the callee-saved registers in the function prologue โ y'know, the ones the function actually uses (except"BP", she stays, icon behavior ๐ ). But bestie, heads up: this can mess with debugging of whoever called that"noreturn"function, or literally any function further up the call stack. That's exactly why it's not enabled by default. Not worth the chaos unless you know what you're doing. ๐-mcx16โ this lets GCC generate"CMPXCHG16B"instructions in 64-bit code, so it can do compare-and-exchange on 16-byte aligned 128-bit objects. Super useful when you're atomically updating data structures that are bigger than one machine word. The compiler reaches for this instruction to implement__syncBuiltins. BUT โ for__atomicBuiltins working on 128-bit integers, a library call is always used instead. No exceptions, periodt.-msahfโ enables generation of"SAHF"instructions in 64-bit code. Storytime: 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 already supported. Those two are load and store instructions (respectively) for certain status flags. In 64-bit mode,"SAHF"gets used to optimize the"fmod","drem", and"remainder"built-in functions โ peep Other Builtins for the details, iykyk. โจ-mmovbeโ enables use of the"movbe"instruction to optimize byte swapping of four and eight byte entities. Little endian girlies, this one's for you ๐ฆ-mshstkโ the-mshstkoption enables shadow stack built-in functions from x86 Control-flow Enforcement Technology (CET). Fancy security vibes only. ๐-mcrc32โ this one enables the built-in functions"__builtin_ia32_crc32qi","__builtin_ia32_crc32hi","__builtin_ia32_crc32si"and"__builtin_ia32_crc32di"so they generate the"crc32"machine instruction. Checksums but make it โจsiliconโจ-mmwaitโ enables the built-in functions"__builtin_ia32_monitor"and"__builtin_ia32_mwait"to generate the"monitor"and"mwait"machine instructions. Your CPU is literally napping until it's needed, main character energy fr fr. ๐ค-mrecipโ okay this one is spicy ๐ถ๏ธ. It enables use of"RCPSS"and"RSQRTSS"instructions (plus their vectorized besties"RCPPS"and"RSQRTPS") with an additional Newton-Raphson step to bump up precision, instead of using"DIVSS"and"SQRTSS"(and their vectorized variants) for single-precision floating-point arguments. These instructions are generated only when-funsafe-math-optimizationsis enabled together with-ffinite-math-onlyand-fno-trapping-math. Note that while the throughput of the sequence is higher than the throughput of the non-reciprocal instruction, the precision of the sequence can be decreased by up to 2 ulp โ like, the inverse of 1.0 equals0.99999994. ๐
Also note that GCC implements "1.0f/sqrtf(x)" in terms of "RSQRTSS" (or "RSQRTPS") already with -ffast-math (or the option combo above), and doesn't need -mrecip at all.
And also also: GCC emits that same sequence with the extra Newton-Raphson step for vectorized single-float division and vectorized sqrtf(x) already with -ffast-math (or the combo above), and again doesn't need -mrecip.
-mrecip=optโ this one controls which reciprocal estimate instructions are allowed to be used.optis a comma-separated list of options, and any of them may be preceded by a!to invert it:allโ enable all estimate instructions. go wild. ๐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. Selective slay. โจ
-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,aoclfor the math library (LibM) from AMD Optimizing CPU Libraries (AOCL) andacmlfor the end-of-life AMD core math library (to which AOCL-LibM is the successor). To use this option, both-ftree-vectorizeand-funsafe-math-optimizationshave to be enabled, and an SVML or ACML ABI-compatible library must be specified at link time.
GCC currently emits calls to the following for the corresponding function type when -mveclibabi=svml is used:
vmldExp2 vmldLn2 vmldLog102 vmldPow2 vmldTanh2 vmldTan2 vmldAtan2
vmldAtanh2 vmldCbrt2 vmldSinh2 vmldSin2 vmldAsinh2 vmldAsin2 vmldCosh2
vmldCos2 vmldAcosh2 vmldAcos2 vmlsExp4 vmlsLn4 vmlsLog104 vmlsPow4
vmlsTanh4 vmlsTan4 vmlsAtan4 vmlsAtanh4 vmlsCbrt4 vmlsSinh4 vmlsSin4
vmlsAsinh4 vmlsAsin4 vmlsCosh4 vmlsCos4 vmlsAcosh4 and vmlsAcos4
...and these for the corresponding function type when -mveclibabi=aocl is used:
amd_vrs4_acosf amd_vrs16_acosf amd_vrd8_asin amd_vrs4_asinf
amd_vrs8_asinf amd_vrs16_asinf amd_vrd2_atan amd_vrd8_atan
amd_vrs4_atanf amd_vrs8_atanf amd_vrs16_atanf amd_vrd2_cos
amd_vrd4_cos amd_vrd8_cos amd_vrs4_cosf amd_vrs8_cosf amd_vrs16_cosf
amd_vrs4_coshf amd_vrs8_coshf amd_vrd2_erf amd_vrd4_erf amd_vrd8_erf
amd_vrs4_erff amd_vrs8_erff amd_vrs16_erff amd_vrd2_exp amd_vrd4_exp
amd_vrd8_exp amd_vrs4_expf amd_vrs8_expf amd_vrs16_expf amd_vrd2_exp10
amd_vrs4_exp10f amd_vrd2_exp2 amd_vrd4_exp2 amd_vrd8_exp2
amd_vrs4_exp2f amd_vrs8_exp2f amd_vrs16_exp2f amd_vrs4_expm1f
amd_vrd2_log amd_vrd4_log amd_vrd8_log amd_vrs4_logf amd_vrs8_logf
amd_vrs16_logf amd_vrd2_log10 amd_vrs4_log10f amd_vrs8_log10f
amd_vrs16_log10f amd_vrd2_log1p amd_vrs4_log1pf amd_vrd2_log2
amd_vrd4_log2 amd_vrd8_log2 amd_vrs4_log2f amd_vrs8_log2f
amd_vrs16_log2f amd_vrd2_pow amd_vrd4_pow amd_vrd8_pow amd_vrs4_powf
amd_vrs8_powf amd_vrs16_powf amd_vrd2_sin amd_vrd4_sin amd_vrd8_sin
amd_vrs4_sinf amd_vrs8_sinf amd_vrs16_sinf amd_vrd2_tan amd_vrd4_tan
amd_vrd8_tan amd_vrs16_tanf amd_vrs4_tanhf amd_vrs8_tanhf
amd_vrs16_tanhf
...and finally these for the corresponding function type when -mveclibabi=acml is used:
__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
That's a lot of names but we do not skip a single one, bestie. Every. Single. One. ๐
-mabi=nameโ generate code for the specified calling convention. The 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". Pick your fighter. ๐ฅ-masm=dialectโ output assembly instructions using the selected dialect. It also affects which dialect is used for basic"asm"and extended"asm". Supported choices (in dialect order) areattorintel. The default isatt. Darwin does not supportintel. Sorry Darwin girlies ๐ญ-mforce-indirect-callโ force all calls to functions to be indirect. This is useful when you're using Intel Processor Trace, where it generates more precise timing information for function calls. Not me making every call take the scenic route ๐-mmanual-endbrโ insertENDBRinstruction 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. You're the one holding the remote now. ๐๏ธ-mcet-switchโ by default, CET instrumentation is turned off on switch statements that use a jump table, and indirect branch track is disabled. Since jump tables are stored in read-only memory, this does not result in a direct loss of hardening. But โ and this is the important part โ if the jump table index is attacker-controlled, the indirect jump may not be constrained by CET. This option turns on CET instrumentation to enable indirect branch track for switch statements with jump tables, which leads to the jump targets reachable via any indirect jumps. Security girlies, take note. ๐จ-mcall-ms2sysv-xloguesโ so because of differences in 64-bit ABIs, any Microsoft ABI function that calls a System V ABI function must considerRSI,RDIandXMM6-15as clobbered. By default, the code for saving and restoring these registers is emitted inline, which results in fairly lengthy prologues and epilogues (not cute). Using-mcall-ms2sysv-xloguesemits prologues and epilogues that use stubs in the static portion of libgcc to do those saves and restores โ so you reduce function size, at the cost of a few extra instructions. Tradeoff queen. ๐-mtls-dialect=typeโ generate code to access thread-local storage using thegnuorgnu2conventions.gnuis the conservative default;gnu2is more efficient, but it may add compile- and run-time requirements that cannot be satisfied on all systems. Efficient but needy, we've all dated one. ๐-mpush-args/-mno-push-argsโ usePUSHoperations to store outgoing parameters. This method is shorter and usually equally fast as the method usingSUB/MOVoperations, and it's enabled by default. In some cases, disabling it may improve performance because of improved scheduling and reduced dependencies. Sometimes the flop era is actually the growth era. ๐ฆ-maccumulate-outgoing-argsโ if enabled, the maximum amount of space required for outgoing arguments is computed in the function prologue. This is faster on most modern CPUs because of reduced dependencies, improved scheduling and reduced stack usage when the preferred stack boundary is not equal to 2. The drawback? A notable increase in code size. Also, this switch implies-mno-push-args. Bloating but make it fast โจ-mms-bitfields/-mno-ms-bitfieldsโ enable/disable bit-field layout compatible with the native Microsoft Windows compiler.
If "packed" is used on a structure, or if bit-fields are used, it may be that the Microsoft ABI lays out the structure differently than the way GCC normally does. Particularly when moving packed data between functions compiled with GCC and the native Microsoft compiler (either via function call or as data in a file), it may be necessary to access either format. Basically: two compilers, two opinions, one struct. Stay safe out there. ๐
This option is on by default for Microsoft Windows targets. You can also wrangle it locally with variable or type attributes โ peek at x86 Attributes for the tea. ๐ซ
The Microsoft structure layout algorithm is honestly pretty simple, except for the bit-field packing drama. The padding and alignment of struct members, plus whether a bit-field can straddle a storage-unit boundary, is decided by these rules:
- Structure members are stored sequentially in the order in which they are declared: the first member has the lowest memory address and the last member the highest.
- Every data object has an alignment requirement. The alignment requirement for all data except structures, unions, and arrays is either the size of the object or the current packing size (specified with either the
"aligned"attribute or the"pack"pragma), whichever is less. For structures, unions, and arrays, the alignment requirement is the largest alignment requirement of its members. Every object is allocated an offset so that:
offset % alignment_requirement == 0
- Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation unit if the integral types are the same size and if the next bit-field fits into the current allocation unit without crossing the boundary imposed by the common alignment requirements of the bit-fields.
MSVC interprets zero-length bit-fields like this: ๐
- If a zero-length bit-field is inserted between two bit-fields that are normally coalesced, the bit-fields are not coalesced.
For example:
struct
{
unsigned long bf_1 : 12;
unsigned long : 0;
unsigned long bf_2 : 12;
} t1;
The size of "t1" is 8 bytes with the zero-length bit-field. If the zero-length bit-field were removed, "t1"'s size would be 4 bytes.
- If a zero-length bit-field is inserted after a bit-field,
"foo", and the alignment of the zero-length bit-field is greater than the member that follows it,"bar","bar"is aligned as the type of the zero-length bit-field.
For example:
struct
{
char foo : 4;
short : 0;
char bar;
} t2;
struct
{
char foo : 4;
short : 0;
double bar;
} t3;
For "t2", "bar" is placed at offset 2, rather than offset 1. Accordingly, the size of "t2" is 4. For "t3", the zero-length bit-field does not affect the alignment of "bar" or, as a result, the size of the structure.
Taking this into account, it is important to note the following:
- If a zero-length bit-field follows a normal bit-field, the type of the zero-length bit-field may affect the alignment of the structure as whole. For example,
"t2"has a size of 4 bytes, since the zero-length bit-field follows a normal bit-field, and is of type short. - Even if a zero-length bit-field is not followed by a normal bit-field, it may still affect the alignment of the structure:
struct
{
char foo : 6;
long : 0;
} t4;
Here, "t4" takes up 4 bytes.
- Zero-length bit-fields following non-bit-field members are ignored:
struct
{
char foo;
long : 0;
char bar;
} t5;
Here, "t5" takes up 2 bytes.
-mno-align-stringopsโ Do not align the destination of inlined string operations. This switch shrinks your code size and boosts performance when the destination is already aligned โ but GCC has no idea it is. ๐-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 turns on way more inlining and grows your code size, but it may speed up code that leans on fast"memcpy"and"memset"for short lengths. It also enables inline expansion of"strlen"for all pointer alignments. โจ-minline-stringops-dynamicallyโ For string operations of unknown size, it uses run-time checks, with inline code for small blocks and a library call for large blocks.-mstringop-strategy=algโ Override the internal decision heuristic for which particular algorithm to use when inlining string operations. The allowed values for alg are:rep_byterep_4byterep_8byteโ Expand using i386"rep"prefix of the specified size.byte_looploopunrolled_loopโ Expand into an inline loop.libcallโ Always use a library call.
-mmemcpy-strategy=strategyโ Override the internal decision heuristic for deciding if"__builtin_memcpy"should be inlined, and which 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 is 0 for the first triplet and"max_size + 1"of the preceding range.-mmemset-strategy=strategyโ Same vibe as-mmemcpy-strategy=, except this one controls the"__builtin_memset"expansion. ๐-momit-leaf-frame-pointerโ Don't keep the frame pointer in a register for leaf functions. This dodges the instructions to save, set up, and restore frame pointers, and frees up an extra register in leaf functions. Heads up though:-momit-leaf-frame-pointerremoves the frame pointer for leaf functions, which might make debugging harder. ๐ญ-mtls-direct-seg-refs-mno-tls-direct-seg-refsโ Controls whether TLS variables may be accessed with offsets from the TLS segment register (%gsfor 32-bit,%fsfor 64-bit), or whether the thread base pointer must be added. Whether or not this is valid depends on the operating system, and whether it maps the segment to cover the entire TLS area.
For systems that use the GNU C Library, the default is on. โ
-msse2avx-mno-sse2avxโ Specify that the assembler should encode SSE instructions with VEX prefix. The option-mavxturns this on by default.-mfentry-mno-fentryโ If profiling is active (-pg), put the profiling counter call before the prologue. Note: On x86 architectures the attribute"ms_hook_prologue"isn't possible at the moment for-mfentryand-pg.-mrecord-mcount-mno-record-mcountโ If profiling is active (-pg), generate a section that contains pointers to each profiling call; this is useful for automatically patching the calls. You can use themfentry-section=option to set the name of the section; it defaults to__mcount_loc.-mnop-mcount-mno-nop-mcountโ If profiling is active (-pg), generate the calls to the profiling functions as NOPs. This is useful when they should be patched in later dynamically. This is likely only useful together with-mrecord-mcount.-minstrument-return=typeโ With-pg -mfentry, instrument function exits according to type, which may be one ofnoneto not instrument,callto generate a call to"__return__", ornop5to generate a 5-byte nop sequence. This option only instruments true returns ending with a"ret", not sibling calls via a jump.-mrecord-return-mno-record-returnโ Generate a"__return_loc"section pointing to all return instrumentation code.-mfentry-name=nameโ Set name of"__fentry__"symbol called at function entry for-pg -mfentryfunctions.-mfentry-section=nameโ Set name of section to record-mrecord-mcountcalls. The default is__mcount_loc.-mskip-rax-setup-mno-skip-rax-setupโ When generating code for the x86-64 architecture with SSE extensions disabled,-mskip-rax-setupcan be used to skip setting up the RAX register when there are no variable arguments passed in vector registers.-m8bit-idiv-mno-8bit-idivโ On some processors, like Intel Atom, 8-bit unsigned integer divide is much faster than 32-bit/64-bit integer divide. This option generates a run-time check. If both dividend and divisor are within range of 0 to 255, 8-bit unsigned integer divide is used instead of 32-bit/64-bit integer divide. ๐ง-mavx256-split-unaligned-load-mavx256-split-unaligned-storeโ Split 32-byte AVX unaligned load and store.-mstack-protector-guard=guard-mstack-protector-guard-reg=reg-mstack-protector-guard-offset=offset-mstack-protector-guard-symbol=symbolโ Generate stack protection code using 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.
-mstack-protector-guard-symbol=symbol overrides the offset with a symbol reference to a canary in the TLS block. ๐ก๏ธ
-mgeneral-regs-onlyโ Generate code that uses only the general-purpose registers. This stops the compiler from using floating-point, vector, mask and bound registers. ๐ซ-mrelax-cmpxchg-loopโ bestie, when GCC has to emit a compare-and-swap loop for__syncBuiltins and__atomicBuiltins that don't have a native instruction to lean on, this flag makes it optimize for the highly contended case. How? It fires off an atomic load before theCMPXCHGinstruction, and it uses thePAUSEinstruction to save CPU power when the loop restarts. Very demure, very mindful, very power-efficient. ๐- *
-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.
โ ๏ธ Heads up:-mcmodel=largeis incompatible with-mindirect-branch=thunkand-mindirect-branch=thunk-extern, because the thunk function may not be reachable in the large code model. Like, it just can't get there. ๐ญ
Also good to know: -mindirect-branch=thunk-extern is compatible with -fcf-protection=branch, since the external thunk can be made to enable control-flow check. Slay.
- *
-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=branch, because the external thunk can be made to enable control-flow check.
โ ๏ธ And also note that-mcmodel=largeis incompatible with-mfunction-return=thunkand-mfunction-return=thunk-extern, since the thunk function may not be reachable in the large code model. Same energy as above, fr fr.
-mindirect-branch-registerโ Force indirect call and jump via register. No detours, just vibes through a register. โจ- *
-mharden-sls=choice* โ Generate code to mitigate against straight line speculation (SLS) with choice. The default isnone, which disables all SLS hardening.returnenables SLS hardening for function returns.indirect-jmpenables SLS hardening for indirect jumps.allenables all SLS hardening. Pick your fighter. ๐ก๏ธ -mindirect-branch-cs-prefixโ Adds a CS prefix tocallandjmpto indirect thunk when the branch target is in ther8-r15registers, so that thecallandjmpinstruction length is 6 bytes. Why do we care? Because it lets them potentially be replaced withlfence; call *%r8-r15orlfence; jmp *%r8-r15at run time. Clever little glow-up. ๐-mapx-inline-asm-use-gpr32โ By default, EGPR usage is disabled in inline asm constraints, because GCC cannot be aware of whether the asm instructions support GP32 or not. So if your inline asm can handle EGPR, go ahead and use-mapx-inline-asm-use-gpr32. You know your asm best, bestie. ๐ซถ-mgather-mscatterโ Enable vectorization for gather and scatter instructions, respectively. Iconic duo, no notes. ๐
These -m switches are supported in addition to the above on x86-64 processors in 64-bit environments. iykyk.
โจ The -m32 / -m64 / -mx32 / -m16 Situation โจ
-m32-m64-mx32-m16โ Generate code for a 16-bit, 32-bit or 64-bit environment. Let's break it down, bestie:- The
-m32option setsint,long, and pointer types to 32 bits, and generates code that runs in 32-bit mode. - The
-m64option 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. Special little exception. ๐ - The
-mx32option setsint,long, and pointer types to 32 bits, and generates code for the x86-64 architecture. - The
-m16option is the same as-m32, except for that it outputs the.code16gccassembly directive at the beginning of the assembly output, so that the binary can run in 16-bit mode.
- The
-miamcuโ The-miamcuoption generates code that conforms to Intel MCU psABI. It requires the-m32option to be turned on. No-m32, no deal. ๐-mno-red-zoneโ Do not use a so-called "red zone" for x86-64 code. Okay so what even is the red zone? The red zone is mandated by the x86-64 ABI; it's 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. Put the red zone back where it came from or so help me. ๐
๐ธ Code Models, Address Modes & Friends ๐ธ
-mcmodel=smallโ Generate code for the small code model: the program and its symbols must be linked in the lower 2 GB of the address space. Pointers are 64 bits. Programs can be statically or dynamically linked. This is the default code model, the main character. ๐-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. Mandatory, periodt.-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. It's giving unbothered, unfazed, unassuming. โจ-maddress-mode=longโ Generate code for long address mode. This is only supported for 64-bit and x32 environments. It is the default address mode for 64-bit environments.-maddress-mode=shortโ Generate code for short address mode. This is only supported for 32-bit and x32 environments. It is the default address mode for 32-bit and x32 environments.-mneeded-mno-neededโ EmitGNU_PROPERTY_X86_ISA_1_NEEDEDGNU property for Linux target to indicate the micro-architecture ISA level required to execute the binary. Letting everyone know your requirements upfront. Very communicative of you. ๐-mno-direct-extern-accessโ Without-fpicor-fPIC, always use the GOT pointer to access external symbols. With-fpicor-fPIC, treat access to protected symbols as local symbols. The default is-mdirect-extern-access.
โ ๏ธ Warning: shared libraries compiled with-mno-direct-extern-accessand executable compiled with-mdirect-extern-accessmay not be binary compatible if protected symbols are used in shared libraries and executable. Do not mix and match unless you're ready for chaos. ๐ญ
-munroll-only-small-loops-mno-unroll-only-small-loopsโ Controls conservative small loop unrolling. It is enabled by default with-O2, and unrolls loops with less than 4 instructions by 1 time. This gives better utilization of the instruction decoding pipeline on modern processors. You can disable this with-mno-unroll-only-small-loops, and it is also disabled if the more general options-funroll-loopsor-funroll-all-loopsare either enabled or explicitly disabled. So basically it knows when to step back. ๐ธ-mdispatch-schedulerโ Enable instruction scheduling. This is only supported onbdver1,bdver2,bdver3,bdver4, andznver1processors, and additionally requires-fschedule-insns -fsched-pressure. Very specific queen energy. ๐- *
-mlam=choice* โ LAM (linear-address masking) allows special bits in the pointer to be used for metadata. The default isnone. Withu48, pointer bits in positions62:48can be used for metadata; withu57, pointer bits in positions62:57can be used for metadata. Bits doing double duty, we love a multitasker. ๐
๐ฆ x86 Windows Options ๐ฆ
๐ฆ Xstormy16 Options ๐ฆ
These options are defined for Xstormy16:
-msimโ Choose startup files and linker script suitable for the simulator. Simulator-ready, cute and functional. โจ
๐ง Xtensa Options ๐ง
These options are supported for Xtensa targets:
-mconst16-mno-const16โ Enable or disable use ofCONST16instructions for loading constant values. When enabled,CONST16instructions are always used in place of the standardL32Rinstructions. The use ofCONST16is enabled by default only if theL32Rinstruction is not available. Backup plan behavior, honestly.-mserialize-volatile-mno-serialize-volatileโ When this option is enabled, GCC insertsMEMWinstructions beforevolatilememory references to guarantee sequential consistency. The default is-mserialize-volatile. Use-mno-serialize-volatileto omit theMEMWinstructions.-mforce-no-pic-mno-force-no-picโ For targets like GNU/Linux, where all user-mode Xtensa code must be position-independent code (PIC), this option disables PIC for compiling kernel code. Kernel code said "not like other 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. Besties sticking together, adorable. ๐ซถ-mauto-litpools-mno-auto-litpoolsโ These options control the treatment of literal pools. The default is-mno-auto-litpools, which places literals in a separate section in the output file unless-mtext-section-literalsis used. With-mauto-litpoolsthe literals are interspersed in the text section by the assembler. The compiler does not produce explicit.literaldirectives and loads literals into registers withMOVIinstructions instead ofL32R, to let the assembler do relaxation and place literals as necessary. This option allows the assembler to create several literal pools per function and assemble very big functions, which may not be possible with-mtext-section-literals. Big function support, iconic. ๐ฅ-mtarget-align-mno-target-alignโ When this option is enabled, GCC instructs the assembler to automatically align instructions to reduce branch penalties at the expense of some code density. The assembler attempts to widen density instructions to align branch targets and the instructions following call instructions. If there are not enough preceding safe density instructions to align a target, no widening is performed. The default is-mtarget-align. These options do not affect the treatment of auto-aligned instructions likeLOOP, which the assembler always aligns, either by widening density instructions or by inserting NOP instructions.LOOPdoes what it wants, honestly. ๐-mlongcalls,-mno-longcallsโ okay bestie, when you turn this on, GCC tells the assembler to swap direct calls for indirect calls unless it can prove the target of that direct call is chillin' inside the range the call instruction can actually reach. This translation usually kicks in for calls to functions living in other source files. Like, specifically, the assembler takes a directCALLinstruction and turns it into anL32Rfollowed by aCALLX. The default is-mno-longcalls. You'd want this in programs where the call target could potentially be out of range. Heads up though: this option is implemented in the assembler, not the compiler, so the assembly code GCC spits out still shows direct call instructions โ you gotta look at the disassembled object code to see the real instructions. And note that the assembler uses an indirect call for every cross-file call, not just the ones that are actually out of range. ๐-mabi=nameโ generates code for the ABI you name. Permissible values are:call0,windowed. The default ABI is chosen by the Xtensa core configuration. โจ-mabi=call0โ when this one's on, function parameters get passed in registersa2througha7, registersa12througha15are caller-saved, and registera15may be used as a frame pointer. When this version of the ABI is enabled, the C preprocessor symbol__XTENSA_CALL0_ABI__is defined. ๐-mabi=windowedโ when this one's on, function parameters get passed in registersa10througha15, and the called function rotates the register window by 8 registers on entry so its arguments are found in registersa2througha7. Registera7may be used as a frame pointer. The register window rotates 8 registers back upon return. When this version of the ABI is enabled, the C preprocessor symbol__XTENSA_WINDOWED_ABI__is defined. ๐ฆ-mextra-l32r-costs=nโ sets an extra cost, in clock cycles, of instruction RAM/ROM access forL32Rinstructions. This affects, when optimizing for speed, whether loading a constant from the literal pool usingL32Rbeats synthesizing that constant from a small one with a couple of arithmetic instructions. The default value is0. ๐ธ-mstrict-align,-mno-strict-alignโ avoids or allows generating memory accesses that may not be aligned on a natural object boundary as described in the architecture specification. The default is-mno-strict-alignfor cores that support both unaligned loads and stores in hardware, and-mstrict-alignfor all other cores. โญ
๐ zSeries Options ๐
These are listed under
โจ ENVIRONMENT โจ
okay so bestie, this bit is ALL about the environment variables that change how GCC behaves, and honestly it's giving "backstage pass" energy. Some of them work by handing GCC directories or prefixes to use when it's out there searching for files. Others just straight up configure other aspects of the compilation environment. slay.
lowkey important tho: you can ALSO tell GCC where to look using options like -B, -I and -L. And here's the priority order, memorize it:
- places you specified with those options โ they take precedence over everything
- places specified using environment variables โ next in line
- places specified by the configuration of GCC โ last, sorry bestie
๐ LANG, LC_CTYPE, LC_MESSAGES, LC_ALL
these four control how GCC uses localization info, which is what lets GCC vibe with different national conventions for its diagnostic and informational output. GCC peeks at the locale categories LC_CTYPE and LC_MESSAGES if it's been configured to do so. You can set these locale categories to literally any value your installation supports. A typical value is en_GB.UTF-8 โ that's English, United Kingdom, encoded in UTF-8, periodt.
The rules, fr fr:
- If
LC_ALLis set, it overrides the value ofLC_CTYPEandLC_MESSAGES. - Otherwise,
LC_CTYPEandLC_MESSAGESdefault to the value of theLANGenvironment variable. - If NONE of these variables are set, GCC defaults to traditional C English behavior. iconic of it honestly.
๐ซถ heads up: these environment variables do not touch the encodings of input files, or strings in output files produced by GCC. Those are controlled by the-finput-charsetand-fexec-charsetoptions, respectively. different girl, different job.
๐พ TMPDIR
If TMPDIR is set, it specifies the directory to use for temporary files. GCC uses temp files to hold the output of one stage of compilation that's about to become the input of the next stage โ for example, the output of the preprocessor, which is the input to the compiler proper. it's passing notes in class, basically.
๐ GCC_DIAGNOSTICS_LOG
If GCC_DIAGNOSTICS_LOG is set, then extra info about the diagnostics subsystem gets emitted. And check this:
- If it's set to an empty value โ the info goes to
stderr. - Otherwise โ GCC will attempt to open that file and write the info there.
โ ๏ธ The precise content and format of this information is subject to change. It's meant for GCC developers, not end-users. so like, devs only, no gatekeeping just facts.
GCC_COMPARE_DEBUG
Setting GCC_COMPARE_DEBUG is nearly equivalent to passing -fcompare-debug to the compiler driver. Go read that option's documentation for the full tea.
๐ ๏ธ GCC_EXEC_PREFIX
If GCC_EXEC_PREFIX is set, it specifies a prefix to use in the names of the subprograms executed by the compiler. No slash gets added when this prefix is combined with the name of a subprogram โ but you CAN specify a prefix that ends with a slash if that's your moment. ๐
- If
GCC_EXEC_PREFIXis not set, GCC tries to figure out an appropriate prefix based on the pathname it was invoked with. self-sufficient queen. - If GCC can't find the subprogram using the specified prefix, it goes looking in the usual places for the subprogram.
The default value of GCC_EXEC_PREFIX is prefix/lib/gcc/ where prefix is the prefix to the installed compiler. In many cases prefix is the value of "prefix" when you ran the configure script.
Other prefixes specified with -B take precedence over this prefix. periodt.
This prefix is also used for finding files such as crt0.o that are used for linking.
AND in addition โ plot twist โ the prefix is used in an unusual way in finding the directories to search for header files. For each of the standard directories whose name normally begins with /usr/local/lib/gcc (more precisely, with the value of GCC_INCLUDE_DIR), GCC tries replacing that beginning with the specified prefix to produce an alternate directory name. 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. wild right? ๐ธ
COMPILER_PATH
The value of COMPILER_PATH is a colon-separated list of directories, much like PATH. GCC tries the directories you specified this way when searching for subprograms โ but only if it can't find the subprograms using GCC_EXEC_PREFIX.
๐ LIBRARY_PATH
The value of LIBRARY_PATH is a colon-separated list of directories, much like PATH. When configured as a native compiler, GCC tries the directories you specified this way when searching for special linker files โ if it can't find them using GCC_EXEC_PREFIX. Linking using GCC also uses these directories when searching for ordinary libraries for the -l option (but directories specified with -L come first, always ๐
).
๐ฉน GCC_EXTRA_DIAGNOSTIC_OUTPUT
If GCC_EXTRA_DIAGNOSTIC_OUTPUT is set to one of the following values, then additional text will be emitted to stderr when fix-it hints are emitted.
โญ note:-fdiagnostics-parseable-fixitsand-fno-diagnostics-parseable-fixitstake precedence over this environment variable. options over env vars, as always.
fixits-v1
Emit parseable fix-it hints, equivalent to -fdiagnostics-parseable-fixits. In particular, columns are expressed as a count of bytes, starting at byte 1 for the initial column.
fixits-v2
As "fixits-v1", but columns are expressed as display columns, as per -fdiagnostics-column-unit=display.
๐งช EXPERIMENTAL_SARIF_SOCKET
If EXPERIMENTAL_SARIF_SOCKET is set in the environment, then the compiler will attempt to connect to a UNIX domain stream socket with that name, and send an "OnSarifResult" JSON-RPC 2.0 notification to it for each diagnostic that occurs, where the value of the notification is a SARIF "result" object.
The compiler will fail immediately if EXPERIMENTAL_SARIF_SOCKET is set and it cannot connect to it. no chill, no retries. ๐
๐จ This feature is experimental and subject to change or removal without notice.
Some additional environment variables affect the behavior of the preprocessor. and yes, this is a whole separate little crew:
CPATH, C_INCLUDE_PATH, CPLUS_INCLUDE_PATH, OBJC_INCLUDE_PATH
Each variable's value is a list of directories separated by a special character, much like PATH, in which to look for header files. That special character, "PATH_SEPARATOR", is target-dependent and determined at GCC build time. For Microsoft Windows-based targets it's a semicolon, and for almost all other targets it's a colon. iykyk.
CPATHspecifies a list of directories to be searched as if specified with-I, but after any paths given with-Ioptions on the command line. This environment variable is used regardless of which language is being preprocessed.- The remaining environment variables apply only when preprocessing the particular language indicated. Each specifies a list of directories to be searched as if specified with
-isystem, but after any paths given with-isystemoptions on the command line.
In all these variables, an empty element instructs the compiler to search its current working directory. Empty elements can appear at the beginning or end of a path. For instance, if the value of CPATH is ":/special/include", that has the same effect as -I. -I/special/include. cute little trick, obsessed. ๐
๐ DEPENDENCIES_OUTPUT
If this variable is set, its value specifies how to output dependencies for Make based on the non-system header files processed by the compiler. System header files are ignored in the dependency output.
The value of DEPENDENCIES_OUTPUT can be:
- just a file name โ in which case the Make rules are written to that file, guessing the target name from the source file name. OR
- the form
file targetโ in which case the rules are written to file file using target as the target name.
In other words, this environment variable is equivalent to combining the options -MM and -MF, with an optional -MT switch too. combo meal.
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. she's the same but different, okay?
โฐ SOURCE_DATE_EPOCH
If this variable is set, its value specifies a UNIX timestamp to be used in replacement of the current date and time in the "__DATE__" and "__TIME__" macros, so that the embedded timestamps become reproducible. reproducibility rights! ๐ฅ
The value of SOURCE_DATE_EPOCH must be a UNIX timestamp, defined as the number of seconds (excluding leap seconds) since 01 Jan 1970 00:00:00 represented in ASCII; identical to the output of "date +%s" on GNU/Linux and other systems that support the %s extension in the "date" command.
The value should be a known timestamp such as the last modification time of the source or package, and it should be set by the build process.
๐ BUGS
For instructions on reporting bugs, see https://gitlab.archlinux.org/archlinux/packaging/packages/gcc/-/issues. go tell them everything bestie, they wanna know. ๐
๐ FOOTNOTES
- On some systems,
gcc -sharedneeds to build supplementary stub code for constructors to work. On multi-libbed systems,gcc -sharedmust select the correct support libraries to link against. Failing to supply the correct flags may lead to subtle defects. Supplying them in cases where they are not necessary is innocuous.-sharedsuppresses the addition of startup code to alter the floating-point environment as done with-ffast-math,-Ofastor-funsafe-math-optimizationson some targets.
๐ SEE ALSO
gpl(7), gfdl(7), fsf-funding(7), cpp(1), gcov(1), as(1), ld(1), gdb(1) and the Info entries for gcc, cpp, as, ld, binutils and gdb. the whole friend group honestly. ๐ซถ
๐ AUTHOR
See the Info entry for gcc, or https://gcc.gnu.org/onlinedocs/gcc/Contributors.html, for contributors to GCC. legends, every single one. โญ
๐ COPYRIGHT ๐
okay bestie, last section, we made it, and this one is short but important so let's not scroll past it ๐
Copyright (c) 1988-2026 Free Software Foundation, Inc. ๐
That's it. That's the owner. Forty-plus years of GNU energy and they're still going, iconic behavior fr fr.
๐ฆ the permission slip (read it, it slaps)
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) (peep below), and the Back-Cover texts being (b) (also below, keep reading, I got you).
A copy of the license is literally included in the gfdl(7) man page, so if you ever want the whole thing, that's where you go. no cap. ๐โจ
ngl the "Invariant Sections" bit is doing a lot of heavy lifting โ it means those two sections stay put no matter what you do with the rest. they're the main characters and they know it. ๐
(a) โจ the FSF's Front-Cover Text โจ
A GNU Manual
short. clean. ate. ๐ซถ
(b) ๐ธ the FSF's Back-Cover Text ๐ธ
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.
likeโฆ freedom to copy and modify?? and the copies help fund development?? that's the whole vibe, bestie, that's the entire ethos and it's honestly kind of beautiful ๐ญ๐
and that's a wrap on the whole page, every single section, no crumbs left, no details skipped, we did the thing. ๐
This was page gcc-16, dated 2026-08-10 โ so shoutout to the manual itself and the fine folks keeping it alive, and shoutout to YOU for reading a manpage all the way to the copyright notice. that's dedication. that's main character energy. periodt. ๐
๐
๐ฆ where this page comes from
- arch rolling: gcc 16.2.1+r23+gd564253eb6c8-1 ยท GPL-3.0-or-later WITH GCC-exception-3.1 AND GFDL-1.3-or-later
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms