GCC(1)
๐ GCC(1) ๐ โ the GNU project C and C++ compiler โจ
okay bestie, sit down, hydrate, because this is THE manual page for gcc, the GNU project C and C++ compiler, and it's a whole journey ๐ซถ
๐ธ NAME ๐ธ
gcc โ GNU project C and C++ compiler ๐
๐ SYNOPSIS ๐
gcc [-c|-S|-E] [-std=standard]
[-g] [-pg] [-Olevel]
[-Wwarn...] [-Wpedantic]
[-Idir...] [-Ldir...]
[-Dmacro[=defn]...] [-Umacro]
[-foption...] [-mmachine-option...]
[-o outfile] [@file] infile...
so like, only the most useful options are listed up there โ the rest of them are down below, keep scrolling bestie ๐ and heads up: g++ accepts mostly the same options as gcc.
๐ฆ DESCRIPTION ๐ฆ
When you invoke GCC, it normally does preprocessing, compilation, assembly and linking. The "overall options" let you stop this whole process at an intermediate stage โ like hitting pause mid-glow-up ๐
for example, the -c option says do NOT run the linker. Then the output is just object files that the assembler spat out.
Other options get passed on to one or more stages of processing. Some options control the preprocessor, others control the compiler itself. And then there's a whole other crew of options controlling the assembler and the linker โ most of those aren't documented here, because fr fr you rarely ever need them.
Most of the command-line options you can use with GCC are useful for C programs; when an option is only useful with another language (usually C++), the explanation says so explicitly. And if a particular option's description doesn't mention a source language? Then 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. And when you compile C++ programs, you should invoke GCC as g++ instead. iykyk ๐
The gcc program accepts options and file names as operands. Many options have multi-letter names; therefore multiple single-letter options may not be grouped: -dv is very different from -d -v. not me learning that the hard way ๐ญ
You can mix options and other arguments. For the most part, the order you use doesn't matter. Order does matter when you use several options of the same kind โ for example, if you specify -L more than once, the directories are searched in the order specified. Also, the placement of the -l option is significant. yes queen, position matters ๐
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. iconic behavior honestly.
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. ๐ง standards girlies rise up.
โจ OPTIONS โจ
๐ซ Option Summary ๐ซ
Here is a summary of all the options, grouped by type. Explanations are in the following sections. (yes, we're doing the whole list, no skipping, we're thorough like that ๐ค)
๐ฅ Overall Options
-c-S-E-o file-x language-v-###--help[=class[,...]]--target-help--version-pass-exit-codes-pipe-specs=file-wrapper@file-ffile-prefix-map=old=new-fplugin=file-fplugin-arg-name=arg-fdump-ada-spec[-slim]-fada-spec-parent=unit-fdump-go-spec=file
๐ C Language Options
-ansi-std=standard-fgnu89-inline-fpermitted-flt-eval-methods=standard-aux-info filename-fallow-parameterless-variadic-functions-fno-asm-fno-builtin-fno-builtin-function-fgimple-fhosted-ffreestanding-fopenacc-fopenacc-dim=geom-fopenmp-fopenmp-simd-fms-extensions-fplan9-extensions-fsso-struct=endianness-fallow-single-precision-fcond-mismatch-flax-vector-conversions-fsigned-bitfields-fsigned-char-funsigned-bitfields-funsigned-char
๐ C++ Language Options
-fabi-version=n-fno-access-control-faligned-new=n-fargs-in-order=n-fchar8_t-fcheck-new-fconstexpr-depth=n-fconstexpr-cache-depth=n-fconstexpr-loop-limit=n-fconstexpr-ops-limit=n-fno-elide-constructors-fno-enforce-eh-specs-fno-gnu-keywords-fno-implicit-templates-fno-implicit-inline-templates-fno-implement-inlines-fms-extensions-fnew-inheriting-ctors-fnew-ttp-matching-fno-nonansi-builtins-fnothrow-opt-fno-operator-names-fno-optional-diags-fpermissive-fno-pretty-templates-fno-rtti-fsized-deallocation-ftemplate-backtrace-limit=n-ftemplate-depth=n-fno-threadsafe-statics-fuse-cxa-atexit-fno-weak-nostdinc++-fvisibility-inlines-hidden-fvisibility-ms-compat-fext-numeric-literals-Wabi-tag-Wcatch-value-Wcatch-value=n-Wno-class-conversion-Wclass-memaccess-Wcomma-subscript-Wconditionally-supported-Wno-conversion-null-Wctor-dtor-privacy-Wno-delete-incomplete-Wdelete-non-virtual-dtor-Wdeprecated-copy-Wdeprecated-copy-dtor-Weffc++-Wextra-semi-Wno-inaccessible-base-Wno-inherited-variadic-ctor-Wno-init-list-lifetime-Wno-invalid-offsetof-Wno-literal-suffix-Wmismatched-tags-Wmultiple-inheritance-Wnamespaces-Wnarrowing-Wnoexcept-Wnoexcept-type-Wnon-virtual-dtor-Wpessimizing-move-Wno-placement-new-Wplacement-new=n-Wredundant-move-Wredundant-tags-Wreorder-Wregister-Wstrict-null-sentinel-Wno-subobject-linkage-Wtemplates-Wno-non-template-friend-Wold-style-cast-Woverloaded-virtual-Wno-pmf-conversions-Wsign-promo-Wsized-deallocation-Wsuggest-final-methods-Wsuggest-final-types-Wsuggest-override-Wno-terminate-Wuseless-cast-Wvirtual-inheritance-Wno-virtual-move-assign-Wvolatile-Wzero-as-null-pointer-constant
๐ Objective-C and Objective-C++ Language Options
-fconstant-string-class=class-name-fgnu-runtime-fnext-runtime-fno-nil-receivers-fobjc-abi-version=n-fobjc-call-cxx-cdtors-fobjc-direct-dispatch-fobjc-exceptions-fobjc-gc-fobjc-nilcheck-fobjc-std=objc1-fno-local-ivars-fivar-visibility=[public|protected|private|package]-freplace-objc-classes-fzero-link-gen-decls-Wassign-intercept-Wno-property-assign-default-Wno-protocol-Wselector-Wstrict-selector-match-Wundeclared-selector
๐ Diagnostic Message Formatting Options
-fmessage-length=n-fdiagnostics-show-location=[once|every-line]-fdiagnostics-color=[auto|never|always]-fdiagnostics-urls=[auto|never|always]-fdiagnostics-format=[text|json]-fno-diagnostics-show-option-fno-diagnostics-show-caret-fno-diagnostics-show-labels-fno-diagnostics-show-line-numbers-fno-diagnostics-show-cwe-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
โจ Warning Options โจ
okay bestie, this is the warning flag menu and it's giving encyclopedia energy ๐ . Every single one is here, no skips, no cap. Periodt.
-fsyntax-only-fmax-errors=n-Wpedantic-pedantic-errors-w-Wextra-Wall-Wabi=n-Waddress-Wno-address-of-packed-member-Waggregate-return-Walloc-size-larger-than=byte-size-Walloc-zero-Walloca-Walloca-larger-than=byte-size-Wno-aggressive-loop-optimizations-Warith-conversion-Warray-bounds-Warray-bounds=n-Wno-attributes-Wattribute-alias=n-Wno-attribute-alias-Wno-attribute-warning-Wbool-compare-Wbool-operation-Wno-builtin-declaration-mismatch-Wno-builtin-macro-redefined-Wc90-c99-compat-Wc99-c11-compat-Wc11-c2x-compat-Wc++-compat-Wc++11-compat-Wc++14-compat-Wc++17-compat-Wc++20-compat-Wcast-align-Wcast-align=strict-Wcast-function-type-Wcast-qual-Wchar-subscripts-Wclobbered-Wcomment-Wconversion-Wno-coverage-mismatch-Wno-cpp-Wdangling-else-Wdate-time-Wno-deprecated-Wno-deprecated-declarations-Wno-designated-init-Wdisabled-optimization-Wno-discarded-array-qualifiers-Wno-discarded-qualifiers-Wno-div-by-zero-Wdouble-promotion-Wduplicated-branches-Wduplicated-cond-Wempty-body-Wno-endif-labels-Wenum-compare-Wenum-conversion-Werror-Werror=*-Wexpansion-to-defined-Wfatal-errors-Wfloat-conversion-Wfloat-equal-Wformat-Wformat=2-Wno-format-contains-nul-Wno-format-extra-args-Wformat-nonliteral-Wformat-overflow=n-Wformat-security-Wformat-signedness-Wformat-truncation=n-Wformat-y2k-Wframe-address-Wframe-larger-than=byte-size-Wno-free-nonheap-object-Wno-hsa-Wno-if-not-aligned-Wno-ignored-attributes-Wignored-qualifiers-Wno-incompatible-pointer-types-Wimplicit-Wimplicit-fallthrough-Wimplicit-fallthrough=n-Wno-implicit-function-declaration-Wno-implicit-int-Winit-self-Winline-Wno-int-conversion-Wint-in-bool-context-Wno-int-to-pointer-cast-Wno-invalid-memory-model-Winvalid-pch-Wjump-misses-init-Wlarger-than=byte-size-Wlogical-not-parentheses-Wlogical-op-Wlong-long-Wno-lto-type-mismatch-Wmain-Wmaybe-uninitialized-Wmemset-elt-size-Wmemset-transposed-args-Wmisleading-indentation-Wmissing-attributes-Wmissing-braces-Wmissing-field-initializers-Wmissing-format-attribute-Wmissing-include-dirs-Wmissing-noreturn-Wno-missing-profile-Wno-multichar-Wmultistatement-macros-Wnonnull-Wnonnull-compare-Wnormalized=[none|id|nfc|nfkc]-Wnull-dereference-Wno-odr-Wopenmp-simd-Wno-overflow-Woverlength-strings-Wno-override-init-side-effects-Wpacked-Wno-packed-bitfield-compat-Wpacked-not-aligned-Wpadded-Wparentheses-Wno-pedantic-ms-format-Wpointer-arith-Wno-pointer-compare-Wno-pointer-to-int-cast-Wno-pragmas-Wno-prio-ctor-dtor-Wredundant-decls-Wrestrict-Wno-return-local-addr-Wreturn-type-Wno-scalar-storage-order-Wsequence-point-Wshadow-Wshadow=global-Wshadow=local-Wshadow=compatible-local-Wno-shadow-ivar-Wno-shift-count-negative-Wno-shift-count-overflow-Wshift-negative-value-Wno-shift-overflow-Wshift-overflow=n-Wsign-compare-Wsign-conversion-Wno-sizeof-array-argument-Wsizeof-pointer-div-Wsizeof-pointer-memaccess-Wstack-protector-Wstack-usage=byte-size-Wstrict-aliasing-Wstrict-aliasing=n-Wstrict-overflow-Wstrict-overflow=n-Wstring-compare-Wstringop-overflow=n-Wno-stringop-truncation-Wsuggest-attribute=[pure|const|noreturn|format|malloc]-Wswitch-Wno-switch-bool-Wswitch-default-Wswitch-enum-Wno-switch-outside-range-Wno-switch-unreachable-Wsync-nand-Wsystem-headers-Wtautological-compare-Wtrampolines-Wtrigraphs-Wtype-limits-Wundef-Wuninitialized-Wunknown-pragmas-Wunsuffixed-float-constants-Wunused-Wunused-but-set-parameter-Wunused-but-set-variable-Wunused-const-variable-Wunused-const-variable=n-Wunused-function-Wunused-label-Wunused-local-typedefs-Wunused-macros-Wunused-parameter-Wno-unused-result-Wunused-value-Wunused-variable-Wno-varargs-Wvariadic-macros-Wvector-operation-performance-Wvla-Wvla-larger-than=byte-size-Wno-vla-larger-than-Wvolatile-register-var-Wwrite-strings-Wzero-length-bounds
๐งช Static Analyzer Options ๐งช
bestie, this is the static analyzer corner of the group chat. It's lowkey detective mode ๐.
-fanalyzer-fanalyzer-call-summaries-fanalyzer-checker=name-fanalyzer-fine-grained-fanalyzer-state-merge-fanalyzer-state-purge-fanalyzer-transitivity-fanalyzer-verbose-edges-fanalyzer-verbose-state-changes-fanalyzer-verbosity=level-fdump-analyzer-fdump-analyzer-stderr-fdump-analyzer-callgraph-fdump-analyzer-exploded-graph-fdump-analyzer-exploded-nodes-fdump-analyzer-exploded-nodes-2-fdump-analyzer-exploded-nodes-3-fdump-analyzer-state-purge-fdump-analyzer-supergraph-Wno-analyzer-double-fclose-Wno-analyzer-double-free-Wno-analyzer-exposure-through-output-file-Wno-analyzer-file-leak-Wno-analyzer-free-of-non-heap-Wno-analyzer-malloc-leak-Wno-analyzer-null-argument-Wno-analyzer-null-dereference-Wno-analyzer-possible-null-argument-Wno-analyzer-possible-null-dereference-Wno-analyzer-stale-setjmp-buffer-Wno-analyzer-tainted-array-index-Wanalyzer-too-complex-Wno-analyzer-unsafe-call-within-signal-handler-Wno-analyzer-use-after-free-Wno-analyzer-use-of-pointer-in-stale-stack-frame-Wno-analyzer-use-of-uninitialized-value
๐ C and Objective-C-only Warning Options ๐
bestie, these are the C and Objective-C-only warning flags. It's giving specialized ๐ .
-Wbad-function-cast-Wmissing-declarations-Wmissing-parameter-type-Wmissing-prototypes-Wnested-externs-Wold-style-declaration-Wold-style-definition-Wstrict-prototypes-Wtraditional-Wtraditional-conversion-Wdeclaration-after-statement-Wpointer-sign
๐ Debugging Options ๐
okay so debugging is where you get the tea โ. These flags are the magnifying glass energy ๐ง.
-g-glevel-gdwarf-gdwarf-version-ggdb-grecord-gcc-switches-gno-record-gcc-switches-gstabs-gstabs+-gstrict-dwarf-gno-strict-dwarf-gas-loc-support-gno-as-loc-support-gas-locview-support-gno-as-locview-support-gcolumn-info-gno-column-info-gstatement-frontiers-gno-statement-frontiers-gvariable-location-views-gno-variable-location-views-ginternal-reset-location-views-gno-internal-reset-location-views-ginline-points-gno-inline-points-gvms-gxcoff-gxcoff+-gz[=type]-gsplit-dwarf-gdescribe-dies-gno-describe-dies-fdebug-prefix-map=old=new-fdebug-types-section-fno-eliminate-unused-debug-types-femit-struct-debug-baseonly-femit-struct-debug-reduced-femit-struct-debug-detailed[=spec-list]-fno-eliminate-unused-debug-symbols-femit-class-debug-always-fno-merge-debug-strings-fno-dwarf2-cfi-asm-fvar-tracking-fvar-tracking-assignments
โจ Optimization Options โจ
okay bestie, this is the optimization menu and it's literally a whole mood. no descriptions in this part, just the names, but you know I got you. every single flag, no cap. ๐
-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]]]]-fno-allocation-dce-fallow-store-data-races-fassociative-math-fauto-profile-fauto-profile[=path]-fauto-inc-dec-fbranch-probabilities-fcaller-saves-fcombine-stack-adjustments-fconserve-stack-fcompare-elim-fcprop-registers-fcrossjumping-fcse-follow-jumps-fcse-skip-blocks-fcx-fortran-rules-fcx-limited-range-fdata-sections-fdce-fdelayed-branch-fdelete-null-pointer-checks-fdevirtualize-fdevirtualize-speculatively-fdevirtualize-at-ltrans-fdse-fearly-inlining-fipa-sra-fexpensive-optimizations-ffat-lto-objects-ffast-math-ffinite-math-only-ffloat-store-fexcess-precision=style-ffinite-loops-fforward-propagate-ffp-contract=style-ffunction-sections-fgcse-fgcse-after-reload-fgcse-las-fgcse-lm-fgraphite-identity-fgcse-sm-fhoist-adjacent-loads-fif-conversion-fif-conversion2-findirect-inlining-finline-functions-finline-functions-called-once-finline-limit=n-finline-small-functions-fipa-cp-fipa-cp-clone-fipa-bit-cp-fipa-vrp-fipa-pta-fipa-profile-fipa-pure-const-fipa-reference-fipa-reference-addressable-fipa-stack-alignment-fipa-icf-fira-algorithm=algorithm-flive-patching=level-fira-region=region-fira-hoist-pressure-fira-loop-pressure-fno-ira-share-save-slots-fno-ira-share-spill-slots-fisolate-erroneous-paths-dereference-fisolate-erroneous-paths-attribute-fivopts-fkeep-inline-functions-fkeep-static-functions-fkeep-static-consts-flimit-function-alignment-flive-range-shrinkage-floop-block-floop-interchange-floop-strip-mine-floop-unroll-and-jam-floop-nest-optimize-floop-parallelize-all-flra-remat-flto-flto-compression-level-flto-partition=alg-fmerge-all-constants-fmerge-constants-fmodulo-sched-fmodulo-sched-allow-regmoves-fmove-loop-invariants-fno-branch-count-reg-fno-defer-pop-fno-fp-int-builtin-inexact-fno-function-cse-fno-guess-branch-probability-fno-inline-fno-math-errno-fno-peephole-fno-peephole2-fno-printf-return-value-fno-sched-interblock-fno-sched-spec-fno-signed-zeros-fno-toplevel-reorder-fno-trapping-math-fno-zero-initialized-in-bss-fomit-frame-pointer-foptimize-sibling-calls-fpartial-inlining-fpeel-loops-fpredictive-commoning-fprefetch-loop-arrays-fprofile-correction-fprofile-use-fprofile-use=path-fprofile-partial-training-fprofile-values-fprofile-reorder-functions-freciprocal-math-free-frename-registers-freorder-blocks-freorder-blocks-algorithm=algorithm-freorder-blocks-and-partition-freorder-functions-frerun-cse-after-loop-freschedule-modulo-scheduled-loops-frounding-math-fsave-optimization-record-fsched2-use-superblocks-fsched-pressure-fsched-spec-load-fsched-spec-load-dangerous-fsched-stalled-insns-dep[=n]-fsched-stalled-insns[=n]-fsched-group-heuristic-fsched-critical-path-heuristic-fsched-spec-insn-heuristic-fsched-rank-heuristic-fsched-last-insn-heuristic-fsched-dep-count-heuristic-fschedule-fusion-fschedule-insns-fschedule-insns2-fsection-anchors-fselective-scheduling-fselective-scheduling2-fsel-sched-pipelining-fsel-sched-pipelining-outer-loops-fsemantic-interposition-fshrink-wrap-fshrink-wrap-separate-fsignaling-nans-fsingle-precision-constant-fsplit-ivs-in-unroller-fsplit-loops-fsplit-paths-fsplit-wide-types-fsplit-wide-types-early-fssa-backprop-fssa-phiopt-fstdarg-opt-fstore-merging-fstrict-aliasing-fthread-jumps-ftracer-ftree-bit-ccp-ftree-builtin-call-dce-ftree-ccp-ftree-ch-ftree-coalesce-vars-ftree-copy-prop-ftree-dce-ftree-dominator-opts-ftree-dse-ftree-forwprop-ftree-fre-fcode-hoisting-ftree-loop-if-convert-ftree-loop-im-ftree-phiprop-ftree-loop-distribution-ftree-loop-distribute-patterns-ftree-loop-ivcanon-ftree-loop-linear-ftree-loop-optimize-ftree-loop-vectorize-ftree-parallelize-loops=n-ftree-pre-ftree-partial-pre-ftree-pta-ftree-reassoc-ftree-scev-cprop-ftree-sink-ftree-slsr-ftree-sra-ftree-switch-conversion-ftree-tail-merge-ftree-ter-ftree-vectorize-ftree-vrp-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--param name=value-O-O0-O1-O2-O3-Os-Ofast-Og
๐ Program Instrumentation Options ๐
bestie, this section is all about spying on your program (in a cute way, for debugging and coverage). here's the full list, no skips. ๐ซถ
-p-pg-fprofile-arcs--coverage-ftest-coverage-fprofile-abs-path-fprofile-dir=path-fprofile-generate-fprofile-generate=path-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-fasan-shadow-offset=number-fsanitize-sections=s1,s2,...-fsanitize-undefined-trap-on-error-fbounds-check-fcf-protection=[full|branch|return|none|check]-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-fvtable-verify=[std|preinit|none]-fvtv-counts-fvtv-debug-finstrument-functions-finstrument-functions-exclude-function-list=sym,sym,...-finstrument-functions-exclude-file-list=file,file,...
๐ธ Preprocessor Options ๐ธ
the preprocessor is like the opening act before the main compiler show. here's every flag, periodt. โจ
-Aquestion=answer-A-question[=answer]-C-CC-Dmacro[=defn]-dD-dI-dM-dN-dU-fdebug-cpp-fdirectives-only-fdollars-in-identifiers-fexec-charset=charset-fextended-identifiers-finput-charset=charset-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-no-integrated-cpp-P-pthread-remap-traditional-traditional-cpp-trigraphs-Umacro-undef-Wp,option-Xpreprocessor option
๐ฆ Assembler Options ๐ฆ
just two, but they're iconic. sending these straight to the assembler. ๐
-Wa,option-Xassembler option
๐ Linker Options ๐
linking time, bestie. this is where all your object files become besties and form an executable. here's the whole squad. ๐
object-file-name-fuse-ld=linker-llibrary-nostartfiles-nodefaultlibs-nolibc-nostdlib-e entry--entry=entry-pie-pthread-r-rdynamic-s-static-static-pie-static-libgcc-static-libstdc++-static-libasan-static-libtsan-static-liblsan-static-libubsan-shared-shared-libgcc-symbolic-T script-Wl,option-Xlinker option-u symbol-z keyword
๐ Directory Options ๐
where to find all the files and libs? this section is literally the map. no cap. ๐บ๏ธ
-Bprefix-Idir-I--idirafter dir-imacros file-imultilib dir-iplugindir=dir-iprefix file-iquote dir-isysroot dir-isystem dir-iwithprefix dir-iwithprefixbefore dir-Ldir-no-canonical-prefixes--no-sysroot-suffix-nostdinc-nostdinc++--sysroot=dir
โญ Code Generation Options โญ
code gen is where the magic happens. these flags control how your code actually turns into machine instructions. it's giving low-level realness. ๐
-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-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-ftrapv-fwrapv-fvisibility=[default|internal|hidden|protected]-fstrict-volatile-bitfields-fsync-libcalls
๐ Developer Options ๐
for when you're literally a GCC dev or just curious. these are the deep cuts, bestie. iykyk. ๐ง
-dletters-dumpspecs-dumpmachine-dumpversion-dumpfullversion-fcallgraph-info[=su,da]-fchecking-fchecking=n-fdbg-cnt-list-fdbg-cnt=counter-value-list-fdisable-ipa-pass_name-fdisable-rtl-pass_name-fdisable-rtl-pass-name=range-list-fdisable-tree-pass_name-fdisable-tree-pass-name=range-list-fdump-debug-fdump-earlydebug-fdump-noaddr-fdump-unnumbered-fdump-unnumbered-links-fdump-final-insns[=file]-fdump-ipa-all-fdump-ipa-cgraph-fdump-ipa-inline-fdump-lang-all-fdump-lang-switch-fdump-lang-switch-options-fdump-lang-switch-options=filename-fdump-passes-fdump-rtl-pass-fdump-rtl-pass=filename-fdump-statistics-fdump-tree-all-fdump-tree-switch-fdump-tree-switch-options-fdump-tree-switch-options=filename-fcompare-debug[=opts]-fcompare-debug-second-fenable-kind-pass-fenable-kind-pass=range-list-fira-verbose=n-flto-report-flto-report-wpa-fmem-report-wpa-fmem-report-fpre-ipa-mem-report-fpost-ipa-mem-report-fopt-info-fopt-info-options[=file]-fprofile-report-frandom-seed=string-fsched-verbose=n-fsel-sched-verbose-fsel-sched-dump-cfg-fsel-sched-pipelining-verbose-fstats-fstack-usage-ftime-report-ftime-report-details-fvar-tracking-assignments-toggle-gtoggle-print-file-name=library-print-libgcc-file-name-print-multi-directory-print-multi-lib-print-multi-os-directory-print-prog-name=program-print-search-dirs-Q-print-sysroot-print-sysroot-headers-suffix-save-temps-save-temps=cwd-save-temps=obj-time[=file]
๐ Machine-Dependent Options ๐
not all machines are the same, bestie. these flags change depending on the target. it's giving "it depends" energy. ๐
๐ AArch64 Options ๐
here's the AArch64 squad, slaying on ARM 64-bit. ๐
-mabi=name-mbig-endian-mlittle-endian-mgeneral-regs-only-mcmodel=tiny-mcmodel=small-mcmodel=large-mstrict-align-mno-strict-align-momit-leaf-frame-pointer-mtls-dialect=desc-mtls-dialect=traditional-mtls-size=size-mfix-cortex-a53-835769-mfix-cortex-a53-843419-mlow-precision-recip-sqrt-mlow-precision-sqrt-mlow-precision-div-mpc-relative-literal-loads-msign-return-address=scope-mbranch-protection=none|standard|pac-ret[+leaf +b-key]|bti-mharden-sls=opts-march=name-mcpu=name-mtune=name-moverride=string-mverbose-cost-dump-mstack-protector-guard=guard-mstack-protector-guard-reg=sysreg-mstack-protector-guard-offset=offset-mtrack-speculation-moutline-atomics
๐ธ Adapteva Epiphany Options ๐ธ
okay bestie, welcome to the part of the manual where every CPU family gets its own lil closet of flags ๐ we're deep in the machine-dependent options now, and I am not about to skip a single one. First up, Adapteva Epiphany โ here's the entire lineup, spelled exactly how the manual spells it:
-mhalf-reg-file-mprefer-short-insn-regs-mbranch-cost=num-mcmove-mnops=num-msoft-cmpsf-msplit-lohi-mpost-inc-mpost-modify-mstack-offset=num-mround-nearest-mlong-calls-mshort-calls-msmall16-mfp-mode=mode-mvect-double-max-vect-align=num-msplit-vecmove-early-m1reg-reg
not me double-checking -m1reg-reg like five times. yes. that's what it says. we copy it as-is, no editorializing, periodt.
๐ AMD GCN Options ๐
short and sweet, three of them, and they are:
-march=gpu-mtune=gpu-mstack-size=bytes
๐ฆ ARC Options ๐ฆ
okay this one is a whole meal, fr fr. every single one, no cap:
-mbarrel-shifter-mjli-always-mcpu=cpu-mA6-mARC600-mA7-mARC700-mdpfp-mdpfp-compact-mdpfp-fast-mno-dpfp-lrsr-mea-mno-mpy-mmul32x16-mmul64-matomic-mnorm-mspfp-mspfp-compact-mspfp-fast-msimd-msoft-float-mswap-mcrc-mdsp-packa-mdvbf-mlock-mmac-d16-mmac-24-mrtsc-mswape-mtelephony-mxy-misize-mannotate-align-marclinux-marclinux_prof-mlong-calls-mmedium-calls-msdata-mirq-ctrl-saved-mrgf-banked-regs-mlpc-width=width-G num-mvolatile-cache-mtp-regno=regno-malign-call-mauto-modify-reg-mbbit-peephole-mno-brcc-mcase-vector-pcrel-mcompact-casesi-mno-cond-exec-mearly-cbranchsi-mexpand-adddi-mindexed-loads-mlra-mlra-priority-none-mlra-priority-compactmlra-priority-noncompact-mmillicode-mmixed-code-mq-class-mRcq-mRcw-msize-level=level-mtune=cpu-mmultcost=num-mcode-density-frame-munalign-prob-threshold=probability-mmpy-option=multo-mdiv-rem-mcode-density-mll64-mfpu=fpu-mrf16-mbranch-index
see mlra-priority-noncompact sitting there with no leading dash? yeah. that's literally what's printed. I'm not fixing it, you're not fixing it, we're all just living with it ๐
๐ ARM Options ๐
the ARM section. it's giving iconic, it's giving enormous. hold my boba:
-mapcs-frame-mno-apcs-frame-mabi=name-mapcs-stack-check-mno-apcs-stack-check-mapcs-reentrant-mno-apcs-reentrant-mgeneral-regs-only-msched-prolog-mno-sched-prolog-mlittle-endian-mbig-endian-mbe8-mbe32-mfloat-abi=name-mfp16-format=name-mthumb-interwork-mno-thumb-interwork-mcpu=name-march=name-mfpu=name-mtune=name-mprint-tune-info-mstructure-size-boundary=n-mabort-on-noreturn-mlong-calls-mno-long-calls-msingle-pic-base-mno-single-pic-base-mpic-register=reg-mnop-fun-dllimport-mpoke-function-name-mthumb-marm-mflip-thumb-mtpcs-frame-mtpcs-leaf-frame-mcaller-super-interworking-mcallee-super-interworking-mtp=name-mtls-dialect=dialect-mword-relocations-mfix-cortex-m3-ldrd-munaligned-access-mneon-for-64bits-mslow-flash-data-masm-syntax-unified-mrestrict-it-mverbose-cost-dump-mpure-code-mcmse-mfix-cmse-cve-2021-35465-mfdpic
โญ AVR Options โญ
tiny microcontroller energy, adorable, still got a full list:
-mmcu=mcu-mabsdata-maccumulate-args-mbranch-cost=cost-mcall-prologues-mgas-isr-prologues-mint8-mdouble=bits-mlong-double=bits-mn_flash=size-mno-interrupts-mmain-is-OS_task-mrelax-mrmw-mstrict-X-mtiny-stack-mfract-convert-truncate-mshort-calls-nodevicelib-nodevicespecs-Waddr-space-convert-Wmisspelled-isr
yes bestie,-Waddr-space-convertand-Wmisspelled-israre in this list and they start with a capitalW, not anm. that's not a typo, that's just how it is ๐ซถ
๐ Blackfin Options ๐
-mcpu=cpu[-sirevision]-msim-momit-leaf-frame-pointer-mno-omit-leaf-frame-pointer-mspecld-anomaly-mno-specld-anomaly-mcsync-anomaly-mno-csync-anomaly-mlow-64k-mno-low64k-mstack-check-l1-mid-shared-library-mno-id-shared-library-mshared-library-id=n-mleaf-id-shared-library-mno-leaf-id-shared-library-msep-data-mno-sep-data-mlong-calls-mno-long-calls-mfast-fp-minline-plt-mmulticore-mcorea-mcoreb-msdram-micplb
๐ C6X Options ๐
-mbig-endian-mlittle-endian-march=cpu-msim-msdata=sdata-type
๐ง CRIS Options ๐ง
-mcpu=cpu-march=cpu-mtune=cpu-mmax-stack-frame=n-melinux-stacksize=n-metrax4-metrax100-mpdebug-mcc-init-mno-side-effects-mstack-align-mdata-align-mconst-align-m32-bit-m16-bit-m8-bit-mno-prologue-epilogue-mno-gotplt-melf-maout-melinux-mlinux-sim-sim2-mmul-bug-workaround-mno-mul-bug-workaround
-simand-sim2? nom. noW. just vibes. that's what the manual says and I am but a humble messenger ๐
๐ CR16 Options ๐
-mmac-mcr16cplus-mcr16c-msim-mint32-mbit-ops-mdata-model=model
๐ธ C-SKY Options ๐ธ
-march=arch-mcpu=cpu-mbig-endian-EB-mlittle-endian-EL-mhard-float-msoft-float-mfpu=fpu-mdouble-float-mfdivdu-melrw-mistack-mmp-mcp-mcache-msecurity-mtrust-mdsp-medsp-mvdsp-mdiv-msmart-mhigh-registers-manchor-mpushpop-mmultiple-stld-mconstpool-mstack-size-mccrt-mbranch-cost=n-mcse-cc-msched-prolog
๐ Darwin Options ๐
okay so this one is the long one. and listen โ some of these literally appear twice in the original list. I'm keeping the duplicates because keeping every detail is the whole assignment, so don't come for me:
-all_load-allowable_client-arch-arch_errors_fatal-arch_only-bind_at_load-bundle-bundle_loader-client_name-compatibility_version-current_version-dead_strip-dependency-file-dylib_file-dylinker_install_name-dynamic-dynamiclib-exported_symbols_list-filelist-flat_namespace-force_cpusubtype_ALL-force_flat_namespace-headerpad_max_install_names-iframework-image_base-init-install_name-keep_private_externs-multi_module-multiply_defined-multiply_defined_unused-noall_load-no_dead_strip_inits_and_terms-nofixprebinding-nomultidefs-noprebind-noseglinkedit-pagezero_size-prebind-prebind_all_twolevel_modules-private_bundle-read_only_relocs-sectalign-sectobjectsymbols-whyload-seg1addr-sectcreate-sectobjectsymbols-sectorder-segaddr-segs_read_only_addr-segs_read_write_addr-seg_addr_table-seg_addr_table_filename-seglinkedit-segprot-segs_read_only_addr-segs_read_write_addr-single_module-static-sub_library-sub_umbrella-twolevel_namespace-umbrella-undefined-unexported_symbols_list-weak_reference_mismatches-whatsloaded-F-gused-gfull-mmacosx-version-min=version-mkernel-mone-byte-bool
ngl-F,-gusedand-gfullare just out here living their lowercase life while everything else has an underscore. main character behavior tbh โจ
๐ฆ DEC Alpha Options ๐ฆ
-mno-fp-regs-msoft-float-mieee-mieee-with-inexact-mieee-conformant-mfp-trap-mode=mode-mfp-rounding-mode=mode-mtrap-precision=mode-mbuild-constants-mcpu=cpu-type-mtune=cpu-type-mbwx-mmax-mfix-mcix-mfloat-vax-mfloat-ieee-mexplicit-relocs-msmall-data-mlarge-data-msmall-text-mlarge-text-mmemory-latency=time
๐ eBPF Options ๐
-mbig-endian-mlittle-endian-mkernel=version-mframe-limit=bytes-mxbpf
โญ FR30 Options โญ
-msmall-model-mno-lsim
๐ FT32 Options ๐
-msim-mlra-mnodiv-mft32b-mcompress-mnopm
๐ง FRV Options ๐ง
another absolute unit of a list. here we go:
-mgpr-32-mgpr-64-mfpr-32-mfpr-64-mhard-float-msoft-float-malloc-cc-mfixed-cc-mdword-mno-dword-mdouble-mno-double-mmedia-mno-media-mmuladd-mno-muladd-mfdpic-minline-plt-mgprel-ro-multilib-library-pic-mlinked-fp-mlong-calls-malign-labels-mlibrary-pic-macc-4-macc-8-mpack-mno-pack-mno-eflags-mcond-move-mno-cond-move-moptimize-membar-mno-optimize-membar-mscc-mno-scc-mcond-exec-mno-cond-exec-mvliw-branch-mno-vliw-branch-mmulti-cond-exec-mno-multi-cond-exec-mnested-cond-exec-mno-nested-cond-exec-mtomcat-stats-mTLS-mtls-mcpu=cpu
-mTLSand-mtlssitting right next to each other, differing only by ONE capital letter. the manual is testing us and honestly? we passed ๐ญ
๐ธ GNU/Linux Options ๐ธ
-mglibc-muclibc-mmusl-mbionic-mandroid-tno-android-cc-tno-android-ld
๐ H8/300 Options ๐
-mrelax-mh-ms-mn-mexr-mno-exr-mint32-malign-300
๐ HPPA Options ๐
-march=architecture-type-mcaller-copies-mdisable-fpregs-mdisable-indexing-mfast-indirect-calls-mgas-mgnu-ld-mhp-ld-mfixed-range=register-range-mjump-in-delay-mlinker-opt-mlong-calls-mlong-load-store-mno-disable-fpregs-mno-disable-indexing-mno-fast-indirect-calls-mno-gas-mno-jump-in-delay-mno-long-load-store-mno-portable-runtime-mno-soft-float-mno-space-regs-msoft-float-mpa-risc-1-0-mpa-risc-1-1-mpa-risc-2-0-mportable-runtime-mschedule=cpu-type-mspace-regs-msio-mwsio-munix=unix-std-nolibdld-static-threads
-nolibdld,-staticand-threadsin here with nomprefix at all. they're just built different ๐
๐ IA-64 Options ๐
-mbig-endian-mlittle-endian-mgnu-as-mgnu-ld-mno-pic-mvolatile-asm-stop-mregister-names-msdata-mno-sdata-mconstant-gp-mauto-pic-mfused-madd-minline-float-divide-min-latency-minline-float-divide-max-throughput-mno-inline-float-divide-minline-int-divide-min-latency-minline-int-divide-max-throughput-mno-inline-int-divide-minline-sqrt-min-latency-minline-sqrt-max-throughput-mno-inline-sqrt-mdwarf2-asm-mearly-stop-bits-mfixed-range=register-range-mtls-size=tls-size-mtune=cpu-type-milp32-mlp64-msched-br-data-spec-msched-ar-data-spec-msched-control-spec-msched-br-in-data-spec-msched-ar-in-data-spec-msched-in-control-spec-msched-spec-ldc-msched-spec-control-ldc-msched-prefer-non-data-spec-insns-msched-prefer-non-control-spec-insns-msched-stop-bits-after-every-cycle-msched-count-spec-in-critical-path-msel-sched-dont-check-control-spec-msched-fp-mem-deps-zero-cost-msched-max-memory-insns-hard-limit-msched-max-memory-insns=max-insns
๐ LM32 Options ๐
-mbarrel-shift-enabled-mdivide-enabled-mmultiply-enabled-msign-extend-enabled-muser-enabled
๐ M32R/D Options ๐
-m32r2-m32rx-m32r-mdebug-malign-loops-mno-align-loops-missue-rate=number-mbranch-cost=number-mmodel=code-size-model-type-msdata=sdata-type-mno-flush-func-mflush-func=name-mno-flush-trap-mflush-trap=number-G num
๐ฆ M32C Options ๐ฆ
-mcpu=cpu-msim-memregs=number
โญ M680x0 Options โญ
-march=arch-mcpu=cpu-mtune=tune-m68000-m68020-m68020-40-m68020-60-m68030-m68040-m68060-mcpu32-m5200-m5206e-m528x-m5307-m5407-mcfv4e-mbitfield-mno-bitfield-mc68000-mc68020-mnobitfield-mrtd-mno-rtd-mdiv-mno-div-mshort-mno-short-mhard-float-m68881-msoft-float-mpcrel-malign-int-mstrict-align-msep-data-mno-sep-data-mshared-library-id=n-mid-shared-library-mno-id-shared-library-mxgot-mno-xgot-mlong-jump-table-offsets
note that-mbitfieldhas a-mno-bitfieldfriend AND a whole separate-mnobitfieldspelling. three whole flags for one vibe. obsessed ๐
๐ง MCore Options ๐ง
-mhardlit-mno-hardlit-mdiv-mno-div-mrelax-immediates-mno-relax-immediates-mwide-bitfields-mno-wide-bitfields-m4byte-functions-mno-4byte-functions-mcallgraph-data-mno-callgraph-data-mslow-bytes-mno-slow-bytes-mno-lsim-mlittle-endian-mbig-endian-m210-m340-mstack-increment
๐ธ MeP Options ๐ธ
-mabsdiff-mall-opts-maverage-mbased=n-mbitops-mc=n-mclip-mconfig=name-mcop-mcop32-mcop64-mivc2-mdc-mdiv-meb-mel-mio-volatile-ml-mleadz-mm-mminmax-mmult-mno-opts-mrepeat-ms-msatur-msdram-msim-msimnovec-mtf-mtiny=n
-ml,-mm,-ms,-mtfโฆ the single-letter flags are out here thriving. tiny names, big presence ๐ซถ
๐ MicroBlaze Options ๐
-msoft-float-mhard-float-msmall-divides-mcpu=cpu-mmemcpy-mxl-soft-mul-mxl-soft-div-mxl-barrel-shift-mxl-pattern-compare-mxl-stack-check-mxl-gp-opt-mno-clearbss-mxl-multiply-high-mxl-float-convert-mxl-float-sqrt-mbig-endian-mlittle-endian-mxl-reorder-mxl-mode-app-model-mpic-data-is-text-relative
and that is NOT the end of the machine-dependent saga, bestie โ we have not even gotten to the letters past M yet ๐ญ keep scrolling, the next batch is right there ๐
โจ MIPS Options โจ
bestie, MIPS is giving so many flags itโs not even funny. hereโs the full list, no cap:
-EL-EB-march=arch-mtune=arch-mips1-mips2-mips3-mips4-mips32-mips32r2-mips32r3-mips32r5-mips32r6-mips64-mips64r2-mips64r3-mips64r5-mips64r6-mips16-mno-mips16-mflip-mips16-minterlink-compressed-mno-interlink-compressed-minterlink-mips16-mno-interlink-mips16-mabi=abi-mabicalls-mno-abicalls-mshared-mno-shared-mplt-mno-plt-mxgot-mno-xgot-mgp32-mgp64-mfp32-mfpxx-mfp64-mhard-float-msoft-float-mno-float-msingle-float-mdouble-float-modd-spreg-mno-odd-spreg-mabs=mode-mnan=encoding-mdsp-mno-dsp-mdspr2-mno-dspr2-mmcu-mmno-mcu-meva-mno-eva-mvirt-mno-virt-mxpa-mno-xpa-mcrc-mno-crc-mginv-mno-ginv-mmicromips-mno-micromips-mmsa-mno-msa-mloongson-mmi-mno-loongson-mmi-mloongson-ext-mno-loongson-ext-mloongson-ext2-mno-loongson-ext2-mfpu=fpu-type-msmartmips-mno-smartmips-mpaired-single-mno-paired-single-mdmx-mno-mdmx-mips3d-mno-mips3d-mmt-mno-mt-mllsc-mno-llsc-mlong64-mlong32-msym32-mno-sym32-Gnum-mlocal-sdata-mno-local-sdata-mextern-sdata-mno-extern-sdata-mgpopt-mno-gopt-membedded-data-mno-embedded-data-muninit-const-in-rodata-mno-uninit-const-in-rodata-mcode-readable=setting-msplit-addresses-mno-split-addresses-mexplicit-relocs-mno-explicit-relocs-mcheck-zero-division-mno-check-zero-division-mdivide-traps-mdivide-breaks-mload-store-pairs-mno-load-store-pairs-mmemcpy-mno-memcpy-mlong-calls-mno-long-calls-mmad-mno-mad-mimadd-mno-imadd-mfused-madd-mno-fused-madd-nocpp-mfix-24k-mno-fix-24k-mfix-r4000-mno-fix-r4000-mfix-r4400-mno-fix-r4400-mfix-r5900-mno-fix-r5900-mfix-r10000-mno-fix-r10000-mfix-rm7000-mno-fix-rm7000-mfix-vr4120-mno-fix-vr4120-mfix-vr4130-mno-fix-vr4130-mfix-sb1-mno-fix-sb1-mflush-func=func-mno-flush-func-mbranch-cost=num-mbranch-likely-mno-branch-likely-mcompact-branches=policy-mfp-exceptions-mno-fp-exceptions-mvr4130-align-mno-vr4130-align-msynci-mno-synci-mlxc1-sxc1-mno-lxc1-sxc1-mmadd4-mno-madd4-mrelax-pic-calls-mno-relax-pic-calls-mmcount-ra-address-mframe-header-opt-mno-frame-header-opt
๐ MMIX Options ๐
MMIX bestie, you get your own little set. slay:
-mlibfuncs-mno-libfuncs-mepsilon-mno-epsilon-mabi=gnu-mabi=mmixware-mzero-extend-mknuthdiv-mtoplevel-symbols-melf-mbranch-predict-mno-branch-predict-mbase-addresses-mno-base-addresses-msingle-exit-mno-single-exit
โจ MN10300 Options โจ
these are lowkey specific but we keep every one:
-mmult-bug-mno-mult-bug-mno-am33-mam33-mam33-2-mam34-mtune=cpu-type-mreturn-pointer-on-d0-mno-crt0-mrelax-mliw-msetlb
๐ฆ Moxie Options ๐ฆ
short and sweet, periodt:
-meb-mel-mmul.x-mno-crt0
๐ธ MSP430 Options ๐ธ
MSP430 girlies, this is your moment:
-msim-masm-hex-mmcu=-mcpu=-mlarge-msmall-mrelax-mwarn-mcu-mcode-region=-mdata-region=-msilicon-errata=-msilicon-errata-warn=-mhwmult=-minrt-mtiny-printf
๐ NDS32 Options ๐
NDS32 said โI have options too,โ and honestly? valid:
-mbig-endian-mlittle-endian-mreduced-regs-mfull-regs-mcmov-mno-cmov-mext-perf-mno-ext-perf-mext-perf2-mno-ext-perf2-mext-string-mno-ext-string-mv3push-mno-v3push-m16bit-mno-16bit-misr-vector-size=num-mcache-block-size=num-march=arch-mcmodel=code-model-mctor-dtor-mrelax
๐ Nios II Options ๐
Nios II bestie, hereโs your whole vibe:
-G num-mgpopt=option-mgpopt-mno-gpopt-mgprel-sec=regexp-mr0rel-sec=regexp-mel-meb-mno-bypass-cache-mbypass-cache-mno-cache-volatile-mcache-volatile-mno-fast-sw-div-mfast-sw-div-mhw-mul-mno-hw-mul-mhw-mulx-mno-hw-mulx-mno-hw-div-mhw-div-mcustom-insn=N-mno-custom-insn-mcustom-fpu-cfg=name-mhal-msmallc-msys-crt0=name-msys-lib=name-march=arch-mbmx-mno-bmx-mcdx-mno-cdx
๐ Nvidia PTX Options ๐
Nvidia PTX, keeping it cute and short:
-m32-m64-mmainkernel-moptimize
๐ฟ OpenRISC Options ๐ฟ
OpenRISC bestie, this is your flag bouquet:
-mboard=name-mnewlib-mhard-mul-mhard-div-msoft-mul-msoft-div-msoft-float-mhard-float-mdouble-float-munordered-float-mcmov-mror-mrori-msext-msfimm-mshftimm
๐ PDP-11 Options ๐
PDP-11 said โretro but make it fashionโ:
-mfpu-msoft-float-mac0-mno-ac0-m40-m45-m10-mint32-mno-int16-mint16-mno-int32-msplit-munix-asm-mdec-asm-mgnu-asm-mlra
๐ picoChip Options ๐
picoChip, tiny but mighty:
-mae=ae_type-mvliw-lookahead=N-msymbol-as-address-mno-inefficient-warnings
๐ PowerPC Options ๐
bestie, this oneโs literally just:
See RS/6000 and PowerPC Options.
periodt.
โญ PRU Options โญ
PRU bestie, hereโs your set:
-mmcu=mcu-minrt-mno-relax-mloop-mabi=variant
๐ฆ RISC-V Options ๐ฆ
RISC-V is that girl, and these are her flags:
-mbranch-cost=N-instruction-mplt-mno-plt-mabi=ABI-string-mfdiv-mno-fdiv-mdiv-mno-div-march=ISA-string-mtune=processor-string-mpreferred-stack-boundary=num-msmall-data-limit=N-bytes-msave-restore-mno-save-restore-mstrict-align-mno-strict-align-mcmodel=medlow-mcmodel=medany-mexplicit-relocs-mno-explicit-relocs-mrelax-mno-relax-mriscv-attribute-mmo-riscv-attribute-malign-data=type
๐ผ RL78 Options ๐ผ
RL78 said โIโm small but I have rangeโ:
-msim-mmul=none-mmul=g13-mmul=g14-mallregs-mcpu=g10-mcpu=g13-mcpu=g14-mg10-mg13-mg14-m64bit-doubles-m32bit-doubles-msave-mduc-in-interrupts
๐ RS/6000 and PowerPC Options ๐
okay bestie, this is the big one. RS/6000 and PowerPC came prepared. no skipping:
-mcpu=cpu-type-mtune=cpu-type-mcmodel=code-model-mpowerpc64-maltivec-mno-altivec-mpowerpc-gpopt-mno-powerpc-gpopt-mpowerpc-gfxopt-mno-powerpc-gfxopt-mmfcrf-mno-mfcrf-mpopcntb-mno-popcntb-mpopcntd-mno-popcntd-mfprnd-mno-fprnd-mcmpb-mno-cmpb-mhard-dfp-mno-hard-dfp-mfull-toc-mminimal-toc-mno-fp-in-toc-mno-sum-in-toc-m64-m32-mxl-compat-mno-xl-compat-mpe-malign-power-malign-natural-msoft-float-mhard-float-mmultiple-mno-multiple-mupdate-mno-update-mavoid-indexed-addresses-mno-avoid-indexed-addresses-mfused-madd-mno-fused-madd-mbit-align-mno-bit-align-mstrict-align-mno-strict-align-mrelocatable-mno-relocatable-mrelocatable-lib-mno-relocatable-lib-mtoc-mno-toc-mlittle-mlittle-endian-mbig-mbig-endian-mdynamic-no-pic-mswdiv-msingle-pic-base-mprioritize-restricted-insns=priority-msched-costly-dep=dependence_type-minsert-sched-nops=scheme-mcall-aixdesc-mcall-eabi-mcall-freebsd-mcall-linux-mcall-netbsd-mcall-openbsd-mcall-sysv-mcall-sysv-eabi-mcall-sysv-noeabi-mtraceback=traceback_type-maix-struct-return-msvr4-struct-return-mabi=abi-type-msecure-plt-mbss-plt-mlongcall-mno-longcall-mpltseq-mno-pltseq-mblock-move-inline-limit=num-mblock-compare-inline-limit=num-mblock-compare-inline-loop-limit=num-mstring-compare-inline-limit=num-misel-mno-isel-mvrsave-mno-vrsave-mmulhw-mno-mulhw-mdlmzb-mno-dlmzb-mprototype-mno-prototype-msim-mmvme-mads-myellowknife-memb-msdata-msdata=opt-mreadonly-in-sdata-mvxworks-G num-mrecip-mrecip=opt-mno-recip-mrecip-precision-mno-recip-precision-mveclibabi=type-mfriz-mno-friz-mpointers-to-nested-functions-mno-pointers-to-nested-functions-msave-toc-indirect-mno-save-toc-indirect-mpower8-fusion-mno-mpower8-fusion-mpower8-vector-mno-power8-vector-mcrypto-mno-crypto-mhtm-mno-htm-mquad-memory-mno-quad-memory-mquad-memory-atomic-mno-quad-memory-atomic-mcompat-align-parm-mno-compat-align-parm-mfloat128-mno-float128-mfloat128-hardware-mno-float128-hardware-mgnu-attribute-mno-gnu-attribute-mstack-protector-guard=guard-mstack-protector-guard-reg=reg-mstack-protector-guard-offset=offset-mprefixed-mno-prefixed-mpcrel-mno-pcrel-mmma-mno-mmma
๐ฆ RX Options ๐ฆ
RX bestie, this is your moment:
-m64bit-doubles-m32bit-doubles-fpu-nofpu-mcpu=-mbig-endian-data-mlittle-endian-data-msmall-data-msim-mno-sim-mas100-syntax-mno-as100-syntax-mrelax-mmax-constant-size=-mint-register=-mpid-mallow-string-insns-mno-allow-string-insns-mjsr-mno-warn-multiple-fast-interrupts-msave-acc-in-interrupts
๐ S/390 and zSeries Options ๐
S/390 and zSeries, mainframe energy, letโs go:
-mtune=cpu-type-march=cpu-type-mhard-float-msoft-float-mhard-dfp-mno-hard-dfp-mlong-double-64-mlong-double-128-mbackchain-mno-backchain-mpacked-stack-mno-packed-stack-msmall-exec-mno-small-exec-mmvcle-mno-mvcle-m64-m31-mdebug-mno-debug-mesa-mzarch-mhtm-mvx-mzvector-mtpf-trace-mno-tpf-trace-mtpf-trace-skip-mno-tpf-trace-skip-mfused-madd-mno-fused-madd-mwarn-framesize-mwarn-dynamicstack-mstack-size-mstack-guard-mhotpatch=halfwords,halfwords
๐ธ Score Options ๐ธ
Score bestie, short but iconic:
-meb-mel-mnhwloop-muls-mmac-mscore5-mscore5u-mscore7-mscore7d
๐ SH Options ๐
SH said โI contain multitudes,โ and honestly? facts:
-m1-m2-m2e-m2a-nofpu-m2a-single-only-m2a-single-m2a-m3-m3e-m4-nofpu-m4-single-only-m4-single-m4-m4a-nofpu-m4a-single-only-m4a-single-m4a-m4al-mb-ml-mdalign-mrelax-mbigtable-mfmovd-mrenesas-mno-renesas-mnomacsave-mieee-mno-ieee-mbitops-misize-minline-ic_invalidate-mpadstruct-mprefergot-musermode-multcost=number-mdiv=strategy-mdivsi3_libfunc=name-mfixed-range=register-range-maccumulate-outgoing-args-matomic-model=atomic-model-mbranch-cost=num-mzdcbranch-mno-zdcbranch-mcbranch-force-delay-slot-mfused-madd-mno-fused-madd-mfsca-mno-fsca-mfsrra-mno-fsrra-mpretend-cmove-mtas
โ๏ธ Solaris 2 Options โ๏ธ
Solaris 2 bestie, hereโs your set:
-mclear-hwcap-mno-clear-hwcap-mimpure-text-mno-impure-text-pthreads
๐ SPARC Options ๐
SPARC is giving range, bestie:
-mcpu=cpu-type-mtune=cpu-type-mcmodel=code-model-mmemory-model=mem-model-m32-m64-mapp-regs-mno-app-regs-mfaster-structs-mno-faster-structs-mflat-mno-flat-mfpu-mno-fpu-mhard-float-msoft-float-mhard-quad-float-msoft-quad-float-mstack-bias-mno-stack-bias-mstd-struct-return-mno-std-struct-return-munaligned-doubles-mno-unaligned-doubles-muser-mode-mno-user-mode-mv8plus-mno-v8plus-mvis-mno-vis-mvis2-mno-vis2-mvis3-mno-vis3-mvis4-mno-vis4-mvis4b-mno-vis4b-mcbcond-mno-cbcond-mfmaf-mno-fmaf-mfsmuld-mno-fsmuld-mpopc-mno-popc-msubxc-mno-subxc-mfix-at697f-mfix-ut699-mfix-ut700-mfix-gr712rc-mlra-mno-lra
โญ System V Options โญ
System V, keeping it classic:
-Qy-Qn-YP,paths-Ym,dir
๐ TILE-Gx Options ๐
TILE-Gx bestie, here you go:
-mcpu=CPU-m32-m64-mbig-endian-mlittle-endian-mcmodel=code-model
๐ฉต TILEPro Options ๐ฉต
TILEPro, tiny list, big energy:
-mcpu=cpu-m32
๐ V850 Options ๐
V850 bestie, this oneโs stacked:
-mlong-calls-mno-long-calls-mep-mno-ep-mprolog-function-mno-prolog-function-mspace-mtda=n-msda=n-mzda=n-mapp-regs-mno-app-regs-mdisable-callt-mno-disable-callt-mv850e2v3-mv850e2-mv850e1-mv850es-mv850e-mv850-mv850e3v5-mloop-mrelax-mlong-jumps-msoft-float-mhard-float-mgcc-abi-mrh850-abi-mbig-switch
๐ฟ VAX Options ๐ฟ
VAX, the retro icon. hereโs the whole vibe:
-mg-mgnu-munix
๐ฝ Visium Options
-mdebug,-msim,-mfpu,-mno-fpu,-mhard-float,-msoft-float,-mcpu=cpu-type*, *-mtune=cpu-type**, **-msv-mode,-muser-mode
๐ง VMS Options
-mvms-return-codes,-mdebug-main=prefix*, *-mmalloc64, *-mpointer-size=size* **
๐ VxWorks Options
-mrtp,-non-static,-Bstatic,-Bdynamic,-Xbind-lazy,-Xbind-now
๐ x86 Options
okay bestie, this one is A LOT, but we're gonna get through it together, no cap.
-mtune=cpu-type*, *-march=cpu-type*, *-mtune-ctrl=feature-list*, *-mdump-tune-features,-mno-default,-mfpmath=unit*, *-masm=dialect*, *-mno-fancy-math-387,-mno-fp-ret-in-387,-m80387,-mhard-float,-msoft-float,-mno-wide-multiply,-mrtd,-malign-double,-mpreferred-stack-boundary=num*, *-mincoming-stack-boundary=num*, *-mcld,-mcx16,-msahf,-mmovbe,-mcrc32,-mrecip,-mrecip=opt*, *-mvzeroupper,-mprefer-avx128,-mprefer-vector-width=opt*, *-mmmx,-msse,-msse2,-msse3,-mssse3,-msse4.1,-msse4.2,-msse4,-mavx,-mavx2,-mavx512f,-mavx512pf,-mavx512er,-mavx512cd,-mavx512vl,-mavx512bw,-mavx512dq,-mavx512ifma,-mavx512vbmi,-msha,-maes,-mpclmul,-mfsgsbase,-mrdrnd,-mf16c,-mfma,-mpconfig,-mwbnoinvd,-mptwrite,-mprefetchwt1,-mclflushopt,-mclwb,-mxsavec,-mxsaves,-msse4a,-m3dnow,-m3dnowa,-mpopcnt,-mabm,-mbmi,-mtbm,-mfma4,-mxop,-madx,-mlzcnt,-mbmi2,-mfxsr,-mxsave,-mxsaveopt,-mrtm,-mhle,-mlwp,-mmwaitx,-mclzero,-mpku,-mthreads,-mgfni,-mvaes,-mwaitpkg,-mshstk,-mmanual-endbr,-mforce-indirect-call,-mavx512vbmi2,-mavx512bf16,-menqcmd,-mvpclmulqdq,-mavx512bitalg,-mmovdiri,-mmovdir64b,-mavx512vpopcntdq,-mavx5124fmaps,-mavx512vnni,-mavx5124vnniw,-mprfchw,-mrdpid,-mrdseed,-msgx,-mavx512vp2intersect,-mcldemote,-mms-bitfields,-mno-align-stringops,-minline-all-stringops,-minline-stringops-dynamically,-mstringop-strategy=alg*, *-mmemcpy-strategy=strategy*, *-mmemset-strategy=strategy*, *-mpush-args,-maccumulate-outgoing-args,-m128bit-long-double,-m96bit-long-double,-mlong-double-64,-mlong-double-80,-mlong-double-128,-mregparm=num*, *-msseregparm,-mveclibabi=type*, *-mvect8-ret-in-mem,-mpc32,-mpc64,-mpc80,-mstackrealign,-momit-leaf-frame-pointer,-mno-red-zone,-mno-tls-direct-seg-refs,-mcmodel=code-model*, *-mabi=name*, *-maddress-mode=mode*, *-m32,-m64,-mx32,-m16,-miamcu,-mlarge-data-threshold=num*, *-msse2avx,-mfentry,-mrecord-mcount,-mnop-mcount,-m8bit-idiv,-minstrument-return=type*, *-mfentry-name=name*, *-mfentry-section=name*, *-mavx256-split-unaligned-load,-mavx256-split-unaligned-store,-malign-data=type*, *-mstack-protector-guard=guard*, *-mstack-protector-guard-reg=reg*, *-mstack-protector-guard-offset=offset*, *-mstack-protector-guard-symbol=symbol*, *-mgeneral-regs-only,-mcall-ms2sysv-xlogues,-mindirect-branch=choice*, *-mfunction-return=choice*, *-mindirect-branch-register,-mharden-sls=choice**, **-mindirect-branch-cs-prefix
๐ช x86 Windows Options
-mconsole,-mcygwin,-mno-cygwin,-mdll,-mnop-fun-dllimport,-mthread,-municode,-mwin32,-mwindows,-fno-set-stack-executable
โ๏ธ Xstormy16 Options
-msim
๐ธ Xtensa Options
-mconst16,-mno-const16,-mfused-madd,-mno-fused-madd,-mforce-no-pic,-mserialize-volatile,-mno-serialize-volatile,-mtext-section-literals,-mno-text-section-literals,-mauto-litpools,-mno-auto-litpools,-mtarget-align,-mno-target-align,-mlongcalls,-mno-longcalls
๐ zSeries Options
See S/390 and zSeries Options.
๐ Options Controlling the Kind of Output
so bestie, compiling isn't one single thing โ it's a whole little pipeline, and the way that it goes is: up to four stages: preprocessing, compilation proper, assembly and linking, always in that exact order. GCC can preprocess and compile a bunch of files either into several assembler input files, or smush them into one assembler input file. Then every assembler input file makes an object file, and linking brings all the object files together โ both the freshly compiled ones and the ones you passed in as input โ into one executable file. โจ
For any given input file, the file name suffix is what decides which kind of compilation happens:
file.cโ C source code that must be preprocessed.file.iโ C source code that should not be preprocessed.file.iiโ C++ source code that should not be preprocessed.file.mโ Objective-C source code. Heads up though: you must link with thelibobjclibrary to make an Objective-C program actually work.file.miโ Objective-C source code that should not be preprocessed.file.mm,file.Mโ Objective-C++ source code. And yes, you must link with thelibobjclibrary to make an Objective-C++ program work. Also 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 (that's the default), or a C, C++ header file to be turned into an Ada spec (via the-fdump-ada-specswitch).file.cc,file.cp,file.cxx,file.cpp,file.CPP,file.c++,file.Cโ C++ source code that must be preprocessed. Careful: in.cxxthe 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โ Fixed form Fortran source code that should not be preprocessed.file.F,file.FOR,file.fpp,file.FPP,file.FTNโ Fixed form Fortran source code that must be preprocessed (with the traditional preprocessor).file.f90,file.f95,file.f03,file.f08โ Free form Fortran source code that should not be preprocessed.file.F90,file.F95,file.F03,file.F08โ Free form Fortran source code that must be preprocessed (with the traditional preprocessor).file.goโ Go source code.file.brigโ BRIG files (binary representation of HSAIL).file.dโ D source code.file.diโ D interface file.file.ddโ D documentation code (Ddoc).file.adsโ Ada source code file 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). These files are also called specs. ๐งfile.adbโ Ada source code file containing a library unit body (a subprogram or package body). These 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 gets treated this way.
You can also just say it out loud which language it is with the -x option:
-xlanguageโ 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. The possible values forlanguageare:
c c-header cpp-output
c++ c++-header c++-cpp-output
objective-c objective-c-header objective-c-cpp-output
objective-c++ objective-c++-header objective-c++-cpp-output
assembler assembler-with-cpp
ada
d
f77 f77-cpp-input f95 f95-cpp-input
go
brig
-x noneโ Turn off any specification of a language, so that subsequent files are handled according to their file name suffixes (as they are if-xhas not been used at all). back to vibes-based defaults, we love to see it.
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 or assemble the source files, but do not link. The linking stage simply is not done. The ultimate output is in the form of an object file for each source file.
By default, the object file name for a source file is made by replacing the suffix .c, .i, .s, etc., with .o.
Unrecognized input files, not requiring compilation or assembly, are ignored.
-Sโ Stop after the stage of compilation proper; do not assemble. The output is in the form of an assembler code file for each non-assembler input file specified.
By default, the assembler file name for a source file is made by replacing the suffix .c, .i, etc., with .s.
Input files that don't require compilation are ignored.
-Eโ Stop after the preprocessing stage; do not run the compiler proper. The output is in the form of preprocessed source code, which is sent to the standard output.
Input files that don't require preprocessing are ignored.
-ofileโ Place output in filefile. 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.
-vโ Print (on standard error output) the commands executed to run the stages of compilation. Also print the version number of the compiler driver program and of the preprocessor and the compiler proper. receipts for everything, love that for us.-###โ 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.
okay that was a lot but you're doing amazing sweetie, keep scrolling, there's more ๐
--help={class|[^]qualifier}[,...]โ bestie this one PRINTS stuff to standard output, ok? It shows you a description of every command-line option the compiler understands that fits into all the classes and qualifiers you listed. Here are the classes you can pick from:optimizersโ shows you literally every optimization option the compiler supports. all of them. the whole squad. ๐ฅwarningsโ shows all the options that control warning messages the compiler spits out.targetโ shows target-specific options. But heads up, unlike the--target-helpoption, this does not show target-specific options of the linker and assembler, because those tools don't currently support the extended--help=syntax. ngl kind of a them problem.paramsโ shows the values that the--paramoption recognizes.languageโ shows the options supported for language, where language is the name of one of the languages supported in this version of GCC. If an option is supported by all languages, you gotta select thecommonclass instead.commonโ shows the options that are common to every language. the shared faves โจ
And here are the supported qualifiers:
undocumentedโ shows only the options that are undocumented. the mysterious ones ๐joinedโ shows options that take an argument appearing right after an equal sign, in the same continuous piece of text, like this:--help=target.separateโ shows options that take an argument appearing as a separate word after the original option, like this:-o output-file.
So for example, to display all the undocumented target-specific switches the compiler supports, you'd use:
--help=target,undocumented
The sense of a qualifier can be flipped 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. fr fr, don't do it.
Combining several classes is possible, though it usually restricts the output so much that there's literally nothing left to display. One case where it does work though 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. And if --help is also specified anywhere on the command line, then it takes precedence over any --help= option. periodt. ๐
If the -Q option shows up on the command line before the --help= option, then the descriptive text that --help= displays changes. Instead of describing the displayed options, it gives you an indication of whether the option is enabled, disabled, or set to a specific value (assuming the compiler knows this at the point where the --help= option is used).
Here's a truncated example from the ARM port of gcc:
% gcc -Q -mabi=2 --help=target -c
The following options are target specific:
-mabi= 2
-mabort-on-noreturn [disabled]
-mapcs [disabled]
The output is sensitive to the effects of previous command-line options, so for example it's possible to find out which optimizations are enabled at -O2 by using:
-Q -O2 --help=optimizers
Alternatively, you can discover which binary optimizations are enabled by -O3 by using:
gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
diff /tmp/O2-opts /tmp/O3-opts | grep enabled
๐ iconic detective work honestly.
--versionโ displays the version number and copyrights of the GCC you just invoked. the receipts, basically. ๐งพ-pass-exit-codesโ normally thegccprogram exits with the code1if 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. Also, the C, C++, and Fortran front ends return4if an internal compiler error is encountered. good to know, bestie.-pipeโ uses pipes instead of temporary files for communication between the various stages of compilation. Lowkey this fails to work on some systems where the assembler can't read from a pipe, but the GNU assembler has no trouble at all. ๐-specs=fileโ processes file after the compiler reads in the standard specs file, in order to override the defaults that thegccdriver program uses when determining what switches to pass tocc1,cc1plus,as,ld, etc. You can specify more than one-specs=fileon the command line, and they get processed in order, from left to right.-wrapperโ invokes all subcommands under a wrapper program. The name of the wrapper program and its parameters are passed as a comma separated list.
gcc -c t.c -wrapper gdb,--args
This invokes all subprograms of gcc under gdb --args, so the invocation of cc1 becomes gdb --args cc1 .... cute little inception moment ๐
-ffile-prefix-map=old=newโ when compiling files that live in directory old, record any references to them in the compilation result as if the files lived 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. See also-fmacro-prefix-mapand-fdebug-prefix-map.-fplugin=name.soโ loads the plugin code in file name.so, assumed to be a shared object to bedlopen'd by the compiler. The base name of the shared object file is used to identify the plugin for the purposes of argument parsing (see-fplugin-arg-name-key=valuebelow). Each plugin should define the callback functions specified in the Plugins API.-fplugin-arg-name-key=valueโ defines an argument called key with a value of value for the plugin called name. โจ-fdump-ada-spec[-slim]โ for C and C++ source and include files, generates corresponding Ada specs. slay, cross-language queen.-fada-spec-parent=unitโ in conjunction with-fdump-ada-spec[-slim]above, generates Ada specs as child units of parent unit.-fdump-go-spec=fileโ for input files in any language, generates corresponding Go declarations in file. This generates Go"const","type","var", and"func"declarations, which may be a useful way to start writing a Go interface to code written in some other language. ๐ฆ@fileโ reads command-line options from file. The options read are inserted in place of the original@fileoption. If file doesn't exist, or can't be read, then the option gets treated literally, and is 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. recursion bestie, we love to see it. ๐
๐ Compiling C++ Programs ๐
C++ source files conventionally use one of the suffixes .C, .cc, .cpp, .CPP, .c++, .cp, or .cxx. C++ header files often use .hh, .hpp, .H, or (for shared template code) .tcc, and preprocessed C++ files use the suffix .ii. GCC recognizes files with these names and compiles them as C++ programs even if you call the compiler the same way as for compiling C programs (usually with the name gcc).
However โ and this is the important part bestie โ the use of gcc does not add the C++ library. g++ is a program that calls GCC and automatically specifies linking against the C++ library. It treats .c, .h and .i files as C++ source files instead of C source files unless -x is used. This program is also useful when precompiling a C header file with a .h extension for use in C++ compilations. On many systems, g++ is also installed with the name c++. ๐
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โ in C mode, this is equivalent to-std=c90. In C++ mode, it's equivalent to-std=c++98.
This turns off certain features of GCC that are incompatible with ISO C90 (when compiling C code), or of standard C++ (when compiling C++ code), such as the "asm" and "typeof" keywords, and predefined macros such as "unix" and "vax" that identify the type of system you're using. It also enables the undesirable and rarely used ISO trigraph feature. For the C compiler, it disables recognition of C++ style // comments as well as the "inline" keyword.
The alternate keywords "__asm__", "__extension__", "__inline__" and "__typeof__" continue to work despite -ansi. You would not want to use them in an ISO C program, of course, but it's useful to put them in header files that might be included in compilations done with -ansi. Alternate predefined macros such as "__unix__" and "__vax__" are also available, with or without -ansi.
The -ansi option does not cause non-ISO programs to be rejected gratuitously. For that, -Wpedantic is required in addition to -ansi.
The macro "__STRICT_ANSI__" is predefined when the -ansi option is used. Some header files may notice this macro and refrain from declaring certain functions or defining certain macros that the ISO standard doesn't call for; this is to avoid interfering with any programs that might use these names for other things.
Functions that are normally built in but do not have semantics defined by ISO C (such as "alloca" and "ffs") are not built-in functions when -ansi is used. noted. ๐
-std=โ determine the language standard. This option is currently only supported when compiling C or C++.
So like, the compiler is not a one-standard stan, bestie ๐
โ she can accept several base standards, like c90 or c++98, plus the GNU dialects of those standards, like gnu90 or gnu++98. When you pick a base standard, she accepts every program that follows that standard, plus the ones using GNU extensions that don't contradict it. For example, -std=c90 turns off certain features of GCC that are incompatible with ISO C90 โ like the asm and typeof keywords โ but not other GNU extensions that just don't have a meaning in ISO C90, like omitting the middle term of a ?: expression. iconic, honestly โจ
But flip it โ when you specify a GNU dialect of a standard, all the features the compiler supports get enabled, even when those features change the meaning of the base standard ๐ณ. As a result, some strict-conforming programs may get rejected. The particular standard you picked is what -Wpedantic uses to figure out which features count as GNU extensions for that version of the standard. For example, -std=gnu90 -Wpedantic warns about C++ style // comments, while -std=gnu99 -Wpedantic does not. the way she keeps track of all thatโฆ ๐
A value for this option must be provided, no vibes-based guessing allowed. Possible values are:
c90,c89,iso9899:1990โ support all ISO C90 programs (certain GNU extensions that conflict with ISO C90 are disabled). Same as-ansifor C code. โจiso9899:199409โ ISO C90 as modified in amendment 1.c99,c9x,iso9899:1999,iso9899:199xโ ISO C99. This standard is substantially completely supported, modulo bugs and floating-point issues (mainly but not entirely relating to optional C99 features from Annexes F and G). See <http://gcc.gnu.org/c99status.html> for more info. The namesc9xandiso9899:199xare deprecated. ๐ซc11,c1x,iso9899:2011โ ISO C11, the 2011 revision of the ISO C standard. Substantially completely supported, modulo bugs, floating-point issues (mainly but not entirely relating to optional C11 features from Annexes F and G) and the optional Annexes K (Bounds-checking interfaces) and L (Analyzability). The namec1xis deprecated.c17,c18,iso9899:2017,iso9899:2018โ ISO C17, the 2017 revision of the ISO C standard (published in 2018). This standard is same as C11 except for corrections of defects (all of which are also applied with-std=c11) and a new value of__STDC_VERSION__, and so is supported to the same extent as C11. ๐c2xโ the next version of the ISO C standard, still under development. Support for this version is experimental and incomplete.gnu90,gnu89โ GNU dialect of ISO C90 (including some C99 features).gnu99,gnu9xโ GNU dialect of ISO C99. The namegnu9xis deprecated.gnu11,gnu1xโ GNU dialect of ISO C11. The namegnu1xis deprecated.gnu17,gnu18โ GNU dialect of ISO C17. This is the default for C code. ๐gnu2xโ the next version of the ISO C standard, still under development, plus GNU extensions. Support for this version is experimental and incomplete.c++98,c++03โ the 1998 ISO C++ standard plus the 2003 technical corrigendum and some additional defect reports. Same as-ansifor C++ code.gnu++98,gnu++03โ GNU dialect of-std=c++98.c++11,c++0xโ the 2011 ISO C++ standard plus amendments. The namec++0xis deprecated.gnu++11,gnu++0xโ GNU dialect of-std=c++11. The namegnu++0xis deprecated.c++14,c++1yโ the 2014 ISO C++ standard plus amendments. The namec++1yis deprecated.gnu++14,gnu++1yโ GNU dialect of-std=c++14. This is the default for C++ code. 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 next revision of the ISO C++ standard, planned for 2020. Support is highly experimental, and will almost certainly change in incompatible ways in future releases. ๐ญgnu++20,gnu++2aโ GNU dialect of-std=c++20. Support is highly experimental, and will almost certainly change in incompatible ways in future releases.
-fgnu89-inlineโ tells GCC to use the traditional GNU semantics forinlinefunctions when in C99 mode. Using this option is roughly equivalent to adding thegnu_inlinefunction 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. ๐ซถ
-fpermitted-flt-eval-methods=styleโ ISO/IEC TS 18661-3 defines new permissible values forFLT_EVAL_METHODthat indicate that operations and constants with a semantic type that is an interchange or extended format should be evaluated to the precision and range of that type. These new values are a superset of those permitted under C99/C11, which does not specify the meaning of other positive values ofFLT_EVAL_METHOD. As such, code conforming to C11 may not have been written expecting the possibility of the new values. ๐ณ
-fpermitted-flt-eval-methods specifies whether the compiler should allow only the values of FLT_EVAL_METHOD specified in C99/C11, or the extended set of values specified in ISO/IEC TS 18661-3.
style is either c11 or ts-18661-3 as appropriate.
The default when in a standards compliant mode (-std=c11 or similar) is -fpermitted-flt-eval-methods=c11. The default when in a GNU dialect (-std=gnu11 or similar) is -fpermitted-flt-eval-methods=ts-18661-3. ๐
-aux-infofilename โ output to the given filename prototyped declarations for all functions declared and/or defined in a translation unit, including those in header files. This option is silently ignored in any language other than C.
Besides declarations, the file indicates, in comments, the origin of each declaration (source file and line), whether the declaration was implicit, prototyped or unprototyped (I, N for new or O for old, respectively, in the first character after the line number and the colon), and whether it came from a declaration or a definition (C or F, respectively, in the following character). In the case of function definitions, a K&R-style list of arguments followed by their declarations is also provided, inside comments, after the declaration. ๐
-fallow-parameterless-variadic-functionsโ accept variadic functions without named parameters. Although it is possible to define such a function, this is not very useful as it is not possible to read the arguments ๐. This is only supported for C as this construct is allowed by C++.-fno-asmโ do not recognizeasm,inlineortypeofas a keyword, so that code can use these words as identifiers. You can use the keywords__asm__,__inline__and__typeof__instead.-ansiimplies-fno-asm.
In C++, this switch only affects the typeof keyword, since asm and inline are standard keywords. You may want to use the -fno-gnu-keywords flag instead, which has the same effect. In C99 mode (-std=c99 or -std=gnu99), this switch only affects the asm and typeof keywords, since inline is a standard keyword in ISO C99. โจ
-fno-builtin,-fno-builtin-functionโ don't recognize built-in functions that do not begin with__builtin_as prefix.
GCC normally generates special code to handle certain built-in functions more efficiently; for instance, calls to alloca may become single instructions which adjust the stack directly, and calls to memcpy may become inline copy loops. The resulting code is often both smaller and faster, but since the function calls no longer appear as such, you cannot set a breakpoint on those calls, nor can you change the behavior of the functions by linking with a different library. In addition, when a function is recognized as a built-in function, GCC may use information about that function to warn about problems with calls to that function, or to generate more efficient code, even if the resulting code still contains calls to that function. For example, warnings are given with -Wformat for bad calls to printf when printf is built in and strlen is known not to modify global memory.
With the -fno-builtin-function option only the built-in function function is disabled. function must not begin with __builtin_. If a function is named that is not built-in in this version of GCC, this option is ignored. There is no corresponding -fbuiltin-function option; if you wish to enable built-in functions selectively when using -fno-builtin or -ffreestanding, you may define macros such as:
#define abs(n) __builtin_abs ((n))
#define strcpy(d, s) __builtin_strcpy ((d), (s))
-fgimpleโ enable parsing of function definitions marked with__GIMPLE. This is an experimental feature that allows unit testing of GIMPLE passes. ๐ง-fhostedโ assert that compilation targets a hosted environment. This implies-fbuiltin. A hosted environment is one in which the entire standard library is available, and in whichmainhas a return type ofint. Examples are nearly everything except a kernel. This is equivalent to-fno-freestanding. ๐-ffreestandingโ assert that compilation targets a freestanding environment. This implies-fno-builtin. A freestanding environment is one in which the standard library may not exist, and program startup may not necessarily be atmain. The most obvious example is an OS kernel. This is equivalent to-fno-hosted. ๐-fopenaccโ bestie, this turns ON handling of OpenACC directives:#pragma accin C/C++ and!$accin Fortran ๐. When you pass-fopenacc, the compiler generates accelerated code according to the OpenACC Application Programming Interface v2.6 <https://www.openacc.org>. Heads up though: this option implies-pthread, so it's only supported on targets that actually have support for-pthread. No-pthread, no vibes โจ.-fopenacc-dim=geom โ sets the default compute dimensions for parallel offload regions that don't explicitly specify them. The geom value is a triple of:-separated sizes, in ordergang,worker, andvector๐ซถ. Any size can be omitted, and then it just uses a target-specific default value. Lowkey flexible of it.-fopenmpโ enables handling of OpenMP directives:#pragma ompin C/C++ and!$ompin Fortran. When-fopenmpis specified, the compiler generates parallel code according to the OpenMP Application Program Interface v4.5 <https://www.openmp.org>. This option implies-pthread, so โ same deal as above โ it's only supported on targets that have support for-pthread. Also,-fopenmpimplies-fopenmp-simd. It's giving "package deal" ๐ .-fopenmp-simdโ enables handling of OpenMP's SIMD directives with#pragma ompin C/C++ and!$ompin Fortran. Other OpenMP directives are ignored, periodt. So it's SIMD only, the rest can sit down ๐.-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) ๐ฅ. Now listen: this is an experimental feature whose interface may change in future versions of GCC as the official specification changes. Also please note that not all architectures are supported for this feature. Not everyone gets an invite to this party.
For more information on GCC's support for transactional memory, (that's where the original trails off, bestie, it just... stops โจ).
Note that the transactional memory feature is not supported with non-call exceptions (-fnon-call-exceptions). Pick one, babes.
-fms-extensionsโ accepts some non-standard constructs used in Microsoft header files. Very "we tolerate your ex" energy ๐.
In C++ code, this allows member names in structures to be similar to previous types declarations. Like:
typedef int UOW;
struct ABC {
UOW UOW;
};
Some cases of unnamed fields in structures and unions are only accepted with this option. And note that this option is off for all targets except for x86 targets using ms-abi ๐.
-fplan9-extensionsโ accepts 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++ ๐ฆ.
-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++. Sorry C++ girlies, not today ๐.-flax-vector-conversionsโ allow implicit conversions between vectors with differing numbers of elements and/or incompatible element types. Um, this option should not be used for new code. It's a legacy thing, iykyk ๐.-funsigned-charโ let the typecharbe unsigned, likeunsigned char๐ธ.
Each kind of machine has a default for what char should be. It's either like unsigned char by default or like signed char by default. No cap.
Ideally, a portable program should always use signed char or unsigned char when it depends on the signedness of an object. But many programs have been written to use plain char and expect it to be signed, or expect it to be unsigned, depending on the machines they were written for. This option, and its inverse, let you make such a program work with the opposite default. So cute of it honestly ๐ซถ.
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. Main character with a costume change, fr.
-fsigned-charโ let the typecharbe signed, likesigned char.
Note that this is equivalent to -fno-unsigned-char, which is the negative form of -funsigned-char. Likewise, the option -fno-signed-char is equivalent to -funsigned-char. So many ways to say the same thing, iconic ๐
.
-fsigned-bitfieldsโจ-funsigned-bitfields-fno-signed-bitfields-fno-unsigned-bitfields
These options control whether a bit-field is signed or unsigned, when the declaration does not use either signed or unsigned. By default, such a bit-field is signed, because this is consistent: the basic integer types such as int are signed types. Consistency slay ๐.
-fsso-struct=endianness โ set 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 (the default). This option is not supported for C++.
Warning: the -fsso-struct switch causes GCC to generate code that is not binary compatible with code generated without it if the specified endianness is not the native endianness of the target. Do not mix and match, bestie, it will not go well ๐ญ.
๐ Options Controlling C++ Dialect ๐
This section describes the command-line options that are only meaningful for C++ programs. You can also use most of the GNU compiler options regardless of what language your program is in ๐. For example, you might compile a file firstClass.C like this:
g++ -g -fstrict-enums -O -c firstClass.C
In this example, only -fstrict-enums is an option meant only for C++ programs; you can use the other options with any language supported by GCC โจ.
Some options for compiling C programs, such as -std, are also relevant for C++ programs.
Here is a list of options that are only for compiling C++ programs:
-fabi-version=n โ use version n of the C++ ABI. The default is version0.
Version 0 refers to the version conforming most closely to the C++ ABI specification. Therefore, the ABI obtained using version 0 will change in different versions of G++ as ABI bugs are fixed. It's giving "living document", fr fr.
Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
Version 2 is the version of the C++ ABI that first appeared in G++ 3.4, and was the default through G++ 4.9.
Version 3 corrects an error in mangling a constant address as a template argument.
Version 4, which first appeared in G++ 4.5, implements a standard mangling for vector types.
Version 5, which first appeared in G++ 4.6, corrects the mangling of attribute const/volatile on function pointer types, decltype of a plain decl, and use of a function parameter in the declaration of another parameter.
Version 6, which first appeared in G++ 4.7, corrects the promotion behavior of C++11 scoped enums and the mangling of template argument packs, const/static_cast, prefix ++ and --, and a class scope function used as a template argument.
Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a builtin type and corrects the mangling of lambdas in default argument scope.
Version 8, which first appeared in G++ 4.9, corrects the substitution behavior of function types with function-cv-qualifiers.
Version 9, which first appeared in G++ 5.2, corrects the alignment of nullptr_t.
Version 10, which first appeared in G++ 6.1, adds mangling of attributes that affect type identity, such as ia32 calling convention attributes (e.g. stdcall).
Version 11, which first appeared in G++ 7, corrects the mangling of sizeof... expressions and operator names. For multiple entities with the same name within a function, that are declared in different scopes, the mangling now changes starting with the twelfth occurrence. It also implies -fnew-inheriting-ctors.
Version 12, which first appeared in G++ 8, corrects the calling conventions for empty classes on the x86_64 target and for classes with only deleted copy/move constructors. It accidentally changes the calling convention for classes with a deleted copy constructor and a trivial move constructor. Oopsie ๐.
Version 13, which first appeared in G++ 8.2, fixes the accidental change in version 12. Character development ๐
.
Version 14, which first appeared in G++ 10, corrects the mangling of the nullptr expression.
See also -Wabi.
-fabi-compat-version=n โ on targets that support strong aliases, G++ works around mangling changes by creating an alias with the correct mangled name when defining a symbol with an incorrect mangled name. This switch specifies which ABI version to use for the alias ๐ฅ.
With -fabi-version=0 (the default), this defaults to 11 (GCC 7 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. Coordinated, no cap โจ.
-fno-access-controlโ turn off all access checking. This switch is mainly useful for working around bugs in the access control code. It's giving "the rules are a suggestion" ๐.-faligned-newโ enable support for C++17newof types that require more alignment thanvoid* ::operator new(std::size_t)provides. A numeric argument such as-faligned-new=32can be used to specify how much alignment (in bytes) is provided by that function, but few users will need to override the default ofalignof(std::max_align_t)๐ซถ.
This flag is enabled by default for -std=c++17.
-fchar8_tโจ-fno-char8_t
Enable support for char8_t as adopted for C++2a. This includes the addition of a new char8_t fundamental type, changes to the types of UTF-8 string and character literals, new signatures for user-defined literals, associated standard library updates, and new __cpp_char8_t and __cpp_lib_char8_t feature test macros ๐.
This option enables functions to be overloaded for ordinary and UTF-8 strings:
int f(const char *); // #1
int f(const char8_t *); // #2
int v1 = f("text"); // Calls #1
int v2 = f(u8"text"); // Calls #2
and introduces new signatures for user-defined literals:
int operator""_udl1(char8_t);
int v3 = u8'x'_udl1;
int operator""_udl2(const char8_t*, std::size_t);
int v4 = u8"text"_udl2;
template<typename T, T...> int operator""_udl3();
int v5 = u8"text"_udl3;
okay so bestie, the glow-up to the types of UTF-8 string and character literals? it introduces incompatibilities with ISO C++11 and later standards. ๐ญ Like, this lil guy right here is well-formed under ISO C++11, but the literal second you add -fchar8_t it becomes ill-formed. no cap:
char ca[] = u8"xx"; // error: char-array initialized from wide
// string
const char *cp = u8"xx";// error: invalid conversion from
// `const char8_t*' to `const char*'
int f(const char*);
auto v = f(u8"xx"); // error: invalid conversion from
// `const char8_t*' to `const char*'
std::string s{u8"xx"}; // error: no matching function for call to
// `std::basic_string<char>::basic_string()'
using namespace std::literals;
s = u8"xx"s; // error: conversion from
// `basic_string<char8_t>' to non-scalar
// type `basic_string<char>' requested
-fcheck-newโ vibe check the pointer, bestie โจ Before touching the storage thatoperator newhanded you, make sure that pointer isn't null. Normally you don't need this at all, because the C++ standard saysoperator newonly returns 0 if it's declaredthrow(), and in that case the compiler always checks the return value anyway, even without this option. In every other case, whenoperator newhas a non-empty exception specification, running out of memory gets signalled by throwingstd::bad_allocinstead. See also new (nothrow). ๐ซถ-fconcepts-fconcepts-tsโ Okay so below-std=c++2a,-fconceptsturns on support for the C++ Extensions for Concepts Technical Specification, ISO 19217 (2015). ๐ And with-std=c++2aand above, Concepts are part of the language standard, so-fconceptsdefaults to on. BUT โ and this is the tea โ the standard's specification of Concepts differs significantly from the TS, so some constructs that were allowed in the TS but didn't make it into the standard can still be enabled with-fconcepts-ts. ๐- *
-fconstexpr-depth=n* โ Sets the maximum nested evaluation depth for C++11 constexpr functions to n. You need a limit, otherwise the compiler would just spiral into endless recursion during constant expression evaluation forever. ๐ตโ๐ซ The minimum specified by the standard is512. - *
-fconstexpr-cache-depth=n* โ Sets the max level of nested evaluation depth for C++11 constexpr functions that gets cached to n. It's a heuristic, so it's trading off compilation speed (when the cache avoids repeated calculations ๐๏ธ) against memory consumption (when the cache grows huge from highly recursive evaluations ๐). The default is8. Very few users are likely to want to adjust it, but if your code does heavy constexpr calculations you might want to experiment to find which value works best for you. ๐ฌ - *
-fconstexpr-loop-limit=n* โ Sets the max number of iterations for a loop in C++14 constexpr functions to n. Again, a limit is needed to detect infinite loops during constant expression evaluation. ๐ The default is262144(1<<18). - *
-fconstexpr-ops-limit=n* โ Sets the max number of operations during a single constexpr evaluation. Even when the number of iterations of a single loop is limited with the above limit, if there are several nested loops and each of them has many iterations but still smaller than the above limit, or if in a body of some loop or even outside of a loop too many expressions need to be evaluated, the resulting constexpr evaluation might take way too long. โณ The default is33554432(1<<25). -fcoroutinesโ Turns on support for the C++ coroutines extension (experimental). ๐งช experimental, bestie, you've been warned-fno-elide-constructorsโ So the C++ standard allows an implementation to skip creating a temporary that's only used to initialize another object of the same type. Specifying this option disables that optimization, and forces G++ to call the copy constructor in all cases. This option also causes G++ to call trivial member functions which otherwise would be expanded inline. In C++17, the compiler is required to omit these temporaries, but this option still affects trivial member functions. ๐-fno-enforce-eh-specsโ Don't generate code to check for violation of exception specifications at run time. ๐ซ This option violates the C++ standard, but it may be useful for reducing code size in production builds, much like definingNDEBUG. Heads up though: this does not give user code permission to throw exceptions in violation of the exception specifications โ the compiler still optimizes based on the specifications, so throwing an unexpected exception results in undefined behavior at run time. ๐-fextern-tls-init-fno-extern-tls-initโ The C++11 and OpenMP standards allowthread_localandthreadprivatevariables to have dynamic (runtime) initialization. To support this, any use of such a variable goes through a wrapper function that performs any necessary initialization. ๐ When the use and definition of the variable are in the same translation unit, this overhead can be optimized away โ but when the use is in a different translation unit there'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 avoid this overhead with the-fno-extern-tls-initoption. ๐ง On targets that support symbol aliases, the default is-fextern-tls-init. On targets that do not support symbol aliases, the default is-fno-extern-tls-init. periodt.-fno-gnu-keywordsโ Don't recognizetypeofas a keyword, so that code can use this word as an identifier. You can use the keyword__typeof__instead. ๐ This option is implied by the strict ISO C++ dialects:-ansi,-std=c++98,-std=c++11, etc.-fno-implicit-templatesโ never emit code for non-inline templates that are instantiated implicitly (i.e. by use); only emit code for explicit instantiations. ๐จ If you use this option, you must take care to structure your code to include all the necessary explicit instantiations, otherwise you're getting undefined symbols at link time. link errors are not the vibe. ๐ญ-fno-implicit-inline-templatesโ Don't emit code for implicit instantiations of inline templates, either. The default is to handle inlines differently so that compiles with and without optimization need the same set of explicit instantiations. ๐ธ-fno-implement-inlinesโ To save space, don't emit out-of-line copies of inline functions controlled by#pragma implementation. โ ๏ธ This causes linker errors if these functions aren't inlined everywhere they're called. so like, yikes.-fms-extensionsโ DisablesWpedanticwarnings about constructs used in MFC, such as implicit int and getting a pointer to member function via non-standard syntax. ๐ช-fnew-inheriting-ctorsโ Enables the P0136 adjustment to the semantics of C++11 constructor inheritance. This is part of C++17 but also considered to be a Defect Report against C++11 and C++14. โ This flag is enabled by default unless-fabi-version=10or lower is specified.-fnew-ttp-matchingโ Enables 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โ Disables built-in declarations of functions that are not mandated by ANSI/ISO C. ๐ซ These includeffs,alloca,_exit,index,bzero,conjf, and other related functions.-fnothrow-optโ Treats athrow()exception specification as if it were anoexceptspecification, to reduce or eliminate the text size overhead relative to a function with no exception specification. ๐ค If the function has local variables of types with non-trivial destructors, the exception specification actually makes the function smaller, because the EH cleanups for those variables can be optimized away. The semantic effect is that an exception thrown out of a function with such an exception specification results in a call toterminaterather thanunexpected. ๐ณ-fno-operator-namesโ Don't treat the operator name keywordsand,bitand,bitor,compl,not,orandxoras synonyms as keywords. โ๏ธ-fno-optional-diagsโ Disables 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. ๐คซ-fpermissiveโ Downgrades some diagnostics about nonconformant code from errors to warnings. ๐ So using-fpermissiveallows some nonconforming code to compile. (the compiler is being nice to you, don't push it ๐ )-fno-pretty-templatesโ So when an error message refers to a specialization of a function template, the compiler normally prints the signature of the template followed by the template arguments and any typedefs or typenames in the signature (e.g.void f(T) [with T = int]rather thanvoid f(int)) so that it's clear which template is involved. ๐ And when an error message refers to a specialization of a class template, the compiler omits any template arguments that match the default template arguments for that template. If either of these behaviors makes it harder to understand the error message rather than easier, you can use-fno-pretty-templatesto disable them.-fno-rttiโ Disables generation of information about every class with virtual functions for use by the C++ run-time type identification features (dynamic_castandtypeid). ๐ซ If you don't use those parts of the language, you can save some space by using this flag. Note that exception handling uses the same information, but G++ generates it as needed. Thedynamic_castoperator can still be used for casts that do not require run-time type information, i.e. casts tovoid *or to unambiguous base classes. ๐
โ ๏ธ Mixing code compiled with-frttiwith that compiled with-fno-rttimay not work. For example, programs may fail to link if a class compiled with-fno-rttiis used as a base for a class compiled with-frtti. fr fr, keep your RTI settings consistent bestie. ๐ญ
-fsized-deallocationโ bestie, this turns on 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. It's giving very useful energy for user-defined replacement deallocation functions that, for example, use the size of the object to make deallocation faster. Enabled by default under -std=c++14 and above. And the flag -Wsized-deallocation warns about places that might want to add a definition. ๐
-fstrict-enumsโ lets the compiler optimize using the assumption that a value of enumerated type can only be one of the values of the enumeration (as defined in the C++ standard; basically, a value that can be represented in the minimum number of bits needed to represent all the enumerators). โจ Heads up though: this assumption may not be valid if the program uses a cast to convert an arbitrary integer value to the enumerated type. So like, don't do that.-fstrong-eval-orderโ evaluate member access, array subscripting, and shift expressions in left-to-right order, and evaluate assignment in right-to-left order, as adopted for C++17. Enabled by default with-std=c++17. The flavor-fstrong-eval-order=someenables just the ordering of member access and shift expressions, and is the default without-std=c++17. Ordering? We love her. ๐-ftemplate-backtrace-limit=nโ sets the maximum number of template instantiation notes for a single warning or error to n. The default value is10.-ftemplate-depth=nโ sets the maximum instantiation depth for template classes to n. A limit on the template instantiation depth is needed to detect endless recursions during template class instantiation. ANSI/ISO C++ conforming programs must not rely on a maximum depth greater than17(changed to1024in C++11). The default value is900, as the compiler can run out of stack space before hitting1024in some situations. ๐ญ the stack said no.-fno-threadsafe-staticsโ do not emit the extra code to use the routines specified in the C++ ABI for thread-safe initialization of local statics. You can use this option to reduce code size slightly in code that doesn't need to be thread-safe. Lowkey a size-queen move.-fuse-cxa-atexitโ register destructors for objects with static storage duration with the"__cxa_atexit"function rather than the"atexit"function. This option is required for fully standards-compliant handling of static destructors, but only works if your C library supports"__cxa_atexit". No cap, check your libc first. ๐ซถ-fno-use-cxa-get-exception-ptrโ don't use the"__cxa_get_exception_ptr"runtime routine. This causes"std::uncaught_exception"to be incorrect, but is necessary if the runtime routine is not available. Trade-offs, babe. ๐-fvisibility-inlines-hiddenโ this switch declares that the user does not attempt to compare pointers to inline functions or methods where the addresses of the two functions are taken in different shared objects.
The effect of this is that GCC may, effectively, mark inline methods with "__attribute__ ((visibility ("hidden")))" so that they do not appear in the export table of a DSO and do not require a PLT indirection when used within the DSO. Enabling this option can have a dramatic effect on load and link times of a DSO as it massively reduces the size of the dynamic export table when the library makes heavy use of templates. ๐ฅ iconic behavior honestly.
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.
- It sets the default visibility to
In new code it is better to use -fvisibility=hidden and export those classes that are intended to be externally visible. Unfortunately it is possible for code to rely, perhaps accidentally, on the Visual Studio behavior. ๐
Among the consequences of these changes are that static data members of the same type with the same name but defined in different shared objects are different, so changing one does not change the other; and that pointers to function members defined in different shared objects may not compare equal. When this flag is given, it is a violation of the ODR to define types with the same name differently.
-fno-weakโ do not use weak symbol support, even if it is provided by the linker. By default, G++ uses weak symbols if they are available.
This option exists only for testing, and should not be used by end-users; it results in inferior code and has no benefits. This option may be removed in a future release of G++. ๐จ bestie do NOT.
-fext-numeric-literals(C++ and Objective-C++ only) โ accept imaginary, fixed-point, or machine-defined literal number suffixes as GNU extensions. When this option is turned off these suffixes are treated as C++11 user-defined literal numeric suffixes. This is on by default for all pre-C++11 dialects and all GNU dialects:-std=c++98,-std=gnu++98,-std=gnu++11,-std=gnu++14. This option is off by default for ISO C++11 onwards (-std=c++11, ...).-nostdinc++โ do not search for header files in the standard directories specific to C++, but do still search the other standard directories. (This option is used when building the C++ library.) ๐
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.-Wcomma-subscript(C++ and Objective-C++ only) โ warn about uses of a comma expression within a subscripting expression. This usage was deprecated in C++2a. However, a comma expression wrapped in"( )"is not deprecated. Example:
void f(int *a, int b, int c) {
a[b,c]; // deprecated
a[(b,c)]; // OK
}
Enabled by default with -std=c++2a. Parentheses are the moment, fr fr. ๐
-Wctor-dtor-privacy(C++ and Objective-C++ only) โ warn when a class seems unusable because all the constructors or destructors in that class are private, and it has neither friends nor public static member functions. Also warn if there are no non-private methods, and there's at least one private member function that isn't a constructor or destructor. She's private and unusable, the way that nobody can even touch her ๐ญ-Wdelete-non-virtual-dtor(C++ and Objective-C++ only) โ warn when"delete"is used to destroy an instance of a class that has virtual functions and 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. ๐จ unsafe, bestie!-Wdeprecated-copy(C++ and Objective-C++ only) โ warn that the implicit declaration of a copy constructor or copy assignment operator is deprecated if the class has a user-provided copy constructor or copy assignment operator, in C++11 and up. This warning is enabled by-Wextra. With-Wdeprecated-copy-dtor, also deprecate if the class has a user-provided destructor.-Wno-init-list-lifetime(C++ and Objective-C++ only) โ do not warn about uses 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.
- If a function returns a temporary
// li's initial underlying array lives as long as li
std::initializer_list<int> li = { 1,2,3 };
// assignment changes li to point to a temporary array
li = { 4, 5 };
// now the temporary is gone and li has a dangling pointer
int i = li.begin()[0] // undefined behavior
- When a list constructor stores the
"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, babes. literally do not. ๐ซ
-Wno-literal-suffix(C++ and Objective-C++ only) โ do not warn when a string or character literal is followed by a ud-suffix which does not begin with an underscore. As a conforming extension, GCC treats such suffixes as separate preprocessing tokens in order to maintain backwards compatibility with code that uses formatting macros from"<inttypes.h>". For example:
#define __STDC_FORMAT_MACROS
#include <inttypes.h>
#include <stdio.h>
-Wno-narrowing(C++ and Objective-C++ only) โ okay so bestie, for C++11 and later standards, narrowing conversions get diagnosed by default, because the standard literally says so, no cap. A narrowing conversion from a constant produces an error, and a narrowing conversion from a non-constant produces a warning, but-Wno-narrowingshuts the whole diagnostic up. โ ๏ธ Heads up though: this does not change the meaning of well-formed code โ narrowing conversions are still considered ill-formed in SFINAE contexts. It's giving "silenced but not forgiven."
With -Wnarrowing in C++98, you'll get a warning when a narrowing conversion prohibited by C++11 happens inside { }, like:
int i = { 2.2 }; // error: narrowing from double to int
This flag is included in -Wall and -Wc++11-compat. ๐
-Wnoexcept(C++ and Objective-C++ only) โ warn when anoexcept-expression evaluates tofalsebecause of a call to a function that does not have a non-throwing exception specification (i.e.throw()or"noexcept") but is known by the compiler to never throw an exception. She's messy like that. ๐-Wnoexcept-type(C++ and Objective-C++ only) โ warn if the C++17 feature making"noexcept"part of a function type changes the mangled name of a symbol relative to C++14. Enabled by-Wabiand-Wc++17-compat. Lowkey a glow-up that breaks stuff.
For example:
template <class T> void f(T t) { t(); };
void g() noexcept;
void h() { f(g); }
In C++14, "f" calls "f<void(*)()>", but in C++17 it calls "f<void(*)()noexcept>". โจ
-Wclass-memaccess(C++ and Objective-C++ only) โ warn when the destination of a call to a raw memory function such as"memset"or"memcpy"is an object of class type, and when writing into such an object might bypass the class non-trivial or deleted constructor or copy assignment, violate const-correctness or encapsulation, or corrupt virtual table pointers. Modifying the representation of such objects may violate invariants maintained by member functions of the class. ๐ญ For example, the call to"memset"below is undefined because it modifies a non-trivial class object and is, therefore, diagnosed. The safe way to either initialize or clear the storage of objects of such types is by using the appropriate constructor or assignment operator, if one is available. ๐ซถ
std::string str = "abc";
memset (&str, 0, sizeof str);
The -Wclass-memaccess option is enabled by -Wall. Explicitly casting the pointer to the class object to "void *" or to a type that can be safely accessed by the raw memory function suppresses the warning. ๐ฆ
-Wnon-virtual-dtor(C++ and Objective-C++ only) โ warn when a class has virtual functions and an accessible non-virtual destructor itself or in an accessible polymorphic base class, in which case it is possible but unsafe to delete an instance of a derived class through a pointer to the class itself or base class. This warning is automatically enabled if-Weffc++is specified. ๐-Wregister(C++ and Objective-C++ only) โ warn on uses of the"register"storage class specifier, except when it's part of the GNU Explicit Register Variables extension. The use of the"register"keyword as storage class specifier has been deprecated in C++11 and removed in C++17. Enabled by default with-std=c++17. She's an icon, she's a legend, and she's gone. ๐-Wreorder(C++ and Objective-C++ only) โ warn when the order of member initializers given in the code does not match the order in which they must be executed. For instance:
struct A {
int i;
int j;
A(): j (0), i (1) { }
};
The compiler rearranges the member initializers for "i" and "j" to match the declaration order of the members, emitting a warning to that effect. This warning is enabled by -Wall. ๐ธ
-Wno-pessimizing-move(C++ and Objective-C++ only) โ this warning warns when a call to"std::move"prevents copy elision. A typical scenario when copy elision can occur is when returning in a function with a class return type, when the expression being returned is the name of a non-volatile automatic object, and is not a function parameter, and has the same type as the function return type. ๐
struct T {
...
};
T fn()
{
T t;
...
return std::move (t);
}
But in this example, the "std::move" call prevents copy elision. Not the vibe. ๐
This warning is enabled by -Wall.
-Wno-redundant-move(C++ and Objective-C++ only) โ this warning warns about redundant calls to"std::move"; that is, when a move operation would have been performed even without the"std::move"call. This happens because the compiler is forced to treat the object as if it were an rvalue in certain situations such as returning a local variable, where copy elision isn't applicable. Consider:
struct T {
...
};
T fn(T t)
{
...
return std::move (t);
}
Here, the "std::move" call is redundant. Because G++ implements Core Issue 1579, another example is:
struct T { // convertible to U
...
};
struct U {
...
};
U fn()
{
T t;
...
return std::move (t);
}
In this example, copy elision isn't applicable because the type of the expression being returned and the function return type differ, yet G++ treats the return value as if it were designated by an rvalue. ๐คท
This warning is enabled by -Wextra. โญ
-Wredundant-tags(C++ and Objective-C++ only) โ warn about redundant class-key and enum-key in references to class types and enumerated types in contexts where the key can be eliminated without causing an ambiguity. For example:
struct foo;
struct foo *p; // warn that keyword struct can be eliminated
On the other hand, in this example there is no warning:
struct foo;
void foo (); // "hides" struct foo
void bar (struct foo&); // no warning, keyword struct is necessary
-Wno-subobject-linkage(C++ and Objective-C++ only) โ do not warn if a class type has a base or a field whose type uses the anonymous namespace or depends on a type with no linkage. If a type A depends on a type B with no or internal linkage, defining it in multiple translation units would be an ODR violation because the meaning of B is different in each translation unit. If A only appears in a single translation unit, the best way to silence the warning is to give it internal linkage by putting it in an anonymous namespace as well. The compiler doesn't give this warning for types defined in the main.Cfile, as those are unlikely to have multiple definitions.-Wsubobject-linkageis enabled by default. ๐ง-Weffc++(C++ and Objective-C++ only) โ warn about violations of the following style guidelines from Scott Meyers' Effective C++ series of books:- Define a copy constructor and an assignment operator for classes with dynamically-allocated memory.
- Prefer initialization to assignment in constructors.
- Have
"operator="return a reference to*this. - Don't try to return a reference when you must return an object.
- Distinguish between prefix and postfix forms of increment and decrement operators.
- Never overload
"&&","||", or",".
This option also enables -Wnon-virtual-dtor, which is also one of the effective C++ recommendations. However, the check is extended to warn about the lack of virtual destructor in accessible non-polymorphic bases classes too. ๐
When selecting this option, be aware that the standard library headers do not obey all of these guidelines; use grep -v to filter out those warnings. ๐
-Wstrict-null-sentinel(C++ and Objective-C++ only) โ warn about the use of an uncasted"NULL"as sentinel. When compiling only with GCC this is a valid sentinel, as"NULL"is defined to"__null". Although it is a null pointer constant rather than a null pointer, it is guaranteed to be of the same size as a pointer. But this use is not portable across different compilers. ๐-Wno-non-template-friend(C++ and Objective-C++ only) โ disable warnings when non-template friend functions are declared within a template. In very old versions of GCC that predate implementation of the ISO standard, declarations such asfriend int foo(int), where the name of the friend is an unqualified-id, could be interpreted as a particular specialization of a template function; the warning exists to diagnose compatibility problems, and is enabled by default. ๐ฆ-Wold-style-cast(C++ and Objective-C++ only) โ warn if an old-style (C-style) cast to a non-void type is used within a C++ program. The new-style casts ("dynamic_cast","static_cast","reinterpret_cast", and"const_cast") are less vulnerable to unintended effects and much easier to search for. Slay, modernize bestie. ๐-Woverloaded-virtual(C++ and Objective-C++ only) โ warn when a function declaration hides virtual functions from a base class. For example, in:
struct A {
virtual void f();
};
struct B: public A {
void f(int);
};
the "A" class version of "f" is hidden in "B", and code like:
B* b;
b->f();
fails to compile. ๐ญ
-Wno-pmf-conversions(C++ and Objective-C++ only) โ disable the diagnostic for converting a bound pointer to member function to a plain pointer. โจ-Wsign-promo(C++ and Objective-C++ only) โ bestie this one is so specific. It yells at you when overload resolution picks a promotion from an unsigned or enumerated type to a signed type instead of a conversion to an unsigned type of the same size. Fun lore drop: previous versions of G++ tried to preserve unsignedness, but the standard mandates the current behavior. So likeโฆ the old vibe is gone, the standard said what it said. ๐-Wtemplates(C++ and Objective-C++ only) โ warns whenever a primary template declaration shows up. Some coding rules straight-up ban templates, and this is the enforcer for that rule. BUT: the warning is inactive inside a system header file, such as the STL, so you can still use the STL like a normal person. You may also instantiate or specialize templates โ those are fine, no cap. โจ-Wmismatched-tags(C++ and Objective-C++ only) โ warns for declarations of structs, classes, and class templates and their specializations where the class-key doesn't match either the definition or the first declaration (if no definition is provided).
For example, the declaration of struct Object in the argument list of draw triggers the warning. To avoid it, either remove the redundant class-key struct or replace it with class to match its definition.
class Object {
public:
virtual ~Object () = 0;
};
void draw (struct Object*);
Okay and listen โ it is not wrong to declare a class with the class-key struct, like the example above shows. -Wmismatched-tags is just here to help you achieve a consistent style of class declarations. In code 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 is the vibe-check for that rule. The warning is inactive inside a system header file, such as the STL, so the STL is still yours to use. You may also define classes that indirectly use multiple inheritance โ indirect is fine, direct is the problem. ๐-Wvirtual-inheritanceโ warns when a class is defined with a virtual direct base class. Same deal as above: some coding rules disallow multiple inheritance and this can be used to enforce that rule. Inactive inside a system header file, such as the STL, so the STL stays usable. You may also define classes that indirectly use virtual inheritance. ๐ธ-Wno-virtual-move-assignโ suppresses warnings about inheriting from a virtual base with a non-trivial C++11 move assignment operator. And bestie, this one is genuinely dangerous: 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 only silence it if you actually did the work. Periodt.-Wnamespacesโ warns when a namespace definition is opened. Some coding rules disallow namespaces, and this enforces that rule. The warning is inactive inside a system header file, such as the STL, so you can still use the STL. You may also use using directives and qualified names โ those don't trip it. โจ-Wno-terminate(C++ and Objective-C++ only) โ disables the warning about a throw-expression that will immediately result in a call toterminate. ๐-Wno-class-conversion(C++ and Objective-C++ only) โ do not warn when a conversion function converts an object to the same type, to a base class of that type, or to void; such a conversion function will never be called. Not even once. ๐-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 a
volatile-qualified non-class type for their value - compound assignments where the left operand is a
volatile-qualified non-class type volatile-qualified function return typevolatile-qualified parameter type- structured bindings of a
volatile-qualified type
- postfix and prefix
This usage was deprecated in C++20. ๐
Enabled by default with -std=c++2a.
-Wzero-as-null-pointer-constant(C++ and Objective-C++ only) โ warns when a literal0is used as null pointer constant. This can be useful to facilitate the conversion tonullptrin C++11. Yes bestie,0is notnullptr, we been knew. ๐-Waligned-newโ 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. ๐ฅ
-Wno-placement-new-Wplacement-new=nโ warns about placement new expressions with undefined behavior, such as constructing an object in a buffer that is smaller than the type of the object. For example, the placement new expression below is diagnosed because it attempts to construct an array of 64 integers in a buffer only 64 bytes large.
char buf [64];
new (buf) int[64];
This warning is enabled by default. โ ๏ธ
-Wplacement-new=1โ this is the default warning level of-Wplacement-new. At this level the warning is not issued for some strictly undefined constructs that GCC allows as extensions for compatibility with legacy code. For example, the followingnewexpression is not diagnosed at this level even though it has undefined behavior according to the C++ standard because it writes past the end of the one-element array.
struct S { int n, a[1]; };
S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
new (s->a)int [32]();
-Wplacement-new=2โ at this level, in addition to diagnosing all the same constructs as at level 1, a diagnostic is also issued for placement new expressions that construct an object in the last member of structure whose type is an array of a single element and whose size is less than the size of the object being constructed. While the previous example would be diagnosed, the following construct makes use of the flexible member array extension to avoid the warning at level 2.
struct S { int n, a[]; };
S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
new (s->a)int [32]();
-Wcatch-value-Wcatch-value=n(C++ and Objective-C++ only) โ warns about catch handlers that do not catch via reference. With-Wcatch-value=1(or-Wcatch-valuefor short) warn about polymorphic class types that are caught by value. With-Wcatch-value=2warn about all class types that are caught by value. With-Wcatch-value=3warn about all types that are not caught by reference.-Wcatch-valueis enabled by-Wall. ๐-Wconditionally-supported(C++ and Objective-C++ only) โ warns for conditionally-supported (C++11 [intro.defs]) constructs. That's it, that's the whole vibe. โจ-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. So silencing it is a choice you're making with your whole chest. ๐ญ-Wextra-semi(C++, Objective-C++ only) โ warns about redundant semicolons after in-class function definitions. The little;that didn't need to be there. We see it. ๐-Wno-inaccessible-base(C++, Objective-C++ only) โ this option controls warnings when a base class is inaccessible in a class derived from it due to ambiguity. The warning is enabled by default. Note that the warning for ambiguous virtual bases is enabled by the-Wextraoption.
struct A { int a; };
struct B : A { };
struct C : B, A { };
-Wno-inherited-variadic-ctorโ suppresses warnings about use of C++11 inheriting constructors when the base class inherited from has a C variadic constructor; the warning is on by default because the ellipsis is not inherited....stays with the base, it does not get passed down. ๐ซถ-Wno-invalid-offsetof(C++ and Objective-C++ only) โ suppresses warnings from applying theoffsetofmacro to a non-POD type. According to the 2014 ISO C++ standard, applyingoffsetofto a non-standard-layout type is undefined. In existing C++ implementations, however,offsetoftypically gives meaningful results. This flag is for users who are aware that they are writing nonportable code and who have deliberately chosen to ignore the warning about it. So like, you know what you're doing. We hope. ๐
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 allows GCC to more aggressively devirtualize the polymorphic calls. This warning is more effective with link-time optimization, where the information about the class hierarchy graph is more complete. ๐-Wsuggest-final-methodsโ 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 information about the class hierarchy graph is more complete. It is recommended to first consider suggestions of-Wsuggest-final-typesand then rebuild with new annotations. Do it in that order bestie, don't skip steps. ๐-Wsuggest-overrideโ warns about overriding virtual functions that are not marked with theoverridekeyword. Say it with your chest:override. โจ-Wuseless-cast(C++ and Objective-C++ only) โ warns when an expression is casted to its own type.(int)xwherexis alreadyint? Caught. It's giving nothing. ๐-Wno-conversion-null<span style="color:pink">(C++ and Objective-C++ only)</span> โ bestie, this one just says: don't warn when someone converts betweenNULLand non-pointer types. And heads up,-Wconversion-nullis on by default, so the warnings are coming unless you shut them off. ๐
โจ Options Controlling Objective-C and Objective-C++ Dialects โจ
<span style="color:red">NOTE:</span> this manual does not describe the Objective-C and Objective-C++ languages themselves. That's on you, bestie. ๐ญ
Okay so this section is all about the command-line options that only hit different for Objective-C and Objective-C++ programs. You can still use most of the language-independent GNU compiler options too, no worries. Like, say you wanna compile a file called some_class.m, you'd do:
gcc -g -fgnu-runtime -O -c some_class.m
In this little example, -fgnu-runtime is an option meant only for Objective-C and Objective-C++ programs โ the other options work with any language GCC supports. ๐ซถ
Also, quick note: since Objective-C is literally an extension of C, your Objective-C compilations can also use options specific to the C front-end (like -Wtraditional). And similarly, Objective-C++ compilations can use C++-specific options (like -Wabi). It's giving "everything is connected." ๐ฆ
Here's the list of options that are only for compiling Objective-C and Objective-C++ programs:
-fconstant-string-class=class-nameโ use class-name as the name of the class to instantiate for each literal string you write with the@"..."syntax. The default class name isNXConstantStringif you're on the GNU runtime, andNSConstantStringif you're on the NeXT runtime (more on that below). Oh and if-fconstant-cfstringsis also present, it overrides the-fconstant-string-classsetting and makes those@"..."literals get laid out as constant CoreFoundation strings instead. ๐-fgnu-runtimeโ generate object code compatible with the standard GNU Objective-C runtime. This is the default for most types of systems. Slay, GNU.-fnext-runtimeโ generate output compatible with the NeXT runtime. This is the default for NeXT-based systems, including Darwin and Mac OS X. And the macro__NEXT_RUNTIME__gets predefined if (and only if) you use this option. <span style="color:cyan">if and only if, bestie, they're being precise</span> โจ-fno-nil-receiversโ assume that all Objective-C message dispatches ([receiver message:arg]) in this translation unit make sure the receiver is notnil. This lets the runtime use more efficient entry points. Heads up: this option is only available in conjunction with the NeXT runtime and ABI version 0 or 1. ๐-fobjc-abi-version=nโ use version n of the Objective-C ABI for the selected runtime. Currently this option is only supported for the NeXT runtime. In that case:- Version 0 is the traditional (32-bit) ABI without support for properties and other Objective-C 2.0 additions.
- Version 1 is the traditional (32-bit) ABI with support for properties and other Objective-C 2.0 additions.
- Version 2 is the modern (64-bit) ABI.
If you specify nothing, 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, it synthesizes a special- (id) .cxx_constructinstance method which runs those non-trivial default constructors on any such instance variables, in order, and then returnsself. Same energy for destructors: 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 those default destructors, in reverse order.
The - (id) .cxx_construct and - (void) .cxx_destruct methods generated this way only operate on instance variables declared in the current Objective-C class, not the ones inherited from superclasses. It's the Objective-C runtime's job to invoke all such methods across an object's inheritance hierarchy. The - (id) .cxx_construct methods get invoked by the runtime right after a new object instance is allocated; the - (void) .cxx_destruct methods get invoked right 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. <span style="color:peach">read that again before you go feral</span> ๐
-fobjc-direct-dispatchโ allow fast jumps to the message dispatcher. On Darwin this is accomplished via the comm page. Zoom zoom. ๐ฅ-fobjc-exceptionsโ enable syntactic support for structured exception handling in Objective-C, similar to what C++ offers. You need this option 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 one is only available with the NeXT runtime; the GNU runtime has a different garbage collection implementation that does not require special compiler flags. different vibes, different runtime.-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 you can turn it off with-fno-objc-nilcheck. Class methods and super calls are never checked for nil this way, no matter what this flag is set to. And currently this flag does nothing at all 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 you use this option with the Objective-C or Objective-C++ compiler, any Objective-C syntax not recognized by GCC 4.0 gets rejected. Super useful if you need to make sure your Objective-C code can compile with older versions of GCC. โจ-freplace-objc-classesโ emit a special marker instructingld(1)not to statically link in the resulting object file, and letdyld(1)load it in at run time instead. This gets used with the Fix-and-Continue debugging mode, where the object file in question can be recompiled and dynamically reloaded while the program is running, no restart needed. Currently, Fix-and-Continue functionality is only available 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 class name 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 that behavior and causes calls toobjc_getClass("...")to be retained. This is useful in Zero-Link debugging mode, since it lets individual class implementations be modified during program execution. And btw, the GNU runtime currently always retains calls toobjc_get_class("...")regardless of command-line options. periodt. ๐-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 those variable shadowing issues. <span style="color:mint">no more name drama</span> ๐ง-fivar-visibility=[public|protected|private|package]โ set the default instance variable visibility to the specified option, so that instance variables declared outside the scope of any access modifier directives default to that specified visibility. ๐-gen-declsโ dump interface declarations for all classes seen in the source file to a file namedsourcename.decl. cute little receipt. ๐-Wassign-intercept<span style="color:pink">(Objective-C and Objective-C++ only)</span> โ warn whenever an Objective-C assignment is being intercepted by the garbage collector. ๐ซถ-Wno-property-assign-default<span style="color:pink">(Objective-C and Objective-C++ only)</span> โ do not warn if a property for an Objective-C object has no assign semantics specified. silence is golden.-Wno-protocol<span style="color:pink">(Objective-C and Objective-C++ only)</span> โ okay so if a class is declared to implement a protocol, a warning gets issued for every method in the protocol that isn't 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 count as implemented, and no warning is issued for them. inherited counts, bestie ๐-Wselector<span style="color:pink">(Objective-C and Objective-C++ only)</span> โ warn if multiple methods of different types for the same selector are found during compilation. The check happens on the list of methods in the final stage of compilation. Additionally, a check is performed for each selector appearing in a@selector(...)expression, and a corresponding method for that selector has been found during compilation. And because these checks scan the method table only at the end of compilation, these warnings are not produced if the final stage of compilation isn't reached โ for example because an error is found during compilation, or because the-fsyntax-onlyoption is being used. <span style="color:peach">iykyk, timing matters</span> ๐-Wstrict-selector-match<span style="color:pink">(Objective-C and Objective-C++ only)</span> โ warn if multiple methods with differing argument and/or return types are found for a given selector when you're attempting to send a message using this selector to a receiver of typeidorClass. When this flag is off (which is the default behavior), the compiler omits such warnings if any differences found are confined to types that share the same size and alignment. โจ-Wundeclared-selector<span style="color:hotpink">(Objective-C and Objective-C++ only)</span> โ bestie this one yells at you if a@selector(...)expression shows up referring to a selector that was never declared. And when do we call a selector "undeclared"? When no method with that name got declared before the@selector(...)expression โ whether explicitly in an@interfaceor@protocoldeclaration, or implicitly in an@implementationsection. The way this one works: it always performs its checks the second a@selector(...)expression is found, whereas-Wselectoronly does its checks in the final stage of compilation. It also enforces that coding style convention that methods and selectors must be declared before being used. โจ-print-objc-runtime-infoโ generates a C header describing the largest structure that is passed by value, if any. ๐ซถ
๐ Options to Control Diagnostic Messages Formatting ๐
Okay so traditionally, diagnostic messages have been formatted irrespective of the output device's aspect (like its width, ...). Which, rude, honestly. ๐ You can use the options below to control the formatting algorithm for diagnostic messages โ like how many characters per line, how often source location information gets reported. Just know that some language front ends may not honor these options. Not everyone got the memo, iykyk.
-fmessage-length=nโ tries to format error messages so they fit on lines of about n characters. If n is zero, then no line-wrapping happens at all; each error message appears on a single line. This is the default for all front ends. โจ
Heads up โ this option also affects the display of the#errorand#warningpre-processor directives, and the deprecated function/type/variable attribute. It does not, however, affect thepragma GCC warningandpragma GCC errorpragmas. So those two are just out here living their own life. ๐
-fdiagnostics-show-location=onceโ only meaningful in line-wrapping mode. It tells the diagnostic messages reporter to emit source location information once; that is, if the message is too long to fit on a single physical line and has to be wrapped, the source location won't be emitted (as prefix) again, over and over, in subsequent continuation lines. This is the default behavior. ๐-fdiagnostics-show-location=every-lineโ only meaningful in line-wrapping mode. It tells the diagnostic messages reporter to emit the same source location information (as prefix) for physical lines that result from the process of breaking a message which is too long to fit on a single line. Every line. Every single one. ๐ญ-fdiagnostics-color[=WHEN]-fno-diagnostics-colorโ use color in diagnostics. WHEN isnever,always, orauto. The default depends on how the compiler has been configured, and it can be any of the above WHEN options, or alsoneverif theGCC_COLORSenvironment variable isn't present in the environment, andautootherwise.automakes GCC use color only when the standard error is a terminal, and when not executing in an emacs shell. The forms-fdiagnostics-colorand-fno-diagnostics-colorare aliases for-fdiagnostics-color=alwaysand-fdiagnostics-color=never, respectively. ๐
The colors are defined by the environment variable GCC_COLORS. Its value is a colon-separated list of capabilities and Select Graphic Rendition (SGR) substrings. SGR commands are interpreted by the terminal or terminal emulator. (See the section in the documentation of your text terminal for permitted values and their meanings as character attributes.) These substring values are integers in decimal representation and can be concatenated with semicolons. Common values to concatenate include 1 for bold, 4 for underline, 5 for blink, 7 for inverse, 39 for default foreground color, 30 to 37 for foreground colors, 90 to 97 for 16-color mode foreground colors, 38;5;0 to 38;5;255 for 88-color and 256-color modes foreground colors, 49 for default background color, 40 to 47 for background colors, 100 to 107 for 16-color mode background colors, and 48;5;0 to 48;5;255 for 88-color and 256-color modes background colors. ๐
The default GCC_COLORS is
error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
quote=01:path=01;36:fixit-insert=32:fixit-delete=31:\
diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
type-diff=01;32
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. ๐
"error="โ SGR substring forerror:markers."warning="โ SGR substring forwarning:markers."note="โ SGR substring fornote:markers."path="โ SGR substring for colorizing paths of control-flow events as printed via-fdiagnostics-path-format=, such as the identifiers of individual events and lines indicating interprocedural calls and returns."range1="โ SGR substring for first additional range."range2="โ SGR substring for second additional range."locus="โ SGR substring for location information,file:lineorfile:line:columnetc."quote="โ SGR substring for information printed within quotes."fixit-insert="โ SGR substring for fix-it hints suggesting text to be inserted or replaced."fixit-delete="โ SGR substring for fix-it hints suggesting text to be deleted."diff-filename="โ SGR substring for filename headers within generated patches."diff-hunk="โ SGR substring for the starts of hunks within generated patches."diff-delete="โ SGR substring for deleted lines within generated patches."diff-insert="โ SGR substring for inserted lines within generated patches."type-diff="โ SGR substring for highlighting mismatching types within template arguments in the C++ frontend.
-fdiagnostics-urls[=WHEN]โ use escape sequences to embed URLs in diagnostics. For example, when-fdiagnostics-show-optionemits text showing the command-line option controlling a diagnostic, embed a URL for documentation of that option. ๐
WHEN is never, always, or auto. auto makes GCC use URL escape sequences only when the standard error is a terminal, and when not executing in an emacs shell or any graphical terminal which is known to be incompatible with this feature, see below. ๐
The default depends on how the compiler has been configured. It can be any of the above WHEN options.
GCC can also be configured (via the --with-diagnostics-urls=auto-if-env configure-time option) so that the default is affected by environment variables. Under such a configuration, GCC defaults to using auto if either GCC_URLS or TERM_URLS environment variables are present and non-empty in the environment of the compiler, or never if neither are.
However, even with -fdiagnostics-urls=always the behavior is dependent on those environment variables: if GCC_URLS is set to empty or no, do not embed URLs in diagnostics. If set to st, URLs use ST escape sequences. If set to bel, the default, URLs use BEL escape sequences. Any other non-empty value enables the feature. If GCC_URLS is not set, use TERM_URLS as a fallback. Note: ST is an ANSI escape sequence, string terminator ESC \, BEL is an ASCII character, CTRL-G that usually sounds like a beep. ๐
At this time GCC tries to detect also a few terminals that are known to not implement the URL feature, and have bugs or at least had bugs in some versions that are still in use, where the URL escapes are likely to misbehave, i.e. print garbage on the screen. That list is currently xfce4-terminal, certain known to be buggy gnome-terminal versions, the linux console, and mingw. This check can be skipped with the -fdiagnostics-urls=always. ๐
-fno-diagnostics-show-optionโ by default, each diagnostic emitted includes text indicating the command-line option that directly controls the diagnostic (if such an option is known to the diagnostic machinery). Specifying the-fno-diagnostics-show-optionflag suppresses that behavior. ๐-fno-diagnostics-show-caretโ by default, each diagnostic emitted includes the original source line and a caret^indicating the column. This option suppresses this information. The source line is truncated to n characters, if the-fmessage-length=noption is given. When the output is done to the terminal, the width is limited to the width given by theCOLUMNSenvironment variable or, if not set, to the terminal width. ๐-fno-diagnostics-show-labelsโ by default, when printing source code (via-fdiagnostics-show-caret), diagnostics can label ranges of source code with pertinent information, such as the types of expressions:
printf ("foo %s bar", long_i + long_j);
~^ ~~~~~~~~~~~~~~~
| |
char * long int
This option suppresses the printing of these labels (in the example above, the vertical bars and the "char *" and "long int" text). ๐
-fno-diagnostics-show-cweโ diagnostic messages can optionally have an associatedhttps://cwe.mitre.org/index.htmlCWE identifier. GCC itself only provides such metadata for some of the-fanalyzerdiagnostics. GCC plugins may also provide diagnostics with such metadata. By default, if this information is present, it will be printed with the diagnostic. This option suppresses the printing of this metadata. ๐ต๏ธ-fno-diagnostics-show-line-numbersโ by default, when printing source code (via-fdiagnostics-show-caret), a left margin is printed, showing line numbers. This option suppresses this left margin. ๐ข-fdiagnostics-minimum-margin-width=widthโ this option controls the minimum width of the left margin printed by-fdiagnostics-show-line-numbers. It defaults to6. โจ-fdiagnostics-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โ prints fix-it hints tostderrin unified diff format, after any diagnostics are printed. For example:
--- test.c
+++ test.c
@ -42,5 +42,5 @
void show_cb(GtkDialog *dlg)
{
- gtk_widget_showall(dlg);
+ gtk_widget_show_all(dlg);
}
The diff may or may not be colorized, following the same rules as for diagnostics (see -fdiagnostics-color). iykyk ๐
-fdiagnostics-show-template-treeโ in the C++ frontend, when printing diagnostics showing mismatching template types, such as:
could not convert 'std::map<int, std::vector<double> >()'
from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
the -fdiagnostics-show-template-tree flag enables printing a tree-like structure showing the common and differing parts of the types, such as:
map<
[...],
vector<
[double != float]>>
The parts that differ are highlighted with color ("double" and "float" in this case). cute right?? โจ
-fno-elide-typeโ by default, when the C++ frontend prints diagnostics showing mismatching template types, common parts of the types are printed as"[...]"to simplify the error message. For example:
could not convert 'std::map<int, std::vector<double> >()'
from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
Specifying the -fno-elide-type flag suppresses that behavior. This flag also affects the output of the -fdiagnostics-show-template-tree flag. they're besties fr fr
-fdiagnostics-path-format=KINDโ specify how to print paths of control-flow events for diagnostics that have such a path associated with them.
KIND is none, separate-events, or inline-events, the default.
nonemeans to not print diagnostic paths.separate-eventsmeans 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-eventsmeans 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.
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)
the little arrows?? the nesting?? it's giving โจfamily treeโจ honestly
-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=separate-events.
This is intended for use by GCC developers and plugin developers when debugging diagnostics that report interprocedural control flow. not really a you-and-me feature bestie, but go off ๐
-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-format=FORMATโ select a different format for printing diagnostics. FORMAT istextorjson. The default istext.
The json format consists of a top-level JSON array containing JSON objects representing the diagnostics.
The JSON is emitted as one line, without formatting; the examples below have been formatted for clarity. don't come for me about the pretty-printing, it's for YOU ๐ญ
Diagnostics can have child diagnostics. For example, this error and note:
misleading-indentation.c:15:3: warning: this 'if' clause does not
guard... [-Wmisleading-indentation]
15 | if (flag)
| ^~
misleading-indentation.c:17:5: note: ...this statement, but the latter
is misleadingly indented as if it were guarded by the 'if'
17 | y = 2;
| ^
might be printed in JSON form (after formatting) like this:
[
{
"kind": "warning",
"locations": [
{
"caret": {
"column": 3,
"file": "misleading-indentation.c",
"line": 15
},
"finish": {
"column": 4,
"file": "misleading-indentation.c",
"line": 15
}
}
],
"message": "this \u2018if\u2019 clause does not guard...",
"option": "-Wmisleading-indentation",
"option_url": "https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html#index-Wmisleading-indentation",
"children": [
{
"kind": "note",
"locations": [
{
"caret": {
"column": 5,
"file": "misleading-indentation.c",
"line": 17
}
}
],
"message": "...this statement, but the latter is ..."
}
]
},
...
]
where the "note" is a child of the "warning".
A diagnostic has a "kind". If this is "warning", then there is an "option" key describing the command-line option controlling the warning.
A diagnostic can contain zero or more locations. Each location has up to three positions within it: a "caret" position and optional "start" and "finish" positions. A location can also have an optional "label" string. For example, this error:
bad-binary-ops.c:64:23: error: invalid operands to binary + (have 'S' {aka
'struct s'} and 'T' {aka 'struct t'})
64 | return callee_4a () + callee_4b ();
| ~~~~~~~~~~~~ ^ ~~~~~~~~~~~~
| | |
| | T {aka struct t}
| S {aka struct s}
has three locations. Its primary location is at the "+" token at column 23. It has two secondary locations, describing the left and right-hand sides of the expression, which have labels. It might be printed in JSON form as:
{
"children": [],
"kind": "error",
"locations": [
{
"caret": {
"column": 23, "file": "bad-binary-ops.c", "line": 64
}
},
{
"caret": {
"column": 10, "file": "bad-binary-ops.c", "line": 64
},
"finish": {
"column": 21, "file": "bad-binary-ops.c", "line": 64
},
"label": "S {aka struct s}"
},
{
"caret": {
"column": 25, "file": "bad-binary-ops.c", "line": 64
},
"finish": {
"column": 36, "file": "bad-binary-ops.c", "line": 64
},
"label": "T {aka struct t}"
}
],
"message": "invalid operands to binary + ..."
}
If a diagnostic contains fix-it hints, it has a "fixits" array, consisting of half-open intervals, similar to the output of -fdiagnostics-parseable-fixits. For example, this diagnostic with a replacement fix-it hint:
demo.c:8:15: error: 'struct s' has no member named 'colour'; did you
mean 'color'?
8 | return ptr->colour;
| ^~~~~~
| color
might be printed in JSON form as:
{
"children": [],
"fixits": [
{
"next": {
"column": 21,
"file": "demo.c",
"line": 8
},
"start": {
"column": 15,
"file": "demo.c",
"line": 8
},
"string": "color"
}
],
"kind": "error",
"locations": [
{
"caret": {
"column": 15,
"file": "demo.c",
"line": 8
},
"finish": {
"column": 20,
"file": "demo.c",
"line": 8
}
}
],
"message": "\u2018struct s\u2019 has no member named ..."
}
where the fix-it hint suggests replacing the text from "start" up to but not including "next" with "string"'s value. Deletions are expressed via an empty value for "string", insertions by having "start" equal "next". ๐ซถ
If the diagnostic has a path of control-flow events associated with it, it has a "path" array of objects representing the events. Each event object has a "description" string, a "location" object, along with a "function" string and a "depth" number for representing interprocedural paths. The "function" represents the current function at that event, and the "depth" represents the stack depth relative to some baseline: the higher, the more frames are within the stack.
For example, the intraprocedural example shown for -fdiagnostics-path-format= might have this JSON for its path:
"path": [
{
"depth": 0,
"description": "when 'PyList_New' fails, returning NULL",
"function": "test",
"location": {
"column": 10,
"file": "test.c",
"line": 25
}
},
{
"depth": 0,
"description": "when 'i < count'",
"function": "test",
"location": {
"column": 3,
"file": "test.c",
"line": 27
}
},
{
"depth": 0,
"description": "when calling 'PyList_Append', passing NULL from (1) as argument 1",
"function": "test",
"location": {
"column": 5,
"file": "test.c",
"line": 29
}
}
]
๐ Options to Request or Suppress Warnings ๐
Warnings are diagnostic messages that report constructions that are not inherently erroneous but that are risky or suggest there may have been an error. ๐
The following language-independent options 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 a lil vibe check on your syntax, bestie. โจ- *
-fmax-errors=n* โ Limits the maximum number of error messages to n, at which point GCC bails out rather than attempting to continue processing the source code. If n is0(the default), there is no limit on the number of error messages produced. If-Wfatal-errorsis also specified, then-Wfatal-errorstakes precedence over this option. -wโ Inhibit all warning messages. (Sshh. Silence. ๐คซ)-Werrorโ Make all warnings into errors. No more "just a warning" energy, it's giving hard fail. ๐-Werror=โ Make the specified warning into an error. The specifier for a warning is appended; for example-Werror=switchturns the warnings controlled by-Wswitchinto errors. This switch takes a negative form, to be used to negate-Werrorfor specific warnings; for example-Wno-error=switchmakes-Wswitchwarnings not be errors, even when-Werroris in effect.
The warning message for each controllable warning includes the option that controls the warning. That option can then be used with -Werror= and -Wno-error= as described above. (Printing of the option in the warning message can be disabled using the -fno-diagnostics-show-option flag.)
Note that specifying -Werror=foo automatically implies -Wfoo. However, -Wno-error=foo does not imply anything. ๐
-Wfatal-errorsโ This option causes the compiler to abort compilation on the first error occurred rather than trying to keep going and printing further error messages. Like, it's done. It's over. It's not doing this today. ๐
You can request many specific warnings with options beginning with -W, for example -Wimplicit to request warnings on implicit declarations. Each of these specific warning options also has a negative form beginning -Wno- to turn off warnings; for example -Wno-implicit. This manual lists only one of the two forms, whichever is not the default. For further language-specific options also refer to C++ Dialect Options and Objective-C and Objective-C++ Dialect Options. Additional warnings can be produced by enabling the static analyzer;
Some options, such as -Wall and -Wextra, turn on other options, such as -Wunused, which may turn on further options, such as -Wunused-value. The combined effect of positive and negative forms is that more specific options have priority over less specific ones, independently of their position in the command-line. For options of the same specificity, the last one takes effect. Options enabled or disabled via pragmas take effect as if they appeared at the end of the command-line. โจ
When an unrecognized warning option is requested (e.g., -Wunknown-warning), GCC emits a diagnostic stating that the option is not recognized. However, if the -Wno- form is used, the behavior is slightly different: no diagnostic is produced for -Wno-unknown-warning unless other diagnostics are being produced. This allows the use of new -Wno- options with old compilers, but if something goes wrong, the compiler warns that an unrecognized option is present. ๐
The effectiveness of some warnings depends on optimizations also being enabled. For example -Wsuggest-final-types is more effective with link-time optimization and -Wmaybe-uninitialized does not warn at all unless optimization is enabled.
-Wpedantic-pedanticโ Issue all the warnings demanded by strict ISO C and ISO C++; reject all programs that use forbidden extensions, and some other programs that do not follow ISO C and ISO C++. For ISO C, follows the version of the ISO C standard specified by any-stdoption used.
Valid ISO C and ISO C++ programs should compile properly with or without this option (though a rare few require -ansi or a -std option specifying the required version of ISO C). However, without this option, certain GNU extensions and traditional C and C++ features are supported as well. With this option, they are rejected.
-Wpedantic does not cause warning messages for use of the alternate keywords whose names begin and end with __. This alternate format can also be used to disable warnings for non-ISO __intN types, i.e. __intN__. Pedantic warnings are also disabled in the expression that follows "__extension__". However, only system header files should use these escape routes; application programs should avoid them. ๐จ
Some users try to use -Wpedantic to check programs for strict ISO C conformance. They soon find that it does not do quite what they want: it finds some non-ISO practices, but not all---only those for which ISO C requires a diagnostic, and some others for which diagnostics have been added. ๐ญ
Quick lil sidebar before we get into the flags, bestie:
A feature that reports every single failure to conform to ISO C might sound cute in some instances, but fr it would need considerable extra work and would be pretty different from -Wpedantic. We lowkey don't have plans to support such a feature in the near future. ๐
Okay so when the standard you picked with -std is a GNU extended dialect of C โ like gnu90 or gnu99 โ there's a corresponding base standard, aka the version of ISO C that the GNU extended dialect is built on top of. Warnings from -Wpedantic get given where the base standard requires them. And like, it wouldn't even make sense to only warn about features that aren't in the specified GNU C dialect, because by definition the GNU dialects of C include all the features the compiler supports with the given option, so there'd be nothing left to warn about. ๐ฆ
โจ -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 even prevent compilation of programs that are valid according to the standard. ๐
Heads up: this is not equivalent to -Werror=pedantic, because there are errors enabled by this option that aren't enabled by the latter, and vice versa. ๐
โจ -Wall โจ
This one turns on 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 in the mix. 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 -Warray-bounds=1 (only with -O2) -Wbool-compare
-Wbool-operation -Wc++11-compat -Wc++14-compat -Wcatch-value (C++
and Objective-C++ only) -Wchar-subscripts -Wcomment
-Wduplicate-decl-specifier (C and Objective-C only) -Wenum-compare
(in C/ObjC; this is on by default in C++) -Wenum-conversion in
C/ObjC; -Wformat -Wformat-overflow -Wformat-truncation
-Wint-in-bool-context -Wimplicit (C and Objective-C only)
-Wimplicit-int (C and Objective-C only)
-Wimplicit-function-declaration (C and Objective-C only) -Winit-self
(only for C++) -Wlogical-not-parentheses -Wmain (only for C/ObjC and
unless -ffreestanding) -Wmaybe-uninitialized -Wmemset-elt-size
-Wmemset-transposed-args -Wmisleading-indentation (only for C/C++)
-Wmissing-attributes -Wmissing-braces (only for C/ObjC)
-Wmultistatement-macros -Wnarrowing (only for C++) -Wnonnull
-Wnonnull-compare -Wopenmp-simd -Wparentheses -Wpessimizing-move
(only for C++) -Wpointer-sign -Wreorder -Wrestrict -Wreturn-type
-Wsequence-point -Wsign-compare (only in C++) -Wsizeof-pointer-div
-Wsizeof-pointer-memaccess -Wstrict-aliasing -Wstrict-overflow=1
-Wswitch -Wtautological-compare -Wtrigraphs -Wuninitialized
-Wunknown-pragmas -Wunused-function -Wunused-label -Wunused-value
-Wunused-variable -Wvolatile-register-var -Wzero-length-bounds
Not me needing to tell you: 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 wish to check for; others warn about constructions that are necessary or hard to avoid in some cases, and there's no simple way to modify the code to suppress the warning. Some of them are enabled by -Wextra but many of them must be enabled individually. ๐
โจ -Wextra โจ
This enables some extra warning flags that aren't enabled by -Wall. (Fun fact: this option used to be called -W. The older name is still supported, but the newer name is more descriptive. โจ)
-Wclobbered -Wcast-function-type -Wdeprecated-copy (C++ only)
-Wempty-body -Wignored-qualifiers -Wimplicit-fallthrough=3
-Wmissing-field-initializers -Wmissing-parameter-type (C only)
-Wold-style-declaration (C only) -Woverride-init -Wsign-compare (C
only) -Wstring-compare -Wredundant-move (only for C++) -Wtype-limits
-Wuninitialized -Wshift-negative-value (in C++11 to C++17 and in C99
and newer) -Wunused-parameter (only with -Wunused or -Wall)
-Wunused-but-set-parameter (only with -Wunused or -Wall)
The option -Wextra also prints warning messages for the following cases:
- A pointer is compared against integer zero with
<,<=,>, or>=. - (C++ only) An enumerator and a non-enumerator both appear in a conditional expression.
- (C++ only) Ambiguous virtual bases.
- (C++ only) Subscripting an array that has been declared
register. - (C++ only) Taking the address of a variable that has been declared
register. - (C++ only) A base class is not initialized in the copy constructor of a derived class.
โจ -Wabi (C, Objective-C, C++ and Objective-C++ only) โจ
Warn about code affected by ABI changes. This includes code that may not be compatible with the vendor-neutral C++ ABI as well as the psABI for the particular target. ๐ญ
Since G++ now defaults to updating the ABI with each major release, normally -Wabi warns only about C++ ABI compatibility problems if there's a check added later in a release series for an ABI issue discovered since the initial release. -Wabi warns about more things if an older ABI version is selected (with -fabi-version=n).
-Wabi can also be used with an explicit version number to warn about C++ ABI compatibility with a particular -fabi-version level, e.g. -Wabi=2 to warn about changes relative to -fabi-version=2.
If an explicit version number is provided and -fabi-compat-version isn't specified, the version number from this option is used for compatibility aliases. If no explicit version number is provided with this option, but -fabi-compat-version is specified, that version number is used for C++ ABI warnings.
Ngl, even though an effort has been made to warn about all such cases, there are probably some cases that aren't warned about, even though G++ is generating incompatible code. There may also be cases where warnings are emitted even though the code that is generated is compatible. ๐
You should rewrite your code to avoid these warnings if you'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's 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.
This option also enables warnings about psABI-related changes. The known psABI changes at this point include:
- For SysV/x86-64, unions with
long doublemembers are passed in memory as specified in psABI. Prior to GCC 4.4, this was not the case. For example:
union U {
long double ld;
int i;
};
"union U" is now always passed in memory.
โจ -Wchar-subscripts โจ
Warn if an array subscript has type char. ๐ This is a common cause of error, as programmers often forget that this type is signed on some machines. This warning is enabled by -Wall.
โจ -Wno-coverage-mismatch โจ
Warn if feedback profiles don't 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-cpp โจ
(C, Objective-C, C++, Objective-C++ and Fortran only) Suppress warning messages emitted by "#warning" directives. ๐คซ
-Wdouble-promotion(C, C++, Objective-C and Objective-C++ only) โ okay bestie, this one gives a warning when a value of typefloatis implicitly promoted todouble. why is that a thing? because CPUs with a 32-bit "single-precision" floating-point unit implementfloatin hardware, but emulatedoublein software. On such a machine, doing computations usingdoublevalues is much more expensive because of the overhead required for software emulation. ๐ญ
It is easy to accidentally do computations with double because floating-point literals are implicitly of type double. For example, in:
float area(float radius)
{
return 3.14159 * radius * radius;
}
the compiler performs the entire computation with double because the floating-point literal is a double. sneaky!!
-Wduplicate-decl-specifier(C and Objective-C only) โ warn if a declaration has duplicateconst,volatile,restrictor_Atomicspecifier. This warning is enabled by-Wall. periodt.-Wformat,-Wformat=nโ check calls toprintfandscanf, etc., to make sure that the arguments supplied have types appropriate to the format string specified, and that the conversions specified in the format string make sense. This includes standard functions, and others specified by format attributes, in theprintf,scanf,strftimeandstrfmon(an X/Open extension, not in the C standard) families (or other target-specific families). Which functions are checked without format attributes having been specified depends on the standard version selected, and such checks of functions without the attribute specified are disabled by-ffreestandingor-fno-builtin.
The formats are checked against the format features supported by GNU libc version 2.2. These include all ISO C90 and C99 features, as well as features from the Single Unix Specification and some BSD and GNU extensions. Other library implementations may not support all these features; GCC does not support warning about features that go beyond a particular library's limitations. However, if -Wpedantic is used with -Wformat, warnings are given about format features not in the selected standard version (but not for strfmon formats, since those are not in any version of the C standard).
-Wformat=1,-Wformatโ Option-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 the options:-Wno-format-contains-nul,-Wno-format-extra-args, and-Wno-format-zero-length.-Wformatis enabled by-Wall. iykyk.-Wformat=2โ Enable-Wformatplus additional format checks. Currently equivalent to-Wformat -Wformat-nonliteral -Wformat-security -Wformat-y2k. glow up!
-Wno-format-contains-nulโ if-Wformatis specified, do not warn about format strings that contain NUL bytes. no cap.-Wno-format-extra-argsโ if-Wformatis specified, do not warn about excess arguments to aprintforscanfformat function. The C standard specifies that such arguments are ignored.
Where the unused arguments lie between used arguments that are specified with $ operand number specifications, normally warnings are still given, since the implementation could not know what type to pass to va_arg to skip the unused arguments. However, in the case of scanf formats, this option suppresses the warning if the unused arguments are all pointers, since the Single Unix Specification says that such unused arguments are allowed.
-Wformat-overflow,-Wformat-overflow=levelโ warn about calls to formatted input/output functions such assprintfandvsprintfthat might overflow the destination buffer. When the exact number of bytes written by a format directive cannot be determined at compile-time it is estimated based on heuristics that depend on thelevelargument and on optimization. While enabling optimization will in most cases improve the accuracy of the warning, it may also result in false positives. yikes.-Wformat-overflow,-Wformat-overflow=1โ Level 1 of-Wformat-overflowenabled by-Wformatemploys 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.
An alternative to increasing the size of the destination buffer is to constrain the range of formatted values. The maximum length of string arguments can be bounded by specifying the precision in the format directive. When numeric arguments of format directives can be assumed to be bounded by less than the precision of their type, choosing an appropriate length modifier to the format specifier will reduce the required buffer size. For example, if a and b in the example above can be assumed to be within the precision of the short int type then using either the %hi format directive or casting the argument to short reduces the maximum required size of the buffer to 24 bytes.
void f (int a, int b)
{
char buf [23];
sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
}
-Wno-format-zero-lengthโ if-Wformatis specified, do not warn about zero-length formats. The C standard specifies that zero-length formats are allowed. allowed, bestie.-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. the way it can't check what it can't seeโฆ-Wformat-securityโ if-Wformatis specified, also warn about uses of format functions that represent possible security problems. At present, this warns about calls toprintfandscanffunctions where the format string is not a string literal and there are no format arguments, as inprintf (foo);. This may be a security hole if the format string came from untrusted input and contains%n. (This is currently a subset of what-Wformat-nonliteralwarns about, but in future warnings may be added to-Wformat-securitythat are not included in-Wformat-nonliteral.) security vibes, do not ignore.-Wformat-signednessโ if-Wformatis specified, also warn if the format string requires an unsigned argument and the argument is signed and vice versa. signed/unsigned chaos.-Wformat-truncation,-Wformat-truncation=levelโ warn about calls to formatted input/output functions such assnprintfandvsnprintfthat might result in output truncation. When the exact number of bytes written by a format directive cannot be determined at compile-time it is estimated based on heuristics that depend on 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. truncation? not today.-Wformat-truncation,-Wformat-truncation=1โ Level 1 of-Wformat-truncationenabled by-Wformatemploys a conservative approach that warns only about calls to bounded functions whose return value is unused and that will most likely result in output truncation.-Wformat-truncation=2โ Level 2 warns also about calls to bounded functions whose return value is used and that might result in truncation given an argument of sufficient length or magnitude.
-Wformat-y2kโ if-Wformatis specified, also warn aboutstrftimeformats that may yield only a two-digit year. Y2K?? in this economy??-Wnonnullโ warn about passing a null pointer for arguments marked as requiring a non-null value by thenonnullfunction attribute.
-Wnonnull is included in -Wall and -Wformat. It can be disabled with the -Wno-nonnull option. bestie, don't pass null there.
-Wnonnull-compareโ warn when comparing an argument marked with thenonnullfunction attribute against null inside the function.
-Wnonnull-compare is included in -Wall. It can be disabled with the -Wno-nonnull-compare option. iconic behavior.
-Wnull-dereferenceโ okay so this is your lil guardian angel ๐ต๏ธโ๏ธ and what she does is yell at you when the compiler detects paths that trigger erroneous or undefined behavior because you're dereferencing a null pointer. Big yikes energy. Important caveat bestie: this option is only active when-fdelete-null-pointer-checksis active, and that one is enabled by optimizations in most targets. Also the precision of the warnings depends on the optimization options used. So like, the vibes are not guaranteed. ๐-Winit-self(C, C++, Objective-C and Objective-C++ only) โ warns you about uninitialized variables that are initialized with themselves (a true "I'm my own source of truth" moment, and not in a main-character way ๐ญ). Heads up: this option can only be used together with the-Wuninitializedoption.
For example, GCC warns about i being uninitialized in the following snippet only when -Winit-self has been specified:
int f()
{
int i = i;
return i;
}
This warning is enabled by -Wall in C++.
-Wno-implicit-int(C and Objective-C only) โ this one's the switch that controls warnings when a declaration does not specify a type. (Yes queen, what are you even declaring? ๐) This warning is enabled by default in C99 and later dialects of C, and also by-Wall.-Wno-implicit-function-declaration(C and Objective-C only) โ controls warnings when a function is used before being declared. The classic "hi who are you, you weren't introduced" situation ๐. This warning is enabled by default in C99 and later dialects of C, and also by-Wall. And plot twist: the warning is made into an error by-pedantic-errors.-Wimplicit(C and Objective-C only) โ literally the same as-Wimplicit-intand-Wimplicit-function-declarationcombined. Two-for-one deal โจ. This warning is enabled by-Wall.-Wimplicit-fallthroughโ so-Wimplicit-fallthroughis the same as-Wimplicit-fallthrough=3, and-Wno-implicit-fallthroughis the same as-Wimplicit-fallthrough=0. Slay, symmetry.-Wimplicit-fallthrough=nโ warns when aswitchcase falls through. (You know, when case 2 just casually stumbles into case 3 without abreaklike it lives there now ๐ซถ.) For example:
switch (cond)
{
case 1:
a = 1;
break;
case 2:
a = 2;
case 3:
a = 3;
break;
}
This warning does not warn when the last statement of a case cannot fall through, e.g. when there is a return statement or a call to a function declared with the noreturn attribute. And -Wimplicit-fallthrough= also takes into account control flow statements, such as ifs, and only warns when appropriate. E.g.
switch (cond)
{
case 1:
if (i > 3) {
bar (5);
break;
} else if (i < 1) {
bar (0);
} else
return;
default:
...
}
Since there are occasions where a switch case fall through is desirable (sometimes the fallthrough is the moment, no cap), GCC provides an attribute, __attribute__ ((fallthrough)), that is to be used along with a null statement to suppress this warning that would normally occur:
switch (cond)
{
case 1:
bar (0);
__attribute__ ((fallthrough));
default:
...
}
C++17 provides a standard way to suppress the -Wimplicit-fallthrough warning using [[fallthrough]]; instead of the GNU attribute. In C++11 or C++14 users can use [[gnu::fallthrough]];, which is a GNU extension. Instead of these attributes, it is also possible to add a fallthrough comment to silence the warning. The whole body of the C or C++ style comment should match the given regular expressions listed below. The option argument n specifies what kind of comments are accepted:
-Wimplicit-fallthrough=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 thewarn_if_not_alignedattribute 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 asconst. For ISO C such a type qualifier has no effect, since the value returned by a function is not an lvalue. For C++, the warning is only emitted for scalar types orvoid. ISO C prohibits qualifiedvoidreturn types on function definitions, so such return types always receive a warning even without this option. Rude of them, honestly.
This warning is also enabled by -Wextra.
-Wno-ignored-attributes(C and C++ only) โ controls warnings when an attribute is ignored. This is different from the-Wattributesoption in that it warns whenever the compiler decides to drop an attribute, not that the attribute is either unknown, used in a wrong place, etc. This warning is enabled by default.-Wmainโ warns if the type ofmainis suspicious.mainshould be a function with external linkage, returning int, taking either zero arguments, two, or three arguments of appropriate types. (Bestie,mainhas ONE job and we need it to look right ๐ .) This warning is enabled by default in C++ and is enabled by either-Wallor-Wpedantic.-Wmisleading-indentation(C and C++ only) โ warns when the indentation of the code does not reflect the block structure. Specifically, a warning is issued forif,else,while, andforclauses with a guarded statement that does not use braces, followed by an unguarded statement with the same indentation. The visual gaslighting is real ๐ญ.
In the following example, the call to bar is misleadingly indented as if it were guarded by the if conditional.
if (some_condition ())
foo ();
bar (); /* Gotcha: this is not guarded by the "if". */
In the case of mixed tabs and spaces, the warning uses the -ftabstop= option to determine if the statements line up (defaulting to 8).
The warning is not issued for code involving multiline preprocessor logic such as the following example.
if (flagA)
foo (0);
#if SOME_CONDITION_THAT_DOES_NOT_HOLD
if (flagB)
#endif
foo (1);
The warning is not issued after a #line directive, since this typically indicates autogenerated code, and no assumptions can be made about the layout of the file that the directive references.
This warning is enabled by -Wall in C and C++.
-Wmissing-attributesโ warns when a declaration of a function is missing one or more attributes that a related function is declared with and whose absence may adversely affect the correctness or efficiency of generated code. For example, the warning is issued for declarations of aliases that use attributes to specify less restrictive requirements than those of their targets. This typically represents a potential optimization opportunity โจ. By contrast, the-Wattribute-alias=2option controls warnings issued when the alias is more restrictive than the target, which could lead to incorrect code generation. Attributes considered includealloc_align,alloc_size,cold,const,hot,leaf,malloc,nonnull,noreturn,nothrow,pure,returns_nonnull, andreturns_twice.
In C++, the warning is issued when an explicit specialization of a primary template declared with attribute alloc_align, alloc_size, assume_aligned, format, format_arg, malloc, or nonnull is declared without it. Attributes deprecated, error, and warning suppress the warning..
You can use the copy attribute to apply the same set of attributes to a declaration as that on another declaration without explicitly enumerating the attributes. This attribute can be applied to declarations of functions, variables, or types.
-Wmissing-attributes is enabled by -Wall.
For example, since the declaration of the primary function template below makes use of both attribute malloc and alloc_size the declaration of the explicit specialization of the template is diagnosed because it is missing one of the attributes.
template <class T>
T* __attribute__ ((malloc, alloc_size (1)))
allocate (size_t);
template <>
void* __attribute__ ((malloc)) // missing alloc_size
allocate<void> (size_t);
-Wmissing-bracesโ warns if an aggregate or union initializer is not fully bracketed. In the following example, the initializer forais not fully bracketed, but that forbis fully bracketed. One of them understood the assignment ๐.
int a[2][2] = { 0, 1, 2, 3 };
int b[2][2] = { { 0, 1 }, { 2, 3 } };
This warning is enabled by -Wall.
-Wmissing-include-dirs(C, C++, Objective-C and Objective-C++ only) โ warns if a user-supplied include directory does not exist. Like, bestie, that folder is not there ๐.-Wno-missing-profileโ okay so bestie, this one is the vibe check for your feedback profiles ๐ It controls warnings for when those profiles are missing while you're using-fprofile-use. It catches those situations where you add a brand-new function or a whole new file in between compiling with-fprofile-generateand with-fprofile-use, without regenerating the profiles. And in those cases?? The profile feedback data files just... don't have any profile feedback info for the freshly added function or file. ๐ญ Also, if your profile count data (.gcda) files get deleted, GCC can't use any profile feedback information. In all these cases, warnings get issued to tell you that a profile generation step is due. Ignoring that warning can leave you with poorly optimized code. You can use-Wno-missing-profileto silence it, but this is not recommended and should only be done when non-existent profile data is justified. fr fr, don't just mute it because it's annoying.-Wmultistatement-macrosโ warns about unsafe multiple statement macros that look like they're guarded by a clause likeif,else,for,switch, orwhile, but where only the first statement is actually guarded after the macro expands. The way that this bites you is iconic in the worst way:
#define DOIT x++; y++
if (c)
DOIT;
That will increment y unconditionally, not just when c holds. ๐ณ The usual fix is 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 spot where a truth value is expected, or when operators are nested whose precedence people keep getting 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. not me doing math notation in C ๐
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 about some cases of unnecessary parentheses in declarations, which can hint at an attempted function call instead of a declaration:
{
// Declares a local variable called mymutex.
std::unique_lock<std::mutex> (mymutex);
// User meant std::unique_lock<std::mutex> lock (mymutex);
}
This warning is enabled by -Wall.
-Wsequence-pointโ warns about code that may have undefined semantics because of violations of sequence point rules in the C and C++ standards. buckle up bestie, this one's a whole essay โจ
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 <http://gcc.gnu.org/readings.html>.
This warning is enabled by -Wall for C and C++.
-Wno-return-local-addrโ do not warn about returning a pointer (or in C++, a reference) to a variable that goes out of scope after the function returns. ๐-Wreturn-typeโ warns whenever a function is defined with a return type that defaults toint. Also warns about anyreturnstatement with no return value in a function whose return type is notvoid(falling off the end of the function body is considered returning without a value).
For C only, it warns about a return statement with an expression in a function whose return type is void, unless the expression type is also void. As a GNU extension, the latter case is accepted without a warning unless -Wpedantic is used. Attempting to use the return value of a non-void function other than main that flows off the end by reaching the closing curly brace that terminates the function is undefined.
Unlike in C, in C++, flowing off the end of a non-void function other than main results in undefined behavior even when the value of the function is not used.
This warning is enabled by default in C++ and by -Wall otherwise.
-Wno-shift-count-negativeโ controls warnings if a shift count is negative. This warning is enabled by default. โญ-Wno-shift-count-overflowโ controls warnings if a shift count is greater than or equal to the bit width of the type. This warning is enabled by default. โญ-Wshift-negative-valueโ warns if left shifting a negative value. This warning is 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-overflow and is enabled by default in C99 and C++11 modes (and newer). This warning level does not warn about left-shifting 1 into the sign bit. (However, in C, such an overflow is still rejected in contexts where an integer constant expression is required.) No warning is emitted in C++2A mode (and newer), as signed left shifts always wrap.
-Wshift-overflow=2
This warning level also warns about left-shifting 1 into the sign bit, unless C++14 mode (or newer) is active.
-Wswitchโ 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.)caselabels outside the enumeration range also provoke warnings when this option is used (even if there is adefaultlabel). This warning is 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 outside the enumeration range also provoke warnings when this option is used. The only difference between-Wswitchand this option is that this option gives a warning about an omitted enumeration code even if there is adefaultlabel. ๐-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. It's possible to 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. This warning is 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. ๐ญ-Wunused-but-set-parameterโ warns whenever a function parameter is assigned to, but otherwise unused (aside from its declaration). โจ-Wunused-but-set-variableโ bestie, this one yells at you whenever a local variable gets assigned to but is otherwise just... sitting there, unused (declaration doesn't count, that's not a use, periodt). Enabled by-Wall. ๐
Wanna silence it? Slap the "unused" attribute on it.
It's also enabled by -Wunused, which is itself enabled by -Wall. it's giving stacked. โจ
-Wunused-functionโ warns whenever astaticfunction is declared but never defined, OR a non-inlinestaticfunction is just... never used. ๐ญ Enabled by-Wall.-Wunused-labelโ warns whenever a label is declared but not used. Enabled by-Wall.
Suppress it with the "unused" attribute. ๐
-Wunused-local-typedefs(C, Objective-C, C++ and Objective-C++ only) โ warns when atypedefthat's locally defined inside a function goes unused. Enabled by-Wall. the way that typedef just sat there... ๐-Wunused-parameterโ warns whenever a function parameter is unused aside from its declaration.
Silence it with the "unused" attribute. ๐ธ
-Wno-unused-resultโ do not warn if a caller of a function marked with attribute"warn_unused_result"doesn't use its return value. The default is-Wunused-result. ๐-Wunused-variableโ 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.
Suppress it with the "unused" attribute. ๐ฆ
-Wunused-const-variable-Wunused-const-variable=nโ warns whenever a constant static variable is unused aside from its declaration.-Wunused-const-variable=1is enabled by-Wunused-variablefor C, but not for C++. In C this declares variable storage, but in C++ this is not an error since const variables take the place of"#define"s.
Suppress it with the "unused" attribute. ๐
-Wunused-const-variable=1โ this is the warning level that's enabled by-Wunused-variablefor C. It warns only about unused static const variables defined in the main compilation unit, but not about static const variables declared in any header included. so it's the chill level, lowkey.-Wunused-const-variable=2โ this warning level also warns for unused constant static variables in headers (excluding system headers). This is the warning level of-Wunused-const-variableand must be explicitly requested, since in C++ this isn't an error and in C it might be harder to clean up all the headers included. highkey extra, iykyk. ๐ฅ
-Wunused-valueโ warns whenever a statement computes a result that is explicitly not used. To suppress it, cast the unused expression to"void". This includes an expression-statement or the left-hand side of a comma expression that contains no side effects. For example, an expression such as"x[i,j]"causes a warning, while"x[(void)i,j]"does not. ngl that's a glow-up right there. โจ
Enabled by -Wall.
-Wunusedโ all the above-Wunusedoptions combined. the whole squad. ๐ซถ
So like, to get a warning about an unused function parameter, you must either specify -Wextra -Wunused (heads up: -Wall implies -Wunused), or separately specify -Wunused-parameter. no cap.
-Wuninitializedโ warns if an automatic variable is used without first being initialized. In C++, warns if a non-static reference or non-static"const"member appears in a class without constructors. ๐จ
If you wanna 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. it's giving circumstantial. ๐ญ
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. ๐
-Wno-invalid-memory-modelโ this option controls warnings for invocations of__atomicBuiltins,__syncBuiltins, and the C11 atomic generic functions with a memory consistency argument that is either invalid for the operation or outside the range of values of the"memory_order"enumeration. For example, since the"__atomic_store"and"__atomic_store_n"built-ins are only defined for the relaxed, release, and sequentially consistent memory orders, the following code is diagnosed:
void store (int *i)
{
__atomic_store_n (i, 0, memory_order_consume);
}
-Winvalid-memory-model is enabled by default. โจ
-Wmaybe-uninitializedโ okay so for an automatic (i.e. local) variable, if there exists a path from the function entry to a use of the variable that is initialized, but there exist some other paths for which the variable is not initialized, the compiler emits a warning if it cannot prove the uninitialized paths are not executed at run time. maybe initialized, maybe not, it's giving mystery. ๐ต๏ธ
These warnings are only possible in optimizing compilation, because otherwise GCC does not keep track of the state of variables.
These warnings are made optional because GCC may not be able to determine when the code is correct in spite of appearing to have an error. Here's one example of how this can happen:
{
int x;
switch (y)
{
case 1: x = 1;
break;
case 2: x = 4;
break;
case 3: x = 5;
}
foo (x);
}
If the value of "y" is always 1, 2 or 3, then "x" is always initialized, but GCC doesn't know this. To suppress the warning, you need to provide a default case with assert(0) or similar code. ๐
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. the compiler is doing its best and we love that for it. ๐
Some spurious warnings can be avoided if you declare all the functions you use that never return as "noreturn".
This warning is enabled by -Wall or -Wextra.
-Wunknown-pragmasโ warns when a"#pragma"directive is encountered that 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-Wallcommand-line option. so-Wunknown-pragmassaid "we're going there" and-Walldid not. ๐ค-Wno-pragmasโ do not warn about misuses of pragmas, such as incorrect parameters, invalid syntax, or conflicts between pragmas. See also-Wunknown-pragmas.-Wno-prio-ctor-dtorโ 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. those numbers are taken, bestie, hands off. ๐ซ-Wstrict-aliasingโ this option is only active when-fstrict-aliasingis active. It warns about code that might break the strict aliasing rules that the compiler is using for optimization. The warning does not catch all cases, but does attempt to catch the more common pitfalls. It's included in-Wall. It's equivalent to-Wstrict-aliasing=3. ๐-Wstrict-aliasing=nโ same deal: only active when-fstrict-aliasingis active. It warns about code that might break the strict aliasing rules the compiler is using for optimization. Higher levels correspond to higher accuracy (fewer false positives). Higher levels also correspond to more effort, similar to the way-Oworks.-Wstrict-aliasingis equivalent to-Wstrict-aliasing=3.
Level 1: Most aggressive, quick, least accurate. Possibly useful when higher levels do not warn but -fstrict-aliasing still breaks the code, as it has very few false negatives. However, it has many false positives. Warns for all pointer conversions between possibly incompatible types, even if never dereferenced. Runs in the front end only. it's giving chaotic oversharer. ๐
Level 2: Aggressive, quick, not too precise. May still have many false positives (not as many as level 1 though), and few false negatives (but possibly more than level 1). Unlike level 1, it only warns when an address is taken. Warns about incomplete types. Runs in the front end only.
Level 3 (default for -Wstrict-aliasing): Should have very few false positives and few false negatives. Slightly slower than levels 1 or 2 when optimization is enabled. Takes care of the common pun+dereference pattern in the front end: "*(int*)&some_float". If optimization is enabled, it also runs in the back end, where it deals with multiple statement cases using flow-sensitive points-to information. Only warns when the converted pointer is dereferenced. Does not warn about incomplete types. the balanced queen we deserve. ๐
-Wstrict-overflow-Wstrict-overflow=nโ this option is only active when signed overflow is undefined. It warns about cases where the compiler optimizes based on the assumption that signed overflow does not occur. Note that it does not warn about all cases where the code might overflow: it only warns about cases where the compiler implements some optimization. Thus this warning depends on the optimization level. ๐ฅ
Okay so the vibe here is: an optimization that assumes signed overflow doesn't happen is completely safe when the variables involved genuinely never overflow. Which means this warning can absolutely give you a false positive โ yelling at code that was never a problem. ๐ To keep the drama focused on stuff that actually matters, there are several warning levels. And no cap: no warnings get issued for undefined signed overflow when the compiler is estimating how many iterations a loop needs โ especially when it's figuring out whether the loop runs at all.
-Wstrict-overflow=1โ Warns about the cases that are both questionable and easy to dodge. Like the compiler simplifyingx + 1 > xdown to1. This level of-Wstrict-overflowis turned on by-Wall; the higher levels are not, bestie, you have to ask for them explicitly. ๐-Wstrict-overflow=2โ Also warns about other cases where a comparison gets folded into a constant. Example:abs (x) >= 0. This one can only be simplified when signed integer overflow is undefined, becauseabs (INT_MIN)overflows toINT_MIN, which is less than zero. And-Wstrict-overflowwith no level at all? Same as-Wstrict-overflow=2.-Wstrict-overflow=3โ Also warns about other cases where a comparison is simplified. Example:x + 1 > 1gets simplified tox > 0.-Wstrict-overflow=4โ Also warns about other simplifications that the cases above don't cover. Example:(x * 10) / 5gets simplified tox * 2.-Wstrict-overflow=5โ Also warns about cases where the compiler shrinks the magnitude of a constant involved in a comparison. Example:x + 2 > ygets simplified tox + 1 >= y. This one only gets reported at the highest warning level, because this simplification touches so many comparisons that this level will hand you a truly enormous pile of false positives. ๐
-Wstring-compare
Warns about calls to strcmp and strncmp whose result is already determined to be either zero or non-zero in equality tests โ because one argument's length is greater than the size of the array the other argument lives in (or the bound, in the strncmp case). Calls like this could totally be mistakes. For example, the strcmp call below gets diagnosed because its result is necessarily non-zero no matter what's actually inside the array a.
extern char a[4];
void f (char *d)
{
strcpy (d, "string");
...
if (0 == strcmp (a, d)) // cannot be true
puts ("a and d are the same");
}
-Wstring-compare is enabled by -Wextra. โจ
-Wstringop-overflow
-Wstringop-overflow,-Wstringop-overflow=type โ Warns about calls to string manipulation functions likememcpyandstrcpythat are determined to overflow the destination buffer. The optional argument is one greater than the type of Object Size Checking to perform when figuring out the destination's size. That argument only means something for functions that operate on character arrays โ it does nothing for raw memory functions likememcpy, which always use Object Size type-0. The option also warns for calls that specify a size bigger than the largest possible object, or at mostSIZE_MAX / 2bytes. It gives its best results with optimization enabled, but it can still catch a small subset of simple buffer overflows even with no optimization, in calls to GCC built-ins like__builtin_memcpythat correspond to the standard functions. Either way, it only warns about a subset of the buffer overflows that the corresponding overflow checking built-ins would detect. For example, the option warns about thestrcpycall below because it copies at least 5 characters (the string"blue", terminating NUL included) into a buffer of size 4.
enum Color { blue, purple, yellow };
const char* f (enum Color clr)
{
static char buf [4];
const char *str;
switch (clr)
{
case blue: str = "blue"; break;
case purple: str = "purple"; break;
case yellow: str = "yellow"; break;
}
return strcpy (buf, str); // warning here
}
Option -Wstringop-overflow=2 is enabled by default. ๐ซถ
-Wstringop-overflow,-Wstringop-overflow=1โ Uses type-zero Object Size Checking to work out the sizes of destination objects. This is the default setting of the option. At this setting it does not warn about writes past the end of subobjects of larger objects that are accessed through pointers, unless the size of the largest surrounding object is known. When the destination could be one of several objects, it assumes it's the largest one of them. On Linux systems, with optimization enabled at this setting, the option warns for the exact same code as when the_FORTIFY_SOURCEmacro is defined to a non-zero value.-Wstringop-overflow=2โ Uses type-one Object Size Checking to work out 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. But it does not warn about excessive writes to those same members of unknown objects referenced by pointers, since those could point to arrays with an unknown number of elements.-Wstringop-overflow=3โ Uses type-two Object Size Checking to work out the sizes of destination objects. At this setting the option warns about overflowing the smallest object or data member. This is the most restrictive setting of the option that can produce warnings for code that's actually safe. ๐ฌ-Wstringop-overflow=4โ Uses type-three Object Size Checking to work out 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 warn. Just like-Wstringop-overflow=3, this setting can produce warnings for perfectly benign code.
-Wno-stringop-truncation
Don't warn about calls to bounded string manipulation functions like strncat, strncpy, and stpncpy that might either truncate the copied string or leave the destination untouched.
In the example below, the strncat call specifies a bound that's less than the length of the source string. So the copy of the source gets truncated, and the call gets diagnosed. To dodge the warning, use bufsize - strlen (buf) - 1) as the bound.
void append (char *buf, size_t bufsize)
{
strncat (buf, ".txt", 3);
}
Another one: the strncpy call below ends up copying to d just the characters before the terminating NUL, without appending that NUL at the end. Assuming the result of strncpy is necessarily a NUL-terminated string is a super common mistake, so the call gets diagnosed. If your result isn't expected to be NUL-terminated, call memcpy instead to avoid the warning. ๐ก
void copy (char *d, const char *s)
{
strncpy (d, s, strlen (s));
}
And here's another: this strncpy call uses the size of the destination buffer as the bound. If the source string's length is equal to or greater than that size, the copy's result won't be NUL-terminated. So yes, also diagnosed. To avoid the warning, specify sizeof buf - 1 as the bound and set the last element of the buffer to NUL.
void copy (const char *s)
{
char buf[80];
strncpy (buf, s, sizeof buf);
...
}
When a character array is meant to hold a sequence of bytes with no terminating NUL, you can annotate that array with the attribute nonstring to shut this warning up. But heads up: arrays like that are not suitable arguments to functions that expect NUL-terminated strings. To help catch accidental misuse of those arrays, GCC issues warnings unless it can prove the use is safe.
-Wsuggest-attribute=[pure|const|noreturn|format|cold|malloc]
Warns about cases where adding an attribute might be a glow-up. The attributes currently supported are listed below. ๐
-Wsuggest-attribute=pure,-Wsuggest-attribute=const,-Wsuggest-attribute=noreturn,-Wmissing-noreturn,-Wsuggest-attribute=mallocโ Warns about functions that might be candidates for the attributespure,const,noreturnormalloc. The compiler only warns for functions that are visible in other compilation units, or (forpureandconst) when it can't prove the function returns normally. A function returns normally if it doesn't contain an infinite loop and doesn't return abnormally by throwing, callingabort, or trapping. This analysis needs option-fipa-pure-const, which is enabled by default at-Oand higher. Higher optimization levels make the analysis more accurate.-Wsuggest-attribute=format,-Wmissing-format-attributeโ Warns about function pointers that might be candidates forformatattributes. Note these are only possible candidates, not guaranteed ones. GCC guesses that function pointers withformatattributes used in assignment, initialization, parameter passing or return statements should have a matchingformatattribute in the resulting type. That is: 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 side-eyes function definitions that might be candidates for format attributes. And bestie, again โ these are only possible candidates, okay? GCC is literally just guessing that format attributes might be appropriate for any function that calls something like vprintf or vscanf, but that's not always the case, and some functions where format attributes would totally fit may just fly under the radar. It's giving vibes, not verdicts. ๐
-Wsuggest-attribute=coldโ Warns you about functions that might be candidates for thecoldattribute. This is based on static detection, so it generally only calls out functions that always lead to a call to anothercoldfunction โ think wrappers around C++throw, or fatal-error-reporting functions that lead toabort. ๐-Walloc-zeroโ Warns about calls to allocation functions decorated with thealloc_sizeattribute that specify zero bytes, including calls to the built-in forms ofaligned_alloc,alloca,calloc,malloc, andrealloc. Here's the tea: because the behavior of these functions when called with a zero size differs among implementations (and in the case ofreallocit's been deprecated), relying on it may result in subtle portability bugs and should be avoided. fr fr, just don't.- *
-Walloc-size-larger-than=byte-size* โ Warns about calls to functions decorated with thealloc_sizeattribute that try to allocate objects larger than the specified number of bytes, or where the result of the size computation in an integer type with infinite precision would exceed the value ofPTRDIFF_MAXon the target.-Walloc-size-larger-than=PTRDIFF_MAXis enabled by default. Warnings controlled by the option can be disabled either by specifying byte-size ofSIZE_MAXor more, or by-Wno-alloc-size-larger-than. -Wno-alloc-size-larger-thanโ Disables-Walloc-size-larger-than=warnings. This option is equivalent to-Walloc-size-larger-than=SIZE_MAXor larger.-Wallocaโ This option warns on all uses ofallocain the source. every single one. ๐- *
-Walloca-larger-than=byte-size* โ This one warns on calls toallocawith an integer argument whose value is either zero, or that isn't bounded by a controlling predicate limiting its value to at most byte-size. It also warns for calls toallocawhere the bound value is unknown. Arguments of non-integer types are considered unbounded even if they appear to be constrained to the expected range. ๐ญ
For example, a bounded case of alloca could be:
void func (size_t n)
{
void *p;
if (n <= 1000)
p = alloca (n);
else
p = malloc (n);
f (p);
}
In the above example, passing -Walloca-larger-than=1000 would not issue a warning, because the call to alloca is known to be at most 1000 bytes. However, if -Walloca-larger-than=500 were passed, the compiler would emit a warning.
Unbounded uses, on the other hand, are uses of alloca with no controlling predicate constraining its integer argument. For example:
void func ()
{
void *p = alloca (n);
f (p);
}
If -Walloca-larger-than=500 were passed, the above would trigger a warning, but this time because of the lack of bounds checking.
Note that even seemingly correct code involving signed integers could cause a warning:
void func (signed int n)
{
if (n < 500)
{
p = alloca (n);
f (p);
}
}
In the above example, n could be negative, causing a larger than expected argument to be implicitly cast into the alloca call. sneaky. ๐
This option also warns when alloca is used in a loop.
-Walloca-larger-than=PTRDIFF_MAX is enabled by default but is usually only effective when -ftree-vrp is active (default for -O2 and above).
See also -Wvla-larger-than=byte-size.
-Wno-alloca-larger-thanโ Disables-Walloca-larger-than=warnings. The option is equivalent to-Walloca-larger-than=SIZE_MAXor 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 โ This option is only active when-ftree-vrpis active (default for-O2and above). It warns about subscripts to arrays that are **always out of bounds. This warning is enabled by-Wall. vibe check: your index is not it.-Warray-bounds=1โ This is the warning level of-Warray-boundsand is enabled by-Wall; higher levels are not, and must be explicitly requested.-Warray-bounds=2โ This warning level also warns about out of bounds access for arrays at the end of a struct and for arrays accessed through pointers. This warning level may give a larger number of false positives and is deactivated by default. โ ๏ธ yes it's noisy
-Wattribute-alias=n</n>-Wno-attribute-aliasโ Warns about declarations using thealiasand similar attributes whose target is incompatible with the type of the alias.-Wattribute-alias=1โ The default warning level of the-Wattribute-aliasoption diagnoses incompatibilities between the type of the alias declaration and that of its target. Such incompatibilities are typically indicative of bugs. ๐-Wattribute-alias=2โ At this level-Wattribute-aliasalso diagnoses cases where the attributes of the alias declaration are more restrictive than the attributes applied to its target. These mismatches can potentially result in incorrect code generation. In other cases they may be benign and could be resolved simply by adding the missing attribute to the target. For comparison, see the-Wmissing-attributesoption, which controls diagnostics when the alias declaration is less restrictive than the target, rather than more restrictive.
Attributes considered include alloc_align, alloc_size, cold, const, hot, leaf, malloc, nonnull, noreturn, nothrow, pure, returns_nonnull, and returns_twice.
-Wattribute-alias is equivalent to -Wattribute-alias=1. This is the default. You can disable these warnings with either -Wno-attribute-alias or -Wattribute-alias=0.
-Wbool-compareโ Warns about a boolean expression compared with an integer value different fromtrue/false. For instance, the following comparison is always false:
int n = 5;
...
if ((n > 1) == 2) { ... }
This warning is enabled by -Wall.
-Wbool-operationโ 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.) bestie, why are you doing math on a bool ๐ญ
This warning is enabled by -Wall.
-Wduplicated-branchesโ Warns when an if-else has identical branches. This warning detects cases like
if (p != NULL)
return 0;
else
return 0;
It doesn't warn when both branches contain just a null statement. This warning also warns for conditional operators:
int i = x ? *p : *p;
-Wduplicated-condโ Warns about duplicated conditions in an if-else-if chain. For instance, warn for the following code:
if (p->q != NULL) { ... }
else if (p->q != NULL) { ... }
-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 aconst char *variable is passed to a function that takes achar *parameter. This option can be used to suppress such a warning.-Wno-discarded-array-qualifiers(C and Objective-C only) โ Do not warn if type qualifiers on arrays which are pointer targets are being discarded. Typically, the compiler warns if aconst int (*)[]variable is passed to a function that takes aint (*)[]parameter. This option can be used to suppress such a warning.-Wno-incompatible-pointer-types(C and Objective-C only) โ Do not warn when there is a conversion between pointers that have incompatible types. This warning is for cases not covered by-Wno-pointer-sign, which warns for pointer argument passing or assignment with different signedness.-Wno-int-conversion(C and Objective-C only) โ Do not warn about incompatible integer to pointer and pointer to integer conversions. This warning is about implicit conversions; for explicit conversions the warnings-Wno-int-to-pointer-castand-Wno-pointer-to-int-castmay be used.-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. See
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โ okay so this one is like, please don't yell at me about integer division by zero happening at compile time. That's the whole vibe. But floating-point division by zero? nah, that's fine actually, because dividing a float by zero is a totally legit way to get yourself an infinity or a NaN. So no warning there, bestie. ๐-Wsystem-headersโ this one tells GCC to spill the tea about warnings hiding in system header files. Normally those get suppressed because the assumption is they're usually not real problems and they just make the compiler output unreadable. Turning this on makes GCC emit warnings from system headers like they were in your own code. โจ But heads up: using-Wallwith this option still does not warn about unknown pragmas in system headers โ for that you also gotta use-Wunknown-pragmas. no cap.-Wtautological-compareโ warn if a self-comparison always evaluates to true or false. It catches mistakes like:
int i = 1;
...
if (i > i) { ... }
It also warns about bitwise comparisons that always evaluate to true or false, like:
if ((a & 16) == 10) { ... }
which will always be false. This warning is enabled by -Wall. ๐
-Wtrampolinesโ warn about trampolines generated for pointers to nested functions. So like, a trampoline is a small piece of data or code created at run time on the stack when you take the address of a nested function, and it's used to call that nested function indirectly. For some targets it's made up of data only, so no special treatment needed. But for most targets, it's made up of code, which means the stack has to be made executable for the program to work properly. ๐ฆ-Wfloat-equalโ warn if floating-point values are used in equality comparisons. The idea here is that sometimes it's convenient (for the programmer, bestie) to treat floating-point values as approximations to infinitely precise real numbers. If you're doing that, you need to compute (by analyzing the code or some other way) the maximum or likely maximum error the computation introduces, and allow for it when doing comparisons (and when producing output, but that's a different problem). In particular, instead of testing for equality, you should check whether the two values have ranges that overlap โ and that's done with relational operators. So equality comparisons are probably mistaken. ๐ญ-Wtraditional(C and Objective-C only) โ warn about certain constructs that behave differently in traditional vs ISO C. Also warns about ISO C constructs with no traditional C equivalent, and/or problematic constructs you should avoid. Here's the whole list:- Macro parameters that appear within string literals in the macro body. In traditional C, macro replacement happens inside string literals, but in ISO C it does not.
- In traditional C, some preprocessor directives didn't exist. Traditional preprocessors only considered a line a directive if the
#appeared in column 1. So-Wtraditionalwarns about directives that traditional C understands but ignores because the#isn't the first character on the line. It also suggests you hide directives like#pragmathat traditional C doesn't understand by indenting them. Some traditional implementations don't 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 that these suffixes appear in macros defined in the system headers of most modern systems, e.g. the_MIN/_MAXmacros in<limits.h>. Using these macros in user code might normally lead to spurious warnings, but GCC's integrated preprocessor has enough context to avoid warning in these cases. - A function declared external in one block and then used after the end of the block.
- A
switchstatement has an operand of typelong. - A non-
staticfunction declaration follows astaticone. Some traditional C compilers don't accept this construct. - The ISO type of an integer constant has a different width or signedness from its traditional type. This warning is only issued if the base of the constant is ten. I.e. hexadecimal or octal values, which typically represent bit patterns, are not warned about.
- Usage of ISO string concatenation is detected.
- Initialization of automatic aggregates.
- Identifier conflicts with labels. Traditional C lacks a separate namespace for labels.
- Initialization of unions. If the initializer is zero, the warning is omitted. This is done under the assumption that the zero initializer in user code appears conditioned on e.g.
__STDC__to avoid missing initializer warnings and relies on default initialization to zero in the traditional C case. - Conversions by prototypes between fixed/floating-point values and vice versa. The absence of these prototypes when compiling with traditional C causes serious problems. This is a subset of the possible conversion warnings; for the full set use
-Wtraditional-conversion. - Use of ISO C style function definitions. This warning intentionally is not issued for prototype declarations or variadic functions because these ISO C features appear in your code when using libiberty's traditional C compatibility macros,
PARAMSandVPARAMS. This warning is also bypassed for nested functions because that feature is already a GCC extension and thus not relevant to traditional C compatibility.
-Wtraditional-conversion(C and Objective-C only) โ warn if a prototype causes a type conversion that's different from what would happen to the same argument without a prototype. This includes conversions of fixed point to floating and vice versa, and conversions changing the width or signedness of a fixed-point argument, except when it's the same as the default promotion. ๐-Wdeclaration-after-statement(C and Objective-C only) โ warn when a declaration is found after a statement in a block. This construct, which you know from C++, was introduced with ISO C99 and is allowed in GCC by default. It is not supported by ISO C90. ๐ซถ-Wshadowโ warn whenever a local variable or type declaration shadows another variable, parameter, type, class member (in C++), or instance variable (in Objective-C), or whenever a built-in function is shadowed. Note that in C++, the compiler warns if a local variable shadows an explicit typedef, but not if it shadows a struct/class/enum. If this warning is enabled, it also includes all instances of local shadowing. That means-Wno-shadow=localand-Wno-shadow=compatible-localare ignored when-Wshadowis used. Same as-Wshadow=global. ๐-Wno-shadow-ivar(Objective-C only) โ do not warn whenever a local variable shadows an instance variable in an Objective-C method. ๐-Wshadow=globalโ warn for any shadowing. Same as-Wshadow.-Wshadow=localโ warn when a local variable shadows another local variable or parameter.-Wshadow=compatible-localโ warn when a local variable shadows another local variable or parameter whose type is compatible with that of the shadowing variable. In C++, type compatibility here means the type of the shadowing variable can be converted to that of the shadowed variable. The creation of this flag (on top of-Wshadow=local) is based on the idea that when a local variable shadows another one of incompatible type, it's most likely intentional, not a bug or typo, like in this example:
for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
{
for (int i = 0; i < N; ++i)
{
...
}
...
}
Since the two variable i in the example above have incompatible types, enabling only -Wshadow=compatible-local does not emit a warning. Because their types are incompatible, if a programmer accidentally uses one in place of the other, type checking is expected to catch that and emit an error or warning. Use of this flag instead of -Wshadow=local can possibly reduce the number of warnings triggered by intentional shadowing. Note that this also means that shadowing const char *i by char *i does not emit a warning. โจ
This warning is also enabled by -Wshadow=local. ๐ธ
-Wlarger-than=byte-sizeโ warn whenever an object is defined whose size exceeds byte-size.-Wlarger-than=PTRDIFF_MAXis enabled by default. Warnings controlled by the option can be disabled either by specifying a byte-size ofSIZE_MAXor more, or by-Wno-larger-than. ๐-Wno-larger-thanโ disable-Wlarger-than=warnings. The option is equivalent to-Wlarger-than=SIZE_MAXor larger. ๐-Wframe-larger-than=byte-sizeโ warn if the size of a function frame exceeds byte-size. The computation done to determine the stack frame size is approximate and not conservative. The actual requirements may be somewhat greater than byte-size even if you don't get a warning. On top of that, any space allocated viaalloca, variable-length arrays, or related constructs is not included by the compiler when determining whether or not to issue a warning.-Wframe-larger-than=PTRDIFF_MAXis enabled by default. Warnings controlled by the option can be disabled either by specifying a byte-size ofSIZE_MAXor more, or by-Wno-frame-larger-than. ๐ฆ-Wno-frame-larger-thanโ disable-Wframe-larger-than=warnings. The option is equivalent to-Wframe-larger-than=SIZE_MAXor larger. ๐-Wno-free-nonheap-objectโ do not warn when attempting to free an object that was not allocated on the heap. ๐-Wstack-usage=byte-sizeโ bestie, this one is watching your stack like a hawk ๐ It warns you if a function's stack usage might exceed byte-size. Heads up tho: the computation it does to figure out the stack usage is conservative, so it's giving cautious energy, not exact. And anything you allocate viaalloca, variable-length arrays, or related constructs gets counted by the compiler when it decides whether or not to warn you. No sneaky stacks allowed ๐ซถ
The message matches what -fstack-usage spits out, so here's the vibe check on all three flavours:
- If the stack usage is fully static but exceeds the amount you specified, 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, no cap. And you can silence the warnings this option controls either by specifying byte-size of SIZE_MAX or more, or by using -Wno-stack-usage. Easy โจ
-Wno-stack-usageโ turns off all the-Wstack-usage=warnings. It's literally the same thing as-Wstack-usage=SIZE_MAXor larger. Same energy, different spelling ๐-Wunsafe-loop-optimizationsโ warns you when a loop can't be optimized because the compiler isn't allowed to assume anything about the bounds of the loop indices. Like, it's standing at the door going "I can't go in there, I don't know what's inside ๐ญ". And with-funsafe-loop-optimizations, it warns if the compiler does go ahead and make those assumptions. Chaos either way fr fr-Wno-pedantic-ms-format(MinGW targets only) โ when you use this together with-Wformatand-pedanticwithout GNU extensions, it disables the warnings about non-ISOprintf/scanfformat width specifiersI32,I64, andIused on Windows targets, which depend on the MS runtime. Windows-specific behavior, Windows-specific silence ๐ช-Wpointer-arithโ warns about anything that depends on the "size of" a function type or ofvoid. Why? Because GNU C assigns these types a size of 1 for convenience in calculations withvoid *pointers and pointers to functions. Iconic little hack. In C++, it also warns when an arithmetic operation involvesNULL. This warning is also enabled by-Wpedantic.-Wno-pointer-compareโ do not warn if a pointer is compared with a zero character constant. Because bestie, that usually means the pointer was meant to be dereferenced ๐ Like this:
const char *p = foo ();
if (p == '\0')
return 42;
Note that the code above is invalid in C++11. So if you're on C++11, that's not just a warning situation, that's a whole problem.
This warning is enabled by default.
-Wtype-limitsโ warns if a comparison is always true or always false because of the limited range of the data type. But it does not warn for constant expressions. For example, it warns if an unsigned variable is compared against zero with<or>=. (Like girl, an unsigned can't be negative, what are we doing ๐) This warning is also enabled by-Wextra.-Wabsolute-value(C and Objective-C only) โ warns for calls to standard functions that compute the absolute value of an argument when a more appropriate standard function exists. For example, callingabs(3.14)triggers the warning because the appropriate function to call to compute the absolute value of adoubleargument isfabs. Ma'am that is not the function you're looking for โจ It also warns when the argument in a call to such a function has an unsigned type. You can suppress this with an explicit type cast, and it's also enabled by-Wextra.-Wcomment-Wcommentsโ warns whenever a comment-start sequence/*appears in a/*comment, or whenever a backslash-newline appears in a//comment. Nested-comment jumpscare ๐ญ This warning is enabled by-Wall.-Wtrigraphsโ warns if any trigraphs are encountered that might change the meaning of the program. Trigraphs within comments are not warned about, except those that would form escaped newlines. This option is implied by-Wall. If-Wallis not given, this option is still enabled unless trigraphs are enabled. To get trigraph conversion without warnings, but still get the other-Wallwarnings, use-trigraphs -Wall -Wno-trigraphs. Combo move ๐-Wundefโ warns if an undefined identifier is evaluated in an#ifdirective. Such identifiers get replaced with zero. Surprise zero, the worst kind of zero.-Wexpansion-to-definedโ warns 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โ warns 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 hasn't been used by the time it gets redefined or undefined. Built-in macros, macros defined on the command line, and macros defined in include files are not warned about. So your main file macros better be pulling their weight ๐
Note: If a macro is actually used, but only used in skipped conditional blocks, then the preprocessor reports it as unused. To avoid the warning in such a case, you might improve the scope of the macro's definition by, for example, moving it into the first skipped block. Alternatively, you could provide a dummy use with something like:
#if defined the_macro_causing_the_warning
#endif
-Wno-endif-labelsโ do not warn whenever an#elseor an#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, bestie. They're just vibing out there in the wild ๐ This warning is on by default.
-Wbad-function-cast(C and Objective-C only) โ warns when a function call is cast to a non-matching type. For example, warn if a call to a function returning an integer type is cast to a pointer type. That's not a glow-up, that's a type crime ๐ฅ-Wc90-c99-compat(C and Objective-C only) โ warns about features not present in ISO C90 but present in ISO C99. For instance: 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__. Fancy little escape hatch โจ-Wc99-c11-compat(C and Objective-C only) โ warns about features not present in ISO C99 but present in ISO C11. For instance: anonymous structures and unions,_Atomictype qualifier,_Thread_localstorage-class specifier,_Alignasspecifier,Alignofoperator,_Generickeyword, and so on. This option is independent of the standards mode. Warnings are disabled in the expression that follows__extension__.-Wc11-c2x-compat(C and Objective-C only) โ warns about features not present in ISO C11 but present in ISO C2X. For instance: omitting the string in_Static_assert, use of[[]]syntax for attributes, use of decimal floating-point types, and so on. This option is independent of the standards mode. Warnings are disabled in the expression that follows__extension__.-Wc++-compat(C and Objective-C only) โ warns about ISO C constructs that are outside of the common subset of ISO C and ISO C++, e.g. request for implicit conversion fromvoid *to a pointer to non-voidtype. Living in both worlds is hard, okay ๐ญ-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. This warning is enabled by-Wall.-Wc++17-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 2014 and ISO C++ 2017. This warning is enabled by-Wall.-Wc++20-compat(C++ and Objective-C++ only) โ warns about C++ constructs whose meaning differs between ISO C++ 2017 and ISO C++ 2020. This warning is enabled by-Wall. Standard-by-standard glow-up, one era at a time ๐-Wcast-qualโ warns whenever a pointer is cast so as to remove a type qualifier from the target type. For example, warn if aconst char *is cast to an ordinarychar *. Girl why are we stripping theconstoff, that's its whole personality ๐
It 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. Alignment is real, bestie, respect the boundaries โจ-Wcast-align=strictโ same idea, but stricter energy: 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 *regardless of the target machine. No exceptions, no mercy ๐ฅ-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.-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've been very careful about usingconstin declarations and prototypes. Otherwise, it's just a nuisance. This is why we did not make-Wallrequest these warnings. Fair, honestly ๐ซถ
When compiling C++, warn about the deprecated conversion from string literals to char *. This warning is enabled by default for C++ programs.
-Wclobberedโ warns for variables that might be changed bylongjmporvfork. Sneaky little mutation gremlins ๐ This warning is also enabled by-Wextra.-Wconversionโ bestie, this one yells at you for implicit conversions that could literally change your value. We're talking:- real โ integer conversions, like
abs (x)whenxisdouble - signed โ unsigned conversions, like
unsigned ui = -1 - conversions to smaller types, like
sqrtf (M_PI)
- real โ integer conversions, like
It stays quiet for explicit casts like abs ((int) x) and ui = (unsigned) -1, and also when the conversion doesn't actually change the value, like in abs (2.0). If the signed/unsigned warnings are too much for you, -Wno-sign-conversion turns those off.
For C++, it also warns about confusing overload resolution for user-defined conversions, plus conversions that never use a type conversion operator โ conversions to void, the same type, a base class or a reference to them. And heads up: in C++, the signed/unsigned conversion warnings are off by default unless you explicitly turn on -Wsign-conversion.
Oh and one more thing: warnings about conversion from arithmetic on a small type back to that type only show up with -Warith-conversion. โจ
-Wdangling-elseโ warns you about the classic "wait, whichifdoes thiselsebelong to??" situation. Iconic confusion, honestly. Example:
{
if (a)
if (b)
foo ();
else
bar ();
}
So in C/C++, every else branch belongs to the innermost possible if โ which here is if (b). That's usually not what the programmer meant, and the indentation in that example is exactly the vibe of someone who got got. When this confusion is possible, GCC throws a warning if you passed this flag. Want it gone? Add explicit braces around the innermost if so there's zero way the else can belong to the enclosing if. Like this:
{
if (a)
{
if (b)
foo ();
else
bar ();
}
}
This warning is enabled by -Wparentheses. ๐ซถ
-Wdate-timeโ warns whenever the macros__TIME__,__DATE__or__TIMESTAMP__show up, because they might stop you from getting bit-wise-identical reproducible compilations. Reproducibility queen behavior only. ๐-Wempty-bodyโ warns if there's an empty body in anif,elseordo whilestatement. Also enabled by-Wextra.-Wno-endif-labelsโ stops the warning about stray tokens after#elseand#endif.-Wenum-compareโ warns when you compare values of different enumerated types. In C++, enumerated type mismatches in conditional expressions are also diagnosed, and the warning is on by default there. In C, it's enabled by-Wall.-Wenum-conversion(C, Objective-C only) โ warns when a value of an enumerated type gets implicitly converted to a different enumerated type. Enabled by-Wextra.-Wjump-misses-init(C, Objective-C only) โ warns if agotoor aswitchjumps forward across a variable's initialization, or jumps backward to a label after the variable was initialized. It only cares about variables initialized at declaration, okay? And it's only supported for C and Objective-C โ in C++, this kind of branch is an error no matter what.
-Wjump-misses-init is included in -Wc++-compat, and you can turn it off with -Wno-jump-misses-init. ๐
-Wsign-compareโ warns when comparing signed and unsigned values could give a wrong result because the signed value gets converted to unsigned. In C++, it's also enabled by-Wall. In C, it's also enabled by-Wextra.-Wsign-conversionโ warns about implicit conversions that might flip the sign of an integer value, like assigning a signed integer expression to an unsigned integer variable. An explicit cast shuts it up. In C, this option is also enabled by-Wconversion.-Wfloat-conversionโ warns about implicit conversions that reduce the precision of a real value. That includes real โ integer, and higher-precision real โ lower-precision real. Also enabled by-Wconversion. ๐ญ (rip your precision)-Wno-scalar-storage-orderโ don't warn on suspicious constructs involving reverse scalar storage order.-Wsizeof-pointer-divโ warns about suspicious divisions of twosizeofexpressions that divide pointer size by element size. That's the classic way to compute an array size, but it does not work right with pointers. So it warns about e.g.sizeof (ptr) / sizeof (ptr[0])whenptrisn't an array, it's a pointer. Enabled by-Wall. ๐ต๏ธ-Wsizeof-pointer-memaccessโ warns about suspicious length parameters to certain string and memory built-in functions when the argument usessizeof. It fires for example onmemset (ptr, 0, sizeof (ptr));whenptris not an array but a pointer โ and it even suggests a possible fix โ or onmemcpy (&foo, ptr, sizeof (&foo));.
It also warns about calls to bounded string copy functions like strncat or strncpy that use a sizeof expression of the source array as the bound. For example, in this function the call to strncat specifies the size of the source string as the bound. That is almost certainly a mistake, so the call gets diagnosed:
void make_file (const char *name)
{
char path[PATH_MAX];
strncpy (path, name, sizeof path - 1);
strncat (path, ".text", sizeof ".text");
...
}
-Wsizeof-pointer-memaccess is enabled by -Wall.
-Wno-sizeof-array-argumentโ don't warn whensizeofis applied to a parameter declared as an array in a function definition. This warning is enabled by default for C and C++ programs.-Wmemset-elt-sizeโ warns about suspicious calls to thememsetbuilt-in when the first argument references an array and the third argument is a number equal to the number of elements but not equal to the size of the array in memory. That means somebody forgot to multiply by the element size. Enabled by-Wall. ๐-Wmemset-transposed-argsโ warns about suspiciousmemsetcalls where the second argument isn't zero and the third one is zero. For example,memset (buf, sizeof buf, 0)gets diagnosed becausememset (buf, 0, sizeof buf)was clearly what you meant. The diagnostic only fires if the third argument is a literal zero โ if it's an expression folded to zero, or a cast of zero to some type, it's way less likely the args were accidentally swapped, so no warning. Enabled by-Wall.-Waddressโ warns about suspicious uses of memory addresses. That includes using the address of a function in a conditional expression, likevoid func(void); if (func), and comparisons against the memory address of a string literal, likeif (x == "abc"). These usually scream programmer error: the address of a function always evaluates to true, so using it in a conditional usually means you forgot the parentheses in a function call; and comparing against string literals gives unspecified behavior and isn't portable in C, so it usually means you wantedstrcmp. Enabled by-Wall. ๐-Wno-address-of-packed-memberโ don't warn when the address of a packed member of a struct or union is taken, which usually gives you an unaligned pointer value. This is enabled by default.-Wlogical-opโ warns about suspicious uses of logical operators in expressions. That includes using logical operators in contexts where a bit-wise operator is probably expected. It also warns when both 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. It doesn't warn if the right operand is considered a boolean expression. Its whole purpose is catching suspicious code like this:
int a;
...
if (!a > 1) { ... }
You can silence it by wrapping the LHS in parentheses:
if ((!a) > 1) { ... }
This warning is enabled by -Wall. โจ
-Waggregate-returnโ warns if any function that returns structures or unions gets defined or called. (In languages where you can return an array, that also gets you a warning.)-Wno-aggressive-loop-optimizationsโ warns if, in a loop with a constant number of iterations, the compiler detects undefined behavior in some statement during one or more of the iterations.-Wno-attributesโ don't warn if an unexpected__attribute__is used, like unrecognized attributes, function attributes applied to variables, etc. Note that this does not stop errors for incorrect use of supported attributes.-Wno-builtin-declaration-mismatchโ warns if a built-in function is declared with an incompatible signature or as a non-function, or when a built-in function declared with a type that doesn't include a prototype is called with arguments whose promoted types don't match what the function expects. When-Wextrais specified, it also warns 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 so the prototypes of built-in functions are in scope.
For example, the call to memset below gets diagnosed because the function expects a value of type size_t as its argument, but the type of 32 is int. With -Wextra, the declaration of the function gets diagnosed too.
extern void* memset ();
void f (void *d)
{
memset (d, '\0', 32);
}
-Wno-builtin-macro-redefinedโ bestie, do NOT yell at me if certain built-in macros get redefined. This one shushes warnings for redefinition of"__TIMESTAMP__","__TIME__","__DATE__","__FILE__", and"__BASE_FILE__". ๐-Wstrict-prototypes(C and Objective-C only) โ warns if a function is declared or defined without specifying the argument types. (An old-style function definition is totally allowed with no warning if it's preceded by a declaration that specifies the argument types. okay so it's giving "at least somebody told me the types" energy. ๐ซถ)-Wold-style-declaration(C and Objective-C only) โ warns for obsolescent usages, according to the C Standard, in a declaration. For example, warn if storage-class specifiers like"static"are not the first things in a declaration. This warning is also enabled by-Wextra. ๐-Wold-style-definition(C and Objective-C only) โ warns if an old-style function definition is used. A warning is given even if there is a previous prototype. A definition using()is not considered an old-style definition in C2X mode, because it is equivalent to(void)in that case, but is considered an old-style definition for older standards. the way that standards keep changingโฆ ๐-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.
-Wmissing-prototypes(C and Objective-C only) โ warns 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-declarationsโ warns 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โ warns if a structure's initializer has some fields missing. For example, the following code causes such a warning, because"x.h"is implicitly zero:
struct s { int f, g, h; };
struct s x = { 3, 4 };
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. slay ๐
-Wno-multicharโ do not warn if a multicharacter constant ('FOOF') is used. Usually they indicate a typo in the user's code, as they have implementation-defined values, and should not be used in portable code. lowkey a red flag in ur source fr fr ๐-Wnormalized=[none|id|nfc|nfkc]โ okay so in ISO C and ISO C++, two identifiers are different if they are different sequences of characters. However, sometimes when characters outside the basic ASCII character set are used, you can have two different character sequences that look the same. To avoid confusion, the ISO 10646 standard sets out some normalization rules which when applied ensure that two sequences that look the same are turned into the same sequence. GCC can warn you if you are using identifiers that have not been normalized; this option controls that warning. ๐
There are four levels of warning supported by GCC. The default is -Wnormalized=nfc, which warns about any identifier that is not in the ISO 10646 "C" normalized form, NFC. NFC is the recommended form for most uses. It is equivalent to -Wnormalized.
Unfortunately, there are some characters allowed in identifiers by ISO C and ISO C++ that, when turned into NFC, are not allowed in identifiers. That is, there's no way to use these symbols in portable ISO C or C++ and have all your identifiers in NFC. -Wnormalized=id suppresses the warning for these characters. It is hoped that future versions of the standards involved will correct this, which is why this option is not the default. ๐ง
You can switch the warning off for all characters by writing -Wnormalized=none or -Wno-normalized. You should only do this if you are using some other normalization scheme (like "D"), because otherwise you can easily create bugs that are literally impossible to see. and bestie that is not the vibe ๐
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 has been placed in a superscript. ISO 10646 defines the NFKC normalization scheme to convert all these into a standard form as well, and GCC warns if your code is not in NFKC if you use -Wnormalized=nfkc. This warning is comparable to warning about every identifier that contains the letter O because it might be confused with the digit 0, and so is not the default, but may be useful as a local coding convention if the programming environment cannot be fixed to display these characters distinctly. ๐
-Wno-attribute-warningโ do not warn about usage of functions declared with"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-Werrorflag. ๐-Wno-deprecatedโ do not warn about usage of deprecated features.-Wno-deprecated-declarationsโ do not warn about uses of functions, variables, and types marked as deprecated by using the"deprecated"attribute.-Wno-overflowโ do not warn about compile-time overflow in constant expressions.-Wno-odrโ warn about One Definition Rule violations during link-time optimization. Enabled by default. (yes the name says "no" and the description says it's on by default, that's just how it is bestie, don't come for me ๐ซถ)-Wopenmp-simdโ warns 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) โ warns 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โ warns if a structure is given the packed attribute, but the packed attribute has no effect on the layout or size of the structure. Such structures may be mis-aligned for little benefit. For instance, in this code, the variable"f.x"in"struct bar"is misaligned even though"struct bar"does 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โ 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 field"a"and"b"in this structure:
struct foo
{
char a:4;
char b:8;
} __attribute__ ((packed));
This warning is enabled by default. Use -Wno-packed-bitfield-compat to disable this warning. ๐
-Wpacked-not-aligned(C, C++, Objective-C and Objective-C++ only) โ warns 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โ warns 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 is possible to rearrange the fields of the structure to reduce the padding and so make the structure smaller. the way ur struct is just wasting bytesโฆ rearrange ur life bestie ๐-Wredundant-declsโ warns if anything is declared more than once in the same scope, even in cases where multiple declaration is valid and changes nothing. not me saying the same thing twice ๐ซถ-Wrestrictโ warns when an object referenced by a"restrict"-qualified parameter (or, in C++, a"__restrict"-qualified parameter) is aliased by another argument, or when copies between such objects overlap. For example, the call to the"strcpy"function below attempts to truncate the string by replacing its initial characters with the last four. However, because the call writes the terminating NUL into"a[4]", the copies overlap and the call is diagnosed.
void foo (void)
{
char a[] = "abcd1234";
strcpy (a, a + 4);
...
}
The -Wrestrict option detects some instances of simple overlap even without optimization but works best at -O2 and above. It is included in -Wall. ๐ฅ
-Wnested-externs(C and Objective-C only) โ warns if an"extern"declaration is encountered within a function. ๐-Winlineโ bestie, this one yells at you when a function you swore wasinlinestraight-up cannot be inlined. Plot twist tho: even with this flag on, the compiler stays silent about failures to inline functions that live in system headers. Not our problem, not our warning. ๐
The compiler is out here using a whole bunch of heuristics to decide whether to inline something or not. Like, it's literally weighing the size of the function being inlined against how much inlining has already gone down in the current function. So the tiniest little nothing change in your source can make -Winline warnings pop up or ghost you entirely. It's giving flaky. ๐ญ
-Wint-in-bool-contextโ warns when you're using integer values in places where a boolean was clearly the vibe. Example: conditional expressions (?:) that use non-boolean integer constants in a boolean context, likeif (a <= b ? 2 : 3). Or left shifting signed integers in boolean context, likefor (a = 0; 1 << a; a++);. Same energy for all kinds of multiplications regardless of data type. This warning is enabled by-Wall.-Wno-int-to-pointer-castโ suppresses warnings from casting an integer of a different size to a pointer type. Heads up: in C++, casting to a pointer type of smaller size is an error, not a warning.Wint-to-pointer-castis enabled by default.-Wno-pointer-to-int-cast(C and Objective-C only) โ suppresses warnings from casting from a pointer to an integer type of a different size. ๐ซถ-Winvalid-pchโ warns if a precompiled header is found chilling in the search path but cannot actually be used. Awkward. ๐-Wlong-longโ warns if thelong longtype is used. Enabled by either-Wpedanticor-Wtraditionalin ISO C90 and C++98 modes. Wanna mute it? Use-Wno-long-long.-Wvariadic-macrosโ warns if variadic macros are used in ISO C90 mode, or if the GNU alternate syntax is used in ISO C99 mode. Enabled by either-Wpedanticor-Wtraditional. To silence the messages, use-Wno-variadic-macros.-Wno-varargsโ do not warn upon questionable usage of the macros used to handle variable arguments likeva_start. These warnings are enabled by default.-Wvector-operation-performanceโ warns if a vector operation is not implemented via the SIMD capabilities of the architecture. Mainly useful for performance tuning, iykyk. A vector operation can be implemented:- "piecewise" โ the scalar operation is performed on every vector element.
- "in parallel" โ the vector operation is implemented using scalars of wider type, which normally is more performance efficient.
- "as a single scalar" โ the vector fits into a scalar type.
-Wvlaโ warns if a variable-length array is used in the code.-Wno-vlaprevents the-Wpedanticwarning of the variable-length array. ๐ฆ-Wvla-larger-than=byte-sizeโ when 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. ๐ธ
Ngl, GCC may optimize small variable-length arrays of a known value into plain arrays, so this warning may not get triggered for such arrays. Sneaky.
-Wvla-larger-than=PTRDIFF_MAX is enabled by default but is typically only effective when -ftree-vrp is active (default for -O2 and above).
See also -Walloca-larger-than=byte-size.
-Wno-vla-larger-thanโ disables-Wvla-larger-than=warnings. The option is equivalent to-Wvla-larger-than=SIZE_MAXor larger. Bye bestie. ๐-Wvolatile-register-varโ warns if a register variable is declaredvolatile. Real talk: thevolatilemodifier does not inhibit all optimizations that may eliminate reads and/or writes to register variables. This warning is enabled by-Wall.-Wdisabled-optimizationโ warns if a requested optimization pass is disabled. This warning does not generally indicate that there is anything wrong with your code; it merely indicates that GCC's optimizers are unable to handle the code effectively. Often, the problem is that your code is too big or too complex โ GCC refuses to optimize programs when the optimization itself is likely to take inordinate amounts of time. Like, it's not mad at you, it's just tired. ๐ญ-Wpointer-sign(C and Objective-C only) โ warns for pointer argument passing or assignment with different signedness. This option is only supported for C and Objective-C. It is implied by-Walland by-Wpedantic, which can be disabled with-Wno-pointer-sign.-Wstack-protectorโ this option is only active when-fstack-protectoris active. It warns about functions that are not protected against stack smashing. Protect ya neck. ๐ฅ-Woverlength-stringsโ warns about string constants that are longer than the "minimum maximum" length specified in the C standard. Modern compilers generally allow string constants that are much longer than the standard's minimum limit, but very portable programs should avoid using longer strings. ๐
The limit applies after string constant concatenation, and does not count the trailing NUL. In C90, the limit was 509 characters; in C99, it was raised to 4095. C++98 does not specify a normative minimum maximum, so we do not diagnose overlength strings in C++.
This option is implied by -Wpedantic, and can be disabled with -Wno-overlength-strings.
-Wunsuffixed-float-constants(C and Objective-C only) โ issues a warning for any floating constant that does not have a suffix. When used together with-Wsystem-headersit warns about such constants in system header files. This can be useful when preparing code to use with theFLOAT_CONST_DECIMAL64pragma from the decimal floating-point extension to C99. ๐-Wno-lto-type-mismatchโ during the link-time optimization, do not warn about type mismatches in global declarations from different compilation units. Requires-fltoto be enabled. Enabled by default.-Wno-designated-init(C and Objective-C only) โ suppresses warnings when a positional initializer is used to initialize a structure that has been marked with thedesignated_initattribute. ๐-Wno-hsaโ do not warn when HSAIL cannot be emitted for the compiled function or OpenMP construct. These warnings are enabled by default.
โจ Options That Control Static Analysis โจ
-fanalyzerโ this option enables an static analysis of program flow which looks for "interesting" interprocedural paths through the code, and issues warnings for problems found on them. ๐
Heads up bestie: this analysis is much more expensive than other GCC warnings. Your build is gonna take a minute. ๐
Enabling this option effectively enables the following warnings:
-Wanalyzer-double-fclose -Wanalyzer-double-free
-Wanalyzer-exposure-through-output-file -Wanalyzer-file-leak
-Wanalyzer-free-of-non-heap -Wanalyzer-malloc-leak
-Wanalyzer-possible-null-argument
-Wanalyzer-possible-null-dereference -Wanalyzer-null-argument
-Wanalyzer-null-dereference -Wanalyzer-stale-setjmp-buffer
-Wanalyzer-tainted-array-index
-Wanalyzer-unsafe-call-within-signal-handler
-Wanalyzer-use-after-free
-Wanalyzer-use-of-pointer-in-stale-stack-frame
This option is only available if GCC was configured with analyzer support enabled. So like, vibe check your build first. ๐ซถ
-Wanalyzer-too-complexโ if-fanalyzeris enabled, the analyzer uses various heuristics to attempt to explore the control flow and data flow in the program, but these can be defeated by sufficiently complicated code. ๐ตโ๐ซ
By default, the analysis silently stops if the code is too complicated for the analyzer to fully explore and it reaches an internal limit. The -Wanalyzer-too-complex option warns if this occurs.
-Wno-analyzer-double-fcloseโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-double-fcloseto disable it.
This diagnostic warns for paths through the code in which a FILE * can have fclose called on it more than once. Not the double-dip bestie. ๐ญ
-Wno-analyzer-double-freeโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-double-freeto disable it.
This diagnostic warns for paths through the code in which a pointer can have free called on it more than once.
-Wno-analyzer-exposure-through-output-fileโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-exposure-through-output-fileto disable it.
This diagnostic warns for paths through the code in which a security-sensitive value is written to an output file (such as writing a password to a log file). ๐จ Not the password in the log file, bestie!!
-Wno-analyzer-file-leakโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-file-leakto disable it.
This diagnostic warns for paths through the code in which a <stdio.h> FILE * stream object is leaked. ๐
-Wno-analyzer-free-of-non-heapโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-free-of-non-heapto disable it.
This diagnostic warns for paths through the code in which free is called on a non-heap pointer (e.g. an on-stack buffer, or a global). Rude.
-Wno-analyzer-malloc-leakโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-malloc-leakto disable it.
This diagnostic warns for paths through the code in which a pointer allocated via malloc is leaked. The classic. ๐ง
-Wno-analyzer-possible-null-argumentโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-possible-null-argumentto disable it.
This diagnostic warns for paths through the code in which a possibly-NULL value is passed to a function argument marked with __attribute__((nonnull)) as requiring a non-NULL value.
-Wno-analyzer-possible-null-dereferenceโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-possible-null-dereferenceto disable it.
This diagnostic warns for paths through the code in which a possibly-NULL value is dereferenced.
-Wno-analyzer-null-argumentโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-null-argumentto disable it.
This diagnostic warns for paths through the code in which a value known to be NULL is passed to a function argument marked with __attribute__((nonnull)) as requiring a non-NULL value. ๐
-Wno-analyzer-null-dereferenceโ this warning requires-fanalyzer, which enables it; use-Wno-analyzer-null-dereferenceto disable it.
This diagnostic is like, hey bestie that pointer is literally NULL and you're just dereferencing it?? ๐ It warns you about paths through the code where a value you know is NULL gets dereferenced. Rude of the code, honestly.
-Wno-analyzer-stale-setjmp-bufferโ okay this one needs-fanalyzerto even be a thing (that's what enables it), and you use-Wno-analyzer-stale-setjmp-bufferto turn it back off. It flags paths through the code wherelongjmpis called to rewind to ajmp_bufthat belongs to asetjmpcall in a function that has already returned. Here's the tea ๐ซ: whensetjmpis called on ajmp_bufto record a rewind location, it records the stack frame. That stack frame becomes invalid the moment the function containing thesetjmpcall returns. So trying to rewind to it vialongjmpwould reference a stack frame that no longer exists, and that likely leads to a crash โ or worse. ๐ญ-Wno-analyzer-tainted-array-indexโ this one is extra, it needs both-fanalyzerand-fanalyzer-checker=taintto be enabled; use-Wno-analyzer-tainted-array-indexto disable it. It warns for paths through the code where a value that could be under an attacker's control ๐ต๏ธ gets used as the index of an array access without being sanitized. Not the vibe. Not the vibe at all.-Wno-analyzer-unsafe-call-within-signal-handlerโ requires-fanalyzer(that's the enabler);-Wno-analyzer-unsafe-call-within-signal-handlerdisables it. It flags paths through the code where a function known to be async-signal-unsafe (likefprintf) gets called from a signal handler. ๐จ-Wno-analyzer-use-after-freeโ requires-fanalyzer, which enables it;-Wno-analyzer-use-after-freedisables it. It warns for paths through the code where a pointer is used afterfreeis called on it. the way that memory is just... gone ๐-Wno-analyzer-use-of-pointer-in-stale-stack-frameโ requires-fanalyzer, which enables it;-Wno-analyzer-use-of-pointer-in-stale-stack-framedisables it. It warns for paths through the code where a pointer is dereferenced that points to a variable in a stale stack frame. ๐ซ
Pertinent parameters for controlling the exploration are: --param analyzer-bb-explosion-factor=value, --param analyzer-max-enodes-per-program-point=value, --param analyzer-max-recursion-depth=value, and --param analyzer-min-snodes-for-call-summary=value.
The following options control the analyzer. ๐ง โจ
-fanalyzer-call-summariesโ simplifies interprocedural analysis by computing the effect of certain calls, instead of exploring all the paths through the function from callsite to each possible return. If enabled, call summaries are only used for functions with more than one call site, and that are sufficiently complicated (as per--param analyzer-min-snodes-for-call-summary=value). efficiency queen ๐-fanalyzer-checker=nameโ restricts the analyzer to run just the named checker, and enables it. Some checkers are disabled by default (even with-fanalyzer), such as thetaintchecker that implements-Wanalyzer-tainted-array-index, and this option is required to enable them.-fanalyzer-fine-grainedโ this option is intended for analyzer developers. ๐ ๏ธ Internally the analyzer builds anexploded graphthat combines control flow graphs with data flow information. By default, an edge in this graph can contain the effects of a run of multiple statements within a basic block. With-fanalyzer-fine-grained, each statement gets its own edge. one statement, one edge, no sharing โจ-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 of how many were silenced ๐-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 itsexploded graph. With-fno-analyzer-state-mergethis 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-purgethis purging of state can be suppressed, for debugging state-handling issues.-fanalyzer-transitivityโ this option enables transitivity of constraints within 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:- 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 saga. ๐ฟ - As per the previous level, but also show events for the entry to each function.
- As per the previous level, but also show events relating to control flow that are significant to triggering the issue (e.g.
true path takenat a conditional). This level is the default. โญ - As per the previous level, but show all control flow events, not just significant ones.
- This level is intended for analyzer developers; it adds various other events intended for debugging the analyzer.
- 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-
-fdump-analyzerโ dump internal details about what the analyzer is doing tofile.analyzer.txt. This option is overridden by-fdump-analyzer-stderr. ๐-fdump-analyzer-stderrโ dump internal details about what the analyzer is doing to stderr. This option overrides-fdump-analyzer.-fdump-analyzer-callgraphโ dump a representation of the call graph suitable for viewing with GraphViz tofile.callgraph.dot. ๐-fdump-analyzer-exploded-graphโ dump a representation of theexploded graphsuitable for viewing with GraphViz tofile.eg.dot. Nodes are color-coded based on state-machine states to emphasize state changes. ๐-fdump-analyzer-exploded-nodesโ emit diagnostics showing where nodes in theexploded graphare in relation to the program source.-fdump-analyzer-exploded-nodes-2โ dump a textual representation of theexploded graphtofile.eg.txt.-fdump-analyzer-exploded-nodes-3โ dump a textual representation of theexploded graphto one dump file per node, tofile.eg-id.txt. This is typically a large number of dump files. ๐ญ-fdump-analyzer-state-purgeโ as per-fdump-analyzer-supergraph, dump a representation of thesupergraphsuitable 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โ dump representations of thesupergraphsuitable for viewing with GraphViz tofile.supergraph.dotand tofile.supergraph-eg.dot. These show all of the control flow graphs in the program, with interprocedural edges for calls and returns. The second dump contains annotations showing nodes in theexploded graphand diagnostics associated with them. ๐ฆ
โจ Options for Debugging Your Program โจ
To tell GCC to emit extra information for use by a debugger, in almost all cases you need only to add -g to your other options. that's it. that's the whole trick. ๐
GCC allows you to use -g with -O. The shortcuts taken by optimized code may occasionally be surprising, and honestly, bestie, let's talk about it: some variables you declared may not exist at all; flow of control may briefly move where you did not expect it; some statements may not be executed because they compute constant results or their values are already at hand; some statements may execute in different places because they have been moved out of loops. Nevertheless it is possible to debug optimized output. This makes it reasonable to use the optimizer for programs that might have bugs. ๐
If you are not using some other optimization option, consider using -Og with -g. With no -O option at all, some compiler passes that collect information useful for debugging do not run at all, so that -Og may result in a better debugging experience. โจ
-gโ produce debugging information in the operating system's native format (stabs, COFF, XCOFF, or DWARF). GDB can work with this debugging information. On most systems that use stabs format,-genables use of extra debugging information that only GDB can use; this extra information makes debugging work better in GDB but probably makes other debuggers crash or refuse to read the program. If you want to control for certain whether to generate the extra information, use-gstabs+,-gstabs,-gxcoff+,-gxcoff, or-gvms(see below). ๐-ggdbโ produce debugging information for use by GDB. This means to use the most expressive format available (DWARF, stabs, or the native format if neither of those are supported), including GDB extensions if at all possible. GDB girlies rise ๐ซถ-gdwarf-gdwarf-versionโ produce debugging information in DWARF format (if that is supported). The value of version may be either2,3,4or5; the default version for most targets is4. DWARF Version 5 is only experimental. ๐งช Note that with DWARF Version 2, some ports require and always use some non-conflicting DWARF 3 extensions in the unwind tables. Version 4 may require GDB 7.0 and-fvar-tracking-assignmentsfor maximum benefit. GCC no longer supports DWARF Version 1, which is substantially different than Version 2 and later. For historical reasons, some other DWARF-related options such as-fno-dwarf2-cfi-asm) retain a reference to DWARF Version 2 in their names, but apply to all currently-supported versions of DWARF. iykyk ๐-gstabsโ makes debug info in stabs format (if ur target even supports it), no GDB extensions. This is the format DBX uses on most BSD systems. okay but listen โ on MIPS, Alpha and System V Release 4 systems this option spits out stabs debug output that DBX straight up does not understand ๐. And on System V Release 4 systems it needs the GNU assembler.-gstabs+โ same stabs format (if supported) but with GNU extensions that only the GNU debugger (GDB) gets. heads up bestie: using these extensions is likely to make other debuggers crash or refuse to read the program. not a vibe.-gxcoffโ debug info in XCOFF format (if supported). This is the format the DBX debugger uses on IBM RS/6000 systems. ๐-gxcoff+โ XCOFF format (if supported) but with GNU extensions understood only by GDB. fr be careful: using these extensions is likely to make other debuggers crash or refuse to read the program, AND it may cause assemblers other than the GNU assembler (GAS) to fail with an error. ๐ญ-gvmsโ debug info in Alpha/VMS debug format (if supported). This is the format DEBUG uses on Alpha/VMS systems. ๐ฆ-glevel,-ggdblevel,-gstabslevel,-gxcofflevel,-gvmslevelโ ask for debug info AND use level to say how much info. The default level is2. โจ- Level
0produces no debug info at all. so-g0negates-g. periodt. - Level
1produces minimal info โ enough for making backtraces in parts of the program u don't plan to debug. It includes descriptions of functions and external variables, and line number tables, but no info about local variables. - Level
3includes extra info, like all the macro definitions present in the program. Some debuggers support macro expansion when u use-g3. ๐ - If u use multiple
-goptions, with or without level numbers, the last such option is the one that's effective. (last one wins, always.) -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.
- Level
-fno-eliminate-unused-debug-symbolsโ by default, no debug info is produced for symbols that aren't actually used. Use this option if u want debug info for all 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โ tells 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 residing in directory old, record debugging info describing them as if the files resided in directory new instead. This can replace a build-time path with an install-time path in the debug info. It can also change an absolute path to a relative path by using.for new. This can give more reproducible builds, which are location independent, but may require an extra command to tell GDB where to find the source files. See also-ffile-prefix-map. ๐-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 the compilation and attempt to carry the annotations over throughout the whole compilation all the way to the end, to try to improve debug info while optimizing. Using-gdwarf-4is recommended along with it. โญ
It can be enabled even if var-tracking is disabled, in which case annotations are created and maintained, but discarded at the end. By default, this flag is enabled together with -fvar-tracking, except when selective scheduling is enabled.
-gsplit-dwarfโ separate as much DWARF 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. ๐ง-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.-fdebug-types-sectionโ when using DWARF Version 4 or higher, type DIEs can be put into their own.debug_typessection instead of making them part of the.debug_infosection. It's more efficient to put them in a separate comdat section since the linker can then remove duplicates. but plot twist: not all DWARF consumers support.debug_typessections yet, and on some objects.debug_typesproduces larger instead of smaller debugging info. ๐-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โ disallow using extensions of a later DWARF standard version than the one selected with-gdwarf-version. On most targets, using non-conflicting DWARF extensions from later standard versions is allowed.-gno-strict-dwarfโ allow using extensions of a later DWARF standard version than the one selected with-gdwarf-version. (yep, this is the flip side ๐ฆ)-gas-loc-supportโ tell the compiler that the assembler supports.locdirectives. It may then use them for the assembler to generate DWARF2+ line number tables.
This is generally desirable, because assembler-generated line-number tables are a lot more compact than those the compiler can generate itself. โจ
This option will be enabled by default if, at GCC configure time, the assembler was found to support such directives.
-gno-as-loc-supportโ force GCC to generate DWARF2+ line number tables internally, if DWARF2+ line number tables are to be generated.-gas-locview-supportโ tell the compiler that the assembler supports "view" assignment and reset assertion checking in.locdirectives.
This option will be enabled by default if, at GCC configure time, the assembler was found to support them.
-gno-as-locview-supportโ force GCC to assign view numbers internally, if-gvariable-location-viewsare explicitly requested.-gcolumn-info,-gno-column-infoโ emit location column info into DWARF debugging info, rather than just file and line. This option is enabled by default. ๐-gstatement-frontiers,-gno-statement-frontiersโ this option causes GCC to create markers in the internal representation at the beginning of statements, and to keep them roughly in place throughout compilation, using them to guide the output ofis_stmtmarkers in the line number table. This is enabled by default when compiling with optimization (-Os,-O,-O2, ...), and outputting DWARF 2 debug info at the normal level.-gvariable-location-views,-gvariable-location-views=incompat5,-gno-variable-location-viewsโ augment variable location lists with progressive view numbers implied from the line number table. This enables debug info consumers to inspect state at certain points of the program, even if no instructions associated with the corresponding source locations are present at that point. If the assembler lacks support for view numbers in line number tables, this will cause the compiler to emit the line number table, which generally makes them somewhat less compact. The augmented line number tables and location lists are fully backward-compatible, so they can be consumed by debug info consumers that aren't aware of these augmentations โ but they won't derive any benefit from them either. ๐ญ
This is enabled by default when outputting DWARF 2 debug info at the normal level, as long as there's assembler support, -fvar-tracking-assignments is enabled and -gstrict-dwarf is not. When assembler support isn't available, this may still be enabled, but it will force GCC to output internal line number tables, and if -ginternal-reset-location-views isn't enabled, that will most certainly lead to silently mismatching location views. ๐
There's a proposed representation for view numbers that is not backward compatible with the location list format introduced in DWARF 5, that can be enabled with -gvariable-location-views=incompat5. This option may be removed in the future, and is only provided as a reference implementation of the proposed representation. Debug info consumers aren't 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โ okay so this one tries to figure out which location views can just be yeeted from the location view lists โจ. The catch? It needs the compiler to have super accurate insn length estimates, and bestie, that is not always the case ๐ญ. And if you're using an assembler that doesn't support location view lists, it can silently generate wrong view lists. The GNU assembler will call that out as a"view number mismatch"๐. This is only turned on for ports that define a reliable estimation function, so like, don't worry about it if yours doesn't.-ginline-points,-gno-inline-pointsโ generates extended debug info for inlined functions ๐ซถ. Location view tracking markers get inserted at inlined entry points so address and view numbers can be computed and written out into debug info. Fun fact: you can enable this independently of location views โ but then the view numbers won't be output. It can only be enabled along with statement frontiers tho, and it's only on by default if location views are enabled. iykyk ๐-gz[=type]โ produce compressed debug sections in DWARF format, if that's supported ๐ธ. Don't pass atype? The default depends on what your assembler and linker can actually do.typecan be one ofnone(no compression, we're keeping it raw),zlib(zlib compression in ELF gABI format), orzlib-gnu(zlib compression in traditional GNU format). If the linker can't write compressed debug sections, the option gets rejected, periodt ๐. Otherwise, if the assembler doesn't support them,-gzis silently ignored while producing object files.-femit-struct-debug-baseonlyโ emits debug info for struct-like types only when the base name of the compilation source file matches the base name of the file where the struct is defined ๐
This option substantially shrinks your debugging info size, but at significant potential loss of type info to the debugger ๐ญ. Check -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โ emits debug info for struct-like types only when the base name of the compilation source file matches the base name of the file where the type is defined โ unless the struct is a template or defined in a system header ๐.
This one significantly reduces debug info size, with some potential loss of type info 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]โ lets you specify exactly which struct-like types the compiler generates debug info for ๐. The whole point is reducing duplicate struct debug info between different object files in the same program.
This is the detailed version of -femit-struct-debug-reduced and -femit-struct-debug-baseonly, and it serves for most needs, ngl.
A specification has the syntax:
[dir:|ind:][ord:|gen:](any|sys|base|none)
The optional first word limits the spec to structs that are used directly (dir:) or used indirectly (ind:) ๐. A struct type is used directly when it's the type of a variable or member. Indirect uses happen through pointers to structs โ like, when using an incomplete struct is valid, that use is indirect. An example is struct one direct; struct two * indirect;.
The optional second word limits the spec to ordinary structs (ord:) or generic structs (gen:) โญ. Generic structs are a bit complicated to explain, fr fr. For C++, these are non-explicit specializations of template classes, or non-template classes within the above. Other programming languages have generics, but -femit-struct-debug-detailed doesn't implement them yet.
The third word specifies the source files for those structs the compiler should emit debug info for ๐. The values none and any have the normal meaning. The value base means the base of the name of the file where the type declaration appears has to match the base of the name of the main compilation file. In practice, that means when you're compiling foo.c, debug info gets 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, bestie ๐ฅ.
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โ so normally, when producing DWARF output, GCC avoids making debug symbol output for types that are nowhere used in the source file being compiled ๐. But sometimes it's useful to have GCC emit debugging info for all types declared in a compilation unit, whether or not they're actually used in it โ like if you wanna cast a value to a type in the debugger that isn't used in your program (but is declared). More often tho? This just results in a significant amount of wasted space ๐ญ.
โจ Options That Control Optimization โจ
These options control various sorts of optimizations, bestie ๐ง.
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. Iconic, honestly.
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 lets the compiler use info 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, periodt.
Most optimizations are completely disabled at -O0 or if an -O level isn't set on the command line, even if individual optimization flags are specified ๐. Similarly, -Og suppresses many optimization passes.
Depending on the target and how GCC was configured, a slightly different set of optimizations may be enabled at each -O level than the ones listed here ๐ธ. You can invoke GCC with -Q --help=optimizers to find out the exact set of optimizations enabled at each level. Slay.
-O,-O1โ Optimize โจ. Optimizing compilation takes somewhat more time, and a lot more memory for a large function.
With -O, the compiler tries to reduce code size and execution time, without performing any optimizations that take a great deal of compilation time.
-O turns on the following optimization flags:
-fauto-inc-dec -fbranch-count-reg -fcombine-stack-adjustments
-fcompare-elim -fcprop-registers -fdce -fdefer-pop -fdelayed-branch
-fdse -fforward-propagate -fguess-branch-probability -fif-conversion
-fif-conversion2 -finline-functions-called-once -fipa-profile
-fipa-pure-const -fipa-reference -fipa-reference-addressable
-fmerge-constants -fmove-loop-invariants -fomit-frame-pointer
-freorder-blocks -fshrink-wrap -fshrink-wrap-separate
-fsplit-wide-types -fssa-backprop -fssa-phiopt -ftree-bit-ccp
-ftree-ccp -ftree-ch -ftree-coalesce-vars -ftree-copy-prop
-ftree-dce -ftree-dominator-opts -ftree-dse -ftree-forwprop
-ftree-fre -ftree-phiprop -ftree-pta -ftree-scev-cprop -ftree-sink
-ftree-slsr -ftree-sra -ftree-ter -funit-at-a-time
-O2โ Optimize even more ๐ฅ. GCC performs nearly all supported optimizations that don't involve a space-speed tradeoff. Compared to-O, this option increases both compilation time and the performance of the generated code.
-O2 turns on all optimization flags specified by -O. It also turns on the following optimization flags:
-falign-functions -falign-jumps -falign-labels -falign-loops
-fcaller-saves -fcode-hoisting -fcrossjumping -fcse-follow-jumps
-fcse-skip-blocks -fdelete-null-pointer-checks -fdevirtualize
-fdevirtualize-speculatively -fexpensive-optimizations
-ffinite-loops -fgcse -fgcse-lm -fhoist-adjacent-loads
-finline-functions -finline-small-functions -findirect-inlining
-fipa-bit-cp -fipa-cp -fipa-icf -fipa-ra -fipa-sra -fipa-vrp
-fisolate-erroneous-paths-dereference -flra-remat
-foptimize-sibling-calls -foptimize-strlen -fpartial-inlining
-fpeephole2 -freorder-blocks-algorithm=stc
-freorder-blocks-and-partition -freorder-functions
-frerun-cse-after-loop -fschedule-insns -fschedule-insns2
-fsched-interblock -fsched-spec -fstore-merging -fstrict-aliasing
-fthread-jumps -ftree-builtin-call-dce -ftree-pre
-ftree-switch-conversion -ftree-tail-merge -ftree-vrp
Please note the warning under-fgcseabout invoking-O2on programs that use computed gotos ๐.
NOTE: In Ubuntu 8.10 and later versions,-D_FORTIFY_SOURCE=2is set by default, and is activated when-Ois set to 2 or higher ๐. This enables additional compile-time and run-time checks for several libc functions. To disable, specify either-U_FORTIFY_SOURCEor-D_FORTIFY_SOURCE=0.
-O3โ Optimize yet more ๐.-O3turns on all optimizations specified by-O2and also turns on the following optimization flags:
-fgcse-after-reload -fipa-cp-clone -floop-interchange
-floop-unroll-and-jam -fpeel-loops -fpredictive-commoning
-fsplit-loops -fsplit-paths -ftree-loop-distribution
-ftree-loop-vectorize -ftree-partial-pre -ftree-slp-vectorize
-funswitch-loops -fvect-cost-model -fvect-cost-model=dynamic
-fversion-loops-for-strides
-O0โ Reduce compilation time and make debugging produce the expected results ๐ซถ. This is the default, bestie.-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 turns on -finline-functions, makes the compiler tune for code size instead of execution speed, and does even more optimizations that are all about making the code smaller. ๐
-Ofastโ bestie, this one literally says "rules are fake" ๐. It disregards strict standards compliance.-Ofastenables all-O3optimizations, and on top of that it turns on optimizations that are not valid for all standard-compliant programs. It flips on-ffast-math,-fallow-store-data-races, and the Fortran-specific-fstack-arrays(unless you specified-fmax-stack-var-size), plus-fno-protect-parens.-Ogโ optimize the debugging experience โจ.-Ogshould be your go-to optimization level for the standard edit-compile-debug cycle: it gives you a reasonable level of optimization while keeping compilation fast and debugging actually pleasant. It's a better pick than-O0for producing debuggable code, because some compiler passes that collect debug info are just... disabled at-O0. ๐
Same energy as -O0, -Og completely disables a bunch of optimization passes, so the individual options controlling them have no effect. Otherwise, -Og enables all -O1 optimization flags except for the ones that might interfere with debugging:
-fbranch-count-reg -fdelayed-branch -fdse -fif-conversion
-fif-conversion2 -finline-functions-called-once
-fmove-loop-invariants -fssa-phiopt -ftree-bit-ccp -ftree-dse
-ftree-pta -ftree-sra
Okay so real talk: if you use multiple -O options, with or without level numbers, the last one is the one that's actually effective. No cap. ๐
Options of the form -fflag are the machine-independent flags, iykyk. Most flags have both a positive and a negative form; the negative form of -ffoo is -fno-foo. In the table below, only one of the forms is listed โ the one you'd typically use. You can figure out the other form by either removing no- or adding it. ๐
The following options control specific optimizations. They're either activated by -O options or related to ones that are. Use these flags in those rare cases when you want to "fine-tune" the optimizations being performed. ๐
-fno-defer-popโ for machines that have to pop arguments after a function call, always pop the arguments the moment each function returns. At levels-O1and higher,-fdefer-popis the default; that lets the compiler let arguments pile up on the stack across several function calls and then pop them all at once. ๐ซถ-fforward-propagateโ perform a forward propagation pass on RTL. This pass tries to combine two instructions and checks whether the result can be simplified. If loop unrolling is active, two passes get performed, and the second one is scheduled after loop unrolling. โจ
This option is enabled by default at optimization levels -O, -O2, -O3, -Os.
-ffp-contract=styleโ okay so:-ffp-contract=offdisables floating-point expression contraction.-ffp-contract=fastenables floating-point expression contraction, like forming fused multiply-add operations if the target has native support for them.-ffp-contract=onenables floating-point expression contraction if the language standard allows it. This is currently not implemented and treated equal to-ffp-contract=off. ๐ญ
The default is -ffp-contract=fast.
-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 frees up an extra register. ๐
On some targets this flag has no effect, because the standard calling sequence always uses a frame pointer, so it can't be omitted.
Note that -fno-omit-frame-pointer does not guarantee the frame pointer is used in all functions. Several targets always omit the frame pointer in leaf functions. ๐
Enabled by default at -O and higher.
-foptimize-sibling-callsโ optimize sibling and tail recursive calls.
Enabled at levels -O2, -O3, -Os.
-foptimize-strlenโ optimize various standard C string functions (likestrlen,strchr, orstrcpy) and their_FORTIFY_SOURCEcounterparts into faster alternatives. ๐ฅ
Enabled at levels -O2, -O3.
-fno-inlineโ do not expand any functions inline, apart from those marked with thealways_inlineattribute. This is the default when not optimizing.
Single functions can be exempted from inlining by marking them with the noinline attribute.
-finline-small-functionsโ integrate functions into their callers when their body is smaller than the expected function call code (so the overall size of the program gets smaller). The compiler heuristically decides which functions are simple enough to be worth integrating this way. This inlining applies to all functions, even the ones not declared inline. โจ
Enabled at levels -O2, -O3, -Os.
-findirect-inliningโ inline indirect calls too, when they're discovered to be known at compile time thanks to previous inlining. This option only has any effect when inlining itself is turned on by the-finline-functionsor-finline-small-functionsoptions.
Enabled at levels -O2, -O3, -Os.
-finline-functionsโ consider 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โ consider 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โ inline functions marked byalways_inlineand functions whose body seems smaller than the function call overhead, early, before doing-fprofile-generateinstrumentation and the real inlining pass. Doing it this way makes profiling significantly cheaper and usually makes inlining faster on programs that have large chains of nested wrapper functions. ๐ฆ
Enabled by default.
-fipa-sraโ perform interprocedural scalar replacement of aggregates, removal of unused parameters, and replacement of parameters passed by reference with parameters passed by value. โญ
Enabled at levels -O2, -O3 and -Os.
-finline-limit=nโ by default, GCC limits the size of functions that can be inlined. This flag allows coarse control of that limit. n is the size of functions that can be inlined, in number of pseudo instructions.
Inlining is actually controlled by a number of parameters, which may be specified individually by using --param name=value. The -finline-limit=n option sets some of these parameters like this:
max-inline-insns-singleis set ton/2.max-inline-insns-autois set ton/2.
See below for documentation of the individual parameters controlling inlining and for the defaults of these parameters.
Note: there may be no value of -finline-limit that results in default behavior.
Note: "pseudo instruction" represents, 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, emitstaticfunctions 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++, emit any and all inline functions into the object file.-fkeep-static-functionsโ emitstaticfunctions into the object file, even if the function is never used. ๐-fkeep-static-constsโ emit 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โ attempt to merge identical constants (string constants and floating-point constants) across compilation units. ๐ซถ
This option is the default for optimized compilation if the assembler and linker support it. Use -fno-merge-constants to inhibit this behavior.
Enabled at levels -O, -O2, -O3, -Os.
-fmerge-all-constantsโ attempt to merge identical constants and identical variables. ๐ฅ
This option implies -fmerge-constants. In addition to -fmerge-constants, this considers e.g. even constant initialized arrays or initialized constant variables with integral or floating-point types. Languages like C or C++ require each variable, including multiple instances of the same variable in recursive calls, to have distinct locations, so using this option results in non-conforming behavior. โ ๏ธ
-fmodulo-schedโ perform 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โ perform more aggressive SMS-based modulo scheduling with register moves allowed. By setting this flag, certain anti-dependence 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โ disable the optimization pass that scans for opportunities to use "decrement and branch" instructions on a count register, instead of instruction sequences that decrement a register, compare it against zero, and then branch based upon the result. This option is only meaningful on architectures that support such instructions, which include x86, PowerPC, IA-64 and S/390. Note that the-fno-branch-count-regoption doesn't remove the decrement and branch instructions from the generated instruction stream that were introduced by other optimization passes. ๐
The default is -fbranch-count-reg at -O1 and higher, except for -Og. ๐
-fno-function-cseโ okay so this one says: do NOT put function addresses in registers, bestie. Every single instruction that calls a constant function has to spell out that function's address explicitly, right there, in the open. ๐ซถ
It gives you less efficient code ngl, but some weird little hacks that mess with the assembler output can get confused by the optimizations that happen when this option isn't used. So it's a vibe-preservation thing. ๐ญ
The default is -ffunction-cse.
-fno-zero-initialized-in-bssโ if your target supports a BSS section, GCC by default yeets variables that are initialized to zero into BSS. Saves space in the resulting code, iconic behavior honestly. โจ
This option turns that off, because some programs explicitly rely on variables going to the data section โ like, so the resulting executable can find the beginning of that section and/or make assumptions based on that. They built their whole personality around it. ๐
The default is -fzero-initialized-in-bss.
-fthread-jumpsโ does optimizations that check whether a jump branches to a location where another comparison subsumed by the first is found. If so, the first branch gets redirected to either the destination of the second branch or a point immediately following it โ depending on whether the condition is known to be true or false.
Enabled at levels -O2, -O3, -Os.
-fsplit-wide-typesโ when you're using a type that occupies multiple registers, likelong longon a 32-bit system, this splits the registers apart and allocates them independently. Normally it generates better code for those types, but it may make debugging more difficult. Trade-offs, always. ๐
Enabled at levels -O, -O2, -O3, -Os.
-fsplit-wide-types-earlyโ fully split wide types early, instead of very late. Main character energy, no waiting. 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), scan through jump instructions when the target of the jump isn't 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โ similar to-fcse-follow-jumps, but it makes CSE 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-run common subexpression elimination after loop optimizations are performed. Round two, bestie. ๐ฅ
Enabled at levels -O2, -O3, -Os.
-fgcseโ performs a global common subexpression elimination pass. This pass also does global constant and copy propagation. It's giving overachiever. ๐
Note: when compiling a program using computed gotos, a GCC extension, you may get better run-time performance if you disable the global common subexpression elimination pass by adding -fno-gcse to the command line.
Enabled at levels -O2, -O3, -Os.
-fgcse-lmโ when-fgcse-lmis enabled, global common subexpression elimination attempts to move loads that are only killed by stores into themselves. This allows a loop containing a load/store sequence to be changed to a load outside the loop, and a copy/store within the loop. Literally rearranging the whole situation. โจ
Enabled by default when -fgcse is enabled.
-fgcse-smโ when-fgcse-smis enabled, a store motion pass runs after global common subexpression elimination. This pass attempts to move stores out of loops. When used in conjunction with-fgcse-lm, loops containing a load/store sequence can be changed to a load before the loop and a store after the loop. The glow-up is real. ๐
Not enabled at any optimization level.
-fgcse-lasโ when-fgcse-lasis enabled, the global common subexpression elimination pass eliminates redundant loads that come after stores to the same memory location (both partial and full redundancies).
Not enabled at any optimization level.
-fgcse-after-reloadโ when-fgcse-after-reloadis enabled, a redundant load elimination pass is performed after reload. The purpose of this pass is to clean up redundant spilling. It's the cleanup crew. ๐งน
Enabled by -fprofile-use and -fauto-profile.
-faggressive-loop-optimizationsโ this option tells the loop optimizer to use language constraints to derive bounds for the number of iterations of a loop. This assumes that loop code does not invoke undefined behavior by, for example, causing signed integer overflows or out-of-bound array accesses. ๐จ (yes that's a real assumption, don't be weird about it)
The bounds for the number of iterations of a loop are used to guide loop unrolling and peeling and loop exit test optimizations. This option is enabled by default.
-funconstrained-commonsโ this option tells the compiler that variables declared in common blocks (e.g. Fortran) may later be overridden with longer trailing arrays. This prevents certain optimizations that depend on knowing the array bounds. So like, don't assume, okay? ๐-fcrossjumpingโ performs cross-jumping transformation. This transformation unifies equivalent code and saves code size. The resulting code may or may not perform better than without cross-jumping. No promises, bestie. ๐
Enabled at levels -O2, -O3, -Os.
-fauto-inc-decโ combine increments or decrements of addresses with memory accesses. This pass is always skipped on architectures that don't have instructions to support this. Enabled by default at-Oand higher on architectures that support this.-fdceโ performs dead code elimination (DCE) on RTL. Enabled by default at-Oand higher. RIP to the code that didn't make it. ๐ชฆ-fdseโ performs dead store elimination (DSE) on RTL. Enabled by default at-Oand higher.-fif-conversionโ attempt to transform conditional jumps into branch-less equivalents. This includes use of conditional moves, min, max, set flags and abs instructions, and some tricks doable by standard arithmetics. The use of conditional execution on chips where it's available is controlled by-fif-conversion2.
Enabled at levels -O, -O2, -O3, -Os, but not with -Og.
-fif-conversion2โ use conditional execution (where available) to transform conditional jumps into branch-less equivalents.
Enabled at levels -O, -O2, -O3, -Os, but not with -Og.
-fdeclone-ctor-dtorโ 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, which means two copies of the function. With this option, the base and complete variants are changed to be thunks that call a common implementation. Deduplication slay. ๐
Enabled by -Os.
-fdelete-null-pointer-checksโ assume that programs cannot safely dereference null pointers, and that no code or data element resides at address zero. This option enables simple constant folding optimizations at all optimization levels. In addition, other optimization passes in GCC use this flag to control global dataflow analyses that eliminate useless checks for null pointers; these assume that a memory access to address zero always results in a trap, so that if a pointer is checked after it has already been dereferenced, it cannot be null.
Note however that in some environments this assumption is not true. Use -fno-delete-null-pointer-checks to disable this optimization for programs that depend on that behavior. ๐
This option is enabled by default on most targets. On Nios II ELF, it defaults to off. On AVR, CR16, and MSP430, this option is completely disabled.
Passes that use the dataflow information are enabled independently at different optimization levels.
-fdevirtualizeโ attempt to convert calls to virtual functions to direct calls. This is done both within a procedure and interprocedurally as part of indirect inlining (-findirect-inlining) and interprocedural constant propagation (-fipa-cp). Enabled at levels-O2,-O3,-Os.-fdevirtualize-speculativelyโ attempt to convert calls to virtual functions to speculative direct calls. Based on the analysis of the type inheritance graph, determine for a given call the set of likely targets. If the set is small, preferably of size 1, change the call into a conditional deciding between direct and indirect calls. The speculative calls enable more optimizations, such as inlining. When they seem useless after further optimization, they are converted back into original form. It's giving "we tried, and honestly? we'd do it again". ๐-fdevirtualize-at-ltransโ stream extra information needed for aggressive devirtualization when running the link-time optimizer in local transformation mode. This option enables more devirtualization but significantly increases the size of streamed data. For this reason it is disabled by default. Big data, big cost. ๐-fexpensive-optimizationsโ perform a number of minor optimizations that are relatively expensive. The name says it all, bestie.
Enabled at levels -O2, -O3, -Os.
-freeโ attempt to remove redundant extension instructions. This is especially helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit registers after writing to their lower 32-bit half.
Enabled for Alpha, AArch64 and x86 at levels -O2, -O3, -Os.
-fno-lifetime-dseโ in C++ the value of an object is only affected by changes within its lifetime: when the constructor begins, the object has an indeterminate value, and any changes during the lifetime of the object are dead when the object is destroyed. Normally dead store elimination will take advantage of this; if your code relies on the value of the object storage persisting beyond the lifetime of the object, you can use this flag to disable this optimization. To preserve stores before the constructor starts (e.g. because youroperator newclears the object storage) but still treat the object as dead after the destructor, you can use-flifetime-dse=1. The default behavior can be explicitly selected with-flifetime-dse=2.-flifetime-dse=0is equivalent to-fno-lifetime-dse.-flive-range-shrinkageโ attempt to decrease register pressure through register live range shrinkage. This is helpful for fast processors with small or moderate size register sets. Tiny register set, big dreams. ๐-fira-algorithm=algorithmโ picks the coloring algorithm for the integrated register allocator, bestie. algorithm can bepriority(that's Chow's priority coloring) orCB(that's Chaitin-Briggs coloring). Now here's the tea:CBisn't implemented for every architecture, but for the targets that do support it, it's the default because it generates better code. Periodt. ๐-fira-region=regionโ chooses the regions used by the integrated register allocator. region has to be one of these three, okay?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 it's 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 it's enabled by default for-Osor-O0.
-fira-hoist-pressureโ makes IRA evaluate register pressure in the code hoisting pass so it can decide whether to hoist expressions. Usually this gives you smaller code, but lowkey it can slow the compiler down. ๐
This option is enabled at level -Os for all targets.
-fira-loop-pressureโ makes IRA evaluate register pressure in loops so it can decide whether to move loop invariants. Usually this generates faster and smaller code on machines with large register files (>= 32 registers), but again, it can slow the compiler down. No cap.
This option is enabled at level -O3 for some targets.
-fno-ira-share-save-slotsโ turns off sharing of stack slots used for saving call-used hard registers living through a call. Every single hard register gets its own separate stack slot, and as a result, function stack frames are bigger. It's giving "more space, less sharing." ๐-fno-ira-share-spill-slotsโ turns off sharing of stack slots allocated for pseudo-registers. Each pseudo-register that doesn't get a hard register gets its own separate stack slot, and as a result, function stack frames are larger. Yeah. Same energy.-flra-rematโ enables CFG-sensitive rematerialization in LRA. Instead of loading values of spilled pseudos, LRA tries to rematerialize (recalculate) values if it's profitable. Iconic behavior fr. ๐ฅ
Enabled at levels -O2, -O3, -Os.
-fdelayed-branchโ if the target machine supports it, this attempts to reorder instructions to exploit instruction slots available after delayed branch instructions. Slay.
Enabled at levels -O, -O2, -O3, -Os, but not at -Og.
-fschedule-insnsโ if the target machine supports it, this attempts to reorder instructions to eliminate execution stalls due to required data being unavailable. It helps machines that have slow floating point or memory load instructions by letting other instructions be issued until the result of the load or floating-point instruction is actually required. ๐ฆ
Enabled at levels -O2, -O3.
-fschedule-insns2โ same vibe as-fschedule-insns, but it requests an additional pass of instruction scheduling after register allocation has been done. This is especially useful on machines with a relatively small number of registers and where memory load instructions take more than one cycle. โจ
Enabled at levels -O2, -O3, -Os.
-fno-sched-interblockโ disables instruction scheduling across basic blocks, which is normally enabled when scheduling before register allocation, i.e. with-fschedule-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 option can improve the generated code and decrease its size by preventing register pressure from rising above the number of available hard registers and the subsequent spills in register allocation. Big brain move.-fsched-spec-loadโ allows speculative motion of some load instructions. This 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. This only makes sense when scheduling before register allocation, i.e. with-fschedule-insnsor at-O2or higher. The name literally tells you it's dangerous, bestie. Respect the label. ๐ญ-fsched-stalled-insnsand-fsched-stalled-insns=nโ defines how many insns (if any) can be moved prematurely from the queue of stalled insns into the ready list during the second scheduling pass.-fno-sched-stalled-insnsmeans no insns get moved prematurely,-fsched-stalled-insns=0means there's no limit on how many queued insns can be moved prematurely. And-fsched-stalled-insnswithout a value is equivalent to-fsched-stalled-insns=1. ๐ธ-fsched-stalled-insns-depand-fsched-stalled-insns-dep=nโ defines how many insn groups (cycles) are examined for a dependency on a stalled insn that's a candidate for premature removal from the queue of stalled insns. This has an effect only 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-depwithout a value is equivalent to-fsched-stalled-insns-dep=1. ๐-fsched2-use-superblocksโ when scheduling after register allocation, this uses superblock scheduling. That 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. ๐
This only makes sense when scheduling after register allocation, i.e. with -fschedule-insns2 or at -O2 or higher.
-fsched-group-heuristicโ enables the group heuristic in the scheduler. This heuristic favors the instruction that belongs to a schedule group. It's 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. This heuristic 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. This heuristic 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. This heuristic 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. This heuristic 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. This heuristic favors the instruction that has more instructions depending on it. Enabled by default when scheduling is enabled, i.e. with-fschedule-insnsor-fschedule-insns2or at-O2or higher.-freschedule-modulo-scheduled-loopsโ so modulo scheduling is performed before traditional scheduling. And if a loop is modulo scheduled, later scheduling passes may change its schedule. Use this option to control that behavior. ๐-fselective-schedulingโ schedules instructions using the selective scheduling algorithm. Selective scheduling runs instead of the first scheduler pass.-fselective-scheduling2โ schedules 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, this also pipelines outer loops. This option has no effect unless-fsel-sched-pipeliningis turned on.-fsemantic-interpositionโ okay so some object formats, like ELF, allow interposing of symbols by the dynamic linker. What that means is that for symbols exported from the DSO, the compiler 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 โ for example, to rewrite memory allocation functions by a debugging implementation โ it is expensive in the terms of code quality. With-fno-semantic-interpositionthe compiler assumes that if interposition happens for functions, the overwriting function will have precisely the same semantics (and side effects). Similarly, if interposition happens for variables, the constructor of the variable will be the same. The flag has no effect for functions explicitly declared inline (where it's never allowed for interposition to change semantics) and for symbols explicitly declared weak. ๐ง-fshrink-wrapโ emits function prologues only before the parts of the function that need it, rather than at the top of the function. This flag is enabled by default at-Oand higher. Main character energy for your prologue. โญ-fshrink-wrap-separateโ shrink-wraps 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
okay so this one lets the compiler stash values in registers that function calls would normally clobber โ and to make that work, it emits extra instructions to save and restore those registers around the calls. ๐พ It only does this when it actually looks like it'll produce better code, so it's not out here wasting your cycles for fun.
On some machines this is always on by default โ usually the ones that have literally no call-preserved registers to fall back on. iykyk.
Enabled at levels -O2, -O3, -Os. โจ
-fcombine-stack-adjustments
Tracks stack adjustments (the pushes and pops) plus stack memory references, and then goes looking for ways to combine them. Little glow-up for your stack traffic. ๐
Enabled by default at -O1 and higher.
-fipa-ra
Uses caller save registers for allocation if no called function actually touches those registers. When that's true, there's no need to save and restore them around calls at all โ chef's kiss. ๐ซถ
But bestie, there's a catch: this is only possible if the called functions are part of the same compilation unit as the current function, and they're compiled before it.
Enabled at levels -O2, -O3, -Os. However it gets disabled if the generated code will be instrumented for profiling (-p, or -pg), or if the callee's register usage can't be known exactly โ which happens on targets that don't expose prologues and epilogues in RTL. ๐ญ
-fconserve-stack
Attempts to minimize stack usage. The compiler will try to use less stack space even if that makes the program slower โ it's giving "be frugal, queen." ๐ธ
This option implies setting the large-stack-frame parameter to 100 and the large-stack-frame-growth parameter to 400.
-ftree-reassoc
Performs reassociation on trees. ๐ณ This flag is enabled by default at -O and higher.
-fcode-hoisting
Performs code hoisting. What that means: it tries to move the evaluation of expressions that get 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 code speed too. โจ
This flag is enabled by default at -O2 and higher.
-ftree-pre
Performs partial redundancy elimination (PRE) on trees. This flag is enabled by default at -O2 and -O3. ๐ฅ
-ftree-partial-pre
Makes partial redundancy elimination (PRE) more aggressive. This flag is enabled by default at -O3.
-ftree-forwprop
Performs forward propagation on trees. This flag is enabled by default at -O and higher. ๐
-ftree-fre
Performs full redundancy elimination (FRE) on trees. The difference between FRE and PRE is that FRE only considers expressions that are computed on all paths leading to the redundant computation. So this analysis is faster than PRE, though it exposes fewer redundancies. Tradeoffs, bestie. โ๏ธ
This flag is enabled by default at -O and higher.
-ftree-phiprop
Performs hoisting of loads from conditional pointers on trees. This pass is enabled by default at -O and higher. ๐ฆ
-fhoist-adjacent-loads
Speculatively hoists loads from both branches of an if-then-else โ but only if the loads are from adjacent locations in the same structure and the target architecture has a conditional move instruction. Very specific, very slay. ๐
This flag is enabled by default at -O2 and higher.
-ftree-copy-prop
Performs copy propagation on trees. This pass eliminates unnecessary copy operations. This flag is enabled by default at -O and higher. โจ
-fipa-pure-const
Discovers which functions are pure or constant. Enabled by default at -O and higher.
-fipa-reference
Discovers which static variables do not escape the compilation unit. Enabled by default at -O and higher. ๐
-fipa-reference-addressable
Discovers read-only, write-only and non-addressable static variables. Enabled by default at -O and higher. ๐ธ
-fipa-stack-alignment
Reduces stack alignment on call sites if possible. Enabled by default. ๐
-fipa-pta
Performs interprocedural pointer analysis plus interprocedural modification and reference analysis. Heads up though โ this option can cause excessive memory and compile-time usage on large compilation units. ๐ญ It is not enabled by default at any optimization level.
-fipa-profile
Performs interprocedural profile propagation. Functions called only from cold functions get marked as cold. Also, functions executed once (such as "cold", "noreturn", static constructors or destructors) are identified. Cold functions and loop less parts of functions executed once are then optimized for size. ๐ง
Enabled by default at -O and higher.
-fipa-cp
Performs interprocedural constant propagation. This optimization analyzes the program to figure out when values passed to functions are constants, and then optimizes accordingly. If your app passes constants to functions, this can substantially increase performance. ๐
This flag is enabled by default at -O2, -Os and -O3. It is also enabled by -fprofile-use and -fauto-profile.
-fipa-cp-clone
Performs function cloning to make interprocedural constant propagation stronger. When enabled, interprocedural constant propagation performs function cloning when an externally visible function can be called with constant arguments. Because this optimization can create multiple copies of functions, it may significantly increase code size โ see --param ipa-cp-unit-growth=value. ๐ฌ
This flag is enabled by default at -O3. It is also enabled by -fprofile-use and -fauto-profile.
-fipa-bit-cp
When enabled, performs interprocedural bitwise constant propagation. This flag is enabled by default at -O2 and by -fprofile-use and -fauto-profile. It requires that -fipa-cp is enabled. ๐
-fipa-vrp
When enabled, performs interprocedural propagation of value ranges. This flag is enabled by default at -O2. It requires that -fipa-cp is enabled. โจ
-fipa-icf
Performs Identical Code Folding for functions and read-only variables. This optimization reduces code size, and it 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 the same โ there are equivalences that are found only by GCC and equivalences found only by Gold.
This flag is enabled by default at -O2 and -Os.
-flive-patching=level
Controls GCC's optimizations to produce output suitable for live-patching. ๐ฉน
If the compiler's optimization uses a function's body, or information extracted from its body, to optimize/change another function, that latter one is called an impacted function of the former. And bestie, if a function is patched, its impacted functions should be patched too.
The impacted functions are determined by the compiler's interprocedural optimizations. For example, a caller is impacted when inlining a function into its caller, cloning a function and changing its caller to call this new clone, or extracting a function's pureness/constness information to optimize its direct or indirect callers, etc.
Usually, the more IPA optimizations enabled, the larger the number of impacted functions for each function. In order to control the number of impacted functions and more easily compute the list of impacted function, IPA optimizations can be partially enabled at two different levels. ๐ค
The level argument should be one of the following:
inline-clone
Only enables inlining and cloning optimizations, which includes inlining, cloning, interprocedural scalar replacement of aggregates and partial inlining. As a result, when patching a function, all its callers and its clones' callers are impacted, therefore need to be patched as well.
-flive-patching=inline-clone disables the following optimization flags: -fwhole-program -fipa-pta -fipa-reference -fipa-ra -fipa-icf -fipa-icf-functions -fipa-icf-variables -fipa-bit-cp -fipa-vrp -fipa-pure-const -fipa-reference-addressable -fipa-stack-alignment
inline-only-static
Only enables inlining of static functions. As a result, when patching a static function, all its callers are impacted and so need to be patched as well.
In addition to all the flags that -flive-patching=inline-clone disables, -flive-patching=inline-only-static disables the following additional optimization flags: -fipa-cp-clone -fipa-sra -fpartial-inlining -fipa-cp
When -flive-patching is specified without any value, the default value is inline-clone.
This flag is disabled by default.
Note that-flive-patchingis not supported with link-time optimization (-flto). ๐ซ
-fisolate-erroneous-paths-dereference
Detects paths that trigger erroneous or undefined behavior due to dereferencing a null pointer. It isolates those paths from the main control flow and turns the statement with erroneous or undefined behavior into a trap. ๐ชค
This flag is enabled by default at -O2 and higher, and it depends on -fdelete-null-pointer-checks also being enabled.
-fisolate-erroneous-paths-attribute
Detects paths that trigger erroneous or undefined behavior due to a null value being used in a way forbidden by a "returns_nonnull" or "nonnull" attribute. It isolates those paths from the main control flow and turns the statement with erroneous or undefined behavior into a trap. ๐ชค
This is not currently enabled, but it may be enabled by -O2 in the future. ๐ฎ
-ftree-sink
Performs forward store motion on trees. This flag is enabled by default at -O and higher. ๐
-ftree-bit-ccp
Performs sparse conditional bit constant propagation on trees, and propagates pointer alignment information. This pass only operates on local scalar variables, and it's enabled by default at -O1 and higher โ except for -Og. It requires that -ftree-ccp is enabled. ๐
-ftree-ccp
Performs sparse conditional constant propagation (CCP) on trees. This pass only operates on local scalar variables, and it's enabled by default at -O and higher. โจ
-fssa-backprop
Propagates information about uses of a value up the definition chain, in order to simplify the definitions. For example, this pass strips sign operations if the sign of a value never matters. ๐ช
The flag is enabled by default at -O and higher.
-fssa-phioptโ bestie this one does pattern matching on SSA PHI nodes to optimize conditional code, and it's on by default at-O1and higher... except-Og, obviously, because-Ogsaid "not today" ๐-ftree-switch-conversionโ converts simple initializations in aswitchinto initializations from a scalar array โจ enabled by default at-O2and higher.-ftree-tail-mergeโ hunts for identical code sequences, and when it finds them, it replaces one with a jump to the other. This optimization is known as tail merging or cross jumping. On by default at-O2and higher. The compilation time in this pass can be limited using themax-tail-merge-comparisonsparameter and themax-tail-merge-iterationsparameter. ๐-ftree-dceโ performs dead code elimination (DCE) on trees. Enabled by default at-Oand higher. bye bye useless code ๐-ftree-builtin-call-dceโ performs conditional dead code elimination (DCE) for calls to built-in functions that may seterrnobut are otherwise free of side effects. This flag is enabled by default at-O2and higher if-Osis not also specified. not me being conditional about it ๐-ffinite-loopsโ assumes that a loop with an exit will eventually take the exit and not loop indefinitely. This lets the compiler remove loops that otherwise have no side-effects, not considering eventual endless looping as such. ๐
This option is enabled by default at -O2 for C++ with -std=c++11 or higher.
-ftree-dominator-optsโ performs a variety of simple scalar cleanups (constant/copy propagation, redundancy elimination, range propagation and expression simplification) based on a dominator tree traversal. It also performs jump threading (to reduce jumps to jumps). This flag is enabled by default at-Oand higher. it's giving "clean up your room" but for IR ๐งน-ftree-dseโ performs dead store elimination (DSE) on trees. A dead store is a store into a memory location that is later overwritten by another store without any intervening loads. In that case the earlier store can be deleted. This flag is enabled by default at-Oand higher.-ftree-chโ performs loop header copying on trees. This is beneficial since it increases effectiveness of code motion optimizations. It also saves one jump. This flag is enabled by default at-Oand higher. It is not enabled for-Os, since it usually increases code size. โ ๏ธ-ftree-loop-optimizeโ performs loop optimizations on trees. This flag is enabled by default at-Oand higher.-ftree-loop-linear-floop-strip-mine-floop-blockโ perform loop nest optimizations. Same as-floop-nest-optimize. To use this code transformation, GCC has to be configured with--with-islto enable the Graphite loop transformation infrastructure. ๐ฆ-fgraphite-identityโ enables the identity transformation for graphite. For every SCoP we generate the polyhedral representation and transform it back to gimple. Using-fgraphite-identitywe can check the costs or benefits of theGIMPLE -> GRAPHITE -> GIMPLEtransformation. Some minimal optimizations are also performed by the code generatorisl, like index splitting and dead code elimination in loops. the glow-up round trip ๐ซ-floop-nest-optimizeโ enables theislbased loop nest optimizer. This is a generic loop nest optimizer based on the Pluto optimization algorithms. It calculates a loop structure optimized for data-locality and parallelism. This option is experimental. ๐งช-floop-parallelize-allโ uses the Graphite data dependence analysis to identify loops that can be parallelized. Parallelizes all the loops that can be analyzed to not contain loop carried dependences without checking that it is profitable to parallelize the loops. not it skipping the vibe check on profitability ๐ญ-ftree-coalesce-varsโ while transforming the program out of the SSA representation, attempts to reduce copying by coalescing versions of different user-defined variables, instead of just compiler temporaries. This may severely limit the ability to debug an optimized program compiled with-fno-var-tracking-assignments. In the negated form, this flag prevents SSA coalescing of user variables. This option is enabled by default if optimization is enabled, and it does very little otherwise. ๐ซถ-ftree-loop-if-convertโ attempts to transform conditional jumps in the innermost loops to branch-less equivalents. The intent is to remove control-flow from the innermost loops in order to improve the ability of the vectorization pass to handle these loops. This is enabled by default if vectorization is enabled.-ftree-loop-distributionโ performs loop distribution. This flag can improve cache performance on big loop bodies and allow further loop optimizations, like parallelization or vectorization, to take place. For example, the loop
DO I = 1, N
A(I) = B(I) + C
D(I) = E(I) * F
ENDDO
is transformed to
DO I = 1, N
A(I) = B(I) + C
ENDDO
DO I = 1, N
D(I) = E(I) * F
ENDDO
This flag is enabled by default at -O3. It is also enabled by -fprofile-use and -fauto-profile.
-ftree-loop-distribute-patternsโ performs loop distribution of patterns that can be code generated with calls to a library. This flag is enabled by default at-O2and higher, and by-fprofile-useand-fauto-profile.
This pass distributes the initialization loops and generates a call to memset zero. For example, the loop
DO I = 1, N
A(I) = 0
B(I) = A(I) + I
ENDDO
is transformed to
DO I = 1, N
A(I) = 0
ENDDO
DO I = 1, N
B(I) = A(I) + I
ENDDO
and the initialization loop is transformed into a call to memset zero. This flag is enabled by default at -O3. It is also enabled by -fprofile-use and -fauto-profile.
-floop-interchangeโ performs loop interchange outside of graphite. This flag can improve cache performance on loop nest and allow further loop optimizations, like vectorization, to take place. For example, the loop
for (int i = 0; i < N; i++)
for (int j = 0; j < N; j++)
for (int k = 0; k < N; k++)
c[i][j] = c[i][j] + a[i][k]*b[k][j];
is transformed to
for (int i = 0; i < N; i++)
for (int k = 0; k < N; k++)
for (int j = 0; j < N; j++)
c[i][j] = c[i][j] + a[i][k]*b[k][j];
This flag is enabled by default at -O3. It is also enabled by -fprofile-use and -fauto-profile. swapping the loop order so your cache stops crying ๐ฅ
-floop-unroll-and-jamโ applies unroll and jam transformations on feasible loops. In a loop nest this unrolls the outer loop by some factor and fuses the resulting multiple inner loops. This flag is enabled by default at-O3. It is also enabled by-fprofile-useand-fauto-profile.-ftree-loop-imโ performs loop invariant motion on trees. This pass moves only invariants that are hard to handle at RTL level (function calls, operations that expand to nontrivial sequences of insns). With-funswitch-loopsit also moves operands of conditions that are invariant out of the loop, so that we can use just trivial invariantness analysis in loop unswitching. The pass also includes store motion. ๐-ftree-loop-ivcanonโ creates a canonical counter for number of iterations in loops for which determining number of iterations requires complicated analysis. Later optimizations then may determine the number easily. Useful especially in connection with unrolling. โจ-ftree-scev-cpropโ performs final value replacement. If a variable is modified in a loop in such a way that its value when exiting the loop can be determined using only its initial value and the number of loop iterations, replace uses of the final value by such a computation, provided it is sufficiently cheap. This reduces data dependencies and may allow further simplifications. Enabled by default at-Oand higher.-fivoptsโ performs induction variable optimizations (strength reduction, induction variable merging and induction variable elimination) on trees. glow-up for your loop counters ๐- *
-ftree-parallelize-loops=n* โ parallelizes loops, i.e., splits their iteration space to run in n threads. This is only possible for loops whose iterations are independent and can be arbitrarily reordered. The optimization is only profitable on multiprocessor machines, for loops that are CPU-intensive, rather than constrained e.g. by memory bandwidth. This option implies-pthread, and thus is only supported on targets that have support for-pthread. ๐ -ftree-ptaโ performs function-local points-to analysis on trees. This flag is 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. This flag is enabled by default at-O1and higher, except for-Og. your structs said "not today, memory" ๐-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. This is enabled by default at-O2and higher as well as-Os. ๐-ftree-terโ performs temporary expression replacement during theSSA->normalphase. 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. This is enabled by default at-Oand higher.-ftree-slsrโ performs straight-line strength reduction on trees. This recognizes related expressions involving multiplications and replaces them by less expensive calculations when possible. This is enabled by default at-Oand higher. turning multiplication into something cheaper, we love a budget queen ๐-ftree-vectorizeโ performs vectorization on trees. This flag enables-ftree-loop-vectorizeand-ftree-slp-vectorizeif not explicitly specified.-ftree-loop-vectorizeโ performs loop vectorization on trees. This flag is enabled by default at-O3and by-ftree-vectorize,-fprofile-use, and-fauto-profile. ๐ฆ-ftree-slp-vectorizeโ does basic block vectorization on trees ๐ง like it's taking your straight-line code and making it do the whole squad's work at once. It's on by default at-O3, and also gets switched on by-ftree-vectorize,-fprofile-use, and-fauto-profile. no cap โจ-fvect-cost-model=modelโ swap out the cost model that vectorization uses to decide if it's even worth it ๐ model has to be one ofunlimited,dynamic, orcheap. Here's the tea on each:unlimitedโ the vectorized code-path is just assumed to be profitable. no questions, full send ๐ซถdynamicโ a runtime check guards the vectorized code-path, so it only kicks in for iteration counts that will likely run faster than the original scalar loop. it's giving "let me check first, bestie" ๐ฅcheapโ straight-up disables vectorization of loops where doing it would be cost prohibitive, like when you'd need runtime checks for data dependence or alignment. otherwise? identical todynamic.
The default cost model depends on your other optimization flags, and it's either dynamic or cheap ๐
-fsimd-cost-model=modelโ same energy as above but specifically for vectorizing loops marked with the OpenMPsimddirective โจ model should be one ofunlimited,dynamic,cheap. Every value of model means exactly what it means in-fvect-cost-model, and by default the cost model you set with-fvect-cost-modelis the one that gets used ๐ธ-ftree-vrpโ does Value Range Propagation on trees ๐. It's like the constant propagation pass but instead of propagating values, it propagates ranges of values. Which means the optimizers get to yeet unnecessary range checks โ array bound checks, null pointer checks, all that noise ๐๏ธ. On by default at-O2and higher. Oh and heads up: null pointer check elimination only happens if-fdelete-null-pointer-checksis enabled ๐-fsplit-pathsโ splits the paths that lead to loop backedges ๐ฆ. This can level up dead code elimination and common subexpression elimination. Enabled by default at-O3and above โจ-fsplit-ivs-in-unrollerโ lets values of induction variables in later iterations of the unrolled loop be expressed using the value from the first iteration ๐. This breaks those long dependency chains, which makes the scheduling passes way more efficient. periodt.
Ngl, a combo of -fweb and CSE is often enough to get the same effect. However, that's not reliable when the loop body is more complicated than a single basic block ๐ญ. It also straight up does not work at all on some architectures because of restrictions in the CSE pass. rip.
This optimization is enabled by default. ๐
-fvariable-expansion-in-unrollerโ with this one, the compiler makes multiple copies of some local variables while unrolling a loop, which can give you superior code ๐.
Enabled by default for PowerPC targets, but disabled by default everywhere else ๐
-fpartial-inliningโ inlines parts of functions ๐งฉ. Important: this option only does anything when inlining itself is already turned on by-finline-functionsor-finline-small-functions. iykyk.
Enabled at levels -O2, -O3, -Os โจ
-fpredictive-commoningโ does predictive commoning optimization, aka reusing computations (especially memory loads and stores) that already happened in previous iterations of loops โป๏ธ๐ฅ.
Enabled at level -O3. It's also switched on by -fprofile-use and -fauto-profile ๐
-fprefetch-loop-arraysโ if your target machine supports it, this generates instructions to prefetch memory, which improves performance of loops that access large arrays ๐โจ.
Careful bestie โ this option may generate better or worse code. Results are highly dependent on the structure of loops within the source code ๐ญ so it's a vibe check every time.
Disabled at level -Os ๐
-fno-printf-return-valueโ says do not substitute constants for the known return value of formatted output functions likesprintf,snprintf,vsprintf, andvsnprintf(but notprintfoffprintf) ๐. That transformation is what lets GCC optimize or even eliminate branches based on the known return value of these functions โ when they're called with arguments that are either constant, or whose values are known to be in a range that makes determining the exact return value possible ๐ฎ. For example, when-fprintf-return-valueis in effect, both the branch and the body of theifstatement (but not the call tosnprint) can be optimized away wheniis a 32-bit or smaller integer, because the return value is guaranteed to be at most 8. slay ๐
char buf[9];
if (snprintf (buf, "%08x", i) >= sizeof buf)
...
The -fprintf-return-value option relies on other optimizations and yields best results with -O2 and above โจ. It works in tandem with the -Wformat-overflow and -Wformat-truncation options ๐ซถ. And yes, -fprintf-return-value is enabled by default ๐
-fno-peepholeand-fno-peephole2โ disable any machine-specific peephole optimizations ๐. The difference between-fno-peepholeand-fno-peephole2is just how they're implemented in the compiler โ some targets use one, some use the other, and a few use both ๐.
-fpeephole is enabled by default. -fpeephole2 is enabled at levels -O2, -O3, -Os ๐
-fno-guess-branch-probabilityโ tells GCC not to guess branch probabilities using heuristics ๐ โโ๏ธ.
So here's the deal: GCC uses heuristics to guess branch probabilities when they aren't provided by profiling feedback (-fprofile-arcs). Those heuristics are based on the control flow graph ๐บ๏ธ. If some branch probabilities are specified by __builtin_expect, then the heuristics get 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 get complex, and in some cases it may be useful to disable the heuristics so the effects of __builtin_expect are easier to understand ๐ง โจ.
You can also specify the expected probability of an expression with the __builtin_expect_with_probability built-in function ๐
The default is -fguess-branch-probability at levels -O, -O2, -O3, -Os ๐ธ
-freorder-blocksโ reorders basic blocks in the compiled function so there are fewer taken branches and better code locality ๐ฆ๐ซ.
Enabled at levels -O, -O2, -O3, -Os โจ
-freorder-blocks-algorithm=algorithmโ picks the algorithm used for basic block reordering ๐๏ธ. The algorithm argument can be:simpleโ does not increase code size (except sometimes from secondary effects like alignment) ๐stcโ the "software trace cache" algorithm, which tries to put all often-executed code together, minimizing the number of branches executed by making extra copies of code ๐ฅ
The default is simple at levels -O, -Os, and stc at levels -O2, -O3 ๐
-freorder-blocks-and-partitionโ on top of reordering basic blocks in the compiled function to reduce taken branches, this partitions hot and cold basic blocks into separate sections of the assembly and.ofiles, which improves paging and cache locality performance ๐ฅถ๐ฅ.
This optimization is automatically turned off when exception handling or unwind tables are present (on targets usingsetjump/longjumpor a target-specific scheme), for linkonce sections, for functions with a user-defined section attribute, and on any architecture that doesn't support named sections ๐ญ. Also, when-fsplit-stackis used, this option is not enabled by default (to avoid linker errors) โ but you can enable it explicitly if you're using a working linker ๐ซถ
Enabled for x86 at levels -O2, -O3, -Os โจ
-freorder-functionsโ reorders functions in the object file to improve code locality ๐. It's implemented using special subsections:.text.hotfor the most frequently executed functions and.text.unlikelyfor the unlikely-executed ones ๐. The reordering is done by the linker, so your object file format must support named sections and the linker has to place them in a reasonable way. no pressure or anything ๐
Heads up: this option isn't effective unless you either provide profile feedback (see -fprofile-arcs for details) or manually annotate functions with hot or cold attributes โ๏ธ.
Enabled at levels -O2, -O3, -Os ๐
-fstrict-aliasingโ lets the compiler assume the strictest aliasing rules that apply to the language being compiled ๐จ. For C (and C++), this activates optimizations based on the type of expressions. Specifically: an object of one type is assumed to never live at the same address as an object of a different type, unless the types are almost the same. Like, anunsigned intcan alias anint, but it can not alias avoid*or adouble๐ โโ๏ธ. A character type, though? A character type may alias any other type ๐
Pay extra 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 (this is called "type-punning") is super common ๐. And even with -fstrict-aliasing, type-punning is allowed โ as long as the memory is accessed through the union type. So the code above works as expected โจ. However, this code might not:
int f() {
union a_union t;
int* ip;
t.d = 3.0;
ip = &t.i;
return *ip;
}
Similarly, accessing by taking the address, casting the resulting pointer and dereferencing the result has undefined behavior ๐ฑ โ even if the cast uses a union type, like this:
int f() {
double d = 3.0;
return ((union a_union *) &d)->i;
}
The -fstrict-aliasing option is enabled at levels -O2, -O3, -Os ๐ฅ
-falign-functions,-falign-functions=n,-falign-functions=n:m,-falign-functions=n:m:n2,-falign-functions=n:m:n2:m2โ aligns the start of functions to the next power-of-two greater than or equal to n, skipping up to m-1 bytes ๐ฏ. This guarantees that at least the first m bytes of the function can be fetched by the CPU without crossing an n-byte alignment boundary ๐งโจ
If m isn't specified, it defaults to n ๐ซ
Examples, because examples are everything:
-falign-functions=32aligns functions to the next 32-byte boundary ๐-falign-functions=24aligns to the next 32-byte boundary only if this can be done by skipping 23 bytes or less ๐-falign-functions=32:7aligns to the next 32-byte boundary only if this can be done by skipping 6 bytes or less ๐
The second pair of n2:m2 values lets you set up a secondary alignment, bestie: -falign-functions=64:7:32:3 aligns to the next 64-byte boundary if that can happen by skipping 6 bytes or fewer, otherwise it aligns to the next 32-byte boundary if that can be done by skipping 2 bytes or fewer. 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 they mean functions are not aligned.
If n isn't specified or is zero, it uses a machine-dependent default. The maximum allowed n option value is 65536.
Enabled at levels -O2, -O3. โจ
-flimit-function-alignmentโ turn this on and the compiler tries to avoid unnecessarily overaligning functions. It attempts to instruct the assembler to align by the amount specified by-falign-functions, but not to skip more bytes than the size of the function. ๐
๐ the -falign-labels family
-falign-labels-falign-labels=n-falign-labels=n:m-falign-labels=n:m:n2-falign-labels=n:m:n2:m2 โ align all branch targets to a power-of-two boundary. ๐ฏ
The parameters of this option are analogous to the -falign-functions option. -fno-align-labels and -falign-labels=1 are equivalent and mean that labels are not aligned.
If -falign-loops or -falign-jumps are applicable and are greater than this value, then their values are used instead. ๐
If n isn't specified or is zero, it uses a machine-dependent default which is very likely to be 1, meaning no alignment. The maximum allowed n option value is 65536.
Enabled at levels -O2, -O3. ๐
๐ the -falign-loops family
-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. ๐
If -falign-labels is greater than this value, then its value is used instead.
Parameters of this option are analogous to the -falign-functions option. -fno-align-loops and -falign-loops=1 are equivalent and mean that loops are not aligned. The maximum allowed n option value is 65536.
If n isn't specified or is zero, it uses a machine-dependent default.
Enabled at levels -O2, -O3. ๐
๐ฆ the -falign-jumps family
-falign-jumps-falign-jumps=n-falign-jumps=n:m-falign-jumps=n:m:n2-falign-jumps=n:m:n2:m2 โ align branch targets to a power-of-two boundary, for branch targets where the targets can only be reached by jumping. In this case, no dummy operations need be executed. ๐
If -falign-labels is greater than this value, then its value is used instead.
Parameters of this option are analogous to the -falign-functions option. -fno-align-jumps and -falign-jumps=1 are equivalent and mean that loops are not aligned.
If n isn't specified or is zero, it uses a machine-dependent default. The maximum allowed n option value is 65536.
Enabled at levels -O2, -O3. โจ
-fno-allocation-dceโ do not remove unused C++ allocations in dead code elimination. ๐๏ธ-fallow-store-data-racesโ allow the compiler to introduce new data races on stores. ๐ญ
Enabled at level -Ofast.
-funit-at-a-timeโ this option is left for compatibility reasons.-funit-at-a-timehas no effect, while-fno-unit-at-a-timeimplies-fno-toplevel-reorderand-fno-section-anchors.
Enabled by default.
-fno-toplevel-reorderโ do not reorder top-level functions, variables, andasmstatements. Output them in the same order that they appear in the input file. When this option is used, unreferenced static variables are not removed. This option is intended to support existing code that relies on a particular ordering. For new code, it is better to use attributes when possible. ๐ซถ
-ftoplevel-reorder is the default at -O1 and higher, and also at -O0 if -fsection-anchors is explicitly requested. Additionally -fno-toplevel-reorder implies -fno-section-anchors.
-fwebโ constructs webs as commonly used for register allocation purposes and assigns each web its own individual pseudo register. This allows the register allocation pass to operate on pseudos directly, but also strengthens several other optimization passes, such as CSE, loop optimizer and trivial dead code remover. It can, however, make debugging impossible, since variables no longer stay in a "home register". ๐
Enabled by default with -funroll-loops.
-fwhole-programโ assume that the current compilation unit represents the whole program being compiled. All public functions and variables โ with the exception ofmainand those merged by attributeexternally_visibleโ become static functions and in effect are optimized more aggressively by interprocedural optimizers. ๐
This option should not be used in combination with -flto. Instead, relying on a linker plugin should provide safer and more precise information.
๐ -flto[=n]
This option runs the standard link-time optimizer. When invoked with source code, it generates GIMPLE (one of GCC's internal representations) and writes it to special ELF sections in the object file. When the object files are linked together, all the function bodies are read from these ELF sections and instantiated as if they had been part of the same translation unit. ๐ฅ
To use the link-time optimizer, -flto and optimization options should be specified at compile time and during the final link. It is recommended that you compile all the files participating in the same link with the same options and also specify those options at link time. For example:
gcc -c -O2 -flto foo.c
gcc -c -O2 -flto bar.c
gcc -o myprog -flto -O2 foo.o bar.o
The first two invocations to GCC save a bytecode representation of GIMPLE into special ELF sections inside foo.o and bar.o. The final invocation reads the GIMPLE bytecode from foo.o and bar.o, merges the two files into a single internal image, and compiles the result as usual. Since both foo.o and bar.o are merged into a single image, this causes all the interprocedural analyses and optimizations in GCC to work across the two files as if they were a single one. This means, for example, that the inliner is able to inline functions in bar.o into functions in foo.o and vice-versa. โจ
Another (simpler) way to enable link-time optimization is:
gcc -o myprog -flto -O2 foo.c bar.c
The above generates bytecode for foo.c and bar.c, merges them together into a single GIMPLE representation and optimizes them as usual to produce myprog.
The important thing to keep in mind is that to enable link-time optimizations you need to use the GCC driver to perform the link step. GCC automatically performs link-time optimization if any of the objects involved were compiled with the -flto command-line option. You can always override the automatic decision to do link-time optimization by passing -fno-lto to the link command. ๐ฏ
To make whole program optimization effective, it is necessary to make certain whole program assumptions. The compiler needs to know what functions and variables can be accessed by libraries and runtime outside of the link-time optimized unit. When supported by the linker, the linker plugin (see -fuse-linker-plugin) passes information to the compiler about used and externally visible symbols. When the linker plugin is not available, -fwhole-program should be used to allow the compiler to make these assumptions, which leads to more aggressive optimization decisions. ๐
When a file is compiled with -flto without -fuse-linker-plugin, the generated object file is larger than a regular object file because it contains GIMPLE bytecodes and the usual final code (see -ffat-lto-objects. This means that object files with LTO information can be linked as normal object files; if -fno-lto is passed to the linker, no interprocedural optimizations are applied. Note that when -fno-fat-lto-objects is enabled the compile stage is faster but you cannot perform a regular, non-LTO link on them. ๐
When producing the final binary, GCC only applies link-time optimizations to those files that contain bytecode. Therefore, you can mix and match object files and libraries with GIMPLE bytecodes and final object code. GCC automatically selects which files to optimize in LTO mode and which files to link without further processing. ๐
Generally, options specified at link time override those specified at compile time, although in some cases GCC attempts to infer link-time options from the settings used to compile the input files.
If you do not specify an optimization level option -O at link time, then GCC uses the highest optimization level used when compiling the object files. Note that it is generally ineffective to specify an optimization level option only at link time and not at compile time, for two reasons. First, compiling without optimization suppresses compiler passes that gather information needed for effective optimization at link time. Second, some early optimization passes can be performed only at compile time and not at link time. ๐ญ
There are some code generation flags preserved by GCC when generating bytecodes, as they need to be used during the final link. Currently, the following options and their settings are taken from the first object file that explicitly specifies them: -fPIC, -fpic, -fpie, -fcommon, -fexceptions, -fnon-call-exceptions, -fgnu-tm and all the -m target flags. ๐
Certain ABI-changing flags are required to match in all compilation units, and trying to override this at link time with a conflicting value is ignored. This includes options such as -freg-struct-return and -fpcc-struct-return.
Other options such as -ffp-contract, -fno-strict-overflow, -fwrapv, -fno-trapv or -fno-strict-aliasing are passed through to the link stage and merged conservatively for conflicting translation units. Specifically -fno-strict-overflow, -fwrapv and -fno-trapv take precedence; and for example -ffp-contract=off takes precedence over -ffp-contract=fast. You can override them at link time. ๐
Diagnostic options like -Wstringop-overflow? Yeah, those get passed straight through to the link stage, and their setting matches the compile-step one at function granularity. โจ Lowkey important note: this only matters for diagnostics that get emitted during optimization. And another one โ code transforms like inlining can literally lead to warnings being enabled or disabled for regions of code that aren't consistent with the setting at compile time. ๐ญ
When you need to pass options to the assembler via -Wa or -Xassembler, bestie, make sure you either compile such translation units with -fno-lto or consistently use the same assembler options on all translation units. No cap. You can alternatively also specify assembler options at LTO link time, so there's 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. Periodt.
If LTO encounters objects with C linkage declared with incompatible types in separate translation units to be linked together (undefined behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be issued. The behavior is still undefined at run time. Similar diagnostics may be raised for other languages. ๐
Another feature of LTO is that it is possible to apply interprocedural optimizations on files written in different languages:
gcc -c -flto foo.c
g++ -c -flto bar.cc
gfortran -c -flto baz.f90
g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
Notice that the final link is done with g++ to get the C++ runtime libraries, and -lgfortran is added to get the Fortran runtime libraries. ๐ In general, when mixing languages in LTO mode, you should use the same link command options as when mixing languages in a regular (non-LTO) compilation. iykyk.
If object files containing GIMPLE bytecode are stored in a library archive, say libfoo.a, it is possible to extract and use them in an LTO link if you are using a linker with plugin support. ๐ To create static libraries suitable for LTO, use gcc-ar and gcc-ranlib instead of ar and ranlib; to show the symbols of object files with GIMPLE bytecode, use gcc-nm. Those commands require that ar, ranlib and nm have been compiled with plugin support. At link time, use the flag -fuse-linker-plugin to ensure that the library participates in the LTO optimization process:
gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
With the linker plugin enabled, the linker extracts the needed GIMPLE files from libfoo.a and passes them on to the running GCC to make them part of the aggregated GIMPLE image to be optimized. โจ
If you are not using a linker with plugin support and/or do not enable the linker plugin, then the objects inside libfoo.a are extracted and linked as usual, but they do not participate in the LTO optimization process. In order to make a static library suitable for both LTO optimization and usual linkage, compile its object files with -flto -ffat-lto-objects. ๐
Link-time optimizations do not require the presence of the whole program to operate. If the program does not require any symbols to be exported, it is possible to combine -flto and -fwhole-program to allow the interprocedural optimizers to use more aggressive assumptions which may lead to improved optimization opportunities. Use of -fwhole-program is not needed when linker plugin is active (see -fuse-linker-plugin). ๐
The current implementation of LTO makes no attempt to generate bytecode that is portable between different types of hosts. The bytecode files are versioned and there is a strict version check, so bytecode files generated in one version of GCC do not work with an older or newer version of GCC. ๐ญ
Link-time optimization does not work well with generation of debugging information on systems other than those using a combination of ELF and DWARF. ๐
If you specify the optional n, the optimization and code generation done at link time is executed in parallel using n parallel jobs by utilizing an installed make program. The environment variable MAKE may be used to override the program used. ๐ธ
You can also specify -flto=jobserver to use GNU make's job server mode to determine the number of parallel jobs. This is useful when the Makefile calling GCC is already executing in parallel. You must prepend a + to the command recipe in the parent Makefile for this to work. This option likely only works if MAKE is GNU make. Even without the option value, GCC tries to automatically detect a running GNU make's job server. ๐ฆ
Use -flto=auto to use GNU make's job server, if available, or otherwise fall back to autodetection of the number of CPU threads present in your system. โจ
โจ OPTIONS โจ (continued)
-flto-partition=algโ bestie, this picks the partitioning algorithm used by the link-time optimizer. The value is either1to1to specify a partitioning mirroring the original source files, orbalancedto specify partitioning into equally sized chunks (whenever possible), ormaxto create a new partition for every symbol where possible. Specifyingnoneas an algorithm disables partitioning and streaming completely. The default value isbalanced. While1to1can be used as a workaround for various code ordering issues, themaxpartitioning is intended for internal testing only. ๐ The valueonespecifies that exactly one partition should be used, while the valuenonebypasses partitioning and executes the link-time optimization step directly from the WPA phase. ๐-flto-compression-level=nโ this one specifies the level of compression used for intermediate language written to LTO object files, and it's only meaningful in conjunction with LTO mode (-flto). Valid values are0(no compression) to9(maximum compression). Values outside this range are clamped to either0or9. If the option is not given, a default balanced compression setting is used. ๐-fuse-linker-pluginโ enables the use of a linker plugin during link-time optimization. This option relies on plugin support in the linker, which is available ingoldor in GNUld2.21 or newer. ๐ฅ
This option enables the extraction of object files with GIMPLE bytecode out of library archives. This improves the quality of optimization by exposing more code to the link-time optimizer. This information specifies what symbols can be accessed externally (by non-LTO object or during dynamic linking). Resulting code quality improvements on binaries (and shared libraries that use hidden visibility) are similar to -fwhole-program. See -flto for a description of the effect of this flag and how to use it. ๐
This option is enabled by default when LTO support in GCC is enabled and GCC was configured for use with a linker supporting plugins (GNU ld 2.21 or newer or gold). โจ
-ffat-lto-objectsโ Fat LTO objects are object files that contain both the intermediate language and the object code. This makes them usable for both LTO linking and normal linking. This option is effective only when compiling with-fltoand is ignored at link time. ๐
-fno-fat-lto-objects improves compilation time over plain LTO, but requires the complete toolchain to be aware of LTO. It requires a linker with linker plugin support for basic functionality. Additionally, nm, ar and ranlib need to support linker plugins to allow a full-featured build environment (capable of building static libraries etc). GCC provides the gcc-ar, gcc-nm, gcc-ranlib wrappers to pass the right options to these tools. With non fat LTO, makefiles need to be modified to use them. ๐ญ
Note that modern binutils provide plugin auto-load mechanism. Installing the linker plugin into $libdir/bfd-plugins has the same effect as usage of the command wrappers (gcc-ar, gcc-nm and gcc-ranlib). ๐ธ
The default is -fno-fat-lto-objects on targets with linker plugin support. ๐
-fcompare-elimโ after register allocation and post-register allocation instruction splitting, this identifies arithmetic instructions that compute processor flags similar to a comparison operation based on that arithmetic. If possible, it eliminates the explicit comparison operation. ๐ฆ
This pass only applies to certain targets that cannot explicitly represent the comparison operation before register allocation is complete.
Enabled at levels -O, -O2, -O3, -Os. โจ
-fcprop-registersโ after register allocation and post-register allocation instruction splitting, this performs a copy-propagation pass to try to reduce scheduling dependencies and occasionally eliminate the copy. ๐
Enabled at levels -O, -O2, -O3, -Os. ๐ฅ
-fprofile-correctionโ profiles collected using an instrumented binary for multi-threaded programs may be inconsistent due to missed counter updates. When this option is specified, GCC uses heuristics to correct or smooth out such inconsistencies. By default, GCC emits an error message when an inconsistent profile is detected. ๐ญ
This option is enabled by -fauto-profile. ๐
-fprofile-partial-trainingโ with-fprofile-use, all portions of programs not executed during the train run are optimized agressively for size rather than speed. In some cases it is not practical to train all possible hot paths in the program. (For example, program may contain functions specific for a given hardware and trianing may not cover all hardware configurations program is run on.) With-fprofile-partial-training, profile feedback will be ignored for all functions not executed during the train run, leading them to be optimized as if they were compiled without profile feedback. This leads to better performance when the train run is not representative, but also leads to significantly bigger code. ๐-fprofile-use-fprofile-use=pathโ enable profile feedback-directed optimizations, and the following optimizations, many of which are generally profitable only with profile feedback available: ๐
-fbranch-probabilities -fprofile-values -funroll-loops
-fpeel-loops -ftracer -fvpt -finline-functions -fipa-cp
-fipa-cp-clone -fipa-bit-cp -fpredictive-commoning -fsplit-loops
-funswitch-loops -fgcse-after-reload -ftree-loop-vectorize
-ftree-slp-vectorize -fvect-cost-model=dynamic
-ftree-loop-distribute-patterns -fprofile-reorder-functions
Bestie, plot twist: before you can even use this option, you have to generate profiling information first. No profile data, no party. ๐
By default, GCC throws an error if the feedback profiles don't match the source code. You can turn that error into a warning with -Wno-error=coverage-mismatch โ but heads up, that may give you poorly optimized code. ๐ญ Also, by default GCC throws a warning if the feedback profiles straight up don't exist (peep -Wmissing-profile for that one).
If path is specified, GCC goes looking at path to find the profile feedback data files. See -fprofile-dir. ๐๏ธ
โจ -fauto-profile / -fauto-profile=path โจ
Enable sampling-based feedback-directed optimizations, plus all of these optimizations โ many of which are honestly only worth it when profile feedback is 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
p<span>ath</span> is the name of a file containing AutoFDO profile information. If you leave it out, it defaults to fbdata.afdo in the current directory. ๐
To make an AutoFDO profile data file, you have to run your program with the perf utility on a supported GNU/Linux target system. More info here: https://perf.wiki.kernel.org/
E.g.
perf record -e br_inst_retired:near_taken -b -o perf.data \
-- your_program
Then use the create_gcov tool to convert that raw profile data into a format GCC can actually use. You must also hand this tool the unstripped binary for your program. See https://github.com/google/autofdo.
E.g.
create_gcov --binary=your_program.unstripped --profile=perf.data \
--gcov=profile.afdo
The next batch of options controls how the compiler behaves around floating-point arithmetic. These options are all about trading speed against correctness, and all of them have to be specifically enabled โ no sneaky defaults turning them on for you. โจ
๐ธ -ffloat-store ๐ธ
Don't store floating-point variables in registers, and inhibit other options that might change whether a floating-point value is pulled from a register or from memory.
This option prevents that undesirable excess precision on machines like the 68000, where the floating registers (of the 68881) keep more precision than a double is supposed to have. Same deal on the x86 architecture. For most programs the excess precision does only good, but a few programs rely on the precise definition of IEEE floating point. Use -ffloat-store for those programs โ after you've modified them to store all pertinent intermediate computations into variables. ๐พ
๐ฆ -fexcess-precision=style ๐ฆ
This option gives you further control over excess precision on machines where floating-point operations happen in a format with more precision or range than the IEEE standard and interchange floating-point types.
By default, -fexcess-precision=fast is in effect. What that means: operations may be carried out in a wider precision than the types specified in the source, if that would result in faster code, and it's unpredictable when rounding to the types specified in the source code takes place. ๐
When compiling C, if -fexcess-precision=standard is specified, then excess precision follows the rules specified in ISO C99. In particular, both casts and assignments cause values to be rounded to their semantic types (whereas -ffloat-store only affects assignments). This option is enabled by default for C if a strict conformance option such as -std=c99 is used. -ffast-math enables -fexcess-precision=fast by default regardless of whether a strict conformance option is used.
-fexcess-precision=standardis not implemented for languages other than C. On the x86, it has no effect if-mfpmath=sseor-mfpmath=sse+387is specified โ in the former case, IEEE semantics apply without excess precision, and in the latter, rounding is unpredictable. ๐
๐ -ffast-math ๐
Sets the options -fno-math-errno, -funsafe-math-optimizations, -ffinite-math-only, -fno-rounding-math, -fno-signaling-nans, -fcx-limited-range and -fexcess-precision=fast.
This option causes the preprocessor macro __FAST_MATH__ to be defined. ๐
This option is not turned on by any -O option besides -Ofast, since it can result in incorrect output for programs that depend on an exact implementation of IEEE or ISO rules/specifications for math functions. It may, however, yield faster code for programs that do not require the guarantees of these specifications. ๐๏ธ
๐ -fno-math-errno ๐
Do not set errno after calling math functions that are executed with a single instruction, e.g., sqrt. A program that relies on IEEE exceptions for math error handling may want to use this flag for speed while maintaining IEEE arithmetic compatibility.
This option is not turned on by any -O option, since it can result in incorrect output for programs that depend on an exact implementation of IEEE or ISO rules/specifications for math functions. It may, however, yield faster code for programs that do not require the guarantees of these specifications.
The default is -fmath-errno.
On Darwin systems, the math library never sets errno. So there's literally no reason for the compiler to 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 that arguments and results are valid and (b) may violate IEEE or ANSI standards. When used at link time, it may include libraries or startup files that change the default FPU control word or other similar optimizations.
This option is not turned on by any -O option, since it can result in incorrect output for programs that depend on an exact implementation of IEEE or ISO rules/specifications for math functions. It may, however, yield faster code for programs that do not require the guarantees of these specifications. It enables -fno-signed-zeros, -fno-trapping-math, -fassociative-math and -freciprocal-math.
The default is -fno-unsafe-math-optimizations.
โญ -fassociative-math โญ
Allow re-association of operands in series of floating-point operations. This violates the ISO C and C++ language standard by possibly changing computation result.
NOTE: re-ordering may change the sign of zero as well as ignore NaNs and inhibit or create underflow or overflow (and thus cannot be used on code that relies on rounding behavior like (x + 2**52) - 2**52). May also reorder floating-point comparisons and thus may not be used when ordered comparisons are required.
This option requires that both -fno-signed-zeros and -fno-trapping-math be in effect. Moreover, it doesn't make much sense with -frounding-math. For Fortran the option is automatically enabled when both -fno-signed-zeros and -fno-trapping-math are in effect.
The default is -fno-associative-math.
๐ -freciprocal-math ๐
Allow the reciprocal of a value to be used instead of dividing by the value, if this enables optimizations. For example x / y can be replaced with x * (1/y), which is useful if (1/y) is subject to common subexpression elimination. Note that this loses precision and increases the number of flops operating on the value. ๐ฌ
The default is -fno-reciprocal-math.
๐ง -ffinite-math-only ๐ง
Allow optimizations for floating-point arithmetic that assume that arguments and results are not NaNs or +-Infs.
This option is not turned on by any -O option, since it can result in incorrect output for programs that depend on an exact implementation of IEEE or ISO rules/specifications for math functions. It may, however, yield faster code for programs that do not require the guarantees of these specifications.
The default is -fno-finite-math-only.
๐ -fno-signed-zeros ๐
Allow optimizations for floating-point arithmetic that ignore the signedness of zero. IEEE arithmetic specifies the behavior of distinct +0.0 and -0.0 values, which then prohibits simplification of expressions such as x+0.0 or 0.0*x (even with -ffinite-math-only). This option implies that the sign of a zero result isn't significant.
The default is -fsigned-zeros.
๐ซถ -fno-trapping-math ๐ซถ
Compile code assuming that floating-point operations cannot generate user-visible traps. These traps include division by zero, overflow, underflow, inexact result and invalid operation. This option requires that -fno-signaling-nans be in effect. Setting this option may allow faster code if one relies on "non-stop" IEEE arithmetic, for example.
This option should never be turned on by any -O option, since it can result in incorrect output for programs that depend on an exact implementation of IEEE or ISO rules/specifications for math functions.
The default is -ftrapping-math.
๐ -frounding-math ๐
Disable transformations and optimizations that assume default floating-point rounding behavior. This is round-to-zero for all floating point to integer conversions, and round-to-nearest for all other arithmetic truncations. This option should be specified for programs that change the FP rounding mode dynamically, or that may be executed with a non-default rounding mode. This option disables constant folding of floating-point expressions at compile time (which may be affected by rounding mode) and arithmetic transformations that are unsafe in the presence of sign-dependent rounding modes.
The default is -fno-rounding-math.
This option is experimental and does not currently guarantee to disable all GCC optimizations that are affected by rounding mode. Future versions of GCC may provide finer control of this setting using C99'sFENV_ACCESSpragma. This command-line option will be used to specify the default state forFENV_ACCESS. ๐ฎ
-fsignaling-nansโ okay so this one tells GCC to compile your code assuming that IEEE signaling NaNs might throw user-visible traps while floating-point ops are happening. Turning this on disables optimizations that could change how many exceptions are visible with signaling NaNs, so it's the cautious-girlie option. This option implies-ftrapping-math. ๐
It also makes the preprocessor macro __SUPPORT_SNAN__ get defined, which is lowkey a whole thing.
The default is -fno-signaling-nans.
Heads up bestie: this option is experimental and does not currently guarantee to disable all GCC optimizations that affect signaling NaN behavior. So like... it's giving "trying her best," not "legally binding promise." ๐ญ
-fno-fp-int-builtin-inexactโ do not let the built-in functionsceil,floor,roundandtrunc, plus theirfloatandlong doublevariants, generate code that raises theinexactfloating-point exception for noninteger arguments. ISO C99 and C11 are totally fine with these functions raisinginexact, but ISO/IEC TS 18661-1:2014, the C bindings to IEEE 754-2008, as integrated into ISO C2X, says nope, they can't do that. โจ
The default is -ffp-int-builtin-inexact, which allows the exception to be raised โ unless C2X or a later C standard is selected. And this option does nothing unless -ftrapping-math is in effect. fr fr, it's powerless without its partner.
Even if you use -fno-fp-int-builtin-inexact, if the functions generate a call to a library function then the inexact exception may still be raised if the library implementation doesn't follow TS 18661. ๐
-fsingle-precision-constantโ treat floating-point constants as single precision instead of implicitly converting them to double-precision constants. No silent glow-up to double, periodt.
-fcx-limited-rangeโ when enabled, this option states that a range reduction step is not needed when performing complex division. Also, there's no checking whether the result of a complex multiplication or division isNaN + I*NaN, with an attempt to rescue the situation in that case. The default is-fno-cx-limited-range, but it gets enabled by-ffast-math. ๐ฆ
This option controls the default setting of the ISO C99 CX_LIMITED_RANGE pragma. Nevertheless โ and this is the iconic part โ the option applies to all languages. She does not discriminate. ๐
-fcx-fortran-rulesโ complex multiplication and division follow Fortran rules. Range reduction is done as part of complex division, but there's no checking whether the result of a complex multiplication or division isNaN + I*NaN, with an attempt to rescue the situation in that case.
The default is -fno-cx-fortran-rules.
The following options control optimizations that may improve performance, but are not enabled by any -O options. This section includes experimental options that may produce broken code. ๐ (yes, literally broken code, proceed with the vibes of a girl who reads the warnings)
-fbranch-probabilitiesโ after running a program compiled with-fprofile-arcs, you can compile it a second time using-fbranch-probabilities, to improve optimizations based on the number of 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 that data file is very dependent on the structure of the generated code, so you must use the same source code and the same optimization options for both compilations. No switching up the fit between takes. ๐
With -fbranch-probabilities, GCC puts a REG_BR_PROB note on each JUMP_INSN and CALL_INSN. These can be used to improve optimization. Currently, they're only used in one place: in reorg.c, instead of guessing which path a branch is most likely to take, the REG_BR_PROB values are used to exactly determine which path is taken more often. She's not guessing anymore, she knows. ๐
Enabled by -fprofile-use and -fauto-profile.
-fprofile-valuesโ if combined with-fprofile-arcs, it adds code so that some data about values of expressions in the program is gathered. ๐
With -fbranch-probabilities, it reads back the data gathered from profiling values of expressions for usage in optimizations.
Enabled by -fprofile-generate, -fprofile-use, and -fauto-profile.
-fprofile-reorder-functionsโ function reordering based on profile instrumentation collects first time of execution of a function and orders these functions in ascending order. Neat and tidy, she loves a lineup. โจ
Enabled with -fprofile-use.
-fvptโ if combined with-fprofile-arcs, this option instructs the compiler to add code to gather information about values of expressions. ๐
With -fbranch-probabilities, it reads back the data gathered and actually performs the optimizations based on them. Currently the optimizations include specialization of division operations using the knowledge about the value of the denominator. iykyk.
Enabled with -fprofile-use and -fauto-profile.
-frename-registersโ attempt to avoid false dependencies in scheduled code by making use of registers left over after register allocation. This optimization most benefits processors with lots of registers. Depending on the debug information format adopted by the target, however, it can make debugging impossible, since variables no longer stay in a "home register". ๐ญ sobbing but worth it for the speed sometimes.
Enabled by default with -funroll-loops.
-fschedule-fusionโ performs a target dependent pass over the instruction stream to schedule instructions of same type together because the target machine can execute them more efficiently if they're adjacent to each other in the instruction flow. Besties standing next to each other hit different. ๐ซถ
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. It's giving "bigger isn't always better" but make it compiler flags. ๐
Enabled by -fprofile-use and -fauto-profile.
-funroll-all-loopsโ unroll all loops, even if their number of iterations is uncertain when the loop is entered. This usually makes programs run more slowly. ๐-funroll-all-loopsimplies the same options as-funroll-loops.-fpeel-loopsโ peels loops for which there's enough information that they don't roll much (from profile feedback or static analysis). It also turns on complete loop peeling (i.e. complete removal of loops with small constant number of iterations). Like a glow-up peel but for loops. ๐งโโ๏ธ
Enabled by -O3, -fprofile-use, and -fauto-profile.
-fmove-loop-invariantsโ enables the loop invariant motion pass in the RTL loop optimizer. Enabled at level-O1and higher, except for-Og.-fsplit-loopsโ split a loop into two if it contains a condition that's always true for one side of the iteration space and false for the other. Two loops, one condition, main character energy. ๐
Enabled by -fprofile-use and -fauto-profile.
-funswitch-loopsโ move branches with loop invariant conditions out of the loop, with duplicates of the loop on both branches (modified according to result of the condition). She said "get out of the loop, girl." ๐ช
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. Every function gets her own lil room. ๐
Use these options on systems where the linker can perform optimizations to improve locality of reference in the instruction space. Most systems using the ELF object format have linkers with such optimizations. On AIX, the linker rearranges sections (CSECTs) based on the call graph. The performance impact varies.
Together with a linker garbage collection (linker --gc-sections option) these options may lead to smaller statically-linked executables (after stripping).
On ELF/DWARF systems these options do not degenerate the quality of the debug information. There could be issues with other object files/debug info formats.
Only use these options when there are significant benefits from doing so. When you specify these options, the assembler and linker create larger object and executable files and are also slower. These options affect code generation. They prevent optimizations by the compiler and assembler using relative locations inside a translation unit since the locations are unknown until link time. An example of such an optimization is relaxing calls to short call instructions. So like... it costs you, bestie. Know the price. ๐
-fstdarg-optโ optimize the prologue of variadic argument functions with respect to usage of those arguments.
NOTE: In Ubuntu 14.10 and later versions,-fstack-protector-strongis enabled by default for C, C++, ObjC, ObjC++, if none of-fno-stack-protector,-nostdlib, nor-ffreestandingare found. ๐
-fsection-anchorsโ try to reduce the number of symbolic address calculations by using shared "anchor" symbols to address nearby objects. This transformation can help to reduce the number of GOT entries and GOT accesses on some targets. She's the anchor friend, holding everyone together. ๐ซถ
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];
}
(and yes, that's literally not valid C, don't come for her, it's pseudocode ๐)
Not all targets support this option.
--param name=valueโ bestie, this is the secret dial room ๐งโจ GCC has a whole bunch of internal constants that quietly decide how much optimizing it does โ like, it literally won't inline a function if that function has more instructions than some magic number.--paramlets you poke at those constants from the command line instead of just vibing with the defaults.
Heads up though: the actual parameter names and what their values mean are tied to the compiler's internals, and they can change without notice in future releases. So like, don't build your whole personality on them. ๐
Wanna know the minimal, maximal and default value of a parameter? You can get all of that with the --help=param -Q options. Iconic, honestly. ๐
In each case, the value is an integer. And these are the name choices recognized for all targets:
predictable-branch-outcomeโ when a branch is predicted to be taken with a probability lower than this threshold (in percent), it gets considered well predictable.max-rtl-if-conversion-insnsโ RTL if-conversion tries to remove conditional branches around a block and replace them with conditionally executed instructions. This parameter is the max number of instructions in a block that should even be considered for if-conversion. And ngl, the compiler also uses other heuristics to decide whether if-conversion is likely to be profitable, so this isn't the whole story.max-rtl-if-conversion-predictable-cost,max-rtl-if-conversion-unpredictable-costโ RTL if-conversion will try to remove conditional branches around a block and swap them for conditionally executed instructions. These two give the max permissible cost for the sequence that if-conversion would generate, depending on whether the branch is statically determined to be predictable or not. The units for this parameter are the same as those for the GCC internalseq_costmetric. And the compiler will try to give you a reasonable default for this parameter using theBRANCH_COSTtarget macro. ๐ซถmax-crossjump-edgesโ the max number of incoming edges to consider for cross-jumping. The algorithm used by-fcrossjumpingis O(N^2) in the number of edges incoming to each block. Bump this up and you get more aggressive optimization, but compile time goes up too, with probably only a small improvement in executable size. Trade-offs, bestie. ๐min-crossjump-insnsโ the minimum number of instructions that have to match at the end of two blocks before cross-jumping is even performed on them. This value gets ignored when all the instructions in the block being cross-jumped from are matched.max-grow-copy-bb-insnsโ the max code size expansion factor when copying basic blocks instead of jumping. The expansion is relative to a jump instruction.max-goto-duplication-insnsโ the max number of instructions to duplicate into a block that jumps to a computed goto. To avoid O(N^2) behavior across a bunch of passes, GCC factors computed gotos early in the compilation process and unfactors them as late as possible. Only computed jumps at the end of a basic block with no more thanmax-goto-duplication-insnsget unfactored.max-delay-slot-insn-searchโ the max number of instructions to consider when hunting for an instruction to fill a delay slot. If more than this arbitrary number of instructions get searched, the time savings from filling the delay slot are minimal, so it just stops searching. Higher values = more aggressive optimization, more compilation time, and probably only a small improvement in execution time. ๐ญmax-delay-slot-live-searchโ when trying to fill delay slots, this is the max number of instructions to consider while searching for a block with valid live register information. Cranking this arbitrarily chosen value up means more aggressive optimization and more compilation time. This parameter should be removed when the delay slot code is rewritten to maintain the control-flow graph.max-gcse-memoryโ the approximate max amount of memory that can be allocated in order to do the global common subexpression elimination optimization. If more memory than specified is required, the optimization simply doesn't happen. โจmax-gcse-insertion-ratioโ if the ratio of expression insertions to deletions is larger than this value for any expression, then RTL PRE inserts or removes the expression and thus leaves partially redundant computations in the instruction stream.max-pending-list-lengthโ the max number of pending dependencies scheduling allows before it flushes the current state and starts over. Large functions with few branches or calls can create excessively large lists, which needlessly consume memory and resources. Not the vibe. ๐max-modulo-backtrack-attemptsโ the max number of backtrack attempts the scheduler should make when modulo scheduling a loop. Larger values can exponentially increase compilation time, so like... be careful. ๐max-inline-insns-singleโ several parameters control the tree inliner used in GCC, and this number sets the max number of instructions (counted in GCC's internal representation) in a single function that the tree inliner will consider for inlining. This only affects functions declaredinlineand methods implemented in a class declaration (C++).max-inline-insns-autoโ when you use-finline-functions(which is included in-O3), a lot of functions that would otherwise never be considered for inlining get investigated. For those functions, a different (more restrictive) limit compared to functions declared inline can be applied (--param max-inline-insns-auto).max-inline-insns-smallโ this is the bound applied to calls which are considered relevant with-finline-small-functions.max-inline-insns-sizeโ this is the bound applied to calls which are optimized for size. A little bit of growth may be desirable to anticipate optimization opportunities exposed by inlining. ๐uninlined-function-insnsโ the number of instructions accounted by the inliner for function overhead, like function prologue and epilogue.uninlined-function-timeโ extra time accounted by the inliner for function overhead, like the time needed to execute function prologue and epilogue.inline-heuristics-hint-percentโ the scale (in percents) applied toinline-insns-single,inline-insns-single-O2, andinline-insns-autowhen inline heuristics hint that inlining is very profitable (like, it'll enable later optimizations). Slay.uninlined-thunk-insns,uninlined-thunk-timeโ same as--param uninlined-function-insnsand--param uninlined-function-time, but applied to function thunks.inline-min-speedupโ when the estimated performance improvement of caller + callee runtime exceeds this threshold (in percent), the function can be inlined regardless of the limit on--param max-inline-insns-singleand--param max-inline-insns-auto. Periodt. ๐large-function-insnsโ the limit specifying really large functions. For functions larger than this limit after inlining, inlining gets constrained by--param large-function-growth. This parameter is useful primarily to avoid extreme compilation time caused by non-linear algorithms used by the back end.large-function-growthโ specifies the maximal growth of a large function caused by inlining, in percents. For example, parameter value100limits large function growth to 2.0 times the original size.large-unit-insnsโ the limit specifying a large translation unit. Growth caused by inlining of units larger than this limit is limited by--param inline-unit-growth. For small units this might be too tight. For example, consider a unit consisting of function A that is inline and B that just calls A three times. If B is small relative to A, the growth of the unit is 300% and yet such inlining is very sane. For very large units consisting of small inlineable functions, however, the overall unit growth limit is needed to avoid exponential explosion of code size. Thus for smaller units, the size is increased to--param large-unit-insnsbefore applying--param inline-unit-growth.inline-unit-growthโ specifies the maximal overall growth of the compilation unit caused by inlining. For example, parameter value20limits unit growth to 1.2 times the original size. Cold functions (either marked cold via an attribute or by profile feedback) are not accounted into the unit size.ipa-cp-unit-growthโ specifies the maximal overall growth of the compilation unit caused by interprocedural constant propagation. For example, parameter value10limits unit growth to 1.1 times the original size.large-stack-frameโ the limit specifying large stack frames. While inlining, the algorithm tries not to grow past this limit too much.large-stack-frame-growthโ specifies the maximal growth of large stack frames caused by inlining, in percents. For example, parameter value1000limits large stack frame growth to 11 times the original size.max-inline-insns-recursive,max-inline-insns-recursive-autoโ specifies the max number of instructions an out-of-line copy of a self-recursive inline function can grow into by performing recursive inlining.--param max-inline-insns-recursiveapplies to functions declared inline. For functions not declared inline, recursive inlining only happens when-finline-functions(included in-O3) is enabled;--param max-inline-insns-recursive-autoapplies instead.max-inline-recursive-depth,max-inline-recursive-depth-autoโ specifies the maximum recursion depth used for recursive inlining. ๐
okay so real talk โ when a function is declared inline, --param max-inline-recursive-depth is the one running the show ๐
but for functions that are not declared inline, recursive inlining only happens when -finline-functions (which, bestie, is included in -O3) is enabled โ and when that's the case, it's --param max-inline-recursive-depth-auto that applies instead. no cap.
min-inline-recursive-probabilityโ recursive inlining is only worth it for functions that have deep recursion on average, and it can legitimately hurt functions with a tiny recursion depth, because it bloats the prologue size or makes the function body more complex for the other optimizers to deal with ๐ญ. When profile feedback is available (peep-fprofile-generate), the actual recursion depth can be guessed from the probability that a function recurses via a given call expression. This parameter limits inlining only to call expressions whose probability exceeds the given threshold (in percents).early-inlining-insnsโ specify the growth that the early inliner is allowed to make. Effectively it cranks up the amount of inlining for code that has a large abstraction penalty. slay.max-early-inliner-iterationsโ limit of iterations of the early inliner. Basically it bounds how many nested indirect calls the early inliner can resolve. Deeper chains are still handled by late inlining, so don't stress ๐ซถcomdat-sharing-probabilityโ probability (in percent) that C++ inline functions with comdat visibility get shared across multiple compilation units.profile-func-internal-idโ a parameter controlling whether to use function internal id in profile database lookup. If the value is0, the compiler uses an id based on function assembler name and filename, which makes old profile data more tolerant to source changes such as function reordering etc. iykyk โจmin-vect-loop-boundโ the minimum number of iterations under which loops are not vectorized when-ftree-vectorizeis used. The number of iterations after vectorization needs to be greater than the value specified by this option to allow vectorization.gcse-cost-distance-ratioโ scaling factor in the calculation of the maximum distance an expression can be moved by GCSE optimizations. Currently supported only in the code hoisting pass. The bigger the ratio, the more aggressive code hoisting is with simple expressions, i.e., the expressions that have cost less thangcse-unrestricted-cost. Specifying0disables hoisting of simple expressions.gcse-unrestricted-costโ cost, roughly measured as the cost of a single typical machine instruction, at which GCSE optimizations do not constrain the distance an expression can travel. Currently supported only in the code hoisting pass. The lesser the cost, the more aggressive code hoisting is. Specifying0allows all expressions to travel unrestricted distances ๐ฅmax-hoist-depthโ the depth of search in the dominator tree for expressions to hoist. This is used to avoid quadratic behavior in the hoisting algorithm. The value of0does not limit the search, but may slow down compilation of huge functions.max-tail-merge-comparisonsโ the maximum amount of similar bbs to compare a bb with. Used to avoid quadratic behavior in tree tail merging.max-tail-merge-iterationsโ the maximum amount of iterations of the pass over the function. Used to limit compilation time in tree tail merging.store-merging-allow-unalignedโ allow the store merging pass to introduce unaligned stores if it is legal to do so ๐max-stores-to-mergeโ the maximum number of stores to attempt to merge into wider stores in the store merging pass.max-unrolled-insnsโ the maximum number of instructions a loop may have to be unrolled. If a loop is unrolled, this parameter also determines how many times the loop code is unrolled.max-average-unrolled-insnsโ the maximum number of instructions biased by probabilities of their execution that a loop may have to be unrolled. If a loop is unrolled, this parameter also determines how many times the loop code is unrolled.max-unroll-timesโ the maximum number of unrollings of a single loop.max-peeled-insnsโ the maximum number of instructions a loop may have to be peeled. If a loop is peeled, this parameter also determines how many times the loop code is peeled.max-peel-timesโ the maximum number of peelings of a single loop.max-peel-branchesโ the maximum number of branches on the hot path through the peeled sequence.max-completely-peeled-insnsโ the maximum number of insns of a completely peeled loop.max-completely-peel-timesโ the maximum number of iterations of a loop to be suitable for complete peeling.max-completely-peel-loop-nest-depthโ the maximum depth of a loop nest suitable for complete peeling.max-unswitch-insnsโ the maximum number of insns of an unswitched loop.max-unswitch-levelโ the maximum number of branches unswitched in a single loop.lim-expensiveโ the minimum cost of an expensive expression in the loop invariant motion.min-loop-cond-split-probโ when FDO profile information is available,min-loop-cond-split-probspecifies the minimum threshold for probability of a semi-invariant condition statement to trigger loop split.iv-consider-all-candidates-boundโ bound on the number of candidates for induction variables, below which all candidates are considered for each use in induction variable optimizations. If there are more candidates than this, only the most relevant ones get considered, to avoid quadratic time complexity.iv-max-considered-usesโ the induction variable optimizations give up on loops that contain more induction variable uses.iv-always-prune-cand-set-boundโ if the number of candidates in the set is smaller than this value, always try to remove unnecessary ivs from the set when adding a new one.avg-loop-niterโ average number of iterations of a loop.dse-max-object-sizeโ maximum size (in bytes) of objects tracked bytewise by dead store elimination. Larger values may result in larger compilation times ๐ดdse-max-alias-queries-per-storeโ maximum number of queries into the alias oracle per store. Larger values result in larger compilation times and may result in more removed dead stores.scev-max-expr-sizeโ bound on the size of expressions used in the scalar evolutions analyzer. Large expressions slow the analyzer.scev-max-expr-complexityโ bound on the complexity of the expressions in the scalar evolutions analyzer. Complex expressions slow the analyzer.max-tree-if-conversion-phi-argsโ maximum number of arguments in a PHI supported by TREE if conversion, unless the loop is marked with simd pragma.vect-max-version-for-alignment-checksโ the maximum number of run-time checks that can be performed when doing loop versioning for alignment in the vectorizer.vect-max-version-for-alias-checksโ the maximum number of run-time checks that can be performed when doing loop versioning for alias in the vectorizer.vect-max-peeling-for-alignmentโ the maximum number of loop peels to enhance access alignment for vectorizer. Value-1means no limit. periodt.max-iterations-to-trackโ the maximum number of iterations of a loop the brute-force algorithm for analysis of the number of iterations of the loop tries to evaluate.hot-bb-count-fractionโ the denominator n of fraction 1/n of the maximal execution count of a basic block in the entire program that a basic block needs to at least have in order to be considered hot ๐ฅต The default is10000, which means a basic block is considered hot if its execution count is greater than 1/10000 of the maximal execution count.0means it is never considered hot. Used in non-LTO mode.hot-bb-count-ws-permilleโ the number of most executed permilles, ranging from0to1000, of the profiled execution of the entire program to which the execution count of a basic block must be part of in order to be considered hot. The default is990, which means a basic block is considered hot if its execution count contributes to the upper 990 permilles, or 99.0%, of the profiled execution of the entire program.0means it is never considered hot. Used in LTO mode.hot-bb-frequency-fractionโ the denominator n of fraction 1/n of the execution frequency of the entry block of a function that a basic block of this function needs to at least have in order to be considered hot. The default is1000, which means a basic block is considered hot in a function if it is executed more frequently than 1/1000 of the frequency of the entry block of the function.0means it is never considered hot.unlikely-bb-count-fractionโ the denominator n of fraction 1/n of the number of profiled runs of the entire program below which the execution count of a basic block must be in order for the basic block to be considered unlikely executed. The default is20, which means a basic block is considered unlikely executed if it is executed in fewer than 1/20, or 5%, of the runs of the program.0means it is always considered unlikely executed ๐max-predicted-iterationsโ the maximum number of loop iterations we predict statically. This is useful in cases where a function contains a single loop with a known bound and another loop with an unknown bound. The known number of iterations is predicted correctly, while the unknown number of iterations average to roughly10. This means that the loop without bounds appears artificially cold relative to the other one ๐ฅถbuiltin-expect-probabilityโ this sets how likely an expression is to have the value you specified. It takes a percentage (so0 ... 100), that's it, that's the whole input โจbuiltin-string-cmp-inline-lengthโ the max length of a constant string for a builtin string cmp call that's eligible for inlining.align-thresholdโ picks what fraction of the max execution frequency of a basic block in a function you need before that basic block gets aligned ๐align-loop-iterationsโ a loop that's expected to iterate at least this many times gets aligned.tracer-dynamic-coverage,tracer-dynamic-coverage-feedbackโ this value caps superblock formation once a given percentage of executed instructions is covered. It's there to limit unnecessary code size expansion, bestie. Thetracer-dynamic-coverage-feedbackparameter only kicks in when profile feedback is available โ because real profiles (as opposed to statically estimated ones) are much less balanced, which lets the threshold be a larger value.tracer-max-code-growthโ stops tail duplication once code growth hits the given percentage. Honestly this is a pretty artificial limit, since most of the duplicates get eliminated later in cross jumping anyway, so you can set it way higher than the code growth you actually want ๐ซถtracer-min-branch-ratioโ stops reverse growth when the reverse probability of the best edge drops below this threshold (in percent).tracer-min-branch-probability,tracer-min-branch-probability-feedbackโ stops forward growth if the best edge's probability is lower than this threshold. Same deal astracer-dynamic-coverage, two parameters:tracer-min-branch-probability-feedbackis used for compilation with profile feedback andtracer-min-branch-probabilityfor compilation without. The value for compilation with profile feedback has to be more conservative (higher) to actually make the tracer effective.stack-clash-protection-guard-sizeโ specify the size of the OS-provided stack guard as 2 raised to num bytes. Higher values may reduce the number of explicit probes, but a value larger than the OS-provided guard will leave your code vulnerable to stack clash style attacks ๐ญ so like, be careful.stack-clash-protection-probe-intervalโ stack clash protection probes stack space as it's allocated. This param controls the max distance between probes into the stack as 2 raised to num bytes. Higher values may reduce the number of explicit probes, but again โ a value larger than the OS-provided guard leaves code vulnerable to stack clash style attacks. Same warning, same energy.max-cse-path-lengthโ the max number of basic blocks on a path that CSE considers.max-cse-insnsโ the max number of instructions CSE processes before flushing.ggc-min-expandโ GCC uses a garbage collector to manage its own memory allocation, iconic behaviour honestly. This parameter specifies the minimum percentage by which the garbage collector's heap should be allowed to expand between collections. Tuning this may improve compilation speed; it has no effect on code generation. The default is30% + 70% * (RAM/1GB)with an upper bound of100%whenRAM >= 1GB. Ifgetrlimitis available, the notion of "RAM" is the smallest of actual RAM andRLIMIT_DATAorRLIMIT_AS. If GCC can't calculate RAM on a particular platform, the lower bound of30%is used. And setting this parameter andggc-min-heapsizeto zero causes a full collection to occur at every opportunity โ extremely slow, but it can be useful for debugging ๐ggc-min-heapsizeโ the minimum size of the garbage collector's heap before it even bothers to collect garbage. The first collection happens after the heap expands byggc-min-expand%beyondggc-min-heapsize. Again, tuning this may improve compilation speed, and it has no effect on code generation. The default is the smaller ofRAM/8,RLIMIT_RSS, or a limit that tries to make sureRLIMIT_DATAorRLIMIT_ASare not exceeded โ but with a lower bound of4096(four megabytes) and an upper bound of131072(128 megabytes). If GCC can't calculate RAM on a particular platform, the lower bound is used. Setting this parameter very large effectively disables garbage collection. And setting this parameter andggc-min-expandto zero causes a full collection to occur at every opportunity. Same slow-but-debuggy energy as above ๐ขmax-reload-search-insnsโ the max number of instructions reload should look backward for an equivalent register. Increasing the value means more aggressive optimization, which bumps up compilation time with probably slightly better performance โจmax-cselib-memory-locationsโ the max number of memory locations cselib should take into account. Increasing it means more aggressive optimization, so compilation time goes up with probably slightly better performance.max-sched-ready-insnsโ the max number of instructions ready to be issued that the scheduler should consider at any given time during the first scheduling pass. Increasing this means more thorough searches, which makes compilation time increase with probably, like, little benefit ๐max-sched-region-blocksโ the max number of blocks in a region to be considered for interblock scheduling.max-pipeline-region-blocksโ the max number of blocks in a region to be considered for pipelining in the selective scheduler.max-sched-region-insnsโ the max number of insns in a region to be considered for interblock scheduling.max-pipeline-region-insnsโ the max number of insns in a region to be considered for pipelining in the selective scheduler.min-spec-probโ the minimum probability (in percents) of reaching a source block for interblock speculative scheduling.max-sched-extend-regions-itersโ the max number of iterations through CFG to extend regions. A value of0disables region extensions, periodt.max-sched-insn-conflict-delayโ the max conflict delay for an insn to be considered for speculative motion.sched-spec-prob-cutoffโ the minimal probability of speculation success (in percents), so that speculative insns are scheduled.sched-state-edge-prob-cutoffโ the minimum probability an edge must have for the scheduler to save its state across it.sched-mem-true-dep-costโ the minimal distance (in CPU cycles) between a store and a load targeting the same memory locations.selsched-max-lookaheadโ the max size of the lookahead window of selective scheduling. It's basically a depth of search for available instructions, bestie.selsched-max-sched-timesโ the max number of times an instruction is scheduled during selective scheduling. This is the limit on the number of iterations through which the instruction may be pipelined.selsched-insns-to-renameโ the max number of best instructions in the ready list that get considered for renaming in the selective scheduler.sms-min-scโ the minimum value of stage count that the swing modulo scheduler generates.max-last-value-rtlโ the max size, measured as number of RTLs, that can be recorded in an expression in combiner for a pseudo register as the last known value of that register.max-combine-insnsโ the max number of instructions the RTL combiner tries to combine.integer-share-limitโ small integer constants can share a data structure, which reduces the compiler's memory usage and increases its speed ๐๏ธ. This sets the max value of a shared integer constant.ssp-buffer-sizeโ the minimum size of buffers (i.e. arrays) that receive stack smashing protection when-fstack-protectionis used. This default before Ubuntu 10.10 was"8". Currently it's"4", so more functions end up protected by the stack protector.min-size-for-stack-sharingโ the minimum size of variables taking part in stack slot sharing when not optimizing.max-jump-thread-duplication-stmtsโ the max number of statements allowed in a block that needs to be duplicated when threading jumps.max-fields-for-field-sensitiveโ the max number of fields in a structure treated in a field sensitive manner during pointer analysis.prefetch-latencyโ an estimate of the average number of instructions that get executed before a prefetch finishes. The distance prefetched ahead is proportional to this constant. Heads up: increasing this number may also lead to fewer streams being prefetched (seesimultaneous-prefetches).simultaneous-prefetchesโ the max number of prefetches that can run at the same time.l1-cache-line-sizeโ the size of a cache line in the L1 data cache, in bytes.l1-cache-sizeโ the size of the L1 data cache, in kilobytes.l2-cache-sizeโ the size of the L2 data cache, in kilobytes.prefetch-dynamic-stridesโ whether the loop array prefetch pass should issue software prefetch hints for strides that are non-constant. In some cases this may be beneficial, though the fact that the stride is non-constant may make it hard to predict when there's a clear benefit to issuing these hints. Set it to1if prefetch hints should be issued for non-constant strides. Set it to0if prefetch hints should be issued only for strides that are known to be constant and belowprefetch-minimum-stride.prefetch-minimum-strideโ the minimum constant stride, in bytes, to start using prefetch hints for. If the stride is less than this threshold, prefetch hints will not be issued ๐ธ
...and the vibe check on that whole thing is: this setting is genuinely useful for processors that have hardware prefetchers, because otherwise the hardware prefetchers and the software prefetchers start beefing with each other ๐. So if your hardware prefetchers have a maximum stride they can handle, that's the number you wanna drop here โ it makes the software prefetchers way more useful. โจ
A value of -1 means we don't have a threshold at all, so prefetch hints can be issued for literally any constant stride. ๐ฆ
Real talk though bestie: this setting is only useful for strides that are known and constant. That's the whole vibe. Don't try to make it fetch something chaotic.
loop-interchange-max-num-stmts
The maximum number of stmts in a loop that's allowed to be interchanged. That's it, that's the rule. ๐
loop-interchange-stride-ratio
The minimum ratio between the stride of two loops for interchange to actually be profitable โ like, worth the effort. If it's below this, the compiler's not interested. ๐
min-insn-to-prefetch-ratio
The minimum ratio between the number of instructions and the number of prefetches needed to enable prefetching in a loop. Basically the bar you gotta clear. ๐ฅ
prefetch-min-insn-to-mem-ratio
The minimum ratio between the number of instructions and the number of memory references to enable prefetching in a loop. Same energy, different ratio. โญ
use-canonical-types
Whether the compiler should use the "canonical" type system. Should ALWAYS be 1 โ that's the one that uses a more efficient internal mechanism for comparing types in C++ and Objective-C++. However (and this is the important bit ๐ญ), if bugs in the canonical type system are causing compilation failures, set this value to 0 to disable canonical types. Emergency brake, use only when needed.
switch-conversion-max-branch-ratio
Switch initialization conversion refuses to create arrays that are bigger than switch-conversion-max-branch-ratio times the number of branches in the switch. It just says no. ๐
โโ๏ธ
max-partial-antic-length
Maximum length of the partial antic set computed during the tree partial redundancy elimination optimization (-ftree-pre) when optimizing at -O3 and above. And here's the drama ๐: for some sorts of source code, the enhanced partial redundancy elimination optimization can run away, consuming all of the memory available on the host machine. Yeah. All of it. ๐ญ
This parameter puts a limit on the length of the sets that are computed, which prevents that runaway behavior. Setting a value of 0 for this parameter allows an unlimited set length โ so like, if you enjoy chaos, that's there for you. ๐
rpo-vn-max-loop-depth
Maximum loop depth that is value-numbered optimistically. When the limit hits, the innermost rpo-vn-max-loop-depth loops and the outermost loop in the loop nest are value-numbered optimistically, and the remaining ones are not. Very "some of you get invited to the party" of it. ๐
sccvn-max-alias-queries-per-access
Maximum number of alias-oracle queries we perform when looking for redundancies for loads and stores. If this limit is hit, the search is aborted and the load or store is not considered redundant. FYI the number of queries is algorithmically limited to the number of stores on all paths from the load to the function entry. ๐ฆ
ira-max-loops-num
IRA uses regional register allocation by default. If a function contains more loops than the number given by this parameter, only at most the given number of the most frequently-executed loops form regions for regional register allocation. Popular loops only, sorry. โจ
ira-max-conflict-table-size
Even though IRA uses a sophisticated algorithm to compress the conflict table, that table can still require excessive amounts of memory for huge functions. So: if the conflict table for a function could be more than the size in MB given by this parameter, the register allocator instead uses a faster, simpler, and lower-quality algorithm that doesn't require building a pseudo-register conflict table. Speed over quality, a trade-off arc. ๐
ira-loop-reserved-regs
IRA can be used to evaluate more accurate register pressure in loops for decisions to move loop invariants (see -O3). The number of available registers reserved for some other purposes is given by this parameter. Default of the parameter is the best found from numerous experiments โ so like, they tested. ๐ง
lra-inheritance-ebb-probability-cutoff
LRA tries to reuse values reloaded in registers in subsequent insns. This optimization is called inheritance. EBB is used as a region to do this optimization. The parameter defines a minimal fall-through edge probability in percentage used to add BB to inheritance EBB in LRA. The default value was chosen from numerous runs of SPEC2000 on x86-64. ๐
loop-invariant-max-bbs-in-loop
Loop invariant motion can be very expensive โ both in compilation time and in the amount of needed compile-time memory โ with very large loops. So loops with more basic blocks than this parameter simply won't have loop invariant motion optimization performed on them. Not invited. ๐
loop-max-datarefs-for-datadeps
Building data dependencies is expensive for very large loops. This parameter limits the number of data references in loops that are considered for data dependence analysis. These large loops are not handled by the optimizations using loop data dependencies. ๐ธ
max-vartrack-size
Sets a maximum number of hash table slots to use during variable tracking dataflow analysis of any function. If this limit is exceeded with variable tracking at assignments enabled, analysis for that function is retried without it, after removing all debug insns from the function. If the limit is exceeded even without debug insns, var tracking analysis is completely disabled for the function. Setting the parameter to zero makes it unlimited. ๐ญ
max-vartrack-expr-depth
Sets a maximum number of recursion levels when attempting to map variable names or debug temporaries to value expressions. This trades compilation time for more complete debug information. Set it too low and value expressions that are available and could be represented in debug information may end up not being used; set it higher and the compiler may find more complex debug expressions, but compile time and memory use may grow. Classic trade-off behavior. ๐
max-debug-marker-count
Sets a threshold on the number of debug markers (e.g. begin stmt markers) to avoid complexity explosion at inlining or expanding to RTL. If a function has more such gimple stmts than the set limit, such stmts will be dropped from the inlined copy of a function, and from its RTL expansion. Bye bestie ๐
min-nondebug-insn-uid
Use uids starting at this parameter for nondebug insns. The range below the parameter is reserved exclusively for debug insns created by -fvar-tracking-assignments, but debug insns may get (non-overlapping) uids above it if the reserved range is exhausted. Reserved seating energy. ๐
ipa-sra-ptr-growth-factor
IPA-SRA replaces a pointer to an aggregate with one or more new parameters only when their cumulative size is less or equal to ipa-sra-ptr-growth-factor times the size of the original pointer parameter. Only then. It's giving boundaries. โจ
ipa-sra-max-replacements
Maximum pieces of an aggregate that IPA-SRA tracks. As a consequence, it is also the maximum number of replacements of a formal parameter. Two-for-one info, slay. ๐
sra-max-scalarization-size-Ospeed
sra-max-scalarization-size-Osize
The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to replace scalar parts of aggregates with uses of independent scalar variables. These parameters control the maximum size, in storage units, of aggregate which is considered for replacement when compiling for speed (sra-max-scalarization-size-Ospeed) or size (sra-max-scalarization-size-Osize) respectively. Speed vs. size, the eternal showdown. โญ
sra-max-propagations
The maximum number of artificial accesses that Scalar Replacement of Aggregates (SRA) will track, per one local variable, in order to facilitate copy propagation. Tracking, but make it bounded. ๐ฆ
tm-max-aggregate-size
When making copies of thread-local variables in a transaction, this parameter specifies the size in bytes after which variables are saved with the logging functions as opposed to save/restore code sequence pairs. This option only applies when using -fgnu-tm. ๐ฅ
graphite-max-nb-scop-params
To avoid exponential effects in the Graphite loop transforms, the number of parameters in a Static Control Part (SCoP) is bounded. A value of zero can be used to lift the bound. A variable whose value is unknown at compilation time and defined outside a SCoP is a parameter of the SCoP. Yes, that's the definition, write it down. ๐
loop-block-tile-size
Loop blocking or strip mining transforms, enabled with -floop-block or -floop-strip-mine, strip mine each loop in the loop nest by a given number of iterations. The strip length can be changed using the loop-block-tile-size parameter. Customizable strips, iconic. ๐
ipa-cp-value-list-size
IPA-CP attempts to track all possible values and types passed to a function's parameter in order to propagate them and perform devirtualization. ipa-cp-value-list-size is the maximum number of values and types it stores per one formal parameter of a function. ๐
ipa-cp-eval-threshold
IPA-CP calculates its own score of cloning profitability heuristics and performs those cloning opportunities with scores that exceed ipa-cp-eval-threshold. It's grading itself and only accepting the A's. ๐
ipa-cp-max-recursive-depth
Maximum depth of recursive cloning for self-recursive function. How deep does the recursion go? This deep. ๐
ipa-cp-min-recursive-probability
Recursive cloning only when the probability of call being executed exceeds the parameter. Gotta be likely, or it's not happening. โจ
ipa-cp-recursion-penalty
Percentage penalty the recursive functions will receive when they are evaluated for cloning. Recursion tax, bestie. ๐ญ
ipa-cp-single-call-penalty
Percentage penalty functions containing a single call to another function will receive when they are evaluated for cloning. One call? Penalty. That's just how it is. ๐
ipa-max-agg-items
IPA-CP is also capable to propagate a number of scalar values passed in an aggregate. ipa-max-agg-items controls the maximum number of such values per one parameter. ๐
ipa-cp-loop-hint-bonusโ When IPA-CP figures out that a cloning candidate would make the number of iterations of a loop known, it adds a bonus ofipa-cp-loop-hint-bonusto the profitability score of that candidate. ๐ipa-max-aa-stepsโ During its analysis of function bodies, IPA-CP employs alias analysis to track values pointed to by function parameters. But it doesn't want to spend too much time analyzing huge functions, so after examiningipa-max-aa-stepsstatements that modify memory, it gives up and considers all memory clobbered. ๐ญipa-max-switch-predicate-boundsโ Maximal number of boundary endpoints of case ranges of a switch statement. For a switch that exceeds this limit, IPA-CP will not construct the cloning cost predicate (the thing used to estimate cloning benefit) for the default case of the switch statement. ๐ซipa-max-param-expr-opsโ IPA-CP will analyze a conditional statement that references some function parameter to estimate benefit for cloning upon a certain constant value. But if the number of operations in a parameter expression exceedsipa-max-param-expr-ops, the expression is treated as a complicated one and is not handled by IPA analysis. ๐lto-partitionsโ Specify the desired number of partitions produced during WHOPR compilation. The number of partitions should exceed the number of CPUs used for compilation. ๐lto-min-partitionโ Size of minimal partition for WHOPR (in estimated instructions). This prevents the expense of splitting very small programs into too many partitions. ๐งlto-max-partitionโ Size of max partition for WHOPR (in estimated instructions), to provide an upper bound for the individual size of a partition. Meant to be used only with balanced partitioning. โ๏ธlto-max-streaming-parallelismโ Maximal number of parallel processes used for LTO streaming. ๐cxx-max-namespaces-for-diagnostic-helpโ The maximum number of namespaces to consult for suggestions when C++ name lookup fails for an identifier. ๐sink-frequency-thresholdโ The maximum relative execution frequency (in percents) of the target block relative to a statement's original block to allow statement sinking of a statement. Larger numbers result in more aggressive statement sinking. A small positive adjustment is applied for statements with memory operands, as those are even more profitable to sink. ๐ธmax-stores-to-sinkโ The maximum number of conditional store pairs that can be sunk. Set to0if either vectorization (-ftree-vectorize) or if-conversion (-ftree-loop-if-convert) is disabled. ๐case-values-thresholdโ The smallest number of different values for which it is best to use a jump-table instead of a tree of conditional branches. If the value is0, use the default for the machine. ๐ฏjump-table-max-growth-ratio-for-sizeโ The maximum code size growth ratio when expanding into a jump table (in percent). The parameter is used when optimizing for size. ๐jump-table-max-growth-ratio-for-speedโ The maximum code size growth ratio when expanding into a jump table (in percent). The parameter is used when optimizing for speed. ๐๏ธtree-reassoc-widthโ Set the maximum number of instructions executed in parallel in a reassociated tree. This parameter overrides target dependent heuristics used by default if it has a non-zero value. ๐ฅsched-pressure-algorithmโ Choose between the two available implementations of-fsched-pressure. Algorithm 1 is the original implementation and is the more likely to prevent instructions from being reordered. Algorithm 2 was designed to be a compromise between the relatively conservative approach taken by algorithm 1 and the rather aggressive approach taken by the default scheduler. It relies more heavily on having a regular register file and accurate register pressure classes. Seehaifa-sched.cin the GCC sources for more details. The default choice depends on the target. ๐คทmax-slsr-cand-scanโ Set the maximum number of existing candidates that are considered when seeking a basis for a new straight-line strength reduction candidate. ๐asan-globalsโ Enable buffer overflow detection for global objects. This kind of protection is enabled by default if you are using the-fsanitize=addressoption. To disable global objects protection, use--param asan-globals=0. ๐ก๏ธasan-stackโ Enable buffer overflow detection for stack objects. This kind of protection is enabled by default when using-fsanitize=address. To disable stack protection, use--param asan-stack=0. ๐asan-instrument-readsโ Enable buffer overflow detection for memory reads. This kind of protection is enabled by default when using-fsanitize=address. To disable memory reads protection, use--param asan-instrument-reads=0. ๐asan-instrument-writesโ Enable buffer overflow detection for memory writes. This kind of protection is enabled by default when using-fsanitize=address. To disable memory writes protection, use--param asan-instrument-writes=0. โ๏ธasan-memintrinโ Enable detection for built-in functions. This kind of protection is enabled by default when using-fsanitize=address. To disable built-in functions protection, use--param asan-memintrin=0. ๐งฐasan-use-after-returnโ Enable detection of use-after-return. This kind of protection is enabled by default when using the-fsanitize=addressoption. To disable it, use--param asan-use-after-return=0. ๐ต๏ธ
Note: By default the check is disabled at run time. To enable it, add"detect_stack_use_after_return=1"to the environment variableASAN_OPTIONS.
asan-instrumentation-with-call-thresholdโ If the number of memory accesses in the function being instrumented is greater than or equal to this number, use callbacks instead of inline checks. E.g. to disable inline code, use--param asan-instrumentation-with-call-threshold=0. ๐use-after-scope-direct-emission-thresholdโ If the size of a local variable in bytes is smaller than or equal to this number, directly poison (or unpoison) shadow memory instead of using run-time callbacks. โ ๏ธmax-fsm-thread-path-insnsโ Maximum number of instructions to copy when duplicating blocks on a finite state automaton jump thread path. ๐งตmax-fsm-thread-lengthโ Maximum number of basic blocks on a finite state automaton jump thread path. ๐งฑmax-fsm-thread-pathsโ Maximum number of new jump thread paths to create for a finite state automaton. ๐ค๏ธparloops-chunk-sizeโ Chunk size of omp schedule for loops parallelized by parloops. ๐ฐparloops-scheduleโ Schedule type of omp schedule for loops parallelized by parloops (static,dynamic,guided,auto,runtime). ๐๏ธparloops-min-per-threadโ The minimum number of iterations per thread of an innermost parallelized loop for which the parallelized variant is preferred over the single threaded one. Note that for a parallelized loop nest, the minimum number of iterations of the outermost loop per thread is two. โ๏ธmax-ssa-name-query-depthโ Maximum depth of recursion when querying properties of SSA names in things like fold routines. One level of recursion corresponds to following a use-def chain. ๐hsa-gen-debug-storesโ Enable emission of special debug stores within HSA kernels which are then read and reported by the libgomp plugin. Generation of these stores is disabled by default; use--param hsa-gen-debug-stores=1to enable it. ๐max-speculative-devirt-maydefsโ The maximum number of may-defs we analyze when looking for a must-def specifying the dynamic type of an object that invokes a virtual call we may be able to devirtualize speculatively. ๐ต๏ธโโ๏ธmax-vrp-switch-assertionsโ The maximum number of assertions to add along the default edge of a switch statement during VRP. ๐unroll-jam-min-percentโ The minimum percentage of memory references that must be optimized away for the unroll-and-jam transformation to be considered profitable. ๐ฐunroll-jam-max-unrollโ The maximum number of times the outer loop should be unrolled by the unroll-and-jam transformation. ๐max-rtl-if-conversion-unpredictable-costโ Maximum permissible cost for the sequence that would be generated by the RTL if-conversion pass for a branch that is considered unpredictable. ๐ฒmax-variable-expansions-in-unrollerโ If-fvariable-expansion-in-unrolleris used, the maximum number of times that an individual variable will be expanded during loop unrolling. ๐tracer-min-branch-probability-feedbackโ Stop forward growth if the probability of the best edge is less than this threshold (in percent). Used when profile feedback is available. ๐partial-inlining-entry-probabilityโ Maximum probability of the entry BB of a split region (in percent relative to entry BB of the function) to make partial inlining happen. ๐ฏmax-tracked-strlensโ Maximum number of strings for which the strlen optimization pass will track string lengths. ๐งตgcse-after-reload-partial-fractionโ The threshold ratio for performing partial redundancy elimination after reload. โป๏ธgcse-after-reload-critical-fractionโ The threshold ratio of critical edges execution count that permit performing redundancy elimination after reload. ๐max-loop-header-insnsโ The maximum number of insns in loop header duplicated by the copy loop headers pass. ๐งฌvect-epilogues-nomaskโ Enable loop epilogue vectorization using smaller vector size. ๐งฉslp-max-insns-in-bbโ Maximum number of instructions in basic block to be considered for SLP vectorization. ๐ฆavoid-fma-max-bitsโ Maximum number of bits for which we avoid creating FMAs. ๐ซsms-loop-average-count-thresholdโ the threshold on the average loop count that the swing modulo scheduler is willing to look at.sms-dfa-historyโ how many cycles the swing modulo scheduler peeks at when it's checking conflicts using DFA.max-inline-insns-recursive-autoโ the max number of instructions a non-inline function is allowed to balloon to via recursive inlining.graphite-allow-codegen-errorsโ whether codegen errors should be ICEs when-fcheckingis on.sms-max-ii-factorโ a factor for tuning the upper bound that the swing modulo scheduler uses when scheduling a loop.lra-max-considered-reload-pseudosโ the max number of reload pseudos that get considered while spilling a non-reload pseudo.max-pow-sqrt-depthโ the maximum depth of sqrt chains to use when synthesizing exponentiation by a real constant.max-dse-active-local-storesโ the maximum number of active local stores in RTL dead store elimination.asan-instrument-allocasโ enable asan allocas/VLAs protection.max-iterations-computation-costโ bound on the cost of an expression used to compute the number of iterations.max-isl-operationsโ maximum number of isl operations, and0means unlimited.graphite-max-arrays-per-scopโ maximum number of arrays per scop.max-vartrack-reverse-op-sizeโ max size of the loc list for which reverse ops should be added.tracer-dynamic-coverage-feedbackโ the percentage of a function, weighted by execution frequency, that must be covered by trace formation. Used when profile feedback is available.max-inline-recursive-depth-autoโ the maximum depth of recursive inlining for non-inline functions.fsm-scale-path-stmtsโ the scale factor to apply to the number of statements in a threading path when comparing against the number of (scaled) blocks.fsm-maximum-phi-argumentsโ the maximum number of arguments a PHI may have before the FSM threader will not try to thread through its block.uninit-control-dep-attemptsโ the maximum number of nested calls to search for control dependencies during uninitialized variable analysis.sra-max-scalarization-size-Osizeโ the maximum size, in storage units, of an aggregate that should be considered for scalarization when compiling for size.fsm-scale-path-blocksโ the scale factor to apply to the number of blocks in a threading path when comparing against the number of (scaled) statements.sched-autopref-queue-depthโ a hardware autoprefetcher scheduler model control flag. It's the number of lookahead cycles the model looks into; at' 'only enable the instruction sorting heuristic.loop-versioning-max-inner-insnsโ the maximum number of instructions an inner loop can have before the loop versioning pass decides it's too big to copy.loop-versioning-max-outer-insnsโ the maximum number of instructions an outer loop can have before the loop versioning pass decides it's too big to copy, discounting any instructions in inner loops that directly benefit from versioning.ssa-name-def-chain-limitโ the maximum number ofSSA_NAMEassignments to follow when determining a property of a variable, like its value. This caps the number of iterations or recursive calls GCC performs when optimizing certain statements, or when figuring out their validity before it goes and issues diagnostics.store-merging-max-sizeโ maximum size of a single store merging region, in bytes.hash-table-verification-limitโ the number of elements for which hash table verification is done for each searched element.max-find-base-term-valuesโ maximum number of VALUEs handled during a singlefind_base_termcall.analyzer-max-enodes-per-program-pointโ the maximum number of exploded nodes per program point within the analyzer, before it terminates analysis of that point.analyzer-min-snodes-for-call-summaryโ the minimum number of supernodes within a function for the analyzer to consider summarizing its effects at call sites.analyzer-max-recursion-depthโ the maximum number of times a callsite can show up in a call stack within the analyzer, before it terminates analysis of a call that would recurse deeper.gimple-fe-computed-hot-bb-thresholdโ the number of executions of a basic block that makes it count as hot. This parameter is used only in GIMPLE FE.analyzer-bb-explosion-factorโ the maximum number of 'after supernode' exploded nodes within the analyzer per supernode, before terminating analysis.
The following choices of name are available on AArch64 targets: ๐ฆ
aarch64-sve-compare-costsโ when vectorizing for SVE, consider using "unpacked" vectors for smaller elements and use the cost model to pick the cheapest approach. Also use the cost model to choose between SVE and Advanced SIMD vectorization.
Using unpacked vectors includes storing smaller elements in larger containers, plus accessing elements with extending loads and truncating stores. ๐
aarch64-float-recp-precisionโ the number of Newton iterations for calculating the reciprocal forfloattype. The precision of division is proportional to this param when division approximation is enabled. The default value is1.aarch64-double-recp-precisionโ the number of Newton iterations for calculating the reciprocal fordoubletype. The precision of division is proportional to this param when division approximation is enabled. The default value is2.aarch64-autovec-preferenceโ force an ISA selection strategy for auto-vectorization. Accepts values from0to4, inclusive.0โ use the default heuristics.1โ use only Advanced SIMD for auto-vectorization.2โ use only SVE for auto-vectorization.3โ use both Advanced SIMD and SVE. Prefer Advanced SIMD when the costs are deemed equal.4โ use both Advanced SIMD and SVE. Prefer SVE when the costs are deemed equal.
The default value is 0.
๐ Program Instrumentation Options ๐
Okay bestie, this whole section is about GCC sneaking extra code into the stuff it generates so you can watch it run. โจ
GCC supports a bunch of command-line options that control adding run-time instrumentation to the code it normally generates. Like, one reason you'd do this is to collect profiling statistics so you can find program hot spots, do code coverage analysis, or run profile-guided optimizations. ๐
Another class of program instrumentation is adding run-time checking to catch programming errors โ think invalid pointer dereferences or out-of-bounds array accesses โ plus deliberately hostile attacks like stack smashing or C++ vtable hijacking. ๐ค Not today, attacker.
There's also a general hook that can be used to implement other forms of tracing or function-level instrumentation, for debug or program analysis purposes. Very main character of it.
-p,-pgโ generate extra code to write profile information suitable for the analysis programprof(that's for-p) orgprof(that's for-pg). You must use this option when compiling the source files you want data about, and you must also use it when linking. โจ
You can use the function 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. That 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 one is explicitly specified and it is not the final executable โ otherwise it's the basename of the source file. In both cases any suffix is removed (e.g. foo.gcda for input file dir/foo.c, or dir/foo.gcda for output file specified as -o dir/foo.o).
--coverageโ this option is used to compile and link code instrumented for coverage analysis. It's a synonym for-fprofile-arcs -ftest-coverage(when compiling) and-lgcov(when linking). See the documentation for those options for more details. ๐- Compile the source files with
-fprofile-arcsplus optimization and code generation options. For test coverage analysis, use the additional-ftest-coverageoption. You do not need to profile every source file in a program. - Compile the source files additionally with
-fprofile-abs-pathto create absolute path names in the.gcnofiles. This letsgcovfind the correct sources in projects where compilations 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. ๐ง - For profile-directed optimizations, compile the source files again with the same optimization and code generation options plus
-fbranch-probabilities. - For test coverage analysis, use
gcovto produce human readable information from the.gcnoand.gcdafiles. Refer to thegcovdocumentation for further information.
- Compile the source files with
okay so with -fprofile-arcs, for every single function in your program GCC builds a program flow graph, and then it finds a spanning tree for that graph. The way this works: only the arcs that are not on the spanning tree actually need to be instrumented โ so the compiler sprinkles in code that counts how many times those arcs get executed. โจ And when an arc happens to be the only exit or the only entrance to a block, the instrumentation code can just vibe inside that block. Otherwise? A whole new basic block has to be created just to hold the instrumentation code. no cap. ๐
-ftest-coverageโ this one produces a notes file that thegcovcode-coverage utility can use to show off your program's coverage. Each source file gets its own note file, and it's calledauxname.gcno. Bestie, if you wanna know whatauxnameeven means, scroll up to the-fprofile-arcsoption above โ it explainsauxnameand walks you through generating test coverage data. ๐ซถ Also important: your coverage data matches your source files way more closely if you don't optimize. fr fr.-fprofile-abs-pathโ automatically converts relative source file names into absolute path names inside the.gcnofiles. Why do we care? Because it letsgcovfind the correct sources in projects where the compilations happen with different working directories. iconic behavior honestly. ๐ธ-fprofile-dir=pathโ sets the directory to search for the profile data files to path. Heads up though: this option only affects the profile data generated by-fprofile-generate,-ftest-coverage,-fprofile-arcs, and the data used by-fprofile-useand-fbranch-probabilitiesand its related options. Both absolute and relative paths are allowed. By default, GCC uses the current directory as path, so the profile data file just shows up in the same directory as the object file. And to prevent the file name from clashing, if the object file name isn't an absolute path, we mangle the absolute path of thesourcename.gcdafile and use that as the file name of a.gcdafile. There's a similar option too:-fprofile-note. ๐
When an executable is run in a massive parallel environment, it's recommended to save the profile to different folders. You can do that with variables in path that get exported during run-time:
%pโ process ID. ๐%q{VAR}โ value of environment variableVAR.
-fprofile-generate-fprofile-generate=pathโ enables the options that are usually used for instrumenting an application so it produces a profile that's useful for later recompilation with profile-feedback-based optimization. Bestie, you must use-fprofile-generateboth when compiling and when linking your program, okay? Both times. ๐
The following options get 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.
And when you want to optimize the program based on all that collected profile info, you use -fprofile-use. ๐
-fprofile-note=pathโ if path is specified, GCC saves the.gcnofile into the path location. But watch out: if you combine this option with multiple source files, the.gcnofile will be overwritten. ๐ญ-fprofile-prefix-path=pathโ this one can be used together withprofile-generate=profile_dirandprofile-use=profile_dirto inform GCC where the base directory of the built source tree is. By default,profile_dircontains files with mangled absolute paths of all object files in the built project. That's 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 those setups, you use-fprofile-prefix-path=pathwith path pointing to the base directory of the build, and it strips the irrelevant part of the path and keeps all file names relative to the main build directory. ๐ง-fprofile-update=methodโ alters the update method for an application instrumented for profile-feedback-based optimization. The method argument should be one ofsingle,atomic, orprefer-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 doesn't properly join all its threads (or creates a detached thread), the profile file can still be corrupted. ๐
Using prefer-atomic gets transformed either into atomic, when it's supported by a target, or into single otherwise. And the GCC driver automatically selects prefer-atomic when -pthread is present in the command line. โจ
-fprofile-filter-files=regexโ instruments only the functions from files where the names match any regular expression (separated by a semi-colon).
For example, -fprofile-filter-files=main.c;module.*.c will instrument only main.c and all C files starting with 'module'. ๐
-fprofile-exclude-files=regexโ instruments only the functions from files where the names do not match all the regular expressions (separated by a semi-colon).
For example, -fprofile-exclude-files=/usr/* will prevent instrumentation of all files that are located in the /usr/ folder. ๐ซ
-fprofile-reproducible=[multithreaded|parallel-runs|serial]โ controls the level of reproducibility of the profile gathered by-fprofile-generate. This makes it possible to rebuild the program with the same outcome, which is useful for, like, distribution packages. ๐ฆ
With -fprofile-reproducible=serial, the profile gathered by -fprofile-generate is reproducible provided the trained program behaves the same at each invocation of the train run, it'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 the fork function is invoked.
Also note that it's pretty common for execution counts of some part of programs to depend on stuff like the length of temporary file names or memory space randomization (which can affect hash-table collision rate). Such non-reproducible parts of programs can be annotated with the no_instrument_function function attribute. And gcov-dump with -l can be used to dump the gathered data and verify that it's actually reproducible. ๐
With -fprofile-reproducible=parallel-runs, the collected profile stays reproducible regardless of the order the data is streamed into the gcda files. This setting makes it possible to run multiple instances of the instrumented program in parallel (like with make -j). It does reduce the quality of the gathered data though โ especially of indirect call profiling. ๐
-fsanitize=addressโ enables AddressSanitizer, a fast memory error detector. Memory access instructions get instrumented so it can detect out-of-bounds and use-after-free bugs. This option enables-fsanitize-address-use-after-scope. Seehttps://github.com/google/sanitizers/wiki/AddressSanitizerfor more details. The run-time behavior can be influenced using theASAN_OPTIONSenvironment variable. When it's set tohelp=1, the available options are shown at startup of the instrumented program. Seehttps://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flagsfor a list of supported options. And bestie, this option cannot be combined with-fsanitize=thread. ๐ค-fsanitize=kernel-addressโ enables AddressSanitizer for the Linux kernel. Seehttps://github.com/google/kasan/wikifor more details. ๐ง-fsanitize=pointer-compareโ instruments comparison operations (<,<=,>,>=) with pointer operands. This option must be combined with either-fsanitize=kernel-addressor-fsanitize=address. And it cannot be combined with-fsanitize=thread. Note: by default the check is disabled at run time. To enable it, adddetect_invalid_pointer_pairs=2to the environment variableASAN_OPTIONS. Usingdetect_invalid_pointer_pairs=1detects the invalid operation only when both pointers are non-null. ๐-fsanitize=pointer-subtractโ instruments subtraction with pointer operands. This option must be combined with either-fsanitize=kernel-addressor-fsanitize=address. And it cannot be combined with-fsanitize=thread. Note: by default the check is disabled at run time. To enable it, adddetect_invalid_pointer_pairs=2to the environment variableASAN_OPTIONS. Usingdetect_invalid_pointer_pairs=1detects the invalid operation only when both pointers are non-null. ๐-fsanitize=threadโ enables ThreadSanitizer, a fast data race detector. Memory access instructions get instrumented to detect data race bugs. Seehttps://github.com/google/sanitizers/wiki#threadsanitizerfor more details. The run-time behavior can be influenced using theTSAN_OPTIONSenvironment variable; seehttps://github.com/google/sanitizers/wiki/ThreadSanitizerFlagsfor a list of supported options. And nope โ this option cannot be combined with-fsanitize=addressor-fsanitize=leak. ๐
Also note that sanitized atomic builtins cannot throw exceptions when operating on invalid memory addresses with non-call exceptions (-fnon-call-exceptions). ๐ธ
-fsanitize=leakโ enables LeakSanitizer, a memory leak detector. This option only matters for linking of executables, and the executable gets linked against a library that overridesmallocand other allocator functions. Seehttps://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizerfor more details. The run-time behavior can be influenced using theLSAN_OPTIONSenvironment variable. And this option cannot be combined with-fsanitize=thread. ๐ง-fsanitize=undefinedโ enables UndefinedBehaviorSanitizer, a fast undefined behavior detector. Various computations get instrumented so undefined behavior is detected at runtime. Seehttps://clang.llvm.org/docs/UndefinedBehaviorSanitizer.htmlfor 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 counts as undefined differs slightly between C and C++, and also 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โ okay so if the second arg of a shift is actually in range, this checks that the result of the shift isn't undefined ๐. Heads up bestie: what counts as "undefined" here is lowkey different between C and C++, and also between ISO C90 and C99, etc. etc. โ it's giving "it depends" ๐ .-fsanitize=integer-divide-by-zeroโ catches integer division by zero, and also the iconicINT_MIN / -1division ๐. Not me dividing by zero, fr fr.-fsanitize=unreachableโ with this on, the compiler turns the__builtin_unreachablecall into a diagnostics message call instead ๐ข. And likeโฆ when you actually reach that__builtin_unreachablecall, the behavior is undefined. So yeah, it's a โจvibeโจ but not a safe one.-fsanitize=vla-boundโ tells the compiler to check that the size of a variable length array is positive ๐ข. Positive size or bust.-fsanitize=nullโ pointer checking time ๐ซถ. Specifically: an app built with this on will throw an error message when it tries to dereference a NULL pointer, or if a reference (possibly an rvalue reference) gets bound to a NULL pointer, or if a method gets invoked on an object pointed to by a NULL pointer. NULL said not today ๐ซ.-fsanitize=returnโ return statement checking, bestie ๐. Programs built with this on will issue an error message when the end of a non-void function is reached without actually returning a value. Note: this one works in C++ only. Sorry C girlies ๐ญ.-fsanitize=signed-integer-overflowโ signed integer overflow checking, periodt ๐ฅ. We check that the result of+,*, and both unary and binary-doesn't overflow in signed arithmetics. But lowkey โ integer promotion rules must be taken into account. So the following is not an overflow, okay?
signed char a = SCHAR_MAX;
a++;
Like the promotion said "let her cook" ๐งโ๐ณ.
-fsanitize=boundsโ instruments array bounds ๐. Various out-of-bounds accesses get detected. BUT: flexible array members, flexible array member-like arrays, and initializers of variables with static storage are not instrumented. So, partial coverage, we move.-fsanitize=bounds-strictโ the โจstrictโจ version of array bounds instrumentation ๐. Most out-of-bounds accesses get detected, including flexible array members and flexible array member-like arrays. Still not instrumented though: initializers of variables with static storage. She does more, but not everything ๐ .-fsanitize=alignmentโ checks pointer alignment when they're dereferenced ๐, or when a reference gets bound to an insufficiently aligned target, or when a method or constructor is invoked on an insufficiently aligned object. Alignment queen stays aligned โจ.-fsanitize=object-sizeโ instruments memory references using the__builtin_object_sizefunction ๐. Various out-of-bounds pointer accesses get detected. It's giving "how big even is that" ๐ญ.-fsanitize=float-divide-by-zeroโ detects floating-point division by zero ๐. And unlike other similar options,-fsanitize=float-divide-by-zerois not enabled by-fsanitize=undefined, because floating-point division by zero can legitimately be how you obtain infinities and NaNs. So she's special like that, no cap.-fsanitize=float-cast-overflowโ enables floating-point type to integer conversion checking ๐. We check that the result of the conversion doesn't overflow. And again, unlike other similar options,-fsanitize=float-cast-overflowis not enabled by-fsanitize=undefined. Also this option does not work well withFE_INVALIDexceptions enabled ๐ โ noted, bestie.-fsanitize=nonnull-attributeโ instruments calls, checking whether null values aren't being passed to arguments marked as requiring a non-null value by thenonnullfunction attribute ๐ซ. The attribute said non-null, so act like it.-fsanitize=returns-nonnull-attributeโ instruments return statements in functions marked with thereturns_nonnullfunction attribute, to detect returning null values from such functions ๐ . You promised non-null, you return non-null, it's called integrity.-fsanitize=boolโ instruments loads frombool๐. If a value other than0/1gets loaded, a run-time error is issued. Binary or nothing, fr.-fsanitize=enumโ instruments loads from an enum type ๐ธ. If a value outside the range of values for the enum type gets loaded, a run-time error is issued. Stay in your enum lane.-fsanitize=vptrโ instruments C++ member function calls, member accesses and some conversions between pointers to base and derived classes, to verify the referenced object has the correct dynamic type ๐ง. C++ girlies, this one's for you.-fsanitize=pointer-overflowโ instruments pointer arithmetics ๐. If the pointer arithmetics overflows, a run-time error is issued. Pointers doing too much, caught in 4K.-fsanitize=builtinโ instruments arguments to selected builtin functions ๐ ๏ธ. If an invalid value is passed to such arguments, a run-time error is issued. E.g. passing0as the argument to__builtin_ctzor__builtin_clzinvokes undefined behavior and is diagnosed by this option ๐.
And okay, real talk about the difference here: 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. Periodt.
-fno-sanitize=allโ disables all previously enabled sanitizers ๐งน. And just so you know:-fsanitize=allis not allowed, because some sanitizers literally cannot be used together ๐ฅ. So don't try it, bestie.-fasan-shadow-offset=numberโ forces GCC to use a custom shadow offset in AddressSanitizer checks ๐ถ๏ธ. It's useful for experimenting with different shadow memory layouts in Kernel AddressSanitizer. Experimental queen.-fsanitize-sections=s1,s2,...โ sanitize global variables in selected user-defined sections ๐. Note thatsimay contain wildcards. Pick your sections, girl.-fsanitize-recover[=opts]โ okay this one controls error recovery mode for the sanitizers mentioned in the comma-separated list ofopts๐ . Enabling this for a sanitizer component makes it attempt to keep running the program as if no error happened. That means multiple runtime errors can be reported in a single program run, and the exit code of the program may indicate success even when errors have been reported ๐ญ. The-fno-sanitize-recover=option can be used to alter this behavior: only the first detected error is reported and the program then exits with a non-zero exit code.
Currently this feature only works for -fsanitize=undefined (and its suboptions except for -fsanitize=unreachable and -fsanitize=return), -fsanitize=float-cast-overflow, -fsanitize=float-divide-by-zero, -fsanitize=bounds-strict, -fsanitize=kernel-address and -fsanitize=address. For these sanitizers error recovery is turned on by default, except -fsanitize=address, for which this feature is experimental ๐งช. Both -fsanitize-recover=all and -fno-sanitize-recover=all are also accepted โ the former enables recovery for all sanitizers that support it, the latter disables recovery for all sanitizers that support it.
And like, even if recovery mode is turned on the compiler side, it also needs to be enabled on the runtime library side, otherwise the failures are still fatal ๐. The runtime library defaults to halt_on_error=0 for ThreadSanitizer and UndefinedBehaviorSanitizer, while the default value for AddressSanitizer is halt_on_error=1. 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 ๐. The option sets-fstack-reusetonone. Scope said stay in your lane.-fsanitize-undefined-trap-on-errorโ instructs the compiler to report undefined behavior using__builtin_traprather than alibubsanlibrary routine ๐ชค. The advantage of this? Thelibubsanlibrary is not needed and is not linked in, so this is usable even in freestanding environments. Fancy and self-sufficient, we love ๐.-fsanitize-coverage=trace-pcโ enables coverage-guided fuzzing code instrumentation ๐ฏ. Inserts a call to__sanitizer_cov_trace_pcinto every basic block.-fsanitize-coverage=trace-cmpโ enables dataflow guided fuzzing code instrumentation ๐. Inserts a call to__sanitizer_cov_trace_cmp1,__sanitizer_cov_trace_cmp2,__sanitizer_cov_trace_cmp4or__sanitizer_cov_trace_cmp8for integral comparison with both operands variable, or__sanitizer_cov_trace_const_cmp1,__sanitizer_cov_trace_const_cmp2,__sanitizer_cov_trace_const_cmp4or__sanitizer_cov_trace_const_cmp8for integral comparison with one operand constant, plus__sanitizer_cov_trace_cmpfor__sanitizer_cov_trace_cmpdfor float or double comparisons, and__sanitizer_cov_trace_switchfor switch statements. Whew, that was a mouthful, but every single one matters ๐ซถ.-fcf-protection=[full|branch|return|none|check]โ enables code instrumentation of control-flow transfers to increase program security by checking that target addresses of control-flow transfer instructions (like indirect function call, function return, indirect jump) are valid ๐. This prevents diverting the flow of control to an unexpected target. It's intended to protect against threats like Return-oriented Programming (ROP), and similarly call/jmp-oriented programming (COP/JOP). Security queen stays safe ๐ .
The value branch tells the compiler to implement checking of validity of control-flow transfer at the point of indirect branch instructions, i.e. call/jmp instructions. The value return implements checking of validity at the point of returning from a function. The value full is an alias for specifying both branch and return. The value none turns off instrumentation ๐ซ.
The value check is used for the final link with link-time optimization (LTO) ๐. An error is issued if LTO object files are compiled with different -fcf-protection values. The value check is ignored at the compile time. Noted, bestie ๐.
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. Bit math, but make it cute ๐ธ.
okay so you can ALSO use the "nocf_check" attribute to flag exactly which functions and calls should be skipped from instrumentation ๐
like you're literally hand-picking who gets the vibe check.
Currently the x86 GNU/Linux target ships an implementation based on Intel Control-flow Enforcement Technology (CET), and it works for i686 processor or newer ๐ง
โ ๏ธ NOTE: In Ubuntu 19.10 and later versions,-fcf-protectionis enabled by default for C, C++, ObjC, ObjC++, if none of-fno-cf-protectionnor-fcf-protection=*are found. so bestie if you didn't ask for it, it's still showing up ๐ญ
-fstack-protectorโ emits extra code to check for buffer overflows, like stack smashing attacks ๐ the way it works is by adding a guard variable to functions with vulnerable objects. this includes functions that call"alloca", plus functions with buffers larger than or equal to 8 bytes. the guards get initialized when a function is entered and then checked when the function exits ๐ซถ and if a guard check fails? an error message is printed and the program exits, periodt. only variables that are actually allocated on the stack are considered โ optimized away variables or variables allocated in registers don't count, so don't come for them โจ-fstack-protector-allโ like-fstack-protectorexcept that all functions are protected ๐ no favorites, everyone gets a guard.-fstack-protector-strongโ like-fstack-protectorbut it includes additional functions to be protected โ those that have local array definitions, or have references to local frame addresses ๐ธ only variables that are actually allocated on the stack are considered, optimized away variables or variables allocated in registers don't count. same rules, more coverage ๐-fstack-protector-explicitโ like-fstack-protectorbut it only protects those functions which have the"stack_protect"attribute. invite-only energy fr fr.-fstack-checkโ generates code to verify that you do not go beyond the boundary of the stack ๐ง you should specify this flag if you're running in an environment with multiple threads, but you only rarely need it in a single-threaded environment, since stack overflow is automatically detected on nearly all systems if there is only one stack.
Note that this switch does not actually cause checking to be done โ the operating system or the language runtime must do that. the switch causes generation of code to ensure that they see the stack being extended ๐
You can additionally specify a string parameter:
nomeans no checkinggenericmeans force the use of old-style checkingspecificmeans use the best checking method and is equivalent to bare-fstack-check
Old-style checking is a generic mechanism that requires no specific target support in the compiler, but bestie, it comes with drawbacks:
- Modified allocation strategy for large objects: they are 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 is topped by a particular function, stack checking is not reliable and a warning is issued by the compiler.
- Inefficiency: because of both the modified allocation strategy and the generic implementation, code performance is hampered. ๐
Note that old-style stack checking is also the fallback method for specific if no target support has been added in the compiler.
-fstack-check= is designed for Ada's needs to detect infinite recursion and stack overflows. specific is an excellent choice when compiling Ada code ๐ it is not generally sufficient to protect against stack-clash attacks though. to protect against those you want -fstack-clash-protection.
-fstack-clash-protectionโ generates code to prevent stack clash style attacks ๐ก๏ธ when this option is enabled, the compiler will only allocate one page of stack space at a time and each page is accessed immediately after allocation. thus, it prevents allocations from jumping over any stack guard page provided by the operating system. no sneaking past, no cap.
Most targets do not fully support stack clash protection ๐ however, on those targets -fstack-clash-protection will protect dynamic stack allocations. -fstack-clash-protection may also provide limited protection for static stack allocations if the target supports -fstack-check=specific.
โ ๏ธ NOTE: In Ubuntu 19.10 and later versions,-fstack-clash-protectionis enabled by default for C, C++, ObjC, ObjC++, unless-fno-stack-clash-protectionis found. it's giving "on by default, sorry not sorry" ๐
-fstack-limit-register=reg,-fstack-limit-symbol=sym,-fno-stack-limitโ generate code to ensure that the stack does not grow beyond a certain value, either the value of a register or the address of a symbol ๐ if a larger stack is required, a signal is raised at run time. for most targets, the signal is raised before the stack overruns the boundary, so it is 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, as it is no longer necessary to calculate a good stack size to use for each thread ๐ this is currently only implemented for the x86 targets running GNU/Linux.
When code compiled with -fsplit-stack calls code compiled without -fsplit-stack, there may not be much stack space available for the latter code to run ๐ฌ if compiling all code, including library code, with -fsplit-stack is not an option, then the linker can fix up these calls so that the code compiled without -fsplit-stack always has a large stack. Support for this is implemented in the gold linker in GNU binutils release 2.21 and later ๐
-fvtable-verify=[std|preinit|none]โ this option is only available when compiling C++ code ๐ it turns on (or off, if using-fvtable-verify=none) the security feature that verifies at run time, for every virtual call, that the vtable pointer through which the call is made is valid for the type of the object, and has not been corrupted or overwritten ๐ if an invalid vtable pointer is detected at run time, an error is reported and execution of the program is immediately halted. no second chances, it's done.
This option causes run-time data structures to be built at program startup, which are used for verifying the vtable pointers ๐ง the options std and preinit control the timing of when these data structures are built. in both cases the data structures are built before execution reaches "main". using -fvtable-verify=std causes the data structures to be built after shared libraries have been loaded and initialized. -fvtable-verify=preinit causes them to be built before shared libraries have been loaded and initialized.
If this option appears multiple times in the command line with different values specified, none takes highest priority over both std and preinit; preinit takes priority over std ๐ the hierarchy is real.
-fvtv-debugโ when used in conjunction with-fvtable-verify=stdor-fvtable-verify=preinit, causes debug versions of the runtime functions for the vtable verification feature to be called ๐ this flag also causes the compiler to log information about which vtable pointers it finds for each class. this information is written to a file namedvtv_set_ptr_data.login the directory named by the environment variableVTV_LOGS_DIRif that is defined, or the current working directory otherwise ๐ธ
โ ๏ธ Note: This feature appends data to the log file. If you want a fresh log file, be sure to delete any existing one. learn from my mistakes bestie ๐ญ
-fvtv-countsโ this is a debugging flag ๐ when used in conjunction with-fvtable-verify=stdor-fvtable-verify=preinit, this causes the compiler to keep track of the total number of virtual calls it encounters and the number of verifications it inserts. it also counts the number of calls to certain run-time library functions that it inserts and logs this information for each compilation unit ๐ the compiler writes this information to a file namedvtv_count_data.login the directory named by the environment variableVTV_LOGS_DIRif that is defined, or the current working directory otherwise. it also counts the size of the vtable pointer sets for each class, and writes this information tovtv_class_set_sizes.login the same directory ๐พ
โ ๏ธ Note: This feature appends data to the log files. To get fresh log files, be sure to delete any existing ones. two logs, two chances to forget ๐
-finstrument-functionsโ generates instrumentation calls for entry and exit to functions โจ just after function entry and just before function exit, the following profiling functions are called with the address of the current function and its call site. (On some platforms,"__builtin_return_address"does not work beyond the current function, so the call site information may not be available to the profiling functions otherwise.)
void __cyg_profile_func_enter (void *this_fn,
void *call_site);
void __cyg_profile_func_exit (void *this_fn,
void *call_site);
The first argument is the address of the start of the current function, which may be looked up exactly in the symbol table ๐
This instrumentation is also done for functions expanded inline in other functions ๐ซถ the profiling calls indicate where, conceptually, the inline function is entered and exited. this means that addressable versions of such functions must be available. if all your uses of a function are expanded inline, this may mean an additional expansion of code size ๐ฌ if you use "extern inline" in your C code, an addressable version of such functions must be provided. (This is normally the case anyway, but if you get lucky and the optimizer always expands the functions inline, you might have gotten away without providing static copies.) living dangerously fr fr ๐
Okay so bestie, here's the tea: a function can be given the attribute no_instrument_function, and when that happens, this instrumentation just... does not get done. ๐
And the way that's actually useful is for the profiling functions listed above, for high-priority interrupt routines, and for literally any function from which the profiling functions can't safely be called (maybe signal handlers โ like, if the profiling routines generate output or allocate memory, that's a whole situation). ๐ญ
-finstrument-functions-exclude-file-list=file,file,...โ this sets the list of functions that are excluded from instrumentation (peep the description of-finstrument-functionsfor the lore). If the file that contains a function definition matches with one of file, then that function is not instrumented. And the match is done on substrings: if the file parameter is a substring of the file name, it's considered to be a match.
For example:
-finstrument-functions-exclude-file-list=/bits/stl,include/sys
excludes any inline function defined in files whose pathnames contain /bits/stl or include/sys. ๐ซถ
If, for some reason, you want to include letter , in one of sym, write ,. For example, -finstrument-functions-exclude-file-list=',,tmp' (note the single quote surrounding the option).
-finstrument-functions-exclude-function-list=sym,sym,...โ this one is similar to-finstrument-functions-exclude-file-list, but this option sets the list of function names to be excluded from instrumentation. The function name to be matched is its user-visible name, such as"vector<int> blah(const vector<int> &)", not the internal mangled name (e.g.,"_Z4blahRSt6vectorIiSaIiEE"). The match is done on substrings: if the sym parameter is a substring of the function name, it's considered to be a match. For C99 and C++ extended identifiers, the function name must be given in UTF-8, not using universal character names.-fpatchable-function-entry=N[,M]โ generate N NOPs right at the beginning of each function, with the function entry point before the Mth NOP. If M is omitted, it defaults to0, so the function entry points to the address just at the first NOP. The NOP instructions reserve extra space which can be used to patch in any desired instrumentation at run time, provided that the code segment is writable. The amount of space is controllable indirectly via the number of NOPs; the NOP instruction used corresponds to the instruction emitted by the internal GCC back-end interface"gen_nop". This behavior is target-specific and may also depend on the architecture variant and/or other compilation options.
For run-time identification, the starting addresses of these areas, which correspond to their respective function entries minus M, are additionally collected in the "__patchable_function_entries" section of the resulting binary.
Note that the value of"__attribute__ ((patchable_function_entry (N,M)))"takes precedence over command-line option-fpatchable-function-entry=N,M. This can be used to increase the area size or to remove it completely on a single function. If"N=0", no pad location is recorded.
The NOP instructions are inserted at---and maybe before, depending on M---the function entry address, even before the prologue. ๐ฅ
๐ธ Options Controlling the Preprocessor ๐ธ
These options control the C preprocessor, which gets run on each C source file before the actual compilation happens. Slay.
If you use the -E option, nothing is done except preprocessing. Some of these options make sense only together with -E because they cause the preprocessor output to be unsuitable for actual compilation. Noted.
In addition to the options listed here, there are a number of options to control search paths for include files documented in Directory Options. Options to control preprocessor diagnostics are listed in Warning Options.
-D nameโ predefine name as a macro, with definition1.-D 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. Shells are dramatic like that. ๐
If you wish to define a function-like macro on the command line, write its argument list with surrounding parentheses before the equals sign (if any). Parentheses are meaningful to most shells, so you should quote the option. With sh and csh, -D'name(args...)=definition' works.
-D and -U options are processed in the order they are given on the command line. All -imacros file and -include file options are processed after all -D and -U options.
-U nameโ cancel any previous definition of name, either built in or provided with a-Doption.-include fileโ process file as if"#include "file""appeared as the first line of the primary source file. However, the first directory searched for file is the preprocessor's working directory instead of the directory containing the main source file. If not found there, it is searched for in the remainder of the"#include "...""search chain as normal.
If multiple -include options are given, the files are included in the order they appear on the command line.
-imacros fileโ exactly like-include, except that any output produced by scanning file is thrown away. Macros it defines remain defined. This allows you to acquire all the macros from a header without also processing its declarations. It's giving efficiency. โจ
All files specified by -imacros are processed before all files specified by -include.
-undefโ do not predefine any system-specific or GCC-specific macros. The standard predefined macros remain defined.-pthreadโ define additional macros required for using the POSIX threads library. You should use this option consistently for both compilation and linking. This option is supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets.-Mโ instead of outputting the result of preprocessing, output a rule suitable formakedescribing the dependencies of the main source file. The preprocessor outputs onemakerule containing the object file name for that source file, a colon, and the names of all the included files, including those coming from-includeor-imacroscommand-line options.
Unless specified explicitly (with -MT or -MQ), the object file name consists of the name of the source file with any suffix replaced with object file suffix and with any leading directory parts removed. If there are many included files then the rule is split into several lines using \-newline. The rule has no commands.
This option does not suppress the preprocessor's debug output, such as -dM. To avoid mixing such debug output with the dependency rules you should explicitly specify the dependency output file with -MF, or use an environment variable like DEPENDENCIES_OUTPUT. Debug output is still sent to the regular output stream as normal.
Passing -M to the driver implies -E, and suppresses warnings with an implicit -w.
-MMโ like-Mbut do not mention header files that are found in system header directories, nor header files that are included, directly or indirectly, from such a header.
This implies that the choice of angle brackets or double quotes in an #include directive does not in itself determine whether that header appears in -MM dependency output.
-MF fileโ when used with-Mor-MM, specifies a file to write the dependencies to. If no-MFswitch is given the preprocessor sends the rules to the same place it would send preprocessed output.
When used with the driver options -MD or -MMD, -MF overrides the default dependency output file.
If file is -, then the dependencies are written to stdout.
-MGโ in conjunction with an option such as-Mrequesting dependency generation,-MGassumes missing header files are generated files and adds them to the dependency list without raising an error. The dependency filename is taken directly from the"#include"directive without prepending any path.-MGalso suppresses preprocessed output, as a missing header file renders this useless.
This feature is used in automatic updating of makefiles.
-MPโ this option instructs CPP to add a phony target for each dependency other than the main file, causing each to depend on nothing. These dummy rules work around errorsmakegives if you remove header files without updating theMakefileto match.
This is typical output:
test.o: test.c test.h
test.h:
-MT targetโ change the target of the rule emitted by dependency generation. By default CPP takes the name of the main input file, deletes any directory components and any file suffix such as.c, and appends the platform's usual object suffix. The result is the target.
An -MT option sets the target to be exactly the string you specify. If you want multiple targets, you can specify them as a single argument to -MT, or use multiple -MT options.
For example, -MT '$(objpfx)foo.o' might give
$(objpfx)foo.o: foo.c
-MQ targetโ same as-MT, but it quotes any characters which are special to Make.-MQ '$(objpfx)foo.o'gives
$$(objpfx)foo.o: foo.c
The default target is automatically quoted, as if it were given with -MQ.
-MDโ-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 used without -E, each -o is understood to specify a target object file.
Since -E is not implied, -MD can be used to generate a dependency output file as a side effect of the compilation process.
-MMDโ like-MDexcept mention only user header files, not system header files. ๐ฆ-fpreprocessedโ bestie, this one is for when your file has already been preprocessed and you're like, we been knew. It suppresses macro expansion, trigraph conversion, escaped newline splicing, and processing of most directives. It still recognizes and removes comments though, so you can pass a file that was preprocessed with-Cto the compiler without any problems. In this mode the integrated preprocessor is little more than a tokenizer for the front ends. Periodt.
-fpreprocessed is implicit if the input file has one of the extensions .i, .ii or .mi. Those are the extensions GCC uses for preprocessed files created by -save-temps.
-fdirectives-onlyโ when preprocessing, handle directives, but do not expand macros. โจ
The option's behavior depends on the -E and -fpreprocessed options, so let's do a vibe check on all three situations:
- With
-E, preprocessing is limited to the handling of directives such as#define,#ifdef, and#error. Other preprocessor operations, such as macro expansion and trigraph conversion, are not performed. Also, 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.
-fdollars-in-identifiersโ accept$in identifiers. Iconic, honestly.-fextended-identifiersโ accept universal character names and extended characters in identifiers. This option is enabled by default for C99 (and later C standard versions) and C++.-fno-canonical-system-headersโ when preprocessing, do not shorten system header paths with canonicalization.- *
-fmax-include-depth=depth* โ sets the maximum depth of the nested#include. The default is200. - *
-ftabstop=width* โ set the distance between tab stops. This helps the preprocessor report correct column numbers in warnings or errors, even if tabs appear on the line. If the value is less than1or greater than100, the option is ignored. The default is8. -ftrack-macro-expansion[=level] โ tracks the locations of tokens across macro expansions. This lets the compiler emit a diagnostic about the current macro expansion stack when a compilation error occurs in a macro expansion. Heads up though: using this option makes the preprocessor and the compiler consume more memory. ๐ญ
The level parameter can be used to choose the level of precision of token location tracking, thus decreasing the memory consumption if necessary:
- Value
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. ๐
- *
-fmacro-prefix-map=old*=new โ when preprocessing files residing in directory old, expand the__FILE__and__BASE_FILE__macros as if the files resided in directory new instead. This can be used to change an absolute path to a relative path by using.for new, which can result in more reproducible builds that are location independent. This option also affects__builtin_FILE()during compilation. See also-ffile-prefix-map. - *
-fexec-charset=charset* โ set the execution character set, used for string and character constants. The default isUTF-8. charset can be any encoding supported by the system'siconvlibrary routine. - *
-fwide-exec-charset=charset* โ set the wide execution character set, used for wide string and character constants. The default is one ofUTF-32BE,UTF-32LE,UTF-16BE, orUTF-16LE, whichever corresponds to the width ofwchar_tand the big-endian or little-endian byte order being used for code generation. As with-fexec-charset, charset can be any encoding supported by the system'siconvlibrary routine; however, you will have problems with encodings that do not fit exactly inwchar_t. ๐ซ - *
-finput-charset=charset* โ set the input character set, used for translation from the character set of the input file to the source character set used by GCC. If the locale does not specify, or GCC cannot get this information from the locale, the default isUTF-8. This can be overridden by either the locale or this command-line option. Currently the command-line option takes precedence if there's a conflict. charset can be any encoding supported by the system'siconvlibrary routine. -fpch-depsโ when using precompiled headers, this flag causes the dependency-output flags to also list the files from the precompiled header's dependencies. If not specified, only the precompiled header is listed and not the files that were used to create it, because those files are not consulted when a precompiled header is used.-fpch-preprocessโ this option allows use of a precompiled header together with-E. It inserts a special#pragma,#pragma GCC pch_preprocess "filename", in the output to mark the place where the precompiled header was found, and its filename. When-fpreprocessedis in use, GCC recognizes this#pragmaand loads the PCH.
This option is off by default, because the resulting preprocessed output is only really suitable as input to GCC. It is switched on by -save-temps.
You should not write this #pragma in your own code, but it is safe to edit the filename if the PCH file is available in a different location. The filename may be absolute or it may be relative to GCC's current directory. ๐
-fworking-directoryโ enable generation of linemarkers in the preprocessor output that let the compiler know the current working directory at the time of preprocessing. When this option is enabled, the preprocessor emits, after the initial linemarker, a second linemarker with the current working directory followed by two slashes. GCC uses this directory, when it's present in the preprocessed input, as the directory emitted as the current working directory in some debugging information formats. This option is implicitly enabled if debugging information is enabled, but this can be inhibited with the negated form-fno-working-directory. If the-Pflag is present in the command line, this option has no effect, since no#linedirectives are emitted whatsoever.- *
-Apredicate*=answer โ make an assertion with the predicate predicate and answer answer. This form is preferred to the older form-Apredicate(answer), which is still supported, because it does not use shell special characters. โจ - *
-A -predicate*=answer โ cancel an assertion with the predicate predicate and answer answer. -Cโ do not discard comments. All comments are passed through to the output file, except for comments in processed directives, which are deleted along with the directive.
Be prepared for side effects when using-C; it causes the preprocessor to treat comments as tokens in their own right. For example, comments appearing at the start of what would be a directive line have the effect of turning that line into an ordinary source line, since the first token on the line is no longer a#.
-CCโ do not discard comments, including during macro expansion. This is like-C, except that comments contained within macros are also passed through to the output file where the macro is expanded.
In addition to the side effects of the -C option, the -CC option causes all C++-style comments inside a macro to be converted to C-style comments. This is to prevent later use of that macro from inadvertently commenting out the remainder of the source line.
The -CC option is generally used to support lint comments.
-Pโ inhibit generation of linemarkers in the output from the preprocessor. This might be useful when running the preprocessor on something that is not C code, and will be sent to a program which might be confused by the linemarkers.-traditional-traditional-cppโ try to imitate the behavior of pre-standard C preprocessors, as opposed to ISO C preprocessors. See the GNU CPP manual for details. ๐ง
Note that GCC does not otherwise attempt to emulate a pre-standard C compiler, and these options are only supported with the -E switch, or when invoking CPP explicitly.
-trigraphsโ support ISO C trigraphs. These are three-character sequences, all starting with??, that are defined by ISO C to stand for single characters. For example,??/stands for\, so'??/n'is a character constant for a newline.
The nine trigraphs and their replacements are
Trigraph: ??( ??) ??< ??> ??= ??/ ??' ??! ??-
Replacement: [ ] { } # \ ^ | ~
By default, GCC ignores trigraphs, but in standard-conforming modes it converts them. See the -std and -ansi options.
-remapโ enable special code to work around file systems which only permit very short file names, such as MS-DOS.-Hโ print the name of each header file used, in addition to other normal activities. Each name is indented to show how deep in the#includestack it is. Precompiled header files are also printed, even if they are found to be invalid; an invalid precompiled header file is printed with...xand a valid one with...!. ๐-dletters โ says to make debugging dumps during compilation as specified by letters. The flags documented here are those relevant to the preprocessor. Other letters are interpreted by the compiler proper, or reserved for future versions of GCC, and so are silently ignored. If you specify letters whose behavior conflicts, the result is undefined. ๐-dMโ instead of the normal output, generate a list of#definedirectives for all the macros defined during the execution of the preprocessor, including predefined macros. This gives you a way of finding out what is 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, then -dM is interpreted as a synonym for -fdump-rtl-mach. yeah. iconic little plot twist, iykyk.
-dDโ like-dMexcept in two respects: it does not include the predefined macros, and it outputs both the#definedirectives and the result of preprocessing. Both kinds of output go to the standard output file.-dNโ like-dD, but emit only the macro names, not their expansions.-dIโ output#includedirectives in addition to the result of preprocessing.-dUโ like-dDexcept that only macros that are expanded, or whose definedness is tested in preprocessor directives, are output; the output is delayed until the use or test of the macro; and#undefdirectives are also output for macros tested but undefined at the time.
-fdebug-cppโ this option is only useful for debugging GCC. When used from CPP or with-E, it dumps debugging information about location maps. Every token in the output is preceded by the dump of the map its location belongs to.
When used from GCC without -E, this option has no effect. ๐
-Wp,optionโ you can use-Wp,optionto bypass the compiler driver and pass option directly through to the preprocessor. If option contains commas, it is split into multiple options at the commas. However, many options are modified, translated or interpreted by the compiler driver before being passed to the preprocessor, and-Wpforcibly bypasses this phase. The preprocessor's direct interface is undocumented and subject to change, so whenever possible you should avoid using-Wpand let the driver handle the options instead.
bestie this is the "i know a shortcut" of compiler flags and it is lowkey a trap ๐
-Xpreprocessoroption โ pass option as an option to the preprocessor. You can use this to supply system-specific preprocessor options that GCC does not recognize.
If you want to pass an option that takes an argument, you must use -Xpreprocessor twice, once for the option and once for the argument.
-no-integrated-cppโ perform preprocessing as a separate pass before compilation. By default, GCC performs preprocessing as an integrated part of input tokenization and parsing. If this option is provided, the appropriate language front end (cc1,cc1plus, orcc1objfor C, C++, and Objective-C, respectively) is instead invoked twice, once for preprocessing only and once for actual compilation of the preprocessed input. This option may be useful in conjunction with the-Bor-wrapperoptions to specify an alternate preprocessor or perform additional processing of the program source between normal preprocessing and compilation.
๐ง Passing Options to the Assembler ๐ง
You can pass options to the assembler. periodt.
-Wa,optionโ pass option as an option to the assembler. If option contains commas, it is split into multiple options at the commas.-Xassembleroption โ pass option as an option to the assembler. You can use this to supply system-specific assembler options that GCC does not recognize.
If you want to pass an option that takes an argument, you must use -Xassembler twice, once for the option and once for the argument.
๐ Options for Linking ๐
These options come into play when the compiler links object files into an executable output file. They are meaningless if the compiler is not doing a link step. like, literally no thoughts head empty if there's no linking happening.
- object-file-name โ a file name that does not end in a special recognized suffix is considered to name an object file or library. (Object files are distinguished from libraries by the linker according to the file contents.) If linking is done, these object files are used as input to the linker.
-c,-S,-Eโ if any of these options is used, then the linker is not run, and object file names should not be used as arguments.-flinker-output=type โ this option controls code generation of the link-time optimizer. By default the linker output is automatically determined by the linker plugin. For debugging the compiler and if incremental linking with a non-LTO object file is desired, it may be useful to control the type manually.
If type is exec, code generation produces a static binary. In this case -fpic and -fpie are both disabled.
If type is dyn, code generation produces a shared library. In this case -fpic or -fPIC is preserved, but not enabled automatically. This allows to build shared libraries without position-independent code on architectures where this is possible, i.e. on x86.
If type is pie, code generation produces an -fpie executable. This results in similar optimizations as exec except that -fpie is not disabled if specified at compilation time.
If type is rel, the compiler assumes that incremental linking is done. The sections containing intermediate code for link-time optimization are merged, pre-optimized, and output to the resulting object file. In addition, if -ffat-lto-objects is specified, binary code is produced for future non-LTO linking. The object file produced by incremental linking is smaller than a static library produced from the same object files. At link time the result of incremental linking also loads faster than a static library assuming that the majority of objects in the library are used.
Finally nolto-rel configures the compiler for incremental linking where code generation is forced, a final binary is produced, and the intermediate code for later link-time optimization is stripped. When multiple object files are linked together the resulting code is better optimized than with link-time optimizations disabled (for example, cross-module inlining happens), but most of benefits of whole program optimizations are lost.
During the incremental link (by -r) the linker plugin defaults to rel. With current interfaces to GNU Binutils it is however not possible to incrementally link LTO objects and non-LTO objects into a single mixed object file. If any of object files in incremental link cannot be used for link-time optimization, the linker plugin issues a warning and uses nolto-rel. To maintain whole program optimization, it is recommended to link such objects into static library instead. Alternatively it is possible to use H.J. Lu's binutils with support for mixed objects.
-fuse-ld=bfdโ use 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.-llibrary,-llibrary โ search the library named library when linking. (The second alternative with the library as a separate argument is only for POSIX compliance and is not recommended.)
The -l option is passed directly to the linker by GCC. Refer to your linker documentation for exact details. The general description below applies to the GNU linker.
The linker searches a standard list of directories for the library. The directories searched include several standard system directories plus any that you specify with -L.
Static libraries are archives of object files, and have file names like liblibrary.a. Some targets also support shared libraries, which typically have names like liblibrary.so. If both static and shared libraries are found, the linker gives preference to linking with the shared library unless the -static option is used.
It makes a difference where in the command you write this option; the linker searches and processes libraries and object files in the order they are specified. Thus, foo.o -lz bar.o searches library z after file foo.o but before bar.o. If bar.o refers to functions in z, those functions may not be loaded.
order matters bestie, it's giving "the way that the linker is just reading left to right and not being psychic" ๐ญ
-lobjcโ you need this special case of the-loption in order to link an Objective-C or Objective-C++ program.-nostartfilesโ do not use the standard system startup files when linking. The standard system libraries are used normally, unless-nostdlib,-nolibc, or-nodefaultlibsis used.-nodefaultlibsโ do not use the standard system libraries when linking. Only the libraries you specify are passed to the linker, and options specifying linkage of the system libraries, such as-static-libgccor-shared-libgcc, are ignored. The standard startup files are used normally, unless-nostartfilesis used.
The compiler may generate calls to memcmp, memset, memcpy and memmove. These entries are usually resolved by entries in libc. These entry points should be supplied through some other mechanism when this option is specified.
-nolibcโ do not use the C library or system libraries tightly coupled with it when linking. Still link with the startup files, libgcc or toolchain provided language support libraries such as libgnat, libgfortran or libstdc++ unless options preventing their inclusion are used as well. This typically removes-lcfrom the link command line, as well as system libraries that normally go with it and become meaningless when absence of a C library is assumed, for example-lpthreador-lmin some configurations. This is intended for bare-board targets when there is indeed no C library available.-nostdlibโ do not use the standard system startup files or libraries when linking. No startup files and only the libraries you specify are passed to the linker, and options specifying linkage of the system libraries, such as-static-libgccor-shared-libgcc, are ignored.
The compiler may generate calls to memcmp, memset, memcpy and memmove. 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.
you're out here raw-dogging the link step fr fr. no safety net, no vibes, just you and the linker ๐ธ
okay so real talk bestie: in most cases you need libgcc.a even when you're actively trying to dodge every other standard library. Translation? When you pass -nostdlib or -nodefaultlibs, you should usually also pass -lgcc. Why? Because otherwise you're left with unresolved references to GCC's own internal library subroutines, and that's not the vibe. (A cute lil example of one of those internal subroutines is "__main", which exists to make sure your C++ constructors actually get called.) ๐
-eentry /--entry=entry โ says "hey, the program's entry point is entry". The linker is the one interpreting that argument, and the GNU linker is chill with either a symbol name or an address. ๐ฆ-pieโ produce a dynamically linked position independent executable on targets that support it. For predictable results, you must also pass the exact same set of options you used for compilation (-fpie,-fPIE, or model suboptions) when you hand this linker option over. No cap. โจ-no-pieโ don't produce a dynamically linked position independent executable. Simple as that. ๐ธ-static-pieโ produce a static position independent executable on targets that support it. It's like a static executable but the glow-up is that it can be loaded at any address with no dynamic linker needed. Same deal as-pie: 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. Supported on GNU/Linux targets, most other Unix derivatives, and also on x86 Cygwin and MinGW targets. Heads up: on some targets this option also sets flags for the preprocessor, so use it consistently for both compilation and linking, okay? ๐ฅ-rโ produce a relocatable object as output. Also known as partial linking, iykyk. ๐-rdynamicโ pass the flag-export-dynamicto the ELF linker, on targets that support it. This tells the linker to add all symbols, not only the used ones, to the dynamic symbol table. You need this for some uses of"dlopen"or to allow obtaining backtraces from within a program. ๐-sโ remove all symbol table and relocation information from the executable. Stripped, clean, iconic. ๐-staticโ on systems that support dynamic linking, this overrides-pieand prevents linking with the shared libraries. On other systems, this option has no effect. โญ-sharedโ produce a shared object which can then be linked with other objects to form an executable. Not all systems support this option. For predictable results, you must also specify the same set of options used for compilation (-fpic,-fPIC, or model suboptions) when you specify this linker option.[1] ๐-shared-libgcc/-static-libgccโ on systems that 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 where an app should use the shared libgcc instead of the static version. The most common one is when the app wants to throw and catch exceptions across different shared libraries. In that case, each of the libraries as well as the application itself should use the shared libgcc.
So the G++ driver automatically adds -shared-libgcc whenever you build a shared library or a main executable, because C++ programs typically use exceptions, so this is the right thing to do. periodt.
If, instead, you use the GCC driver to create shared libraries, you may find that they are not always linked with the shared libgcc. If GCC finds, at its configuration time, that you have a non-GNU linker or a GNU linker that does not support option --eh-frame-hdr, it links the shared version of libgcc into shared libraries by default. Otherwise, it takes advantage of the linker and optimizes away the linking with the shared version of libgcc, linking with the static version of libgcc by default. This allows exceptions to propagate through such shared libraries, without incurring relocation costs at library load time. โจ
However, if a library or main executable is supposed to throw or catch exceptions, you must link it using the G++ driver, or using the option-shared-libgcc, such that it is linked with the sharedlibgcc.
-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-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-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-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โ 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. rip, don't do that.
When using the GNU linker, it is usually more convenient to pass arguments to linker options using the option=value syntax than as separate arguments. For example, you can specify -Xlinker -Map=output.map rather than -Xlinker -Map -Xlinker output.map. Other linkers may not support this syntax for command-line options. ๐
-Wl,option โ pass option as an option to the linker. If option contains commas, it is split into multiple options at the commas. You can use this syntax to pass an argument to the option. For example,-Wl,-Map,output.mappasses-Map output.mapto the linker. When using the GNU linker, you can also get the same effect with-Wl,-Map=output.map.
NOTE: In Ubuntu 8.10 and later versions, forLDFLAGS, the option-Wl,-z,relrois used. To disable, use-Wl,-z,norelro.
-usymbol โ 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. ๐ง-zkeyword โ-zis passed directly on to the linker along with the keyword keyword. See the section in the documentation of your linker for permitted values and their meanings. ๐ฆ
๐ Options for Directory Search ๐
These options specify directories to search for header files, for libraries and for parts of the compiler. so basically: where do we look for your stuff.
-Idir /-iquotedir /-isystemdir /-idirafterdir โ add the directory dir to the list of directories to be searched for header files during preprocessing. If dir begins with=or$SYSROOT, then the=or$SYSROOTis replaced by the sysroot prefix; see--sysrootand-isysroot. โจ
Directories specified with -iquote apply only to the quote form of the directive, #include "file". Directories specified with -I, -isystem, or -idirafter apply to lookup for both the #include "file" and #include <file> directives.
You can specify any number or combination of these options on the command line to search for header files in several directories. The lookup order is as follows:
- For the quote form of the include directive, the directory of the current file is searched first.
- For the quote form of the include directive, the directories 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.
๐ and that's the search order, memorise it bestie, it WILL come up.
You can totally use -I to override a system header file and swap in your own version, since those directories get searched before the standard system header directories. But โ and bestie, listen โ do not use this option to add directories that hold vendor-supplied system header files. That's what -isystem is for, okay? Different tool, different job. ๐
The -isystem and -idirafter options also mark the directory as a system directory, so it gets the exact same special treatment that the standard system directories get. Same energy, same VIP pass. ๐
And here's a lil plot twist: if a standard system include directory, or a directory specified with -isystem, is also specified with -I, then the -I option is ignored. The directory is still searched, bestie, don't panic โ but as a system directory, at its normal position in the system include chain. Why? Because this makes sure GCC's whole procedure for fixing buggy system headers, plus the ordering for the #include_next directive, don't get inadvertently changed. If you really need to change the search order for system directories, use the -nostdinc and/or -isystem options instead. Periodt.
-I-โ Split the include path. ๐จ This option has been deprecated. Please use-iquoteinstead for-Idirectories before the-I-, and remove the-I-option.
Any directories specified with -I options before -I- are searched only for headers requested with #include "file"; they are not searched for #include <file>. If 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". And there is no way to override this effect of -I-. Like, none. It's giving irreversible. ๐ญ
-iprefixprefix โ Specify prefix as the prefix for subsequent-iwithprefixoptions. If the prefix represents a directory, you should include the final/. Don't forget it, babe, it matters. ๐ฆ-iwithprefixdir,-iwithprefixbeforedir โ Append dir to the prefix specified previously with-iprefix, and add the resulting directory to the include search path.-iwithprefixbeforeputs it in the same place-Iwould;-iwithprefixputs it where-idirafterwould. Two sisters, two different seats in the include-search auditorium. ๐-isysrootdir โ This option is like the--sysrootoption, but applies only to header files (except for Darwin targets, where it applies to both header files and libraries). See the--sysrootoption for more information. iykyk. ๐-imultilibdir โ Use dir as a subdirectory of the directory containing target-specific C++ headers. Cute lil nesting situation. ๐-nostdincโ Do not search the standard system directories for header files. Only the directories explicitly specified with-I,-iquote,-isystem, and/or-idirafteroptions (and the directory of the current file, if appropriate) are searched. You're on your own now, bestie. ๐ธ-nostdinc++โ Do not search for header files in the C++-specific standard directories, but do still search the other standard directories. (This option is used when building the C++ library.) Selective exclusion, we love to see it. โจ-iplugindir=dir โ Set the directory to search for plugins that are passed by-fplugin=nameinstead of-fplugin=path/name.so. Heads up though: this option is not meant to be used by the user, but only passed by the driver. So like, not your business, but now you know. ๐-Ldir โ Add directory dir to the list of directories to be searched for-l. Simple. Iconic. Does exactly what it says. ๐-Bprefix โ This option specifies where to find the executables, libraries, include files, and data files of the compiler itself. Big responsibility, honestly.
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. Fallback chain, gorgeous. ๐ฆ
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. Multitasking king. ๐
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. No backup plan after that, bestie. ๐ญ
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. Kludge is literally the word they used, I'm just the messenger. ๐
-no-canonical-prefixesโ Do not expand any symbolic links, resolve references to/../or/./, or make the path absolute when generating a relative prefix. Leave it messy, leave it raw. ๐--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. Relocating the whole vibe. โจ
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. Turning off the extra lil garnish. ๐ธ
โจ Options for Code Generation Conventions โจ
These machine-independent options control the interface conventions used in code generation. Very "the rules of how we speak to each other" energy. ๐ซถ
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. Do the math, babe. ๐
-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. Sneaky lil last-one-standing rules. ๐-fwrapvโ This option instructs the compiler to assume that signed arithmetic overflow of addition, subtraction and multiplication wraps around using twos-complement representation. This flag enables some optimizations and disables others. The options-ftrapvand-fwrapvoverride each other, so using-ftrapv -fwrapvon the command-line results in-fwrapvbeing effective. Note that only active options override, so using-ftrapv -fwrapv -fno-wrapvon the command-line results in-ftrapvbeing effective. Same chaotic override drama, opposite winner. ๐-fwrapv-pointerโ bestie this one is about pointer math going feral ๐ it tells the compiler to just assume that pointer arithmetic overflow on addition and subtraction wraps around using twos-complement representation. Cute, right? But heads up โ this flag disables some optimizations which assume pointer overflow is invalid. So like, you're trading speed for predictability, no cap. ๐ฆ-fstrict-overflowโ okay so this one implies-fno-wrapvand-fno-wrapv-pointer, and when it's negated it implies-fwrapvand-fwrapv-pointer. The way that one option just drags two others along with itโฆ it's giving main character energy ๐-fexceptionsโ turn ON exception handling, slay โจ It generates extra code that's needed to propagate exceptions. For some targets, this means GCC generates frame unwind information for all functions, which can produce significant data size overhead โ though it does not affect execution, so breathe, babe. If you don't specify this option, GCC enables it by default for languages like C++ that normally require exception handling, and disables it for languages like C that don't normally require it. But โ you may need to enable it when compiling C code that needs to interoperate properly with exception handlers written in C++. ๐ You may also wish to disable it if you're compiling older C++ programs that don't use exception handling. Iconic either way fr fr.-fnon-call-exceptionsโ generate code that lets trapping instructions throw exceptions. ๐ Lowkey important: this requires platform-specific runtime support that does not exist everywhere. And more โ 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". no cap, don't try it ๐-fdelete-dead-exceptionsโ the vibe here: instructions that may throw exceptions but don't otherwise contribute to the execution of the program can be optimized away. ๐ This option is enabled by default for the Ada front end, as permitted by the Ada language specification. Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels. so it's a whole layered situation ๐ฆ-funwind-tablesโ similar to-fexceptions, except it just generates any needed static data, but does not affect the generated code in any other way. ๐ธ You normally do not need to enable this option; instead, a language processor that needs this handling enables it on your behalf. So basically, let the language handle it, bestie ๐ซถ-fasynchronous-unwind-tablesโ generate unwind table in DWARF format, if supported by target machine. The table is exact at each instruction boundary, so it can be used for stack unwinding from asynchronous events (such as debugger or garbage collector). โญ precise at every single boundary, obsessed-fno-gnu-uniqueโ okay this one is a whole saga, sit down. ๐ On systems with recent GNU assembler and C library, the C++ compiler uses the"STB_GNU_UNIQUE"binding to make sure that definitions of template static data members and static local variables in inline functions are unique even in the presence of"RTLD_LOCAL"; this is necessary to avoid problems with a library used by two different"RTLD_LOCAL"plugins depending on a definition in one of them and therefore disagreeing with the other one about the binding of the symbol. ๐ญ But this causes"dlclose"to be ignored for affected DSOs; if your program relies on reinitialization of a DSO via"dlclose"and"dlopen", you can use-fno-gnu-unique. there, crisis averted ๐-fpcc-struct-returnโ return"short""struct"and"union"values in memory like longer ones, rather than in registers. This convention is less efficient, but it has the advantage of allowing intercallability between GCC-compiled files and files compiled with other compilers, particularly the Portable C Compiler (pcc). ๐
The precise convention for returning structures in memory depends on the target configuration macros.
Short structures and unions are those whose size and alignment match that of some integer type.
Warning: code compiled with the-fpcc-struct-returnswitch is not binary compatible with code compiled with the-freg-struct-returnswitch. Use it to conform to a non-default application binary interface. ๐
-freg-struct-returnโ return"struct"and"union"values in registers when possible. This is more efficient for small structures than-fpcc-struct-return. โก
If you specify neither -fpcc-struct-return nor -freg-struct-return, GCC defaults to whichever convention is standard for the target. If there is no standard convention, GCC defaults to -fpcc-struct-return, except on targets where GCC is the principal compiler. In those cases, we can choose the standard, and we chose the more efficient register return alternative. ๐
Warning: code compiled with the-freg-struct-returnswitch is not binary compatible with code compiled with the-fpcc-struct-returnswitch. Use it to conform to a non-default application binary interface. ๐
-fshort-enumsโ allocate to an"enum"type only as many bytes as it needs for the declared range of possible values. ๐ Specifically, the"enum"type is equivalent to the smallest integer type that has enough room. tiny and efficient, we love her โจ
Warning: the -fshort-enums switch causes GCC to generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface. ๐
-fshort-wcharโ override the underlying type for"wchar_t"to be"short unsigned int"instead of the default for the target. ๐ฆ This option is useful for building programs to run under WINE. ๐ท
Warning: the -fshort-wchar switch causes GCC to generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface. ๐
-fcommonโ in C code, this option controls the placement of global variables defined without an initializer, known as tentative definitions in the C standard. ๐ Tentative definitions are distinct from declarations of a variable with the"extern"keyword, which do not allocate storage. ikyk, they're different things, don't @ me
The default is -fno-common, which specifies that the compiler places uninitialized global variables in the BSS section of the object file. This inhibits the merging of tentative definitions by the linker so you get a multiple-definition error if the same variable is accidentally defined in more than one compilation unit. ๐ญ
The -fcommon places uninitialized global variables in a common block. This allows the linker to resolve all tentative definitions of the same variable in different compilation units to the same object, or to a non-tentative definition. This behavior is inconsistent with C++, and on many targets implies a speed and code size penalty on global variable references. โ ๏ธ It is mainly useful to enable legacy code to link without errors. grandma code deserves love too ๐
-fno-identโ ignore the"#ident"directive. Simple. Clean. periodt ๐-finhibit-size-directiveโ don't output a".size"assembler directive, or anything else that would cause trouble if the function is split in the middle, and the two halves are placed at locations far apart in memory. ๐ฆ This option is used when compilingcrtstuff.c; you should not need to use it for anything else. seriously bestie, hands off this one ๐-fverbose-asmโ put extra commentary information in the generated assembly code to make it more readable. ๐ธ This option is generally only of use to those who actually need to read the generated assembly code (perhaps while debugging the compiler itself). ๐
-fno-verbose-asm, the default, causes the extra information to be omitted and is useful when comparing two assembler files.
The added comments include:
- information on the compiler version and command-line options,
- the source code lines associated with the assembly instructions, in the form
FILENAME:LINENUMBER:CONTENT OF LINE, - hints on which high-level expressions correspond to the various assembly instruction operands.
For example, given this C source file:
int test (int n)
{
int i;
int total = 0;
for (i = 0; i < n; i++)
total += i * i;
return total;
}
compiling to (x86_64) assembly via -S and emitting the result direct to stdout via -o -
gcc -S test.c -fverbose-asm -Os -o -
gives output similar to this:
.file "test.c"
# GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
[...snip...]
# options passed:
[...snip...]
.text
.globl test
.type test, @function
test:
.LFB0:
.cfi_startproc
# test.c:4: int total = 0;
xorl %eax, %eax # <retval>
# test.c:6: for (i = 0; i < n; i++)
xorl %edx, %edx # i
.L2:
# test.c:6: for (i = 0; i < n; i++)
cmpl %edi, %edx # n, i
jge .L5 #,
# test.c:7: total += i * i;
movl %edx, %ecx # i, tmp92
imull %edx, %ecx # i, tmp92
# test.c:6: for (i = 0; i < n; i++)
incl %edx # i
# test.c:7: total += i * i;
addl %ecx, %eax # tmp92, <retval>
jmp .L2 #
.L5:
# test.c:10: }
ret
.cfi_endproc
.LFE0:
.size test, .-test
.ident "GCC: (GNU) 7.0.0 20160809 (experimental)"
.section .note.GNU-stack,"",@progbits
The comments are intended for humans rather than machines and hence the precise format of the comments is subject to change. ๐ฆ so don't go parsing them, bestie
-frecord-gcc-switchesโ this switch causes the command line used to invoke the compiler to be recorded into the object file that is being created. ๐ This switch is only implemented on some targets and the exact format of the recording is target and binary file format dependent, but it usually takes the form of a section containing ASCII text. This switch is related to the-fverbose-asmswitch, but that switch only records information in the assembler output file as comments, so it never reaches the object file. See also-grecord-gcc-switchesfor another way of storing compiler options into the object file. ๐-fpicโ bestie, this one generates position-independent code (PIC) ๐ which is the vibe you want for a shared library, if the target machine supports it. What does that even mean? It means all your constant addresses get accessed through a global offset table (GOT) instead of being hardcoded. The dynamic loader resolves the GOT entries when the program starts โ and no, the dynamic loader is not part of GCC, it's part of the operating system, okurrr. ๐ซถ
Now, plot twist: if the GOT size for your linked executable goes over a machine-specific max, the linker is gonna throw an error at you saying -fpic does not work. In that case, just recompile with -fPIC instead, slay. โจ (The maximums are 8k on the SPARC, 28k on AArch64, and 32k on the m68k and RS/6000. The x86 has no such limit, main character behavior honestly. ๐
)
Position-independent code requires special support, so it only works on certain machines. For the x86, GCC supports PIC for System V but not for the Sun 386i. And code generated for the IBM RS/6000 is always position-independent, periodt.
When this flag is set, the macros "__pic__" and "__PIC__" are defined to 1.
-fPICโ if it's supported for the target machine, this emits position-independent code suitable for dynamic linking and it avoids any limit on the size of the global offset table. ๐ฅ This option actually makes a difference on AArch64, m68k, PowerPC and SPARC.
Position-independent code requires special support, so it works only on certain machines, ngl.
When this flag is set, the macros "__pic__" and "__PIC__" are defined to 2.
-fpie-fPIEโ these are basically-fpicand-fPIC's cousins ๐ but the generated position-independent code can only be linked into executables. Usually you use these to compile code that'll be linked using the-pieGCC option.
-fpie and -fPIE both define the macros "__pie__" and "__PIE__". The macros have the value 1 for -fpie and 2 for -fPIE.
-fno-pltโ do not use the PLT for external function calls in position-independent code. Instead, load the callee address at call sites from the GOT and branch to it. โจ This gives 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 option is useful in conjunction with-fpicor-fPICfor building code that forms part of a dynamic linker and cannot reference the address of a jump table. On some targets, jump tables don't require a GOT and this option isn't needed. ๐-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.
-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. Use of this flag for other registers that have fixed pervasive roles in the machine's execution model produces disastrous results. ๐
This flag does not have a negative form, because it specifies a three-way choice.
-fcall-saved-regโ treat the register named reg as an allocable register saved by functions. It may be allocated even for temporaries or variables that live across a call. Functions compiled this way save and restore the register reg if they use it. ๐ธ
It is an error to use this flag with the frame pointer or stack pointer. Use of this flag for other registers that have fixed pervasive roles in the machine's execution model produces disastrous results. ๐ญ
And a different sort of disaster results from the use of this flag for a register in which function values may be returned. ๐
This flag does not have a negative form, because it specifies a three-way choice.
-fpack-struct[=n]โ without a value specified, pack all structure members together without holes. When a value n is specified (which must be a small power of two), pack structure members according to this value, representing the maximum alignment (that is, objects with default alignment requirements larger than this are output potentially unaligned at the next fitting location). ๐ง
Warning: the -fpack-struct switch causes GCC to generate code that is not binary compatible with code generated without that switch. Additionally, it makes the code suboptimal. Use it to conform to a non-default application binary interface.
-fleading-underscoreโ this option and its counterpart,-fno-leading-underscore, forcibly change the way C symbols are represented in the object file. One use is to help link with legacy assembly code. ๐
Warning: the -fleading-underscore switch causes GCC to generate code that is not binary compatible with code generated without that switch. Use it to conform to a non-default application binary interface. Not all targets provide complete support for this switch.
-ftls-model=modelโ alter the thread-local storage model to be used. The model argument should be one ofglobal-dynamic,local-dynamic,initial-execorlocal-exec. Note that the choice is subject to optimization: the compiler may use a more efficient model for symbols not visible outside of the translation unit, or if-fpicis not given on the command line. โจ
The default without -fpic is initial-exec; with -fpic the default is global-dynamic.
-ftrampolinesโ for targets that normally need trampolines for nested functions, always generate them instead of using descriptors. Otherwise, for targets that don't need them โ like, for example, HP-PA or IA-64 โ do nothing. ๐ฆ
A trampoline is a small piece of code created at run time on the stack when the address of a nested function is taken, and it's used to call the nested function indirectly. Therefore, it requires the stack to be made executable in order for the program to work properly. ๐
-fno-trampolines is enabled by default on a language-by-language basis to let the compiler avoid generating them, if it computes that this is safe, and replace them with descriptors. Descriptors are made up of data only, but the generated code must be prepared to deal with them. As of this writing, -fno-trampolines is enabled by default only for Ada.
Moreover, code compiled with -ftrampolines and code compiled with -fno-trampolines are not binary compatible if nested functions are present. This option must therefore be used on a program-wide basis and be manipulated with extreme care. โ ๏ธ
-fvisibility=[default|internal|hidden|protected]โ set the default ELF image symbol visibility to the specified option โ all symbols are marked with this unless overridden within the code. Using this feature can very substantially improve linking and load times of shared object libraries, produce more optimized code, provide near-perfect API export and prevent symbol clashes. It is strongly recommended that you use this in any shared objects you distribute. ๐
Despite the nomenclature, default always means public โ i.e., available to be linked against from outside the shared object. protected and internal are pretty useless in real-world usage so the only other commonly used option is hidden. The default if -fvisibility isn't specified is default, i.e., make every symbol public. ๐
A good explanation of the benefits offered by ensuring ELF symbols have the correct visibility is given by "How To Write Shared Libraries" by Ulrich Drepper (which can be found at <https://www.akkadia.org/drepper/>) โ however a superior solution made possible by this option to marking things hidden when the default is public is to make the default hidden and mark things public. This is the norm with DLLs on Windows and with -fvisibility=hidden and "__attribute__ ((visibility("default")))" instead of "__declspec(dllexport)" you get almost identical semantics with identical syntax. This is a great boon to those working with cross-platform projects. ๐ฅ
For those adding visibility support to existing code, you may find "#pragma GCC visibility" of use. This works by you enclosing the declarations you wish to set visibility for with (for example) "#pragma GCC visibility push(hidden)" and "#pragma GCC visibility pop". Bear in mind that symbol visibility should be viewed as part of the API interface contract and thus all new code should always specify visibility when it is not the default; i.e., declarations only for use within the local DSO should always be marked explicitly as hidden so as to avoid PLT indirection overheads โ making this abundantly clear also aids readability and self-documentation of the code. Note that due to ISO C++ specification requirements, "operator new" and "operator delete" must always be of default visibility. ๐
Be aware that headers from outside your project โ in particular system headers and headers from any other library you use โ may not be expecting to be compiled with visibility other than the default. You may need to explicitly say "#pragma GCC visibility push(default)" before including any such headers. ๐
"extern" declarations do NOT get touched by -fvisibility, so bestie, a whole lotta code can be recompiled with -fvisibility=hidden and literally nothing needs changing. ๐
BUT โ and this is the plot twist โ it means calls to "extern" functions with no explicit visibility go through the PLT, so it's actually way more effective to use "__attribute ((visibility))" and/or "#pragma GCC visibility" to tell the compiler which "extern" declarations should be treated as hidden. iykyk. ๐ซถ
Also real talk: -fvisibility does affect C++ vague linkage entities. Which means, for instance, an exception class that gets thrown between DSOs must be explicitly marked with default visibility so the type_info nodes get unified between the DSOs. no cap. ๐ญ
Wanna see the whole vibe, the benefits, and how to actually use all this? There's an overview at <http://gcc.gnu.org/wiki/Visibility>. go bestie. โจ
-fstrict-volatile-bitfieldsโ use this one if accesses to volatile bit-fields (or other structure fields, even though the compiler usually honors those types anyway) should use a single access of the width of the field's type, aligned to a natural alignment if possible. Like, picture targets with memory-mapped peripheral registers that need all such accesses to be 16 bits wide โ with this flag you can declare all peripheral bit-fields as"unsigned short"(assuming short is 16 bits on these targets) to force GCC to use 16-bit accesses instead of, maybe, a much chiller-looking-but-wrong 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 totally unrelated to the one being updated. ๐
In some cases, like when the "packed" attribute is applied to a structure field, it may not be possible to access the field with a single read or write that's correctly aligned for the target machine. When that happens, GCC falls back to generating multiple accesses rather than code that will fault or truncate the result at run time. ๐ซก
Note: due to restrictions of the C/C++11 memory model, write accesses are not allowed to touch non bit-field members. So it's recommended to define all bits of the field's type as bit-field members. 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"__sync"family of functions may be used to implement the C++11"__atomic"family of functions. ๐
The default value of this option is enabled, so the only useful form of the option is -fno-sync-libcalls. This option is used in the implementation of the libatomic runtime library. periodt.
๐ ๏ธ GCC Developer Options ๐ ๏ธ
Okay so this section is for the devs โ command-line options that are primarily of interest to GCC developers, including options to support compiler testing and investigation of compiler bugs and compile-time performance problems. It's giving: 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. You should rarely need any of these for ordinary compilation and linking tasks, bestie. ๐
Many developer options that cause GCC to dump output to a file take an optional =filename suffix. You can specify stdout or - to dump to standard output, and stderr for standard error. โจ
If =filename is omitted, a default dump file name is constructed by concatenating the base dump file name, a pass number, a phase letter, and a pass name. The base dump file name is the name of output file produced by the compiler if explicitly specified and not an executable; otherwise it's the source file name. The pass number is determined by the order passes are registered with the compiler's pass manager. This is generally the same as the order of execution, but passes registered by plugins, target-specific passes, or passes that are otherwise registered late are numbered higher than the pass named final, even if they 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 info is generated in the common VCG format. It can be decorated with extra per-node and/or per-edge info if a list of comma-separated markers is additionally specified. When the"su"marker is specified, the callgraph gets decorated with stack usage information โ it's equivalent to-fstack-usage. When the"da"marker is specified, the callgraph is decorated with info 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,-fdump-rtl-pass,-fdump-rtl-pass=filenameโ says to make debugging dumps during compilation at times specified by letters. This is used for debugging the RTL-based passes of the compiler. ๐ฅ
Some -dletters switches have different meaning when -E is used for preprocessing. ๐
Debug dumps can be enabled with a -fdump-rtl switch or some -d option letters. Here are the possible letters for use in pass and letters, and their meanings:
-fdump-rtl-alignmentsโ dump after branch alignments have been computed.-fdump-rtl-asmconsโ dump after fixing rtl statements that have unsatisfied in/out constraints.-fdump-rtl-auto_inc_decโ dump after auto-inc-dec discovery. This pass is only run on architectures that have auto inc or auto dec instructions.-fdump-rtl-barriersโ dump after cleaning up the barrier instructions.-fdump-rtl-bbpartโ dump after partitioning hot and cold basic blocks.-fdump-rtl-bbroโ dump after block reordering.-fdump-rtl-btl1,-fdump-rtl-btl2โ these enable dumping after the two branch target load optimization passes.-fdump-rtl-bypassโ dump after jump bypassing and control flow optimizations.-fdump-rtl-combineโ dump after the RTL instruction combination pass.-fdump-rtl-compgotosโ dump after duplicating the computed gotos.-fdump-rtl-ce1,-fdump-rtl-ce2,-fdump-rtl-ce3โ these enable dumping after the three if conversion passes.-fdump-rtl-cprop_hardregโ dump after hard register copy propagation.-fdump-rtl-csaโ dump after combining stack adjustments.-fdump-rtl-cse1,-fdump-rtl-cse2โ these enable dumping after the two common subexpression elimination passes.-fdump-rtl-dceโ dump after the standalone dead code elimination passes.-fdump-rtl-dbrโ dump after delayed branch scheduling.-fdump-rtl-dce1,-fdump-rtl-dce2โ these enable dumping after the two dead store elimination passes.-fdump-rtl-ehโ dump after finalization of EH handling code.-fdump-rtl-eh_rangesโ dump after conversion of EH handling range regions.-fdump-rtl-expandโ dump after RTL generation.-fdump-rtl-fwprop1,-fdump-rtl-fwprop2โ these enable dumping after the two forward propagation passes.-fdump-rtl-gcse1,-fdump-rtl-gcse2โ these enable dumping after global common subexpression elimination.-fdump-rtl-init-regsโ dump after the initialization of the registers.-fdump-rtl-initvalsโ dump after the computation of the initial value sets.-fdump-rtl-into_cfglayoutโ dump after converting to cfglayout mode.-fdump-rtl-iraโ dump after iterated register allocation.-fdump-rtl-jumpโ dump after the second jump optimization.-fdump-rtl-loop2โ enables dumping after the rtl loop optimization passes.-fdump-rtl-machโ dump after performing the machine dependent reorganization pass, if that pass exists.-fdump-rtl-mode_swโ dump after removing redundant mode switches.-fdump-rtl-rnregโ dump after register renumbering.-fdump-rtl-outof_cfglayoutโ dump after converting from cfglayout mode.-fdump-rtl-peephole2โ dump after the peephole pass.-fdump-rtl-postreloadโ dump after post-reload optimizations.-fdump-rtl-pro_and_epilogueโ dump after generating the function prologues and epilogues.-fdump-rtl-sched1,-fdump-rtl-sched2โ these enable dumping after the basic block scheduling passes.-fdump-rtl-reeโ dump after sign/zero extension elimination.-fdump-rtl-seqabstrโ dump after common sequence discovery.-fdump-rtl-shortenโ dump after shortening branches.-fdump-rtl-siblingโ dump after sibling call optimizations.-fdump-rtl-split1,-fdump-rtl-split2,-fdump-rtl-split3,-fdump-rtl-split4,-fdump-rtl-split5โ these options enable dumping after five rounds of instruction splitting.-fdump-rtl-smsโ dump after modulo scheduling. This pass is only run on some architectures.-fdump-rtl-stackโ dump after conversion from GCC's"flat register file"registers to the x87's stack-like registers. This pass is only run on x86 variants. ๐-fdump-rtl-subreg1,-fdump-rtl-subreg2โ these enable dumping after the two subreg expansion passes.-fdump-rtl-unshareโ dump after all rtl has been unshared.-fdump-rtl-vartrackโ dump after variable tracking.
-fdump-rtl-vregsโ dumps everything right after virtual registers get turned into hard registers. glow-up complete โจ-fdump-rtl-webโ dumps after live range splitting. bestie's ranges are getting split, and we're watching ๐-fdump-rtl-regclass-fdump-rtl-subregs_of_mode_init-fdump-rtl-subregs_of_mode_finish-fdump-rtl-dfinit-fdump-rtl-dfinishโ okay so these dumps are defined, they exist, they're realโฆ but they always produce empty files. it's giving ghost town ๐ป not one single byte of tea.-da-fdump-rtl-allโ produces all the dumps listed above. the whole collection. the full album, no skips ๐ฅ-dAโ annotates the assembler output with miscellaneous debugging info. little notes everywhere, like margin doodles in your notes app ๐-dDโ dumps all macro definitions at the end of preprocessing, in addition to normal output. so you get your usual plus the macro lore ๐-dHโ produces a core dump whenever an error occurs. yeah. it justโฆ fully crashes on purpose when something goes wrong ๐-dpโ annotates the assembler output with a comment showing which pattern and alternative is used. the length and cost of each instruction also get printed. receipts for every instruction, no cap ๐งพ-dPโ dumps the RTL in the assembler output as a comment before each instruction. also turns on-dpannotation, so you get both, bestie.-dxโ just generates RTL for a function instead of actually compiling it. usually used with-fdump-rtl-expand. it's a "look, don't touch" situation ๐
๐ฆ the debug-dump girlies ๐ฆ
-fdump-debugโ dumps debugging information generated during the debug generation phase.-fdump-earlydebugโ dumps debugging information generated during the early debug generation phase. yes there are two phases, and yes they both get a dump ๐-fdump-noaddrโ when doing debugging dumps, suppresses address output. this makes it way more feasible to usediffon debugging dumps for compiler invocations with different compiler binaries and/or different text / bss / data / heap / stack / dso start locations. basically: same vibes, different addresses, now comparable ๐ซถ-freport-bugโ collects and dumps debug information into a temporary file if an internal compiler error (ICE) occurs. so when the compiler fully has a meltdown, at least you get receipts to send ๐ธ-fdump-unnumberedโ when doing debugging dumps, suppresses instruction numbers and address output. this makes it more feasible to usediffon debugging dumps for compiler invocations with different options, in particular with and without-g. clean comparison, slay โจ-fdump-unnumbered-linksโ when doing debugging dumps (see the-doption above), suppresses instruction numbers for the links to the previous and next instructions in a sequence. no numbers on the little chain links ๐
๐ IPA dump section, we're here ๐
-fdump-ipa-switch-fdump-ipa-switch-optionsโ controls the dumping at various stages of inter-procedural analysis language tree to a file. the file name is generated by appending a switch-specific suffix to the source file name, and the file is created in the same directory as the output file. the following dumps are possible:allโ enables all inter-procedural analysis dumps. all of them. the entire buffet ๐cgraphโ dumps information about call-graph optimization, unused function removal, and inlining decisions.inlineโ dump after function inlining.
additionally, the options -optimized, -missed, -note, and -all can be provided, with the same meaning as for -fopt-info, defaulting to -optimized.
for example, -fdump-ipa-inline-optimized-missed will emit information on callsites that were inlined, along with callsites that were not inlined. both sides of the story, periodt ๐
by default, the dump will contain messages about successful optimizations (equivalent to -optimized) together with low-level details about the analysis.
๐ language-specific dumps ๐
-fdump-lang-all-fdump-lang-switch-fdump-lang-switch-options-fdump-lang-switch-options=filenameโ controls the dumping of language-specific information. the options and filename portions behave exactly as described in the-fdump-treeoption. the following switch values are accepted:allโ enables all language-specific dumps.classโ dumps class hierarchy information. virtual table information is emitted unless'slim'is specified. this option is applicable to C++ only.rawโ dumps the raw internal tree data. this option is applicable to C++ only.
-fdump-passesโ prints on stderr the list of optimization passes that are turned on and off by the current command-line options. a little guest list for your passes ๐-fdump-statistics-optionโ enables and controls dumping of pass statistics in a separate file. the file name is generated by appending a suffix ending in.statisticsto the source file name, and the file is created in the same directory as the output file. if the-optionform is used,-statscauses counters to be summed over the whole compilation unit while-detailsdumps every event as the passes generate them. the default with no option is to sum counters for each function compiled. numbers girlies rise up ๐
๐ธ the big one: tree dumps ๐ธ
-fdump-tree-all-fdump-tree-switch-fdump-tree-switch-options-fdump-tree-switch-options=filenameโ controls the dumping at various stages of processing the intermediate language tree to a file. if the-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 are ignored. the following options are available:addressโ prints the address of each node. usually this is not meaningful since it changes according to the environment and source file. its primary use is for tying up a dump file with a debug environment.asmnameโ if"DECL_ASSEMBLER_NAME"has been set for a given decl, use that in the dump instead of"DECL_NAME". its primary use is ease of use working backward from mangled names in the assembly file.slimโ when dumping front-end intermediate representations, inhibits dumping of members of a scope or body of a function merely because that scope has been reached. only dumps such items when they are directly reachable by some other path. when dumping pretty-printed trees, this option inhibits dumping the bodies of control structures. when dumping RTL, prints the RTL in slim (condensed) form instead of the default LISP-like representation.rawโ prints a raw representation of the tree. by default, trees are pretty-printed into a C-like representation.detailsโ enables more detailed dumps (not honored by every dump option). also includes information from the optimization passes.statsโ enables dumping various statistics about the pass (not honored by every dump option).blocksโ enables showing basic block boundaries (disabled in raw dumps).graphโ for each of the other indicated dump files (-fdump-rtl-pass), dumps a representation of the control flow graph suitable for viewing with GraphViz tofile.passid.pass.dot. each function in the file is pretty-printed as a subgraph, so that GraphViz can render them all in a single plot. this option currently only works for RTL dumps, and the RTL is always dumped in slim form.vopsโ enables showing virtual operands for every statement.linenoโ enables showing line numbers for statements.uidโ enables showing the unique ID ("DECL_UID") for each variable.verboseโ enables showing the tree dump for each statement.ehโ enables showing the EH region number holding each statement.scevโ enables showing scalar evolution analysis details.optimizedโ enables showing optimization information (only available in certain passes).missedโ enables showing missed optimization information (only available in certain passes).noteโ enables other detailed optimization information (only available in certain passes).allโ turns on all options, exceptraw,slim,verboseandlineno.optallโ turns on all optimization options, i.e.,optimized,missed, andnote.
to determine what tree dumps are available or find the dump for a pass of interest, follow the steps below. it's a whole treasure hunt, bestie ๐บ๏ธ
- Invoke GCC with
-fdump-passesand in the stderr output look for a code that corresponds to the pass you are interested in. for example, the codes"tree-evrp","tree-vrp1", and"tree-vrp2"correspond to the three Value Range Propagation passes. the number at the end distinguishes distinct invocations of the same pass. - To enable the creation of the dump file, append the pass code to the
-fdump-option prefix and invoke GCC with it. for example, to enable the dump from the Early Value Range Propagation pass, invoke GCC with the-fdump-tree-evrpoption. optionally, you may specify the name of the dump file. if you don't specify one, GCC creates as described below. - Find the pass dump in a file whose name is composed of three components separated by a period: the name of the source file GCC was invoked to compile, a numeric suffix indicating the pass number followed by the letter
tfor tree passes (and the letterrfor RTL passes), and finally the pass code. for example, the Early VRP pass dump might be in a file namedmyfile.c.038t.evrpin the current working directory. note that the numeric codes are not stable and may change from one version of GCC to another. โ ๏ธ
๐ optimization dump vibes ๐
-fopt-info-fopt-info-options-fopt-info-options=filenameโ controls optimization dumps from various optimization passes. if the-optionsform is used, options is a list of-separated option keywords to select the dump details and optimizations.
the options can be divided into three groups:
- 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, always ๐
the following options control which kinds of messages should be emitted:
optimizedโ prints information when an optimization is successfully applied. it is up to a pass to decide which information is relevant. for example, the vectorizer passes print the source location of loops which are successfully vectorized.missedโ prints information about missed optimizations. individual passes control which information to include in the output.
noteโ spills the tea โ on optimizations: certain transformations, plus more detailed messages about the decisions being made and stuff like that.allโ the full rundown, bestie. Detailed optimization info about everything โ optimized, missed, and note, all of it.
The following option controls the dump verbosity:
internalsโ by default you only get the "high-level" messages, the โจpublic-facingโจ ones. This one unlocks the extra-detailed messages, which are lowkey only gonna be interesting to GCC devs themselves. iykyk.
One or more of the following option keywords can describe a whole group of optimizations:
ipaโ turn on dumps from all interprocedural optimizations ๐ซถloopโ turn on dumps from all loop optimizations ๐inlineโ turn on dumps from all inlining optimizations ๐ธompโ turn on dumps from all OMP (Offloading and Multi Processing) optimizations โกvecโ turn on dumps from all vectorization optimizations ๐ฆoptallโ turn on dumps from all optimizations. It's a superset of every optimization group listed above, no cap ๐
If options is omitted, it defaults to optimized-optall, which literally means: dump messages about successful optimizations from all the passes, while skipping the messages that count as "internals".
If the filename is provided, then the dumps from all the applicable optimizations get concatenated into that filename. Otherwise the dump goes out onto stderr. And even though multiple -fopt-info options are accepted, only one of them can include a filename. If other filenames show up, then all but the first such option are just ignored ๐.
Heads up bestie: the output filename gets overwritten in the case of multiple translation units. If you want a combined output from multiple translation units, use stderr 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 the missed optimization report from all the passes into missed.all, and this one:
gcc -O2 -ftree-vectorize -fopt-info-vec-missed
prints info about missed optimization opportunities from the 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, periodt.
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. So only vec.miss is produced, which contains dumps from the vectorizer about missed opportunities.
-fsave-optimization-record ๐
Write a SRCFILE.opt-record.json.gz file detailing what optimizations were performed, for those optimizations that support -fopt-info.
This option is experimental and the format of the data inside that compressed JSON file is subject to change. Don't build your whole life around it, babe.
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, plus the following additional data for each message:
- the execution count of the code being optimized, along with metadata about whether this came from actual profile data, or was just an estimate โ which lets consumers prioritize messages by code hotness ๐ฅ
- the function name of the code being optimized, where applicable
- the "inlining chain" for the code being optimized, so that when a function is inlined into several different places (which might themselves be inlined), the reader can tell the copies apart
- objects identifying those parts of the message that refer to expressions, statements or symbol-table nodes, which of these categories they are, and, when available, their source code location
- the GCC pass that emitted the message, and
- the location in GCC's own code from which the message was emitted
Additionally, some messages are logically nested within other messages, reflecting implementation details of the optimization passes. Nested, like, drama within drama ๐ซ .
-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 higher you crank it, the more it yaps ๐.
-fenable-kind-pass
-fdisable-kind-pass=range-list
This is a set of options used to explicitly disable/enable optimization passes. These options are intended for use for debugging GCC. Compiler users should use regular options for enabling/disabling passes instead. This is dev-only territory, bestie โ not your everyday vibe.
-fdisable-ipa-passโ disable IPA pass pass. pass is the pass name. If the same pass is statically invoked in the compiler multiple times, the pass name should be appended with a sequential number starting from1.-fdisable-rtl-pass-fdisable-rtl-pass=range-listโ disable RTL pass pass. pass is the pass name. If the same pass is statically invoked in the compiler multiple times, the pass name should be appended with a sequential number starting from1. range-list is a comma-separated list of function ranges or assembler names. Each range is a number pair separated by a colon. The range is inclusive in both ends. If the range is trivial, the number pair can be simplified as a single number. If the function's call graph node's uid falls within one of the specified ranges, the pass is disabled for that function. The uid is shown in the function header of a dump file, and the pass names can be dumped by using option-fdump-passes.-fdisable-tree-pass-fdisable-tree-pass=range-listโ disable tree pass pass. See-fdisable-rtlfor the description of option arguments.-fenable-ipa-passโ enable IPA pass pass. pass is the pass name. If the same pass is statically invoked in the compiler multiple times, the pass name should be appended with a sequential number starting from1.-fenable-rtl-pass-fenable-rtl-pass=range-listโ enable RTL pass pass. See-fdisable-rtlfor option argument description and examples.-fenable-tree-pass-fenable-tree-pass=range-listโ enable tree pass pass. See-fdisable-rtlfor the description of option arguments.
Here are some examples showing uses of these options ๐
# disable ccp1 for all functions
-fdisable-tree-ccp1
# disable complete unroll for function whose cgraph node uid is 1
-fenable-tree-cunroll=1
# disable gcse2 for functions at the following ranges [1,1],
# [300,400], and [400,1000]
# disable gcse2 for functions foo and foo2
-fdisable-rtl-gcse2=foo,foo2
# disable early inlining
-fdisable-tree-einline
# disable ipa inlining
-fdisable-ipa-inline
# enable tree full unroll
-fenable-tree-unroll
-fchecking
-fchecking=n โจ
Enable internal consistency checking. The default depends on the compiler configuration. -fchecking=2 enables further internal consistency checking that might affect code generation. So like, extra careful mode, but it can change what your code compiles to ๐.
-frandom-seed=string ๐ฒ
This option provides a seed that GCC uses in place of random numbers when generating certain symbol names that have to be different in every compiled file. It's also used to place unique stamps in coverage data files and the object files that produce them. You can use the -frandom-seed option to produce reproducibly identical object files. Slay, deterministic king ๐.
The string can either be a number (decimal, octal or hex) or an arbitrary string (in which case it's converted to a number by computing CRC32).
The string should be different for every file you compile, bestie. Fr fr.
-save-temps
-save-temps=cwd ๐พ
Store the usual "temporary" intermediate files permanently; place them in the current directory and name them based on the source file. So compiling foo.c with -c -save-temps produces files foo.i and foo.s, as well as foo.o. This creates a preprocessed foo.i output file even though the compiler now normally uses an integrated preprocessor. It's giving "keepsakes, but for compilers" ๐.
When used in combination with the -x command-line option, -save-temps is sensible enough to avoid overwriting an input source file with the same extension as an intermediate file. The corresponding intermediate file may be obtained by renaming the source file before using -save-temps.
If you invoke GCC in parallel, compiling several different source files that share a common base name in different subdirectories, or the same source file compiled for multiple output destinations, it's likely that the different parallel compilers will interfere with each other and overwrite the temporary files. For instance:
gcc -save-temps -o outdir1/foo.o indir1/foo.c&
gcc -save-temps -o outdir2/foo.o indir2/foo.c&
may result in foo.i and foo.o being written to simultaneously by both compilers. Chaos ๐ญ.
-save-temps=obj ๐ธ
Store the usual "temporary" intermediate files permanently. If the -o option is used, the temporary files are based on the object file. If the -o option is not used, the -save-temps=obj switch behaves like -save-temps.
For example:
gcc -save-temps=obj -c foo.c
gcc -save-temps=obj -c bar.c -o dir/xbar.o
gcc -save-temps=obj foobar.c -o dir2/yfoobar
creates foo.i, foo.s, dir/xbar.i, dir/xbar.s, dir2/yfoobar.i,
dir2/yfoobar.s, and dir2/yfoobar.o.
-time[=file]โ okay bestie, this one is the stopwatch moment โฑ๏ธ. It reports the CPU time that each subprocess in the compilation sequence eats up. For C source files, that means the compiler proper and the assembler (plus the linker if you're actually linking).
If you don't give it an output file, the output is giving:
# cc1 0.12 0.01
# as 0.00 0.01
The first number on each line is the "user time", aka the time spent executing the program itself. The second number is "system time", the time spent executing operating system routines on behalf of the program. Both of those are in seconds, no cap. ๐ฐ๏ธ
Now if you do specify an output file, the output gets appended to the named file and it looks like this:
0.12 0.01 cc1 <options>
0.00 0.01 as <options>
The "user time" and the "system time" move up in front of the program name, and the options passed to the program get displayed, so later you can actually tell what file was being compiled and with which options. obsessed with the receipts ๐งพ
-fdump-final-insns[=file]โ dumps the final internal representation (RTL) to file. If you leave out the optional argument (or if file is.), the dump file's name is determined by appending.gkdto the compilation output file name. ๐พ-fcompare-debug[=opts]โ if no error occurs during compilation, this runs the compiler a second time, adding opts and-fcompare-debug-secondto the arguments passed to that second compilation. It dumps the final internal representation in both compilations, and prints an error if they differ. Double-checking queen ๐โจ
If you leave out the equal sign, the default -gtoggle is used.
The environment variable GCC_COMPARE_DEBUG, if it's defined, non-empty and nonzero, implicitly enables -fcompare-debug. If GCC_COMPARE_DEBUG is defined to a string starting with a dash, then it's used for opts; otherwise the default -gtoggle is used.
-fcompare-debug=, with the equal sign but without opts, is equivalent to -fno-compare-debug, which disables the dumping of the final representation and the second compilation, preventing even GCC_COMPARE_DEBUG from taking effect.
To verify full coverage during -fcompare-debug testing, set GCC_COMPARE_DEBUG to say -fcompare-debug-not-overridden, which GCC rejects as an invalid option in any actual compilation (rather than preprocessing, assembly or linking). And if you only want a warning, setting GCC_COMPARE_DEBUG to -w%n-fcompare-debug not overridden will do. the drama of it all ๐
-fcompare-debug-secondโ this one is implicitly passed to the compiler for the second compilation that-fcompare-debugasks for, along with options to silence warnings, and omitting other options that would cause the compiler to produce output to files or to standard output as a side effect. Dump files and preserved temporary files get renamed so they contain the.gkadditional extension during the second compilation, so it doesn't overwrite the ones generated by the first. ๐
When this option is passed to the compiler driver, it causes the first compilation to be skipped, which makes it useful for little other than debugging the compiler proper. niche but valid
-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. 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. Flip it, reverse it โจ-Qโ makes the compiler print out each function name as it's compiled, and print some statistics about each pass when it finishes. the play-by-play commentary we deserve ๐ข-ftime-reportโ makes the compiler print some statistics about the time consumed by each pass when it finishes. โณ-ftime-report-detailsโ records the time consumed by infrastructure parts separately for each pass. ๐-fira-verbose=nโ 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 tostderrusing the same format as n minus10. ๐๏ธ-flto-reportโ prints a report with internal details on the workings of the link-time optimizer. The contents of this report vary from version to version, bestie, it's not consistent like that. It's meant to be useful to GCC developers when processing object files in LTO mode (via-flto).
Disabled by default. ๐ซ
-flto-report-wpaโ like-flto-report, but only prints for the WPA phase of link-time optimization. โ๏ธ-fmem-reportโ makes the compiler print some statistics about permanent memory allocation when it finishes. ๐ง-fmem-report-wpaโ makes the compiler print some statistics about permanent memory allocation for the WPA phase only. ๐ง โจ-fpre-ipa-mem-report,-fpost-ipa-mem-reportโ makes the compiler print some statistics about permanent memory allocation before or after interprocedural optimization. Before AND after, we love a glow-up arc ๐ฆ-fprofile-reportโ makes the compiler print some statistics about consistency of the (estimated) profile and the effect of individual passes. ๐-fstack-usageโ makes the compiler output stack usage information for the program, on a per-function basis. The filename for the dump is made by appending.suto the auxname. auxname is generated from the name of the output file, if it's explicitly specified and it isn't an executable; otherwise it's the basename of the source file. An entry is made up of three fields:- The name of the function.
- A number of bytes.
- One or more qualifiers: "static", "dynamic", "bounded".
The qualifier "static" means 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 isn't present, the amount of these adjustments is not bounded at compile time and the second field only represents the bounded part. ๐ study hall vibes
-fstatsโ emits statistics about front-end processing at the end of the compilation. This option is supported only by the C++ front end, and the information is generally only useful to the G++ development team. so niche, so specific ๐-fdbg-cnt-listโ prints the name and the counter upper bound for all debug counters. ๐-fdbg-cnt=counter-value-listโ sets the internal debug counter lower and upper bound. counter-value-list is a comma-separated list of
name:lower_bound1-upper_bound1 [:lower_bound2-upper_bound2...]
tuples which set 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. For dbg_cnt(tail_call) true is returned for the first 10 invocations. ๐ฏ
-print-file-name=libraryโ prints the full absolute name of the library file library that would be used when linking โ and doesn't do anything else. With this option, GCC doesn't compile or link anything; it just prints the file name. a one-job icon ๐-print-multi-directoryโ prints 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โ prints 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โ prints 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 in libsuffix sibling directories this prints e.g.../lib64,../libor../lib32; or if OS libraries are present inlib/subdir subdirectories it prints e.g.amd64,sparcv9orev6. ๐บ๏ธ-print-multiarchโ prints the path to OS libraries for the selected multiarch, relative to somelibsubdirectory. ๐-print-prog-name=programโ like-print-file-name, but searches for a program such ascpp. ๐-print-libgcc-file-nameโ same as-print-file-name=libgcc.a.
This is useful when you use -nostdlib or -nodefaultlibs but you do want to link with libgcc.a. You can do:
gcc -nostdlib <files>... `gcc -print-libgcc-file-name`
chef's kiss, honestly ๐จโ๐ณ๐
-print-search-dirsโ prints the name of the configured installation directory and a list of program and library directoriesgccsearches โ and doesn't do anything else.
This is useful when gcc prints the error message installation problem, cannot exec cpp0: No such file or directory. To resolve this you either need to put cpp0 and the other compiler components where gcc expects to find them, or you can set the environment variable GCC_EXEC_PREFIX to the directory where you installed them. Don't forget the trailing /. the trailing slash is not optional bestie, don't play โ ๏ธ
-print-sysrootโ prints the target sysroot directory that's used during compilation. This is the target sysroot specified either at configure time or using the--sysrootoption, possibly with an extra suffix that depends on compilation options. If no target sysroot is specified, the option prints nothing. ๐ค-print-sysroot-headers-suffixโ prints the suffix added to the target sysroot when searching for headers, or gives an error if the compiler is not configured with such a suffix โ and doesn't do anything else. ๐-dumpmachineโ prints the compiler's target machine (thinki686-pc-linux-gnu) and then dips, like, it does literally nothing else ๐-dumpversionโ prints the compiler version (like3.0,6.3.0or7) and does nothing 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). iykyk ๐-dumpfullversionโ prints the full compiler version and nothing else. The output is always three numbers separated by dots: major, minor and patchlevel version. no crumbs, just facts โจ-dumpspecsโ prints the compiler's built-in specs and nothing else. (This is used when GCC itself is being built.) lowkey niche but she's iconic ๐ ๏ธ
๐ฆ Machine-Dependent Options ๐ฆ
Every target machine that GCC supports can have its own lil set of options, bestie โ like, to let you compile for a particular processor variant or ABI, or to control optimizations that are specific to that machine. By convention, the names of machine-specific options start with -m. ๐ธ
Some configurations of the compiler also support extra target-specific options, usually for compatibility with other compilers on the same platform. slay, options for days ๐
โญ AArch64 Options โญ
These options are defined for AArch64 implementations:
-mabi=nameโ generate code for the specified data model. Permissible values areilp32for a SysV-like data model whereint,long intand pointers are 32 bits, andlp64for a SysV-like data model whereintis 32 bits, butlong intand pointers are 64 bits.
The default depends on the specific target configuration. Note that the LP64 and ILP32 ABIs are not link-compatible; you must compile your entire program with the same ABI, and link with a compatible set of libraries. like, no mixing, fr fr ๐ญ
-mbig-endianโ generate big-endian code. This is the default when GCC is configured for anaarch64_be-*-*target.-mgeneral-regs-onlyโ generate code which uses only the general-purpose registers. This will prevent the compiler from using floating-point and Advanced SIMD registers but will not impose any restrictions on the assembler. bestie behaves, assembler stays wild ๐-mlittle-endianโ generate little-endian code. This is the default when GCC is configured for anaarch64-*-*but not anaarch64_be-*-*target.-mcmodel=tinyโ generate code for the tiny code model. The program and its statically defined symbols must be within 1MB of each other. Programs can be statically or dynamically linked.-mcmodel=smallโ generate code for the small code model. The program and its statically defined symbols must be within 4GB of each other. Programs can be statically or dynamically linked. This is the default code model. main character energy ๐-mcmodel=largeโ generate code for the large code model. This makes no assumptions about addresses and sizes of sections. Programs can be statically linked only. The-mcmodel=largeoption is incompatible with-mabi=ilp32,-fpicand-fPIC. > โ ๏ธ heads up bestie, that incompatibility is real, don't do it-mstrict-align,-mno-strict-alignโ avoid or allow generating memory accesses that may not be aligned on a natural object boundary as described in the architecture specification.-momit-leaf-frame-pointer,-mno-omit-leaf-frame-pointerโ omit or keep the frame pointer in leaf functions. The former behavior is the default.-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offsetโ generate stack protection code using canary at guard. Supported locations areglobalfor a global canary orsysregfor a canary in an appropriate system register.
With the latter choice the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which system register to use as base register for reading the canary, and from what offset from that base register. There is no default register or offset as this is entirely for use within the Linux kernel. ๐ง
-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offsetโ generate stack protection code using canary at guard. Supported locations areglobalfor a global canary orsysregfor a canary in an appropriate system register.
With the latter choice the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which system register to use as base register for reading the canary, and from what offset from that base register. There is no default register or offset as this is entirely for use within the Linux kernel. ๐ง
๐ not me telling you this exact same entry appears twice in the original โ so I'm keeping both, no erasing, periodt
-mtls-dialect=descโ use TLS descriptors as the thread-local storage mechanism for dynamic accesses of TLS variables. This is the default.-mtls-dialect=traditionalโ use traditional TLS as the thread-local storage mechanism for dynamic accesses of TLS variables.-mtls-size=sizeโ specify bit size of immediate TLS offsets. Valid values are12,24,32,48. This option requires binutils 2.26 or newer.-mfix-cortex-a53-835769,-mno-fix-cortex-a53-835769โ enable or disable the workaround for the ARM Cortex-A53 erratum number 835769. This involves inserting a NOP instruction between memory instructions and 64-bit integer multiply-accumulate instructions. she's doing patchwork ๐-mfix-cortex-a53-843419,-mno-fix-cortex-a53-843419โ enable or disable the workaround for the ARM Cortex-A53 erratum number 843419. This erratum workaround is made at link time and this will only pass the corresponding flag to the linker.-mlow-precision-recip-sqrt,-mno-low-precision-recip-sqrtโ enable or disable the reciprocal square root approximation. This option only has an effect if-ffast-mathor-funsafe-math-optimizationsis used as well. Enabling this reduces precision of reciprocal square root results to about 16 bits for single precision and to 32 bits for double precision. accuracy said goodbye ๐ญ-mlow-precision-sqrt,-mno-low-precision-sqrtโ enable or disable the square root approximation. This option only has an effect if-ffast-mathor-funsafe-math-optimizationsis used as well. Enabling this reduces precision of square root results to about 16 bits for single precision and to 32 bits for double precision. If enabled, it implies-mlow-precision-recip-sqrt.-mlow-precision-div,-mno-low-precision-divโ enable or disable the division approximation. This option only has an effect if-ffast-mathor-funsafe-math-optimizationsis used as well. Enabling this reduces precision of division results to about 16 bits for single precision and to 32 bits for double precision.-mtrack-speculation,-mno-track-speculationโ enable or disable generation of additional code to track speculative execution through conditional branches. The tracking state can then be used by the compiler when expanding calls to"__builtin_speculation_safe_copy"to permit a more efficient code sequence to be generated.-moutline-atomics,-mno-outline-atomicsโ enable or disable calls to out-of-line helpers to implement atomic operations. These helpers will, at runtime, determine if the LSE instructions from ARMv8.1-A can be used; if not, they will use the load/store-exclusive instructions that are present in the base ARMv8.0 ISA.
This option is only applicable when compiling for the base ARMv8.0 instruction set. If using a later revision, e.g. -march=armv8.1-a or -march=armv8-a+lse, the ARMv8.1-Atomics instructions will be used directly. The same applies when using -mcpu= when the selected cpu supports the lse feature. This option is on by default. โจ
-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, +simd
armv8.1-a : Armv8.1-A : armv8-a, +crc, +lse, +rdma
armv8.2-a : Armv8.2-A : armv8.1-a
armv8.3-a : Armv8.3-A : armv8.2-a
armv8.4-a : Armv8.4-A : armv8.3-a, +fp16fml, +dotprod
armv8.5-a : Armv8.5-A : armv8.4-a, +sb, +ssbs, +predres
armv8.6-a : Armv8.6-A : armv8.5-a, +bf16, +i8mm
The value native is available on native AArch64 GNU/Linux and causes the compiler to pick the architecture of the host system. This option has no effect if the compiler is unable to recognize the architecture of the host system,
The permissible values for feature are listed in the sub-section on aarch64-feature-modifiers,,-march and -mcpu Feature Modifiers. Where conflicting feature modifiers are specified, the right-most feature is used. right-most wins, that's the rule ๐
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.
-mtune=nameโ specify the name of the target processor for which GCC should tune the performance of the code. Permissible values for this option are:generic,cortex-a35,cortex-a53,cortex-a55,cortex-a57,cortex-a72,cortex-a73,cortex-a75,cortex-a76,cortex-a76ae,cortex-a77,cortex-a65,cortex-a65ae,cortex-a34,ares,exynos-m1,emag,falkor,neoverse-e1,neoverse-n1,neoverse-n2,neoverse-v1,neoverse-v2,neoverse-512tvb,qdf24xx,saphira,phecda,xgene1,vulcan,octeontx,octeontx81,octeontx83,octeontx2,octeontx2t98,octeontx2t96 octeontx2t93,octeontx2f95,octeontx2f95n,octeontx2f95mm,a64fx,thunderx,thunderxt88,thunderxt88p1,thunderxt81,tsv110,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,ampere1,ampere1a,native.
The values cortex-a57.cortex-a53, cortex-a72.cortex-a53, cortex-a73.cortex-a35, cortex-a73.cortex-a53, cortex-a75.cortex-a55, cortex-a76.cortex-a55 specify that GCC should tune for a big.LITTLE system. big.LITTLE besties, both vibes at once ๐ซถ
ok so the value neoverse-512tvb means GCC should tune for Neoverse cores that (a) implement SVE and (b) have a total vector bandwidth of 512 bits per cycle. In other words, you're telling GCC: "tune me for Neoverse cores that can execute 4 128-bit Advanced SIMD arithmetic instructions a cycle, and the same amount 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 it's highkey more specific than the default tuning we talk about below. ๐
Also, on native AArch64 GNU/Linux systems, the value native tunes performance to the host system. This option does literally nothing if the compiler can't recognize the host system's processor. ๐
Where none of -mtune=, -mcpu= or -march= are specified, the code is tuned to perform well across a range of target processors.
๐จ This option cannot be suffixed by feature modifiers. No +feature glow-ups allowed, bestie.
-mcpu=nameโ Specify the name of the target processor, optionally suffixed by one or more feature modifiers. This option has the form-mcpu=cpu{+[no]feature}*, where the permissible values for cpu are the same as those available for-mtune. The permissible values for feature are documented in the sub-section on aarch64-feature-modifiers,,-march and -mcpu Feature Modifiers. Where conflicting feature modifiers are specified, the right-most feature is used. ๐
GCC uses name to determine what kind of instructions it can emit when generating assembly code (as if by -march) and to determine the target processor for which to tune for performance (as if by -mtune). Where this option is used in conjunction with -march or -mtune, those options take precedence over the appropriate part of this option.
-mcpu=neoverse-512tvb is special in that it does not refer to a specific core, but instead refers to all Neoverse cores that (a) implement SVE and (b) have a total vector bandwidth of 512 bits a cycle. Unless overridden by -march, -mcpu=neoverse-512tvb generates code that can run on a Neoverse V1 core, since Neoverse V1 is the first Neoverse core with these properties. Unless overridden by -mtune, -mcpu=neoverse-512tvb tunes code in the same way as for -mtune=neoverse-512tvb.
-moverride=stringโ Override tuning decisions made by the back-end in response to a-mtune=switch. The syntax, semantics, and accepted values for string in this option are not guaranteed to be consistent across releases. ๐ญ
This option is only intended to be useful when developing GCC. It's giving "internal tools only", fr fr.
-mverbose-cost-dumpโ Enable verbose cost model dumping in the debug dump files. This option is provided for use in debugging the compiler.-mpc-relative-literal-loads,-mno-pc-relative-literal-loadsโ Enable or disable PC-relative literal loads. With this option, literal pools are accessed using a single instruction and emitted after each function. This limits the maximum size of functions to1MB. This is enabled by default for-mcmodel=tiny.-msign-return-address=scopeโ Select the function scope on which return address signing will be applied. Permissible values arenone, which disables return address signing,non-leaf, which enables pointer signing for functions which are not leaf functions, andall, which enables pointer signing for all functions. The default value isnone.
๐ Heads up bestie: this option has been deprecated by -mbranch-protection.
-mbranch-protection=none|standard|pac-ret[+leaf+b-key]|btiโ Select the branch protection features to use.noneis the default and turns off all types of branch protection.standardturns on all types of branch protection features. If a feature has additional tuning options, thenstandardsets it to its standard level.pac-ret[+leaf]turns on return address signing to its standard level: signing functions that save the return address to memory (non-leaf functions will practically always do this) using thea-key. The optional argumentleafcan be used to extend the signing to include leaf functions. The optional argumentb-keycan be used to sign the functions with theB-keyinstead of theA-key.btiturns on branch target identification mechanism. โจ-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.
-msve-vector-bits=bitsโ Specify the number of bits in an SVE vector register. This option only has an effect when SVE is enabled. ๐ฆ
GCC supports two forms of SVE code generation: "vector-length agnostic" output that works with any size of vector register, and "vector-length specific" output that allows GCC to make assumptions about the vector length when it is useful for optimization reasons. The possible values of bits are: scalable, 128, 256, 512, 1024 and 2048. Specifying scalable selects vector-length agnostic output. At present -msve-vector-bits=128 also generates vector-length agnostic output for big-endian targets. All other values generate vector-length specific code. The behavior of these values may change in future releases and no value except scalable should be relied on for producing code that is portable across different hardware SVE vector lengths.
The default is -msve-vector-bits=scalable, which produces vector-length agnostic code.
๐ -march and -mcpu Feature Modifiers ๐
Feature modifiers used with -march and -mcpu can be any of the following and their inverses nofeature:
crcโ Enable CRC extension. This is on by default for-march=armv8.1-a.cryptoโ Enable Crypto extension. This also enables Advanced SIMD and floating-point instructions.fpโ Enable floating-point instructions. This is on by default for all possible values for options-marchand-mcpu.simdโ Enable Advanced SIMD instructions. This also enables floating-point instructions. This is on by default for all possible values for options-marchand-mcpu.sveโ Enable Scalable Vector Extension instructions. This also enables Advanced SIMD and floating-point instructions.lseโ Enable Large System Extension instructions. This is on by default for-march=armv8.1-a.rdmaโ Enable Round Double Multiply Accumulate instructions. This is on by default for-march=armv8.1-a.fp16โ Enable FP16 extension. This also enables floating-point instructions.fp16fmlโ Enable FP16 fmla extension. This also enables FP16 extensions and floating-point instructions. This option is enabled by default for-march=armv8.4-a. Use of this option with architectures prior to Armv8.2-A is not supported.rcpcโ Enable the RcPc extension. This does not change code generation from GCC, but is passed on to the assembler, enabling inline asm statements to use instructions from the RcPc extension.dotprodโ Enable the Dot Product extension. This also enables Advanced SIMD instructions.aesโ Enable the Armv8-a aes and pmull crypto extension. This also enables Advanced SIMD instructions.sha2โ Enable the Armv8-a sha2 crypto extension. This also enables Advanced SIMD instructions.sha3โ Enable the sha512 and sha3 crypto extension. This also enables Advanced SIMD instructions. Use of this option with architectures prior to Armv8.2-A is not supported.sm4โ Enable the sm3 and sm4 crypto extension. This also enables Advanced SIMD instructions. Use of this option with architectures prior to Armv8.2-A is not supported.profileโ Enable the Statistical Profiling extension. This option is only to enable the extension at the assembler level and does not affect code generation.rngโ Enable the Armv8.5-a Random Number instructions. This option is only to enable the extension at the assembler level and does not affect code generation.memtagโ Enable the Armv8.5-a Memory Tagging Extensions. Use of this option with architectures prior to Armv8.5-A is not supported.sbโ Enable the Armv8-a Speculation Barrier instruction. This option is only to enable the extension at the assembler level and does not affect code generation. This option is enabled by default for-march=armv8.5-a.ssbsโ Enable the Armv8-a Speculative Store Bypass Safe instruction. This option is only to enable the extension at the assembler level and does not affect code generation. This option is enabled by default for-march=armv8.5-a.predresโ Enable the Armv8-a Execution and Data Prediction Restriction instructions. This option is only to enable the extension at the assembler level and does not affect code generation. This option is enabled by default for-march=armv8.5-a.sve2โ Enable the Armv8-a Scalable Vector Extension 2. This also enables SVE instructions.sve2-bitpermโ Enable SVE2 bitperm instructions. This also enables SVE2 instructions.sve2-sm4โ Enable SVE2 sm4 instructions. This also enables SVE2 instructions.sve2-aesโ Enable SVE2 aes instructions. This also enables SVE2 instructions.sve2-sha3โ Enable SVE2 sha3 instructions. This also enables SVE2 instructions.tmeโ Enable the Transactional Memory Extension.i8mmโ Enable 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions. This option is enabled by default for-march=armv8.6-a. Use of this option with architectures prior to Armv8.2-A is not supported.f32mmโ Enable 32-bit Floating point Matrix Multiply instructions. This also enables SVE instructions. Use of this option with architectures prior to Armv8.2-A is not supported.f64mmโ Enable 64-bit Floating point Matrix Multiply instructions. This also enables SVE instructions. Use of this option with architectures prior to Armv8.2-A is not supported.bf16โ Enable brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions. This option is enabled by default for-march=armv8.6-a. Use of this option with architectures prior to Armv8.2-A is not supported. ๐ธ
Feature crypto implies aes, sha2, and simd, which implies fp. And conversely, nofp implies nosimd, which implies nocrypto, noaes and nosha2. Like a little domino chain of vibes ๐
๐ Adapteva Epiphany Options ๐
These -m options are defined for Adapteva Epiphany, bestie:
-mhalf-reg-fileโ Don't allocate any register in the range"r32"..."r63". That's the whole point: it lets your code run on hardware variants that just don't have those registers. Slay, flexible.-mprefer-short-insn-regsโ Preferentially allocate registers that allow short instruction generation. It can bump up the instruction count though, so this might either reduce or increase your overall code size. It's giving chaos, honestly. ๐-mbranch-cost=numโ Set the cost of branches to roughly num "simple" instructions. Heads up: this cost is only a heuristic and is not guaranteed to give you consistent results across releases. Lowkey vibes-based, no cap.-mcmoveโ Enable the generation of conditional moves. Iconic.-mnops=numโ Emit num NOPs before every other generated instruction. Just NOPs, NOPs, NOPs. Periodt.-mno-soft-cmpsfโ For single-precision floating-point comparisons, emit an"fsub"instruction and test the flags. This is faster than a software comparison, but it can get incorrect results in the presence of NaNs, or when two different small numbers are compared such that their difference is calculated as zero. ๐ญ The default is-msoft-cmpsf, which uses slower but IEEE-compliant software comparisons. So: speed or correctness, pick your fighter.-mstack-offset=numโ Set the offset between the top of the stack and the stack pointer. Like, a value of 8 means the eight bytes in the range"sp+0...sp+7"can be used by leaf functions without stack allocation. Values other than 8 or 16 are untested and unlikely to work, ngl.
Also note that this option changes the ABI. Compiling a program with a different stack offset than the libraries were compiled with generally does not work. ๐ฉ
This option can be useful if you want to evaluate whether a different stack offset would give you better code, but to actually use a different stack offset to build working programs, it's recommended to configure the toolchain with the appropriate --with-stack-offset=num option.
-mno-round-nearestโ Make the scheduler assume the rounding mode has been set to truncating. The default is-mround-nearest.-mlong-callsโ If not otherwise specified by an attribute, assume all calls might be beyond the offset range of the"b"/"bl"instructions, and therefore load the function address into a register before performing an (otherwise direct) call. This is the default. ๐-mshort-callsโ If not otherwise specified by an attribute, assume all direct calls are in the range of the"b"/"bl"instructions, so use these instructions for direct calls. The default is-mlong-calls.-msmall16โ Assume addresses can be loaded as 16-bit unsigned values. This does not apply to function addresses, for which-mlong-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 of the following values:
callerโ Any mode at function entry is valid, and retained or restored when the function returns, and when it calls other functions. This mode is useful for compiling libraries or other compilation units you might want to incorporate into different programs with different prevailing FPU modes, and the convenience of being able to use a single object file outweighs the size and speed overhead for any extra mode switching that might be needed, compared with what would be needed with a more specific choice of prevailing FPU mode.truncateโ This is the mode used for floating-point calculations with truncating (i.e. round towards zero) rounding mode. That includes conversion from floating point to integer.round-nearestโ This is the mode used for floating-point calculations with round-to-nearest-or-even rounding mode.intโ This is the mode used to perform integer calculations in the FPU, e.g. integer multiply, or integer multiply-and-accumulate.
The default is -mfp-mode=caller.
-mno-split-lohi-mno-postinc-mno-postmodifyโ Code generation tweaks that disable, respectively, splitting of 32-bit loads, generation of post-increment addresses, and generation of post-modify addresses. The defaults aremsplit-lohi,-mpost-inc, and-mpost-modify.-mnovect-doubleโ Change the preferred SIMD mode to SImode. The default is-mvect-double, which uses DImode as preferred SIMD mode.-max-vect-align=numโ The maximum alignment for SIMD vector mode types. num may be 4 or 8. The default is 8. Note that this is an ABI change, even though many library function interfaces are unaffected if they don't use SIMD vector modes in places that affect size and/or alignment of relevant types. ๐ฉ-msplit-vecmove-earlyโ Split vector moves into single word moves before reload. In theory this can give better register allocation, but so far the reverse seems to be generally the case. ๐ Theory said slay, reality said no.-m1reg-regโ Specify a register to hold the constant -1, which makes loading small negative constants and certain bitmasks faster. Allowable values for reg arer43andr63, which specify use of that register as a fixed register, andnone, which means no register is used for this purpose. The default is-m1reg-none.
๐ AMD GCN Options ๐
These options are defined specifically for the AMD GCN port. Let's goooo.
-march=gpu-mtune=gpuโ Set architecture type or tuning for gpu. Supported values for gpu are:fijiโ Compile for GCN3 Fiji devices (gfx803).gfx900โ Compile for GCN5 Vega 10 devices (gfx900).gfx906โ Compile for GCN5 Vega 20 devices (gfx906).
-mstack-size=bytesโ Specify how many bytes of stack space will be requested for each GPU thread (wave-front). โ ๏ธ Beware that there may be many threads and limited memory available. The size of the stack allocation may also have an impact on run-time performance. The default is 32KB when using OpenACC or OpenMP, and 1MB otherwise.
๐ฆ 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.arc600_normโ Compile for ARC 600 CPU with"norm"instructions enabled.arc600_mul32x16โ Compile for ARC 600 CPU with"norm"and 32x16-bit multiply instructions enabled.arc600_mul64โ Compile for ARC 600 CPU with"norm"and"mul64"-family instructions enabled.arc601_normโ Compile for ARC 601 CPU with"norm"instructions enabled.arc601_mul32x16โ Compile for ARC 601 CPU with"norm"and 32x16-bit multiply instructions enabled.arc601_mul64โ Compile for ARC 601 CPU with"norm"and"mul64"-family instructions enabled.nps400โ Compile for ARC 700 on NPS400 chip.em_miniโ Compile for ARC EM minimalist configuration featuring reduced register set.
-mdpfp-mdpfp-compactโ Generate double-precision FPX instructions, tuned for the compact implementation.-mdpfp-fastโ Generate double-precision FPX instructions, tuned for the fast implementation.-mno-dpfp-lrsrโ Disable"lr"and"sr"instructions from using FPX extension aux registers.-meaโ Generate extended arithmetic instructions. Currently only"divaw","adds","subs", and"sat16"are supported. Only valid for-mcpu=ARC700.-mno-mpyโ Do not generate"mpy"-family instructions for ARC700. This option is deprecated. ๐ฉ-mmul32x16โ Generate 32x16-bit multiply and multiply-accumulate instructions.-mmul64โ Generate"mul64"and"mulu64"instructions. Only valid for-mcpu=ARC600.-mnormโ Generate"norm"instructions. This is the default if-mcpu=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โ Enable generation of ARC SIMD instructions via target-specific builtins. Only valid for-mcpu=ARC700.-msoft-floatโ This option is ignored; it is provided for compatibility purposes only. Software floating-point code is emitted by default, and this default can be overridden by FPX options:-mspfp,-mspfp-compact, or-mspfp-fastfor single precision, and-mdpfp,-mdpfp-compact, or-mdpfp-fastfor double precision. ๐-mswapโ bestie, this one generatesswapinstructions. that's it, that's the whole vibe ๐-matomicโ turns on the locked load/store conditional extension so atomic memory built-in functions actually work. heads up tho: it's not available for ARC 6xx or ARC EM cores, so don't come crying to me ๐-mdiv-remโ enablesdivandreminstructions for ARCv2 cores. slay โจ-mcode-densityโ enables code density instructions for ARC EM. and for ARC HS? it's on by default, no cap ๐-mll64โ enables double load/store operations for ARC HS cores ๐ซถ- *
-mtp-regno=regno* โ specify the thread pointer register number, that's the whole job ๐ - *
-mmpy-option=multo* โ compile ARCv2 code with a multiplier design option. you can pass multo as either a string or a numeric value, andwlh1is the default. here are the recognized values, hold on to your wig:0,noneโ no multiplier available. nothing. zero. the void ๐1,wโ 16x16 multiplier, fully pipelined. enables these instructions:mpywandmpyuw.2,wlh1โ 32x32 multiplier, fully pipelined (1 stage). additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.3,wlh2โ 32x32 multiplier, fully pipelined (2 stages). additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.4,wlh3โ two 16x16 multipliers, blocking, sequential. additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.5,wlh4โ one 16x16 multiplier, blocking, sequential. additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.6,wlh5โ one 32x4 multiplier, blocking, sequential. additionally enables:mpy,mpyu,mpym,mpymu, andmpy_s.7,plus_dmpyโ ARC HS SIMD support.8,plus_macdโ ARC HS SIMD support.9,plus_qmacwโ ARC HS SIMD support.
this option is only available for ARCv2 cores. iykyk ๐ธ
- *
-mfpu=fpu* โ enables support for specific floating-point hardware extensions for ARCv2 cores. supported values for fpu are giving: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. single-precision floating-point is also enabled. only available for ARC EM.fpuda_divโ same double-precision assist energy, but the single-precision floating-point, square-root, and divide extensions are also enabled. only available for ARC EM.fpuda_fmaโ double-precision assist again, plus single-precision floating-point and fused multiply and add hardware extensions are also enabled. only available for ARC EM.fpuda_allโ double-precision assist, and all single-precision floating-point hardware extensions are also enabled. only available for ARC EM.fpus_divโ enables support for single-precision floating-point, square-root and divide hardware extensions.fpud_divโ enables support for double-precision floating-point, square-root and divide hardware extensions. this option includes optionfpus_div. not available for ARC EM.fpus_fmaโ enables support for single-precision floating-point and fused multiply and add hardware extensions.fpud_fmaโ enables support for double-precision floating-point and fused multiply and add hardware extensions. this option includes optionfpus_fma. not available for ARC EM.fpus_allโ enables support for all single-precision floating-point hardware extensions.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 the general-purpose registers that the processor automatically saves/restores on interrupt entry and exit. register-range is two registers separated by a dash. the range always starts withr0, and the upper limit is thefpregister. blink and lp_count are optional. this option is **only valid for ARC EM and ARC HS cores โจ- *
-mrgf-banked-regs=number* โ specifies how many registers get replicated in the second register bank on entry to a fast interrupt. and what's a fast interrupt? it's an interrupt with the highest priority level P0. these save only the PC and STATUS32 registers, to avoid memory transactions during interrupt entry and exit sequences. use this when you're rocking fast interrupts in an ARC V2 family processor. permitted values are4,8,16, and32๐ - *
-mlpc-width=width* โ specify the width of thelp_countregister. valid width values are8,16,20,24,28and32bits. default width is fixed at32bits. if the width is less than 32, the compiler won't try to transform loops in your program to use the zero-delay loop mechanism unless it knows thelp_countregister can hold the required loop-counter value. depending on the width you pick, the compiler and run-time library might still keep using the loop mechanism for various needs. also this option defines the macro__ARC_LPC_WIDTH__with the value of width ๐ -mrf16โ tells the compiler to generate code for a 16-entry register file. this option defines the__ARC_RF16__preprocessor macro โญ-mbranch-indexโ enable use ofbiorbihinstructions to implement jump tables. iconic behavior fr fr ๐ฅ
the following options are passed through to the assembler, and also define preprocessor macro symbols.
-mdsp-packaโ passed down to the assembler to enable the DSP Pack A extensions. also sets the preprocessor symbol__Xdsp_packa. this option is deprecated.-mdvbfโ passed down to the assembler to enable the dual Viterbi butterfly extension. also sets the preprocessor symbol__Xdvbf. this option is deprecated.-mlockโ passed down to the assembler to enable the locked load/store conditional extension. also sets the preprocessor symbol__Xlock.-mmac-d16โ passed down to the assembler. also sets the preprocessor symbol__Xxmac_d16. this option is deprecated.-mmac-24โ passed down to the assembler. also sets the preprocessor symbol__Xxmac_24. this option is deprecated.-mrtscโ passed down to the assembler to enable the 64-bit time-stamp counter extension instruction. also sets the preprocessor symbol__Xrtsc. this option is deprecated.-mswapeโ passed down to the assembler to enable the swap byte ordering extension instruction. also sets the preprocessor symbol__Xswape.-mtelephonyโ passed down to the assembler to enable dual- and single-operand instructions for telephony. also sets the preprocessor symbol__Xtelephony. this option is deprecated.-mxyโ passed down to the assembler to enable the XY memory extension. also sets the preprocessor symbol__Xxy.
the following options control how the assembly code is annotated:
-misizeโ annotate assembler instructions with estimated addresses.-mannotate-alignโ explain what alignment considerations led to the decision to make an instruction short or long. like, it tells you why ๐ฆ
the following options are passed through to the linker:
-marclinuxโ passed through to the linker, to specify use of thearclinuxemulation. this one is enabled by default in tool chains built forarc-linux-uclibcandarceb-linux-uclibctargets when profiling is not requested.-marclinux_profโ passed through to the linker, to specify use of thearclinux_profemulation. enabled by default in tool chains built forarc-linux-uclibcandarceb-linux-uclibctargets when profiling is requested ๐
the following options control the semantics of generated code:
-mlong-callsโ generate calls as register indirect calls, which gives you access to the full 32-bit address range. main character energy honestly ๐-mmedium-callsโ don't use less than a 25-bit addressing range for calls, which is the offset available for an unconditional branch-and-link instruction. conditional execution of function calls is suppressed so you can use the 25-bit range instead of the 21-bit range with conditional branch-and-link. this is the default for tool chains built forarc-linux-uclibcandarceb-linux-uclibctargets.- *
-G*num โ put definitions of externally-visible data in a small data section if that data is no bigger than num bytes. the default value of num is4for any ARC configuration, or8when we have double load/store operations ๐ -mno-sdataโ do not generate sdata references. this is the default for tool chains built forarc-linux-uclibcandarceb-linux-uclibctargets.-mvolatile-cacheโ use ordinarily cached memory accesses for volatile references. this is the default.-mno-volatile-cacheโ enable cache bypass for volatile references ๐ง
the following options fine tune code generation:
-malign-callโ do alignment optimizations for call instructions.-mauto-modify-regโ enable the use of pre/post modify with register displacement.-mbbit-peepholeโ enable bbit peephole2.-mno-brccโ disables a target-specific pass inarc_reorgto generate compare-and-branch (brcc) instructions. ngl it has no effect on generation of these instructions driven by the combiner pass ๐-mcase-vector-pcrelโ use PC-relative switch case tables so the case table can get shortened. This is the default for-Os. ๐-mcompact-casesiโ enables the compactcasesipattern. Default for-Os, and only available on ARCv1 cores. Heads up bestie: this option is deprecated.-mno-cond-execโ turns OFF the ARCompact-specific pass that generates conditional execution instructions. ๐ค
So here's the tea: because of delay slot scheduling and all the messy interactions between operand numbers, literal sizes, instruction lengths, and conditional execution support, the target-independent pass for generating conditional execution is often kinda lacking. So the ARC port kept a whole special pass around that hunts for more conditional execution generation opportunities after register allocation, branch shortening, and delay slot scheduling are already done. This pass generally (but not always, ngl) improves performance and code size โ at the cost of extra compile time, which is literally why there's an option to switch it off. And if you're having problems with call instructions blowing past their allowable offset range because they got conditionalized, you should consider using -mmedium-calls instead. ๐ซถ
-mearly-cbranchsiโ enables pre-reload use of thecbranchsipattern.-mexpand-adddiโ expandsadddi3andsubdi3at RTL generation time intoadd.f,adcetc. This option is deprecated. ๐-mindexed-loadsโ enables the use of indexed loads. This can be problematic because some optimizers then assume indexed stores exist, which... they don't. ๐-mlraโ enables Local Register Allocation. Still experimental for ARC, so by default the compiler uses standard reload (i.e.-mno-lra). ๐งช-mlra-priority-noneโ don't indicate any priority for target registers.-mlra-priority-compactโ indicate target register priority forr0..r3/r12..r15.-mlra-priority-noncompactโ reduce target register priority forr0..r3/r12..r15.-mmillicodeโ when optimizing for size (using-Os), prologues and epilogues that have to save or restore a large number of registers often get shortened by calling a special function inlibgcc; that's what a millicode call is. 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. ๐-mcode-density-frameโ lets the compiler emitenterandleaveinstructions. These are only valid for CPUs with the code-density feature, so don't try it elsewhere.-mmixed-codeโ tweaks register allocation to help 16-bit instruction generation. Generally this decreases the average instruction size while increasing the instruction count. it's giving "smaller but more" โจ-mq-classโ this option is deprecated. Enables q instruction alternatives. This is the default for-Os.-mRcqโ enables Rcq constraint handling. Most short code generation depends on this. This is the default.-mRcwโ enables Rcw constraint handling. Most ccfsm condexec mostly depends on this. This is the default.-msize-level=levelโ fine-tune size optimization with regards to instruction lengths and alignment. The recognized values for level are:0โ no size optimization. This level is deprecated and treated like1.1โ short instructions are used opportunistically.2โ in addition, alignment of loops and of code after barriers are dropped.3โ in addition, optional data alignment is dropped, and the optionOsis enabled.
This defaults to 3 when -Os is in effect. Otherwise, the behavior when this is not set is equivalent to level 1.
-mtune=cpuโ set instruction scheduling parameters for cpu, overriding anything implied by-mcpu=. ๐
Supported values for cpu are:
ARC600โ tune for ARC600 CPU.ARC601โ tune for ARC601 CPU.ARC700โ tune for ARC700 CPU with standard multiplier block.ARC700-xmacโ tune for ARC700 CPU with XMAC block.ARC725Dโ tune for ARC725D CPU.ARC750Dโ tune for ARC750D CPU.
-mmultcost=numโ cost to assume for a multiply instruction, with4being equal to a normal instruction.-munalign-prob-threshold=probabilityโ set the probability threshold for unaligning branches. When tuning for ARC700 and optimizing for speed, branches without a filled delay slot are preferably emitted unaligned and long, unless profiling indicates that the probability of the branch being taken is below probability. The default is(REG_BR_PROB_BASE/2), i.e.5000.
The following options are maintained for backward compatibility, but are now deprecated and will be removed in a future release. like... they're on borrowed time, bestie ๐ฐ๏ธ
-margonautโ obsolete FPX.-mbig-endian,-EBโ compile code for big-endian targets. Use of these options is now deprecated. Big-endian code is supported by configuring GCC to buildarceb-elf32andarceb-linux-uclibctargets, for which big endian is the default.-mlittle-endian,-ELโ compile code for little-endian targets. Use of these options is now deprecated. Little-endian code is supported by configuring GCC to buildarc-elf32andarc-linux-uclibctargets, for which little endian is the default.-mbarrel_shifterโ replaced by-mbarrel-shifter.-mdpfp_compactโ replaced by-mdpfp-compact.-mdpfp_fastโ replaced by-mdpfp-fast.-mdsp_packaโ replaced by-mdsp-packa.-mEAโ replaced by-mea.-mmac_24โ replaced by-mmac-24.-mmac_d16โ replaced by-mmac-d16.-mspfp_compactโ replaced by-mspfp-compact.-mspfp_fastโ replaced by-mspfp-fast.-mtune=cpuโ valuesarc600,arc601,arc700andarc700-xmacfor cpu are replaced byARC600,ARC601,ARC700andARC700-xmacrespectively.-multcost=numโ replaced by-mmultcost.
๐ธ ARM Options ๐ธ
These -m options are defined for the ARM port:
-mabi=nameโ generate code for the specified ABI. Permissible values are:apcs-gnu,atpcs,aapcs,aapcs-linuxandiwmmxt.-mapcs-frameโ generate a stack frame that is compliant with the ARM Procedure Call Standard for all functions, even if this isn't strictly necessary for correct execution of the code. Specifying-fomit-frame-pointerwith this option causes the stack frames not to be generated for leaf functions. The default is-mno-apcs-frame. This option is deprecated. ๐-mapcsโ this is a synonym for-mapcs-frameand is deprecated.-mthumb-interworkโ generate code that supports calling between the ARM and Thumb instruction sets. Without this option, on pre-v5 architectures, the two instruction sets cannot be reliably used inside one program. The default is-mno-thumb-interwork, since slightly larger code is generated when-mthumb-interworkis specified. In AAPCS configurations this option is meaningless. ๐คท-mno-sched-prologโ prevent the reordering of instructions in the function prologue, or the merging of those instructions with the instructions in the function's body. This means all functions start with a recognizable set of instructions (or in fact 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. Permissible values are:soft,softfpandhard.
Specifying soft causes GCC to generate output containing library calls for floating-point operations. softfp allows the generation of code using hardware floating-point instructions, but still uses the soft-float calling conventions. hard allows generation of floating-point instructions and uses FPU-specific calling conventions. โจ
The default depends on the specific target configuration. Note that the hard-float and soft-float ABIs are not link-compatible; you must compile your entire program with the same ABI, and link with a compatible set of libraries. no mixing and matching, bestie ๐ญ
-mgeneral-regs-onlyโ generate code which uses only the general-purpose registers. This will prevent the compiler from using floating-point and Advanced SIMD registers but will not impose any restrictions on the assembler.-mlittle-endianโ generate code for a processor running in little-endian mode. This is the default for all standard configurations.-mbig-endianโ generate code for a processor running in big-endian mode; the default is to compile code for a little-endian processor.-mbe8,-mbe32โ when linking a big-endian image, select between BE8 and BE32 formats. The option has no effect for little-endian images and is ignored. The default is dependent on the selected target architecture. For ARMv6 and later architectures the default isBE8, for older architectures the default isBE32. BE32 format has been deprecated by ARM. ๐ซ-march=name[+extension...]โ this specifies the name of the target ARM architecture. GCC uses this name to determine what kind of instructions it can emit when generating assembly code. This option can be used in conjunction with or instead of the-mcpu=option.
Permissible names are: armv4t, armv5t, armv5te, armv6, armv6j, armv6k, armv6kz, armv6t2, armv6z, armv6zk, armv7, armv7-a, armv7ve, armv8-a, armv8.1-a, armv8.2-a, armv8.3-a, armv8.4-a, armv8.5-a, armv8.6-a, armv7-r, armv8-r, armv6-m, armv6s-m, armv7-m, armv7e-m, armv8-m.base, armv8-m.main, armv8.1-m.main, iwmmxt and iwmmxt2.
Additionally, the following architectures, which lack support for the Thumb execution state, are recognized but support is deprecated: armv4.
Many of the architectures support extensions. These can be added by appending +extension to the architecture name. Extension options are processed in order and capabilities accumulate. An extension will also enable any necessary base extensions upon which it depends. For example, the +crypto extension will always enable the +simd extension. ๐
The exception to the additive construction is for extensions that are prefixed with +no...: these extensions disable the specified option and any other extensions that may depend on the presence of that extension.
Okay so for example, -march=armv7-a+simd+nofp+vfpv4 is literally equivalent to writing -march=armv7-a+vfpv4 since the +simd option is entirely disabled by the +nofp option that follows it. ๐
Most extension names are generically named, but have an effect that is dependent upon the architecture to which it is applied. For example, the +simd option can be applied to both armv7-a and armv8-a architectures, but will enable the original ARMv7-A Advanced SIMD (Neon) extensions for armv7-a and the ARMv8-A variant for armv8-a. Itโs giving โsame name, different font,โ no cap. โจ
The table below lists the supported extensions for each architecture. Architectures not mentioned do not support any extensions. Periodt.
armv5te,armv6,armv6j,armv6k,armv6kz,armv6t2,armv6z,armv6zk+fpโ The VFPv2 floating-point instructions. The extension+vfpv2can be used as an alias for this extension.+nofpโ Disable the floating-point instructions.
armv7โ The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.+fpโ The VFPv3 floating-point instructions, with 16 double-precision registers. The extension+vfpv3-d16can be used as an alias for this extension. Note that floating-point is not supported by the base ARMv7-M architecture, but is compatible with both the ARMv7-A and ARMv7-R architectures.+nofpโ Disable the floating-point instructions.
armv7-a+mpโ The multiprocessing extension.+secโ The security extension.+fpโ The VFPv3 floating-point instructions, with 16 double-precision registers. The extension+vfpv3-d16can be used as an alias for this extension.+simdโ The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions. The extensions+neonand+neon-vfpv3can be used as aliases for this extension.+vfpv3โ The VFPv3 floating-point instructions, with 32 double-precision registers.+vfpv3-d16-fp16โ The VFPv3 floating-point instructions, with 16 double-precision registers and the half-precision floating-point conversion operations.+vfpv3-fp16โ The VFPv3 floating-point instructions, with 32 double-precision registers and the half-precision floating-point conversion operations.+vfpv4-d16โ The VFPv4 floating-point instructions, with 16 double-precision registers.+vfpv4โ The VFPv4 floating-point instructions, with 32 double-precision registers.+neon-fp16โ The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with the half-precision floating-point conversion operations.+neon-vfpv4โ The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.+nosimdโ Disable the Advanced SIMD instructions (does not disable floating point).+nofpโ Disable the floating-point and Advanced SIMD instructions.
armv7veโ The extended version of the ARMv7-A architecture with support for virtualization.+fpโ The VFPv4 floating-point instructions, with 16 double-precision registers. The extension+vfpv4-d16can be used as an alias for this extension.+simdโ The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions. The extension+neon-vfpv4can be used as an alias for this extension.+vfpv3-d16โ The VFPv3 floating-point instructions, with 16 double-precision registers.+vfpv3โ The VFPv3 floating-point instructions, with 32 double-precision registers.+vfpv3-d16-fp16โ The VFPv3 floating-point instructions, with 16 double-precision registers and the half-precision floating-point conversion operations.+vfpv3-fp16โ The VFPv3 floating-point instructions, with 32 double-precision registers and the half-precision floating-point conversion operations.+vfpv4-d16โ The VFPv4 floating-point instructions, with 16 double-precision registers.+vfpv4โ The VFPv4 floating-point instructions, with 32 double-precision registers.+neonโ The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions. The extension+neon-vfpv3can be used as an alias for this extension.+neon-fp16โ The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with the half-precision floating-point conversion operations.+nosimdโ Disable the Advanced SIMD instructions (does not disable floating point).+nofpโ Disable the floating-point and Advanced SIMD instructions.
armv8-a+crcโ The Cyclic Redundancy Check (CRC) instructions.+simdโ The ARMv8-A Advanced SIMD and floating-point instructions.+cryptoโ The cryptographic instructions.+nocryptoโ Disable the cryptographic instructions.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.
armv8.1-a+simdโ The ARMv8.1-A Advanced SIMD and floating-point instructions.+cryptoโ The cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions.+nocryptoโ Disable the cryptographic instructions.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.
armv8.2-a,armv8.3-a+fp16โ The half-precision floating-point data processing instructions. This also enables the Advanced SIMD and floating-point instructions.+fp16fmlโ The half-precision floating-point fmla extension. This also enables the half-precision floating-point extension and Advanced SIMD and floating-point instructions.+simdโ The ARMv8.1-A Advanced SIMD and floating-point instructions.+cryptoโ The cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions.+dotprodโ Enable the Dot Product extension. This also enables Advanced SIMD instructions.+nocryptoโ Disable the cryptographic extension.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.+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.+simdโ The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the Dot Product extension.+cryptoโ The cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension.+nocryptoโ Disable the cryptographic extension.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions.+sbโ Speculation Barrier Instruction.+predresโ Execution and Data Prediction Restriction Instructions.+i8mmโ 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions.+bf16โ Brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions.
armv8.5-a+fp16โ The half-precision floating-point data processing instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension and the half-precision floating-point fmla extension.+simdโ The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the Dot Product extension.+cryptoโ The cryptographic instructions. This also enables the Advanced SIMD and floating-point instructions as well as the Dot Product extension.+nocryptoโ Disable the cryptographic extension.+nofpโ Disable the floating-point, Advanced SIMD and cryptographic instructions.+i8mmโ 8-bit Integer Matrix Multiply instructions. This also enables Advanced SIMD and floating-point instructions.+bf16โ Brain half-precision floating-point instructions. This also enables Advanced SIMD and floating-point instructions.
armv8.6-a+fp16โ the half-precision floating-point data processing instructions, bestie ๐ This one also switches on the Advanced SIMD and floating-point instructions, plus the Dot Product extension and the half-precision floating-pointfmlaextension. It's giving bundle deal โจ+simdโ the ARMv8.3-A Advanced SIMD and floating-point instructions, plus 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. bye ๐+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.+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.+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-m.main+dspโ the DSP instructions.+nodspโ disable the DSP extension.+fpโ the single-precision floating-point instructions.+fp.dpโ the single- and double-precision floating-point instructions.+nofpโ disable the floating-point extension.+cdecp0,+cdecp1, ... ,+cdecp7โ enable the Custom Datapath Extension (CDE) on selected coprocessors according to the numbers given in the options in the range 0 to 7.
armv8-r+crcโ the Cyclic Redundancy Check (CRC) instructions.+fp.spโ the single-precision FPv5 floating-point instructions.+simdโ the ARMv8-A Advanced SIMD and floating-point instructions.+cryptoโ the cryptographic instructions.+nocryptoโ disable the cryptographic instructions.+nofpโ disable the floating-point, Advanced SIMD and cryptographic instructions.
Okay so real talk, -march=native makes the compiler auto-detect the architecture of the build computer. But 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 โ it just shrugs and does nothing ๐ญ no cap.
โจ -mtune=name โจ
This one tells GCC the name of the target ARM processor it should tune the performance of the code for. For some ARM implementations you can get better performance by using this option. Permissible names are:
arm7tdmi, arm7tdmi-s, arm710t, arm720t, arm740t, strongarm, strongarm110,
strongarm1100, 0strongarm1110, arm8, arm810, arm9, arm9e, arm920, arm920t,
arm922t, arm946e-s, arm966e-s, arm968e-s, arm926ej-s, arm940t, arm9tdmi,
arm10tdmi, arm1020t, arm1026ej-s, arm10e, arm1020e, arm1022e, arm1136j-s,
arm1136jf-s, mpcore, mpcorenovfp, arm1156t2-s, arm1156t2f-s, arm1176jz-s,
arm1176jzf-s, generic-armv7-a, cortex-a5, cortex-a7, cortex-a8, cortex-a9,
cortex-a12, cortex-a15, cortex-a17, cortex-a32, cortex-a35, cortex-a53,
cortex-a55, cortex-a57, cortex-a72, cortex-a73, cortex-a75, cortex-a76,
cortex-a76ae, cortex-a77, ares, cortex-r4, cortex-r4f, cortex-r5, cortex-r7,
cortex-r8, cortex-r52, cortex-m0, cortex-m0plus, cortex-m1, cortex-m3,
cortex-m4, cortex-m7, cortex-m23, cortex-m33, cortex-m35p, cortex-m55,
cortex-m1.small-multiply, cortex-m0.small-multiply,
cortex-m0plus.small-multiply, exynos-m1, marvell-pj4, neoverse-n1,
neoverse-n2, neoverse-v1, xscale, iwmmxt, iwmmxt2, ep9312, fa526, fa626,
fa606te, fa626te, fmp626, fa726te, xgene1.
Additionally, this option can specify that GCC should tune the performance of the code for a big.LITTLE system ๐ซถ Permissible names are:
cortex-a15.cortex-a7, cortex-a17.cortex-a7, cortex-a57.cortex-a53,
cortex-a72.cortex-a53, cortex-a72.cortex-a35, cortex-a73.cortex-a53,
cortex-a75.cortex-a55, cortex-a76.cortex-a55.
-mtune=generic-arch 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. Heads up though โ the effects of this option may change in future GCC versions as CPU models come and go ๐
-mtune permits the same extension options as -mcpu, but the extension options do not affect the tuning of the generated code. they're just there for the vibe, not the tuning ๐
-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. same energy as before, fr fr ๐
โจ -mcpu=name[+extension...] โจ
This specifies the name of the target ARM processor. GCC uses this name to derive the name of the target ARM architecture (as if 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 if you're double-dipping, -march/-mtune win, periodt ๐
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.+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-m33andcortex-m35p. Disables the floating-point and SIMD instructions ongeneric-armv7-a,cortex-a5,cortex-a7,cortex-a8,cortex-a9,cortex-a12,cortex-a15,cortex-a17,cortex-a15.cortex-a7,cortex-a17.cortex-a7,cortex-a32,cortex-a35,cortex-a53andcortex-a55.+nofp.dpโ disables the double-precision component of the floating-point instructions oncortex-r5,cortex-r7,cortex-r8,cortex-r52andcortex-m7.+nosimdโ disables the SIMD (but not floating-point) instructions ongeneric-armv7-a,cortex-a5,cortex-a7andcortex-a9.+cryptoโ enables the cryptographic instructions oncortex-a32,cortex-a35,cortex-a53,cortex-a55,cortex-a57,cortex-a72,cortex-a73,cortex-a75,exynos-m1,xgene1,cortex-a57.cortex-a53,cortex-a72.cortex-a53,cortex-a73.cortex-a35,cortex-a73.cortex-a53andcortex-a75.cortex-a55.
Additionally the generic-armv7-a pseudo target defaults to VFPv3 with 16 double-precision registers. It supports the following extension options: mp, sec, vfpv3-d16, vfpv3, vfpv3-d16-fp16, vfpv3-fp16, vfpv4-d16, vfpv4, neon, neon-vfpv3, neon-fp16, neon-vfpv4. The meanings are the same as for the extensions to -march=armv7-a. ๐
-mcpu=generic-arch is also permissible, and is equivalent to -march=arch -mtune=generic-arch. See -mtune for more information. ๐
-mcpu=nativeโ bestie, this tells the compiler to auto-detect the CPU of the build computer. At present, this feature is only supported on GNU/Linux, and not all architectures are recognized. If the auto-detect is unsuccessful the option has no effect. ๐-mfpu=nameโ okay so 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-armv8andcrypto-neon-fp-armv8. Note thatneonis an alias forneon-vfpv3andvfpis an alias forvfpv2. ๐ฆ
The setting auto is the default and is special. It causes the compiler to select the floating-point and Advanced SIMD instructions based on the settings of -mcpu and -march.
If the selected floating-point hardware includes the NEON extension (e.g. -mfpu=neon), note that floating-point operations are not generated by GCC's auto-vectorization pass unless -funsafe-math-optimizations is also specified. This is because NEON hardware does not fully implement the IEEE 754 standard for floating-point arithmetic (in particular denormal values are treated as zero), so the use of NEON instructions may lead to a loss of precision. ๐ญ
You can also set the fpu name at function level by using the target("fpu=") function attributes or pragmas. โจ
-mfp16-format=nameโ specify the format of the__fp16half-precision floating-point type. Permissible names arenone,ieee, andalternative; the default isnone, in which case the__fp16type is not defined. ๐-mstructure-size-boundary=nโ the sizes of all structures and unions are rounded up to a multiple of the number of bits set by this option. Permissible values are8,32and64. The default value varies for different toolchains. For the COFF targeted toolchain the default value is8. A value of64is only allowed if the underlying ABI supports it. ๐
Specifying a larger number can produce faster, more efficient code, but can also increase the size of the program. Different values are potentially incompatible. Code compiled with one value cannot necessarily expect to work with code or libraries compiled with another value, if they exchange information using structures or unions. ๐
This option is deprecated. ๐
-mabort-on-noreturnโ generate a call to the functionabortat the end of anoreturnfunction. It is executed if the function tries to return. ๐ซถ-mlong-calls,-mno-long-callsโ tells the compiler to perform function calls by first loading the address of the function into a register and then performing a subroutine call on this register. This switch is needed if the target function lies outside of the 64-megabyte addressing range of the offset-based version of subroutine call instruction. ๐
Even if this switch is enabled, not all function calls are turned into long calls. The heuristic is that static functions, functions that have the short_call attribute, functions that are inside the scope of a #pragma no_long_calls directive, and functions whose definitions have already been compiled within the current compilation unit are not turned into long calls. The exceptions to this rule are that weak function definitions, functions with the long_call attribute or the section attribute, and functions that are within the scope of a #pragma long_calls directive are always turned into long calls. ๐ฅ
This feature is not enabled by default. Specifying -mno-long-calls restores the default behavior, as does placing the function calls within the scope of a #pragma long_calls_off directive. Note these switches have no effect on how the compiler generates code to handle function calls via function pointers. โญ
-msingle-pic-baseโ treat the register used for PIC addressing as read-only, rather than loading it in the prologue for each function. The runtime system is responsible for initializing this register with an appropriate value before execution begins. ๐-mpic-register=regโ specify the register to be used for PIC addressing. For standard PIC base case, the default is any suitable register determined by compiler. For single PIC base case, the default isR9if target is EABI based or stack-checking is enabled, otherwise the default isR10. ๐-mpic-data-is-text-relativeโ assume that the displacement between the text and data segments is fixed at static link time. This permits using PC-relative addressing operations to access data known to be in the data segment. For non-VxWorks RTP targets, this option is enabled by default. When disabled on such targets, it will enable-msingle-pic-baseby default. ๐ธ-mpoke-function-nameโ write the name of each function into the text section, directly preceding the function prologue. The generated code is similar to this:
t0
.ascii "arm_poke_function_name", 0
.align
t1
.word 0xff000000 + (t1 - t0)
arm_poke_function_name
mov ip, sp
stmfd sp!, {fp, ip, lr, pc}
sub fp, ip, #4
When performing a stack backtrace, code can inspect the value of pc stored at fp + 0. If the trace function then looks at location pc - 12 and the top 8 bits are set, then we know that there is a function name embedded immediately preceding this location and has length ((pc[-3]) & 0xff000000). ๐ง
-mthumb,-marmโ select between generating code that executes in ARM and Thumb states. The default for most configurations is to generate code that executes in ARM state, but the default can be changed by configuring GCC with the--with-mode=stateconfigure option. ๐
You can also override the ARM and Thumb mode for each function by using the target("thumb") and target("arm") function attributes or pragmas. ๐
-mflip-thumbโ switch ARM/Thumb modes on alternating functions. This option is provided for regression testing of mixed Thumb/ARM code generation, and is not intended for ordinary use in compiling code. ๐ฆ-mtpcs-frameโ generate a stack frame that is compliant with the Thumb Procedure Call Standard for all non-leaf functions. (A leaf function is one that does not call any other functions.) The default is-mno-tpcs-frame. ๐-mtpcs-leaf-frameโ generate a stack frame that is compliant with the Thumb Procedure Call Standard for all leaf functions. (A leaf function is one that does not call any other functions.) The default is-mno-apcs-leaf-frame. ๐ธ-mcallee-super-interworkingโ gives all externally visible functions in the file being compiled an ARM instruction set header which switches to Thumb mode before executing the rest of the function. This allows these functions to be called from non-interworking code. This option is not valid in AAPCS configurations because interworking is enabled by default. ๐ฅ-mcaller-super-interworkingโ allows calls via function pointers (including virtual functions) to execute correctly regardless of whether the target code has been compiled for interworking or not. There is a small overhead in the cost of executing a function pointer if this option is enabled. This option is not valid in AAPCS configurations because interworking is enabled by default. ๐-mtp=nameโ specify the access model for the thread local storage pointer. The valid models aresoft, which generates calls to__aeabi_read_tp,cp15, which fetches the thread pointer fromcp15directly (supported in the arm6k architecture), andauto, which uses the best available method for the selected processor. The default setting isauto. ๐-mtls-dialect=dialectโ specify the dialect to use for accessing thread local storage. Two dialects are supported---gnuandgnu2. Thegnudialect selects the original GNU scheme for supporting local and global dynamic TLS models. Thegnu2dialect selects the GNU descriptor scheme, which provides better performance for shared libraries. The GNU descriptor scheme is compatible with the original scheme, but does require new assembler, linker and library support. Initial and local exec TLS models are unaffected by this option and always use the original scheme. ๐-mword-relocationsโ only generate absolute relocations on word-sized values (i.e.R_ARM_ABS32). This is enabled by default on targets (uClinux, SymbianOS) where the runtime loader imposes this restriction, and when-fpicor-fPICis specified. This option conflicts with-mslow-flash-data. โญ-mfix-cortex-m3-ldrdโ some Cortex-M3 cores can cause data corruption whenldrdinstructions with overlapping destination and base registers are used. This option avoids generating these instructions. This option is enabled by default when-mcpu=cortex-m3is specified. ๐-munaligned-access,-mno-unaligned-accessโ enables (or disables) reading and writing of 16- and 32- bit values from addresses that are not 16- or 32- bit aligned. By default unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for ARMv8-M Baseline architectures, and enabled for all other architectures. If unaligned access is not enabled then words in packed data structures are accessed a byte at a time. ๐ซถ
The ARM attribute Tag_CPU_unaligned_access is set in the generated object file to either true or false, depending upon the setting of this option. If unaligned access is enabled then the preprocessor symbol __ARM_FEATURE_UNALIGNED is also defined. โจ
-mneon-for-64bitsโ > This option is deprecated and has no effect. ๐ญ-mslow-flash-dataโ assume loading data from flash is slower than fetching instruction. Therefore literal load is minimized for better performance. This option is only supported when compiling for ARMv7 M-profile and off by default. It conflicts with-mword-relocations. ๐-masm-syntax-unifiedโ okay so this one is like, "assume inline assembler is using unified asm syntax." The default is currently off, which implies divided syntax. Heads up bestie: this option has no impact on Thumb2. However โ and this is the tea โ this may change in future releases of GCC. Divided syntax should be considered deprecated. ๐-mrestrict-itโ restricts generation of IT blocks so they conform to the rules of ARMv8-A. IT blocks can only contain a single 16-bit instruction from a select set of instructions. This one is on by default for ARMv8-A Thumb mode. โจ-mprint-tune-infoโ prints CPU tuning information as a comment in the assembler file. Lowkey this is only for regression testing of the compiler and is not intended for ordinary use in compiling code. Disabled by default. ๐-mverbose-cost-dumpโ enables verbose cost model dumping in the debug dump files. It's provided for use in debugging the compiler. iykyk ๐ง-mpure-codeโ do not allow constant data to be placed in code sections. Also, when compiling for ELF object format, give all text sections the ELF processor-specific section attribute"SHF_ARM_PURECODE". This option is only available when generating non-pic code for M-profile targets. ๐-mcmseโ generate secure code as per the "ARMv8-M Security Extensions: Requirements on Development Tools Engineering Specification", which can be found athttps://developer.arm.com/documentation/ecm0359818/latest/. ๐ฅ-mfix-cmse-cve-2021-35465โ mitigate against a potential security issue with theVLLDMinstruction in some M-profile devices when using CMSE (CVE-2021-365465). This option is enabled by default when the option-mcpu=is used withcortex-m33,cortex-m35porcortex-m55. The option-mno-fix-cmse-cve-2021-35465can be used to disable the mitigation. ๐ก๏ธ-mfdpic,-mno-fdpicโ select 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 the user should explicitly provide the PIC/PIE-related options as needed. ๐
Note that static linking is not supported 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. ๐
๐ธ AVR Options ๐ธ
These options are defined for AVR implementations, bestie. Buckle up, there's a lot. ๐ฆ
-mmcu=mcuโ specify Atmel AVR instruction set architectures (ISA) or MCU type. The default for this option isavr2.
GCC supports the following AVR devices and ISAs:
avr2โ "Classic" devices with up to 8 KiB of program memory. mcu =attiny22,attiny26,at90s2313,at90s2323,at90s2333,at90s2343,at90s4414,at90s4433,at90s4434,at90c8534,at90s8515,at90s8535.avr25โ "Classic" devices with up to 8 KiB of program memory and with 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,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,atmega325,atmega325a,atmega325p,atmega325pa,atmega328,atmega328p,atmega328pb,atmega329,atmega329a,atmega329p,atmega329pa,atmega3250,atmega3250a,atmega3250p,atmega3250pa,atmega3290,atmega3290a,atmega3290p,atmega3290pa,atmega406,atmega64,atmega64a,atmega64c1,atmega64hve,atmega64hve2,atmega64m1,atmega64rfr2,atmega640,atmega644,atmega644a,atmega644p,atmega644pa,atmega644rfr2,atmega645,atmega645a,atmega645p,atmega649,atmega649a,atmega649p,atmega6450,atmega6450a,atmega6450p,atmega6490,atmega6490a,atmega6490p,ata5795,ata5790,ata5790n,ata5791,ata6613c,ata6614q,ata5782,ata5831,ata8210,ata8510,ata5702m322,at90pwm161,at90pwm216,at90pwm316,at90can32,at90can64,at90scr100,at90usb646,at90usb647,at94k,m3000.avr51โ "Enhanced" devices with 128 KiB of program memory. mcu =atmega128,atmega128a,atmega128rfa1,atmega128rfr2,atmega1280,atmega1281,atmega1284,atmega1284p,atmega1284rfr2,at90can128,at90usb1286,at90usb1287.avr6โ "Enhanced" devices with 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.avrxmega3โ "XMEGA" devices with up to 64 KiB of combined program memory and RAM, and with program memory visible in the RAM address space. mcu =attiny202,attiny204,attiny212,attiny214,attiny402,attiny404,attiny406,attiny412,attiny414,attiny416,attiny417,attiny804,attiny806,attiny807,attiny814,attiny816,attiny817,attiny1604,attiny1606,attiny1607,attiny1614,attiny1616,attiny1617,attiny3214,attiny3216,attiny3217,atmega808,atmega809,atmega1608,atmega1609,atmega3208,atmega3209,atmega4808,atmega4809.avrxmega4โ "XMEGA" devices with more than 64 KiB and up to 128 KiB of program memory. mcu =atxmega64a3,atxmega64a3u,atxmega64a4u,atxmega64b1,atxmega64b3,atxmega64c3,atxmega64d3,atxmega64d4.avrxmega5โ "XMEGA" devices with more than 64 KiB and up to 128 KiB of program memory and more than 64 KiB of RAM. mcu =atxmega64a1,atxmega64a1u.avrxmega6โ "XMEGA" devices with more than 128 KiB of program memory. mcu =atxmega128a3,atxmega128a3u,atxmega128b1,atxmega128b3,atxmega128c3,atxmega128d3,atxmega128d4,atxmega192a3,atxmega192a3u,atxmega192c3,atxmega192d3,atxmega256a3,atxmega256a3b,atxmega256a3bu,atxmega256a3u,atxmega256c3,atxmega256d3,atxmega384c3,atxmega384d3.avrxmega7โ "XMEGA" devices with more than 128 KiB of program memory and more than 64 KiB of RAM. mcu =atxmega128a1,atxmega128a1u,atxmega128a4u.avrtinyโ "TINY" Tiny core devices with 512 B up to 4 KiB of program memory. mcu =attiny4,attiny5,attiny9,attiny10,attiny20,attiny40.avr1โ this ISA is implemented by the minimal AVR core and supported for assembler only. mcu =attiny11,attiny12,attiny15,attiny28,at90s1200.
-mabsdataโ assume that all data in static storage can be accessed by LDS / STS instructions. This option has only an effect on reduced Tiny devices like ATtiny40. See also theabsdataAVR Variable Attributes, variable attribute. โจ-maccumulate-argsโ accumulate outgoing function arguments and acquire/release the needed stack space for outgoing function arguments once in function prologue/epilogue. Without this option, outgoing arguments are pushed before calling a function and popped afterwards.
Popping the arguments after the function call can be expensive on AVR, so accumulating the stack space might lead to smaller executables because arguments need not be removed from the stack after such a function call.
This option can lead to reduced code size for functions that perform several calls to functions that get their arguments on the stack, like calls to printf-like functions. ๐
-mbranch-cost=costโ set the branch costs for conditional branch instructions to cost. Reasonable values for cost are small, non-negative integers. The default branch cost is0. ๐-mcall-prologuesโ function prologues/epilogues get expanded as calls to the appropriate subroutines. Code size goes down. โจ-mdouble=bits,-mlong-double=bitsโ set the size (in bits) of thedoubleorlong doubletype, respectively.bitscan be32or64. Whether a specificbitsvalue is even allowed depends on the--with-double=and--with-long-double=configure options (https://gcc.gnu.org/install/configure.html#avr), and the default values of the options depend on those too. 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 theno_gccisrfunction attribute fromAVR Function Attributes. 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). slay-mint8โ assumeintis an 8-bit integer. This affects the sizes of all types: acharis 1 byte, anintis 1 byte, alongis 2 bytes, andlong longis 4 bytes. > Heads up bestie: this option does not conform to the C standards, but it results in smaller code size. โ ๏ธ-mmain-is-OS_taskโ do not save registers inmain. The effect is the same like attaching attributeOS_taskfromAVR Function Attributestomain. It is activated per default if optimization is on. main character energy fr-mn-flash=numโ assume that the flash memory has a size ofnumtimes 64 KiB. math girlie-mno-interruptsโ generated code is not compatible with hardware interrupts. Code size is smaller. don't say I didn't warn you-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. periodt
-mrmwโ assume that the device supports the Read-Modify-Write instructionsXCH,LAC,LASandLAT. read modify write, we love a multitasker-mshort-callsโ assume thatRJMPandRCALLcan target the whole program memory.
This option is used internally for multilib selection. It is not an optimization option, and you don't need to set it by hand. compiler internals, not your business bestie
-msp8โ treat the stack pointer register as an 8-bit register, i.e. assume the high byte of the stack pointer is zero. In general, you don't need to set this option by hand.
This option is used internally by the compiler to select and build multilibs for architectures avr2 and avr25. These architectures mix devices with and without SPH. For any setting other than -mmcu=avr2 or -mmcu=avr25 the compiler driver adds or removes this option from the compiler proper's command line, because the compiler then knows if the device or architecture has an 8-bit stack pointer and thus no SPH register or not. compiler lore
-mstrict-Xโ use 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
hardware said no emulation today
-mtiny-stackโ only change the lower 8 bits of the stack pointer. tiny stack, tiny vibes-mfract-convert-truncateโ allow to use truncation instead of rounding towards zero for fractional fixed-point types. math but make it chaotic-nodevicelibโ don't link against AVR-LibC's device specific librarylib<mcu>.a. not today, device lib-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. DIY era
-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. address space drama-Wmisspelled-isrโ warn if the ISR is misspelled, i.e. without__vectorprefix. Enabled by default. spelling matters bestie
โจ "EIND" and Devices with More Than 128 Ki Bytes of Flash โจ
Pointers in the implementation are 16 bits wide. The address of a function or label is represented as word address so that indirect jumps and calls can target any code address in the range of 64 Ki words.
In order to facilitate indirect jump on devices with more than 128 Ki bytes of program memory space, there is a special function register called EIND that serves as most significant part of the target address when EICALL or EIJMP instructions are used.
Indirect jumps and calls on these devices are handled as follows by the compiler and are subject to some limitations:
- The compiler never sets
EIND. respectfully, not its job - The compiler uses
EINDimplicitly inEICALL/EIJMPinstructions or might readEINDdirectly in order to emulate an indirect call/jump by means of aRETinstruction. sneaky - 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. set it and forget it? no, actually don't forget it - For indirect calls to functions and computed goto, the linker generates stubs. Stubs are jump pads sometimes also called trampolines. Thus, the indirect call/jump jumps to such a stub. The stub contains a direct jump to the desired address. trampolines but make it embedded
- 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. > Bestie, turn on relaxation or risk cryptic linker tears. - 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. custom linker script era - 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 (http://nongnu.org/avr-libc/user-manual/). team effort - 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. early bird gets the EIND
- Stubs are generated automatically by the linker if the following two conditions are met:
- The address of a label is taken by means of the
"gs"modifier (short for generate stubs) like so:
- 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. two conditions, one slay
- The compiler emits such
gsmodifiers for code labels in the following situations:- Taking address of a function or code label.
- Computed goto.
- If prologue-save function is used, see
-mcall-prologuescommand-line option. - Switch/case dispatch tables. If you do not want such dispatch tables you can specify the
-fno-jump-tablescommand-line option. - C and C++ constructors/destructors called during startup/shutdown.
- If the tools hit a
gs()modifier explained above. gs modifier everywhere
- 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. no raw address jumps, bestie
๐ Handling of the "RAMPD", "RAMPX", "RAMPY" and "RAMPZ" Special Function Registers ๐
Some AVR devices support memories larger than the 64 KiB range that can be accessed with 16-bit pointers. To access memory locations outside this 64 KiB range, the content of a RAMP register is used as high part of the address: The X, Y, Z address register is concatenated with the RAMPX, RAMPY, RAMPZ special function register, respectively, to get a wide address. Similarly, RAMPD is used together with direct addressing.
- The startup code initializes the
RAMPspecial function registers with zero. zero it out, bestie - If a AVR Named Address Spaces named address space that isn't generic or
__flashis used, thenRAMPZgets set as needed before the operation. โจ - If the device supports RAM larger than 64 KiB and the compiler needs to change
RAMPZto get an operation done, thenRAMPZis reset to zero after the operation. ๐ซถ - If the device comes with a specific
RAMPregister, the ISR prologue/epilogue saves/restores that SFR and initializes it with zero, in case the ISR code might (implicitly) use it. ๐ - RAM larger than 64 KiB is not supported by GCC for AVR targets. So if you use inline assembler to read from locations outside the 16-bit address range and you change one of the
RAMPregisters, you must reset it to zero after the access. No cap. ๐ญ
๐ฆ AVR Built-in Macros ๐ฆ
GCC defines several built-in macros so that your code can test for the presence or absence of features. Almost any of the built-in macros below are deduced from device capabilities, which means they're 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__โ a built-in macro that resolves to a decimal number identifying the architecture, and it 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, and it reflects the device's name. For example,-mmcu=atmega8defines the built-in macro__AVR_ATmega8__, and-mmcu=attiny261adefines__AVR_ATtiny261A__, etc.
The built-in macros' names follow the scheme __AVR_Device__, where Device is the device name as it appears in 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 isn't actually a device but only a core architecture like avr51, this macro is not defined. ๐
__AVR_DEVICE_NAME__โ setting-mmcu=devicedefines this built-in macro to the device's name. For example, with-mmcu=atmega8the macro is defined toatmega8.
If device isn't actually a device but only a core architecture like avr51, this macro is not defined.
__AVR_XMEGA__โ the device / architecture belongs to the XMEGA family of devices. ๐__AVR_HAVE_ELPM__โ the device has theELPMinstruction.__AVR_HAVE_ELPMX__โ the device has theELPM Rn,ZandELPM Rn,Z+instructions.__AVR_HAVE_MOVW__โ the device has theMOVWinstruction, which performs 16-bit register-register moves.__AVR_HAVE_LPMX__โ the device has theLPM Rn,ZandLPM Rn,Z+instructions.__AVR_HAVE_MUL__โ the device has a hardware multiplier. ๐ฅ__AVR_HAVE_JMP_CALL__โ the device has theJMPandCALLinstructions. This is the case for devices with more than 8 KiB of program memory.__AVR_HAVE_EIJMP_EICALL__,__AVR_3_BYTE_PC__โ the device has theEIJMPandEICALLinstructions. This is 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 is 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=avr25, also by-msp8.__AVR_HAVE_RAMPD__,__AVR_HAVE_RAMPX__,__AVR_HAVE_RAMPY__,__AVR_HAVE_RAMPZ__โ the device has theRAMPD,RAMPX,RAMPY,RAMPZspecial function register, respectively.__NO_INTERRUPTS__โ this macro reflects the-mno-interruptscommand-line option.__AVR_ERRATA_SKIP__,__AVR_ERRATA_SKIP_JMP_CALL__โ some AVR devices (AT90S8515, ATmega103) must not skip 32-bit instructions, because of a hardware erratum. ๐ญ 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, LAS and LAT). ๐__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 accessing RAM, likeLDorSTS. This offset depends on the device architecture and has to be subtracted from the RAM address in order to get the respective I/O address.__AVR_SHORT_CALLS__โ the-mshort-callscommand line option is set.__AVR_PM_BASE_ADDRESS__=addrโ 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 is currently available foravrtinyandavrxmega3. Even more convenient: there's no need to use address spaces like__flashor features like attributeprogmemandpgm_read_*. โจ__WITH_AVRLIBC__โ the compiler is configured to be used together with AVR-Libc. See the--with-avrlibcconfigure option.__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__. ๐ซถ__HAVE_LONG_DOUBLE32__,__HAVE_LONG_DOUBLE64__,__HAVE_LONG_DOUBLE_MULTILIB__,__DEFAULT_LONG_DOUBLE__โ same as above, but forlong doubleinstead ofdouble.__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).
๐ธ Blackfin Options ๐ธ
-mcpu=cpu[-sirevision]โ specifies the name of the target Blackfin processor. Currently, cpu can be one of bf512, bf514, bf516, bf518, bf522, bf523, bf524, bf525, bf526, bf527, bf531, bf532, bf533, bf534, bf536, bf537, bf538, bf539, bf542, bf544, bf547, bf548, bf549, bf542m, bf544m, bf547m, bf548m, bf549m, bf561, bf592. ๐
The optional sirevision specifies the silicon revision of the target Blackfin processor. Any workarounds available for the targeted silicon revision are enabled. If sirevision is none, no workarounds are enabled. If sirevision is any, all workarounds for the targeted processor are enabled. The __SILICON_REVISION__ macro is defined to two hexadecimal digits representing the major and minor numbers in the silicon revision. If sirevision is none, the __SILICON_REVISION__ is not defined. If sirevision is any, the __SILICON_REVISION__ is defined to be 0xffff. If this optional sirevision isn't 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.
Heads up bestie: support for bf561 is incomplete. For bf561, only the preprocessor macro is defined. ๐
-msimโ specifies that the program will be run on the simulator. This causes the simulator BSP provided by libgloss to be linked in. This option has effect only for the bfin-elf toolchain. Certain other options, such as-mid-shared-libraryand-mfdpic, imply-msim.-momit-leaf-frame-pointerโ don't keep the frame pointer in a register for leaf functions. This avoids the instructions to save, set up and restore frame pointers, and makes an extra register available in leaf functions. ๐-mspecld-anomalyโ 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.-mno-specld-anomalyโ don't generate extra code to prevent speculative loads from occurring.-mcsync-anomalyโ when enabled, the compiler ensures that the generated code does not contain CSYNC or SSYNC instructions too soon after conditional branches. If this option is used,__WORKAROUND_SPECULATIVE_SYNCSis defined.-mno-csync-anomalyโ don't generate extra code to prevent CSYNC or SSYNC instructions from occurring too soon after a conditional branch.-mlow64kโ when enabled, the compiler is free to take advantage of the knowledge that the entire program fits into the low 64k of memory. โจ-mno-low64kโ assume that the program is arbitrarily large. This is the default.-mstack-check-l1โ do stack checking using information placed into L1 scratchpad memory by the uClinux kernel.-mid-shared-libraryโ generate code that supports shared libraries via the library ID method. This allows for execute in place and shared libraries in an environment without virtual memory management. This option implies-fPIC. With a bfin-elf target, this option implies-msim. ๐ฆ-mno-id-shared-libraryโ bestie, this makes code that does not assume ID-based shared libraries are in play. And plot twist: this is the default ๐-mleaf-id-shared-libraryโ generates code that supports shared libs the library-ID way, but lowkey assumes this library or executable won't link against any other ID shared libraries. Why do we care? Because that assumption lets the compiler use faster code for jumps and calls ๐ฅ-mno-leaf-id-shared-libraryโ the opposite vibe: do NOT assume the code being compiled won't link against ID shared libraries. The price? Slower code gets generated for jump and call insns ๐ญ-mshared-library-id=nโ tells it the identification number of the ID-based shared library being compiled. A value of0generates more compact code; any other value forces that number to be allocated to the current library, but ngl it's no more space- or time-efficient than just omitting this option entirely ๐-msep-dataโ generates code where the data segment can live in a totally different area of memory from the text segment. This allows for execute in place in an environment without virtual memory management, by eliminating relocations against the text section โจ-mno-sep-dataโ generates code that assumes the data segment follows the text segment. This is the default, periodt.-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 lies outside of the 24-bit addressing range of the offset-based version of subroutine call instruction. This feature is not enabled by default, and specifying-mno-long-callsrestores the default behavior. Also heads up: these switches have no effect on how the compiler generates code to handle function calls via function pointers ๐-mfast-fpโ link with the fast floating-point library. This library relaxes some of the IEEE floating-point standard's rules for checking inputs against Not-a-Number (NAN), in the interest of performance โก-minline-pltโ enable inlining of PLT entries in function calls to functions that aren't known to bind locally. It has no effect without-mfdpic.-mmulticoreโ build a standalone application for multicore Blackfin processors. This option causes proper start files and link scripts supporting multicore to be used, and defines the macro"__BFIN_MULTICORE". It can only be used with-mcpu=bf561[-sirevision].
This option can be used with -mcorea or -mcoreb, which selects the one-application-per-core programming model. Without -mcorea or -mcoreb, the single-application/dual-core programming model is used. In this model, the main function of Core B should be named as "coreb_main".
If this option isn't used, the single-core application programming model is used.
-mcoreaโ build a standalone application for Core A of BF561 when using the one-application-per-core programming model. Proper start files and link scripts are used to support Core A, and the macro"__BFIN_COREA"is defined. This option can only be used in conjunction with-mmulticore๐ซถ-mcorebโ build a standalone application for Core B of BF561 when using the one-application-per-core programming model. Proper start files and link scripts are used to support Core B, and the macro"__BFIN_COREB"is defined. When this option is used,"coreb_main"should be used instead of"main". This option can only be used in conjunction with-mmulticore.-msdramโ build a standalone application for SDRAM. Proper start files and link scripts are used to put the application into SDRAM, and the macro"__BFIN_SDRAM"is defined. The loader should initialize SDRAM before loading the application ๐ธ-micplbโ assume that ICPLBs are enabled at run time. This has an effect on certain anomaly workarounds. For Linux targets, the default is to assume ICPLBs are enabled; for standalone applications the default is off.
โจ C6X Options โจ
-march=nameโ this specifies the name of the target architecture. GCC uses this name to determine what kind of instructions it can emit when generating assembly code. Permissible names are:c62x,c64x,c64x+,c67x,c67x+,c674x.-mbig-endianโ generate code for a big-endian target.-mlittle-endianโ generate code for a little-endian target. This is the default ๐-msimโ choose startup files and linker script suitable for the simulator.-msdata=defaultโ put small global and static data in the.neardatasection, which is pointed to by registerB14. Put small uninitialized global and static data in the.bsssection, which is adjacent to the.neardatasection. Put small read-only data into the.rodatasection. The corresponding sections used for large pieces of data are.fardata,.farand.const.-msdata=allโ put all data, not just small objects, into the sections reserved for small data, and use addressing relative to theB14register to access them ๐-msdata=noneโ make no use of the sections reserved for small data, and use absolute addresses to access all data. Put all initialized global and static data in the.fardatasection, and all uninitialized data in the.farsection. Put all constant data into the.constsection.
๐ CRIS Options ๐
These options are defined specifically for the CRIS ports, bestie ๐
-march=architecture-type,-mcpu=architecture-typeโ generate code for the specified architecture. The choices for architecture-type arev3,v8andv10for respectively ETRAX 4, ETRAX 100, and ETRAX 100 LX. Default isv0except forcris-axis-linux-gnu, where the default isv10.-mtune=architecture-typeโ tune to architecture-type everything applicable about the generated code, except for the ABI and the set of available instructions. The choices for architecture-type are the same as for-march=architecture-type.-mmax-stack-frame=nโ warn when the stack frame of a function exceeds n bytes ๐จ-metrax4,-metrax100โ these 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 active by default.-mpdebugโ enable CRIS-specific verbose debug-related information in the assembly code. This option also has the effect of turning off the#NO_APPformatted-code indicator to the assembler at the beginning of the assembly file ๐-mcc-initโ do not use condition-code results from previous instruction; always emit compare and test instructions before use of condition codes.-mno-side-effectsโ do not emit instructions with side effects in addressing modes other than post-increment.-mstack-align,-mno-stack-align,-mdata-align,-mno-data-align,-mconst-align,-mno-const-alignโ these options (and theno-versions) arrange (or eliminate arrangements) for the stack frame, individual data and constants to be aligned for the maximum single data access size for the chosen CPU model. The default is to arrange for 32-bit alignment. ABI details such as structure layout are not affected by these options ๐ซถ-m32-bit,-m16-bit,-m8-bitโ similar to the stack-, data- and const-align options above, these options arrange for stack frame, writable data and constants to all be 32-bit, 16-bit or 8-bit aligned. The default is 32-bit alignment.-mno-prologue-epilogue,-mprologue-epilogueโ with-mno-prologue-epilogue, the normal function prologue and epilogue which set up the stack frame are omitted and no return instructions or return sequences are generated in the code.
โ ๏ธ Use this option only together with visual inspection of the compiled code: no warnings or errors are generated when call-saved registers must be saved, or storage for local variables needs to be allocated. Like, it will just silently do the thing. Be careful, bestie ๐ญ
-mno-gotplt,-mgotpltโ with-fpicand-fPIC, don't generate (do generate) instruction sequences that load addresses for functions from the PLT part of the GOT rather than (traditional on other architectures) calls to the PLT. The default is-mgotplt.-melfโ legacy no-op option only recognized with thecris-axis-elfandcris-axis-linux-gnutargets.-mlinuxโ legacy no-op option only recognized with thecris-axis-linux-gnutarget.-simโ this option, recognized for thecris-axis-elf, arranges to link with input-output functions from a simulator library. Code, initialized data and zero-initialized data are allocated consecutively โจ-sim2โ like-sim, but pass linker options to locate initialized data at0x40000000and zero-initialized data at0x80000000.
๐ฆ CR16 Options ๐ฆ
These options are defined specifically for the CR16 ports.
-mmacโ enable the use of multiply-accumulate instructions. Disabled by default.-mcr16cplus,-mcr16cโ generate code for CR16C or CR16C+ architecture. CR16C+ architecture is default ๐-msimโ links the librarylibsim.awhich is in compatible with simulator. Applicable to ELF compiler only.-mint32โ choose integer type as 32-bit wide.-mbit-opsโ generates"sbit"/"cbit"instructions for bit manipulations ๐ฅ-mdata-model=modelโ choose a data model. The choices for model arenear,farormedium.mediumis default. However,faris not valid with-mcr16c, as the CR16C architecture does not support the far data model ๐ซ
๐ง C-SKY Options ๐ง
GCC supports these options when compiling for C-SKY V2 processors, no cap.
-march=archโ specify the C-SKY target architecture. Valid values for arch are:ck801,ck802,ck803,ck807, andck810. The default isck810โญ-mcpu=cpuโ bestie, this is where you tell GCC which C-SKY target processor you're repping ๐. The valid values for cpu are:
ck801, ck801t, ck802, ck802t, ck802j, ck803, ck803h, ck803t,
ck803ht, ck803f, ck803fh, ck803e, ck803eh, ck803et, ck803eht,
ck803ef, ck803efh, ck803ft, ck803eft, ck803efht, ck803r1, ck803hr1,
ck803tr1, ck803htr1, ck803fr1, ck803fhr1, ck803er1, ck803ehr1,
ck803etr1, ck803ehtr1, ck803efr1, ck803efhr1, ck803ftr1, ck803eftr1,
ck803efhtr1, ck803s, ck803st, ck803se, ck803sf, ck803sef, ck803seft,
ck807e, ck807ef, ck807, ck807f, ck810e, ck810et, ck810ef, ck810eft,
ck810, ck810v, ck810f, ck810t, ck810fv, ck810tv, ck810ft, and
ck810ftv.
like that's a whole alphabet of chips, periodt ๐
-mbig-endian,-EB,-mlittle-endian,-ELโ pick whether you want big- or little-endian code. The default is little-endian โจ.-mhard-float,-msoft-floatโ choose between hardware or software floating-point implementations. Default is soft float ๐ฆ.-mdouble-float,-mno-double-floatโ when-mhard-floatis in effect, this turns on generation of double-precision float instructions. That's the default except when you're compiling for CK803 ๐.-mfdivdu,-mno-fdivduโ when-mhard-floatis in effect, turn on generation offrecipd,fsqrtd, andfdivdinstructions. Default except when compiling for CK803 ๐ธ.-mfpu=fpuโ choose your floating-point processor, bestie. This one can only be used with-mhard-float. The values for fpu arefpv2_sf(equivalent to-mno-double-float -mno-fdivdu),fpv2(-mdouble-float -mno-divdu), andfpv2_divd(-mdouble-float -mdivdu) โจ.-melrw,-mno-elrwโ enable the extendedlrwinstruction. This defaults to on for CK801 and off otherwise ๐.-mistack,-mno-istackโ enable interrupt stack instructions; default is off. ๐ซถ Lowkey important: the-mistackoption is required to handle theinterruptandisrfunction attributes.-mmpโ enable multiprocessor instructions; default is off ๐-mcpโ enable coprocessor instructions; default is off ๐ฅ-mcacheโ enable coprocessor instructions; default is off ๐
okay yes,-mcpand-mcachehave the exact same description in the original, that's not me being lazy, that's just the lore ๐
-msecurityโ enable C-SKY security instructions; default is off ๐-mtrustโ enable C-SKY trust instructions; default is off ๐-mdsp,-medsp,-mvdspโ 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 is ignored for CK801, where this is just the required behavior, and it defaults to on for CK802. For other targets, default is off ๐ง-mhigh-registers,-mno-high-registersโ generate code using the high registers numbered16-31. Not supported on CK801, CK802, or CK803, and it's enabled by default for other processors โจ-manchor,-mno-anchorโ generate code using global anchor symbol addresses ๐-mpushpop,-mno-pushpopโ generate code usingpushandpopinstructions. Defaults to on ๐-mmultiple-stld,-mstm,-mno-multiple-stld,-mno-stmโ generate code usingstmandldminstructions. Not supported on CK801, but enabled by default on other processors ๐ฆ-mconstpool,-mno-constpoolโ create constant pools in the compiler instead of deferring it to the assembler. This is the default and it's required for correct code generation on CK801 and CK802, and optional on other processors ๐ธ-mstack-size,-mno-stack-sizeโ emit.stack_sizedirectives 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. ๐จ Careful bestie: using this option can result in code that is not compliant with the C-SKY V2 ABI prologue requirements and that cannot be debugged or backtraced. It is disabled by default. That's giving "do not pass go" energy ngl ๐
๐ 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 โจ
The subtype of the file created (like ppc7400 or ppc970 or i686) is determined by the flags that specify the ISA that GCC is targeting, like -mcpu or -march. The -force_cpusubtype_ALL option can be used to override this ๐
The Darwin tools vary in their behavior when presented with an ISA mismatch. The assembler, as, only permits instructions to be used that are valid for the subtype of the file it is generating, so you cannot put 64-bit instructions in a ppc750 object file. The linker for shared libraries, /usr/bin/libtool, fails and prints an error if asked to create a shared library with a less restrictive subtype than its input files (for instance, trying to put a ppc970 object file in a ppc7400 library). The linker for executables, ld, quietly gives the executable the most restrictive subtype of any of its input files ๐
-Fdirโ add the framework directory dir to the head of the list of directories to be searched for header files. These directories are interleaved with those specified by-Ioptions and are scanned in a left-to-right order ๐
A framework directory is a directory with frameworks in it. A framework is a directory with a Headers and/or PrivateHeaders directory contained directly in it that ends in .framework. The name of a framework is the name of this directory excluding the .framework. Headers associated with the framework are found in one of those two directories, with Headers being searched first. A subframework is a framework directory that is in a framework's Frameworks directory. Includes of subframework headers can only appear in a header of a framework that contains the subframework, or in a sibling subframework header. Two subframeworks are siblings if they occur in the same framework. A subframework should not have the same name as a framework; a warning is issued if this is violated. Currently a subframework cannot have subframeworks; in the future, the mechanism may be extended to support this. The standard frameworks can be found in /System/Library/Frameworks and /Library/Frameworks. An example include looks like #include <Framework/header.h>, where Framework denotes the name of the framework and header.h is found in the PrivateHeaders or Headers directory ๐
-iframeworkdirโ like-Fexcept the directory is treated as a system directory. The main difference between this-iframeworkand-Fis that with-iframeworkthe compiler does not warn about constructs contained within header files found via dir. This option is valid only for the C family of languages โจ-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 ๐ธ-mmacosx-version-min=versionโ the earliest version of MacOS X that this executable will run on is version. Typical values of version include10.1,10.2, and10.3.9๐ฆ
If the compiler was built to use the system's headers by default, then the default for this option is the system version on which the compiler is running, otherwise the default is to make choices that are compatible with as many systems and code bases as possible ๐
-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 ๐ฅ-mone-byte-boolโ override the defaults forboolso thatsizeof(bool)==1. By defaultsizeof(bool)is4when compiling for Darwin/PowerPC and1when compiling for Darwin/x86, so this option has no effect on x86 ๐
Warning: the -mone-byte-bool switch causes GCC to generate code that is not binary compatible with code generated without that switch. Using this switch may require recompiling all other modules in a program, including system libraries. Use this switch to conform to a non-default data model ๐จ
-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 ๐-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_loader executableโ this option specifies the executable that will load the build output file being linked. Seeman ld(1)for more information ๐ธ-dynamiclibโ when passed this option, GCC produces a dynamic library instead of an executable when linking, using the Darwinlibtoolcommand ๐-force_cpusubtype_ALLโ this causes GCC's output file to have theALLsubtype, instead of one controlled by the-mcpuor-marchoption โญ
bestie listen. these next ones? not even our business fr. GCC literally just takes them and yeets them straight over to the Darwin linker, and the Darwin linker's own man page does all the explaining. We are merely the messenger here ๐ซถ
-allowable_clientclient_name-client_name-compatibility_version-current_version-dead_strip-dependency-file-dylib_file-dylinker_install_name-dynamic-exported_symbols_list-filelist-flat_namespace-force_flat_namespace-headerpad_max_install_names-image_base-init-install_name-keep_private_externs-multi_module-multiply_defined-multiply_defined_unused-noall_load-no_dead_strip_inits_and_terms-nofixprebinding-nomultidefs-noprebind-noseglinkedit-pagezero_size-prebind-prebind_all_twolevel_modules-private_bundle-read_only_relocs-sectalign-sectobjectsymbols-whyload-seg1addr-sectcreate-sectobjectsymbols-sectorder-segaddr-segs_read_only_addr-segs_read_write_addr-seg_addr_table-seg_addr_table_filename-seglinkedit-segprot-segs_read_only_addr-segs_read_write_addr-single_module-static-sub_library-sub_umbrella-twolevel_namespace-umbrella-undefined-unexported_symbols_list-weak_reference_mismatches-whatsloaded
These options are passed to the Darwin linker. The Darwin linker man page describes them in detail. (go read that one, she's the one with the lore ๐ )
๐ DEC Alpha Options ๐
ok so these -m options are the ones defined specifically for the DEC Alpha implementations. Alpha girlies, this one's for you ๐
-mno-soft-float,-msoft-floatโ use (or don't use, hence theno) 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 emulation 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.
heads up bestie: Alpha implementations without floating-point operations are required to have floating-point registers. that's just how she is โจ
-mfp-reg,-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. main character kernel behavior honestly ๐
-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 fully IEEE-compliant code except that the inexact-flag is not maintained (see below). If this option is turned on, the preprocessor macro_IEEE_FPis defined during compilation. The resulting code is less efficient but is able to correctly support denormalized numbers and exceptional IEEE values such as not-a-number and plus/minus infinity. Other Alpha compilers call this option-ieee_with_no_inexact.-mieee-with-inexactโ this is like-mieeeexcept the generated code also maintains the IEEE inexact-flag. Turning on this option causes the generated code to implement fully-compliant IEEE math. In addition to_IEEE_FP,_IEEE_FP_EXACTis defined as a preprocessor macro. On some Alpha implementations the resulting code may execute significantly slower than the code generated by default. Since there is very little code that depends on the inexact-flag, you should normally not specify this option. Other Alpha compilers call this option-ieee_with_inexact.- *
-mfp-trap-mode=trap-mode* โ this option controls what floating-point related traps are enabled. Other Alpha compilers call this option-fptmtrap-mode. The trap mode can be set to one of four values:nโ this is the default (normal) setting. The only traps that are enabled are the ones that cannot be disabled in software (e.g., division by zero trap).uโ in addition to the traps enabled byn, underflow traps are enabled as well.suโ likeu, but the instructions are marked to be safe for software completion (see Alpha architecture manual for details).suiโ likesu, but inexact traps are enabled as well.
- *
-mfp-rounding-mode=rounding-mode* โ selects the IEEE rounding mode. Other Alpha compilers call this option-fprmrounding-mode. The rounding-mode can be one of:nโ normal IEEE rounding mode. Floating-point numbers are rounded towards the nearest machine number or towards the even machine number in case of a tie.mโ round towards minus infinity.cโ chopped rounding mode. Floating-point numbers are rounded towards zero.dโ dynamic rounding mode. A field in the floating-point control register (fpcr, see Alpha architecture reference manual) controls the rounding mode in effect. The C library initializes this register for rounding towards plus infinity. Thus, unless your program modifies thefpcr,dcorresponds to round towards plus infinity.
- *
-mtrap-precision=trap-precision* โ in the Alpha architecture, floating-point traps are imprecise. This means without software assistance it is impossible to recover from a floating trap, and program execution normally needs to be terminated. GCC can generate code that can assist operating system trap handlers in determining the exact location that caused a floating-point trap. Depending on the requirements of an application, different levels of precision can be selected:pโ program precision. This option is the default and means a trap handler can only identify which program caused a floating-point exception.fโ function precision. The trap handler can determine the function that caused a floating-point exception.iโ instruction precision. The trap handler can determine the exact instruction that caused a floating-point exception.
Other Alpha compilers provide the equivalent options called -scope_safe and -resumption_safe.
-mieee-conformantโ this option marks the generated code as IEEE conformant. You must not use this option unless you also specify-mtrap-precision=iand either-mfp-trap-mode=suor-mfp-trap-mode=sui. Its only effect is to emit the line.eflag 48in the function prologue of the generated assembly file.-mbuild-constantsโ normally GCC examines a 32- or 64-bit integer constant to see if it can construct it from smaller constants in two or three instructions. If it cannot, it outputs the constant as a literal and generates code to load it from the data segment at run time.
Use this option to require GCC to construct all integer constants using code, even if it takes more instructions (the maximum is six).
You typically use this option to build a shared library dynamic loader. Itself a shared library, it must relocate itself in memory before it can find the variables and constants in its own data segment. it's giving self-made icon ๐
-mbwx,-mno-bwx,-mcix,-mno-cix,-mfix,-mno-fix,-mmax,-mno-maxโ indicate whether GCC should generate code to use the optional BWX, CIX, FIX and MAX instruction sets. The default is to use the instruction sets supported by the CPU type specified via-mcpu=option, or that of the CPU on which GCC was built if none is specified.-mfloat-vax,-mfloat-ieeeโ generate code that uses (does not use) VAX F and G floating-point arithmetic instead of IEEE single and double precision.-mexplicit-relocs,-mno-explicit-relocsโ older Alpha assemblers provided no way to generate symbol relocations except via assembler macros. Use of these macros does not allow optimal instruction scheduling. GNU binutils as of version 2.12 supports a new syntax that allows the compiler to explicitly mark which relocations should apply to which instructions. This option is mostly useful for debugging, as GCC detects the capabilities of the assembler when it is built and sets the default accordingly.-msmall-data,-mlarge-dataโ when-mexplicit-relocsis in effect, static data is accessed via gp-relative relocations. When-msmall-datais used, objects 8 bytes long or smaller are placed in a small data area (the.sdataand.sbsssections) and are accessed via 16-bit relocations off of the$gpregister. This limits the size of the small data area to 64KB, but allows the variables to be directly accessed via a single instruction.
The default is -mlarge-data. With this option the data area is limited to just below 2GB. Programs that require more than 2GB of data must use malloc or mmap to allocate the data in the heap instead of in the program's data segment.
When generating code for shared libraries, -fpic implies -msmall-data and -fPIC implies -mlarge-data.
-msmall-text,-mlarge-textโ when-msmall-textis used, the compiler assumes that the code of the entire program (or shared library) fits in 4MB, and is thus reachable with a branch instruction. When-msmall-datais used, the compiler can assume that all local symbols share the same$gpvalue, and thus reduce the number of instructions required for a function call from 4 to 1.
The default is -mlarge-text.
- *
-mcpu=cpu_type* โ set the instruction set and instruction scheduling parameters for machine 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 do not 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.
ev5,21164โ schedules like an EV5 and has zero instruction set extensions. that's it, that's the whole vibe ๐ev56,21164aโ schedules like an EV5 but supports the BWX extension.pca56,21164pc,21164PCโ schedules like an EV5 and supports BWX and MAX. two extensions, she's eating ๐ev6,21264โ schedules like an EV6 and supports BWX, FIX, and MAX.ev67,21264aโ schedules like an EV6 and supports BWX, CIX, FIX, and MAX. the whole friend group fr fr ๐
Native toolchains also support the value native, which selects the best architecture option for the host processor. heads up bestie: -mcpu=native has no effect if GCC doesn't recognize the processor. she simply doesn't know her. ๐ญ
-mtune=cpu_typeโ sets only the instruction scheduling parameters for machine type cpu_type. the instruction set itself? untouched. not changed. we're just tuning the vibe, not the whole personality. โจ
Native toolchains also support the value native, which picks the best architecture option for the host processor. and again โ -mtune=native has no effect if GCC doesn't recognize the processor. ๐
-mmemory-latency=timeโ sets how many cycles the scheduler should assume a typical memory reference takes, as seen by the application. ngl this number is super dependent on the memory access patterns your app uses and the size of the external cache on the machine. so likeโฆ it's giving "it depends" ๐
Valid options for time are:
numberโ a decimal number representing clock cycles.L1,L2,L3,mainโ the compiler has built-in estimates of the number of clock cycles for "typical" EV4 & EV5 hardware for the Level 1, 2 & 3 caches (also called Dcache, Scache, and Bcache), plus main memory. quick note bestie:L3is only valid for EV5. ๐
โจ eBPF Options โจ
-mframe-limit=bytesโ sets the hard limit for frame sizes, in bytes. currently the value you can specify has to be less than or equal to32767. defaults to whatever limit the version of the Linux kernel you're targeting imposes. no cap.-mkernel=versionโ says what the minimum version of the kernel is that will run the compiled program. GCC uses this to figure out which instructions to use, which kernel helpers to allow, etc. currently version can be one of4.0,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,4.10,4.11,4.12,4.13,4.14,4.15,4.16,4.17,4.18,4.19,4.20,5.0,5.1,5.2,latestandnative. that's a lot of versions but okay girl we're keeping up ๐ช-mbig-endianโ generate code for a big-endian target.-mlittle-endianโ generate code for a little-endian target. and bestieโฆ this is the default. ๐-mxbpfโ generate code for an expanded version of BPF, one that relaxes some of the restrictions the BPF architecture imposes:- <Save and restore callee-saved registers at function entry and> exit, respectively.
โจ FR30 Options โจ
These options are defined specifically for the FR30 port.
-msmall-modelโ use the small address space model. this can produce smaller code, but it does assume that all symbolic values and addresses fit into a 20-bit range. so like, know your data first bestie ๐ญ-mno-lsimโ assume that runtime support has already been provided, so there's no need to include the simulator library (libsim.a) on the linker command line.
โจ FT32 Options โจ
These options are defined specifically for the FT32 port.
-msimโ specifies that the program will be run on the simulator. this makes an alternate runtime startup and library get linked in. > WARNING bestie: you must not use this option when generating programs that will run on real hardware โ you have to provide your own runtime library for whatever I/O functions are needed. ๐-mlraโ enable Local Register Allocation. this is still experimental for FT32, so by default the compiler uses standard reload. she's in her testing era ๐งช-mnodivโ do not usedivandmodinstructions.-mft32bโ enable use of the extended instructions of the FT32B processor.-mcompressโ compress all code using the Ft32B code compression scheme.-mnopmโ do not generate code that reads program memory.
โจ FRV Options โจ
-mgpr-32โ only use the first 32 general-purpose registers.-mgpr-64โ use all 64 general-purpose registers.-mfpr-32โ use only the first 32 floating-point registers.-mfpr-64โ use all 64 floating-point registers.-mhard-floatโ use hardware instructions for floating-point operations.-msoft-floatโ use library routines for floating-point operations.-malloc-ccโ dynamically allocate condition code registers.-mfixed-ccโ do not try to dynamically allocate condition code registers; only use"icc0"and"fcc0".-mdwordโ change ABI to use double word insns.-mno-dwordโ do not use double word instructions.-mdoubleโ use floating-point double instructions.-mno-doubleโ do not use floating-point double instructions.-mmediaโ use media instructions.-mno-mediaโ do not use media instructions.-mmuladdโ use multiply and add/subtract instructions.-mno-muladdโ do not use multiply and add/subtract instructions.-mfdpicโ select the FDPIC ABI, which uses function descriptors to represent pointers to functions. with no PIC/PIE-related options at all, 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. and with a bfin-elf target, this option implies-msim. ๐ฆ-minline-pltโ enable inlining of PLT entries in function calls to functions that aren't known to bind locally. it has no effect without-mfdpic. it's enabled by default if optimizing for speed and compiling for shared libraries (i.e.,-fPICor-fpic), or when an optimization option such as-O3or above is present in the command line.-mTLSโ assume a large TLS segment when generating thread-local code.-mtlsโ do not assume a large TLS segment when generating thread-local code.-mgprel-roโ enable the use of"GPREL"relocations in the FDPIC ABI for data that's known to be in read-only sections. it's enabled by default, except for-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's 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. bestie 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 lets those functions be placed anywhere within the 32-bit address space. โจ-malign-labelsโ try to align labels to an 8-byte boundary by inserting NOPs into the previous packet. this option only has an effect when VLIW packing is enabled. it doesn't create new packets; it merely adds NOPs to existing ones. no new drama, just filler ๐-mlibrary-picโ generate position-independent EABI code.-macc-4โ use only the first four media accumulator registers.-macc-8โ use all eight media accumulator registers.-mpackโ pack VLIW instructions.-mno-packโ do not pack VLIW instructions.-mno-eflagsโ do not mark ABI switches ine_flags.-mcond-moveโ enable the use of conditional-move instructions (default).
this switch is mainly for debugging the compiler and will likely be removed in a future version. so like, don't get attached. ๐
-mno-cond-moveโ disable the use of conditional-move instructions.
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-msccโ enable the use of conditional set instructions (default).
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-mno-sccโ disable the use of conditional set instructions.
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-mcond-execโ enable the use of conditional execution (default).
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-mno-cond-execโ disable the use of conditional execution.
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-mvliw-branchโ run a pass to pack branches into VLIW instructions (default).
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-mno-vliw-branchโ do not run a pass to pack branches into VLIW instructions.
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-mmulti-cond-execโ enable optimization of"&&"and"||"in conditional execution (default).
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-mno-multi-cond-execโ disable optimization of"&&"and"||"in conditional execution.
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-mnested-cond-execโ enable nested conditional execution optimizations (default).
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-mno-nested-cond-execโ disable nested conditional execution optimizations.
this switch is mainly for debugging the compiler and will likely be removed in a future version.
-moptimize-membarโ this switch removes redundant"membar"instructions from the compiler-generated code. it's enabled by default. โจ-mno-optimize-membarโ this switch disables the automatic removal of redundant"membar"instructions from the generated code.-mtomcat-statsโ causegasto print out tomcat statistics. ๐-mcpu=cpuโ select the processor type for which to generate code. possible values arefrv,fr550,tomcat,fr500,fr450,fr405,fr400,fr300andsimple. pick your fighter ๐ซถ
โจ GNU/Linux Options โจ
okay bestie, these -m options are literally 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 the 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 the Bionic C library. This is the default on*-*-linux-*android*targets.-mandroidโ Compile code compatible with Android platform. This is the default on*-*-linux-*android*targets.
When compiling, this option enables -mbionic, -fPIC, -fno-exceptions and -fno-rtti by default. When linking, this option makes the GCC driver pass Android-specific options to the linker. Finally, this option causes the preprocessor macro "__ANDROID__" to be defined.
-tno-android-ccโ Disable compilation effects of-mandroid, i.e., do not enable-mbionic,-fPIC,-fno-exceptionsand-fno-rttiby default.-tno-android-ldโ Disable linking effects of-mandroid, i.e., pass standard Linux linking options to the linker.
โจ H8/300 Options โจ
These -m options are defined for the H8/300 implementations:
-mrelaxโ Shorten some address references at link time, when possible; uses the linker option-relax.-mhโ Generate code for the H8/300H.-msโ Generate code for the H8S.-mnโ Generate code for the H8S and H8/300H in the normal mode. This switch must be used either with-mhor-ms.-ms2600โ Generate code for the H8S/2600. This switch must be used with-ms.-mexrโ Extended registers are stored on stack before execution of function with monitor attribute. Default option is-mexr. This option is valid only for H8S targets.-mno-exrโ Extended registers are not stored on stack before execution of function with monitor attribute. Default option is-mno-exr. This option is valid only for H8S targets.-mint32โ Make"int"data 32 bits by default.-malign-300โ On the H8/300H and H8S, use the same alignment rules as for the H8/300. The default for the H8/300H and H8S is to align longs and floats on 4-byte boundaries.-malign-300causes them to be aligned on 2-byte boundaries. This option has no effect on the H8/300.
๐ HPPA Options ๐
These -m options are defined for the HPPA family of computers:
-march=architecture-typeโ Generate code for the specified architecture. The choices for architecture-type are1.0for PA 1.0,1.1for PA 1.1, and2.0for PA 2.0 processors. Refer to/usr/lib/sched.modelson an HP-UX system to determine the proper architecture option for your machine. Code compiled for lower numbered architectures runs on higher numbered architectures, but not the other way around.-mpa-risc-1-0,-mpa-risc-1-1,-mpa-risc-2-0โ Synonyms for-march=1.0,-march=1.1, and-march=2.0respectively.-mcaller-copiesโ The caller copies function arguments passed by hidden reference. This option should be used with care as it is not compatible with the default 32-bit runtime. However, only aggregates larger than eight bytes are passed by hidden reference and the option provides better compatibility with OpenMP.-mjump-in-delayโ This option is ignored and provided for compatibility purposes only.-mdisable-fpregsโ Prevent floating-point registers from being used in any manner. This is necessary for compiling kernels that perform lazy context switching of floating-point registers. If you use this option and attempt to perform floating-point operations, the compiler aborts.-mdisable-indexingโ Prevent the compiler from using indexing address modes. This avoids some rather obscure problems when compiling MIG generated code under MACH.-mno-space-regsโ Generate code that assumes the target has no space registers. This allows GCC to generate faster indirect calls and use unscaled index address modes.
Such code is suitable for level 0 PA systems and kernels.
-mfast-indirect-callsโ Generate code that assumes calls never cross space boundaries. This allows GCC to emit code that performs faster indirect calls.
This option does not work in the presence of shared libraries or nested functions.
-mfixed-range=register-rangeโ Generate code treating the given register range as fixed registers. A fixed register is one that the register allocator cannot use. This is useful when compiling kernel code. A register range is specified as two registers separated by a dash. Multiple register ranges can be specified separated by a comma.-mlong-load-storeโ Generate 3-instruction load and store sequences as sometimes required by the HP-UX 10 linker. This is equivalent to the+koption to the HP compilers.-mportable-runtimeโ Use the portable calling conventions proposed by HP for ELF systems.-mgasโ Enable the use of assembler directives only GAS understands.-mschedule=cpu-typeโ Schedule code according to the constraints for the machine type cpu-type. The choices for cpu-type are700,7100,7100LC,7200,7300and8000. Refer to/usr/lib/sched.modelson an HP-UX system to determine the proper scheduling option for your machine. The default scheduling is8000.-mlinker-optโ Enable the optimization pass in the HP-UX linker. Note this makes symbolic debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9 linkers in which they give bogus error messages when linking some programs.-msoft-floatโ Generate output containing library calls for floating point.
Warning: the requisite libraries are not available for all HPPA targets. Normally the facilities of the machine's usual C compiler are used, but this cannot be done directly in cross-compilation. You must make your own arrangements to provide suitable library functions for cross-compilation.
-msoft-float changes the calling convention in the output file; therefore, it is only useful if you compile all of a program with this option. In particular, you need to compile libgcc.a, the library that comes with GCC, with -msoft-float in order for this to work.
-msioโ Generate the predefine,"_SIO", for server IO. The default is-mwsio. This generates the predefines,"__hp9000s700","__hp9000s700__"and"_WSIO", for workstation IO. These options are available under HP-UX and HI-UX.-mgnu-ldโ Use options specific to GNU ld. This passes-sharedto ld when building a shared library. It is the default when GCC is configured, explicitly or implicitly, with the GNU linker. This option does not affect which ld is called; it only changes what parameters are passed to that ld. The ld that is called is determined by the--with-ldconfigure option, GCC's program search path, and finally by the user's PATH. The linker used by GCC can be printed using whichgcc -print-prog-name=ld. This option is only available on the 64-bit HP-UX GCC, i.e. configured withhppa*64*-*-hpux*.-mhp-ldโ Use options specific to HP ld. This passes-bto ld when building a shared library and passes+Accept TypeMismatchto ld on all links. It is the default when GCC is configured, explicitly or implicitly, with the HP linker. This option does not affect which ld is called; it only changes what parameters are passed to that ld. The ld that is called is determined by the--with-ldconfigure option, GCC's program search path, and finally by the user's PATH. The linker used by GCC can be printed using whichgcc -print-prog-name=ld. This option is only available on the 64-bit HP-UX GCC, i.e. configured withhppa*64*-*-hpux*.-mlong-callsโ Generate code that uses long call sequences. This ensures that a call is always able to reach linker generated stubs. The default is to generate long calls only when the distance from the call site to the beginning of the function or translation unit, as the case may be, exceeds a predefined limit set by the branch type being used. The limits for normal calls are 7,600,000 and 240,000 bytes, respectively for the PA 2.0 and PA 1.X architectures. Sibcalls are always limited at 240,000 bytes.
Distances are measured from the beginning of functions when using the -ffunction-sections option, or when using the -mgas and -mno-portable-runtime options together under HP-UX with the SOM linker.
It is normally not desirable to use this option as it degrades performance. However, it may be useful in large applications, particularly when partial linking is used to build the application.
The types of long calls used depends on the capabilities of the assembler and linker, and the type of code being generated. The impact on systems that support long absolute calls, and long pic symbol-difference or pc-relative calls should be relatively small. However, an indirect call is used on 32-bit ELF systems in pic code and it is quite long.
-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 though to 11.00, and98for HP-UX 11.11 and later.
-munix=93 provides the same predefines as GCC 3.3 and 3.4. -munix=95 provides additional predefines for "XOPEN_UNIX" and "_XOPEN_SOURCE_EXTENDED", and the startfile unix95.o. -munix=98 provides additional predefines for "_XOPEN_UNIX", "_XOPEN_SOURCE_EXTENDED", "_INCLUDE__STDC_A1_SOURCE" and "_INCLUDE_XOPEN_SOURCE_500", and the startfile unix98.o.
It is important to note that this option changes the interfaces for various library routines. It also affects the operational behavior of the C library. Thus, extreme care is needed in using this option.
Library code that is intended to operate with more than one UNIX standard must test, set and restore the variable "__xpg4_extended_mask" as appropriate. Most GNU software doesn't provide this capability.
-nolibdldโ Suppress the generation of link options to searchlibdld.slwhen the-staticoption is specified on HP-UX 10 and later.-staticโ okay so here's the HP-UX tea ๐ซ: the HP-UX implementation ofsetlocalein libc has a dependency onlibdld.sl. And there is no archive version oflibdld.sl. So the moment you pass-static, some special link options are needed to resolve that dependency.
On HP-UX 10 and later, the GCC driver adds the necessary options to link with libdld.sl whenever -static is specified. Which meansโฆ the resulting binary ends up being dynamic. ๐ And on the 64-bit port, the linkers generate dynamic binaries by default in any case anyway. If you want to stop the GCC driver from adding these link options, that's what -nolibdld is for.
-threadsโ adds support for multithreading with the dce thread library under HP-UX. This one sets flags for both the preprocessor and the linker. Teamwork ๐
โจ IA-64 Options โจ
These are the -m options defined for the Intel IA-64 architecture. Buckle up bestie, there's a lot ๐
-mbig-endianโ generate code for a big-endian target. This is the default for HP-UX.-mlittle-endianโ generate code for a little-endian target. This is the default for AIX5 and GNU/Linux.-mgnu-as,-mno-gnu-asโ generate (or don't) code for the GNU assembler. This is the default.-mgnu-ld,-mno-gnu-ldโ generate (or don't) code for the GNU linker. This is the default.-mno-picโ generate code that does not use a global pointer register. Heads up: the result is not position independent code, and it violates the IA-64 ABI. ๐-mvolatile-asm-stop,-mno-volatile-asm-stopโ generate (or don't) a stop bit immediately before and after volatile asm statements.-mregister-names,-mno-register-namesโ generate (or don't)in,loc, andoutregister names for the stacked registers. This may make assembler output more readable. ๐-mno-sdata,-msdataโ disable (or enable) optimizations that use the small data section. This may be useful for working around optimizer bugs.-mconstant-gpโ generate code that uses a single constant global pointer value. Useful when compiling kernel code.-mauto-picโ generate code that is self-relocatable. This implies-mconstant-gp. Useful when compiling firmware code.-minline-float-divide-min-latencyโ generate code for inline divides of floating-point values using the minimum latency algorithm.-minline-float-divide-max-throughputโ generate code for inline divides of floating-point values using the maximum throughput algorithm.-mno-inline-float-divideโ do not generate inline code for divides of floating-point values.-minline-int-divide-min-latencyโ generate code for inline divides of integer values using the minimum latency algorithm.-minline-int-divide-max-throughputโ generate code for inline divides of integer values using the maximum throughput algorithm.-mno-inline-int-divideโ do not generate inline code for divides of integer values.-minline-sqrt-min-latencyโ generate code for inline square roots using the minimum latency algorithm.-minline-sqrt-max-throughputโ generate code for inline square roots using the maximum throughput algorithm.-mno-inline-sqrtโ do not generate inline code for"sqrt".-mfused-madd,-mno-fused-maddโ do (don't) generate code that uses the fused multiply/add or multiply/subtract instructions. The default is to use these instructions.-mno-dwarf2-asm,-mdwarf2-asmโ don't (or do) generate assembler code for the DWARF line number debugging info. This may be useful when not using the GNU assembler.-mearly-stop-bits,-mno-early-stop-bitsโ allow stop bits to be placed earlier than immediately preceding the instruction that triggered the stop bit. This can improve instruction scheduling, but does not always do so. Not me promising results I can't guarantee ๐ญ-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. 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 of"ld.a"instructions and the corresponding check instructions ("ld.c"/"chk.a"). The default setting is disabled.-msched-ar-data-spec,-mno-sched-ar-data-specโ (en/dis)able data speculative scheduling after reload. This results in generation of"ld.a"instructions and the corresponding check instructions ("ld.c"/"chk.a"). The default setting is enabled.-mno-sched-control-spec,-msched-control-specโ (dis/en)able control speculative scheduling. This feature is available only during region scheduling (i.e. before reload). This results in generation of the"ld.s"instructions and the corresponding check instructions"chk.s". The default setting is disabled.-msched-br-in-data-spec,-mno-sched-br-in-data-specโ (en/dis)able speculative scheduling of the instructions that are dependent on the data speculative loads before reload. This is effective only with-msched-br-data-specenabled. The default setting is enabled.-msched-ar-in-data-spec,-mno-sched-ar-in-data-specโ (en/dis)able speculative scheduling of the instructions that are dependent on the data speculative loads after reload. This is effective only with-msched-ar-data-specenabled. The default setting is enabled.-msched-in-control-spec,-mno-sched-in-control-specโ (en/dis)able speculative scheduling of the instructions that are dependent on the control speculative loads. This is effective only with-msched-control-specenabled. The default setting is enabled.-mno-sched-prefer-non-data-spec-insns,-msched-prefer-non-data-spec-insnsโ if enabled, data-speculative instructions are chosen for schedule only if there are no other choices at the moment. This makes the use of the data speculation much more conservative. The default setting is disabled.-mno-sched-prefer-non-control-spec-insns,-msched-prefer-non-control-spec-insnsโ if enabled, control-speculative instructions are chosen for schedule only if there are no other choices at the moment. This makes the use of the control speculation much more conservative. The default setting is disabled.-mno-sched-count-spec-in-critical-path,-msched-count-spec-in-critical-pathโ if enabled, speculative dependencies are considered during computation of the instructions priorities. This makes the use of the speculation a bit more conservative. The default setting is disabled.-msched-spec-ldcโ use a simple data speculation check. This option is on by default.-msched-control-spec-ldcโ use a simple check for control speculation. This option is on by default.-msched-stop-bits-after-every-cycleโ place a stop bit after every cycle when scheduling. This option is on by default.-msched-fp-mem-deps-zero-costโ assume that floating-point stores and loads are not likely to cause a conflict when placed into the same instruction group. This option is disabled by default.-msel-sched-dont-check-control-specโ generate checks for control speculation in selective scheduling. This flag is disabled by default.-msched-max-memory-insns=max-insnsโ limit on the number of memory insns per instruction group, giving lower priority to subsequent memory insns attempting to schedule in the same instruction group. Frequently useful to prevent cache bank conflicts. The default value is1.-msched-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.
๐ฆ M32C Options ๐ฆ
-mcpu=nameโ select the CPU for which code is generated.namemay be one ofr8cfor the R8C/Tiny series,m16cfor the M16C (up to /60) series,m32cmfor the M16C/80 series, orm32cfor the M32C/80 series.-msimโ specifies that the program will be run on the simulator. This causes an alternate runtime library to be linked in which supports, for example, file I/O.
Okay real talk bestie: 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. No shortcuts ๐
-memregs=numberโ specifies the number of memory-based pseudo-registers GCC uses during code generation. These pseudo-registers are used like real registers, so there is a tradeoff between GCC's ability to fit the code into available registers, and the performance penalty of using memory instead of registers.
Note that all modules in a program must be compiled with the same value for this option. Because of that, you must not use this option with GCC's default runtime libraries. Consistency is the vibe check โจ
๐ 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โ bestie, this is the โจvibeโจ where every single object is assumed to live in the lower 16MB of memory, so its address can just be loaded with theld24instruction, and every subroutine is assumed to be reachable with theblinstruction. This is the default. The addressability of a particular object can be set with themodelattribute. ๐-mmodel=mediumโ now we're assuming objects could be anywhere in the 32-bit address space (so the compiler generatesseth/add3instructions to load their addresses), but all subroutines are still assumed reachable with theblinstruction. ๐ฆ-mmodel=largeโ objects may be anywhere in the 32-bit address space (compiler generatesseth/add3instructions to load their addresses), and subroutines may not be reachable with theblinstruction. So the compiler generates the much slowerseth/add3/jlinstruction sequence instead. ๐-msdata=noneโ disables use of the small data area entirely. Variables get put into one of.data,.bss, or.rodata(unless thesectionattribute has been specified). This is the default. Just so you know: the small data area consists of the sections.sdataand.sbss, and objects may be explicitly put in the small data area with thesectionattribute using one of those sections. ๐ธ-msdata=sdataโ puts small global and static data in the small data area, but does not generate special code to reference them. ๐-msdata=useโ puts small global and static data in the small data area, and generates special instructions to reference them. slay. ๐-G numโ puts 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 is8. Heads up: 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. it's giving detective energy ๐-malign-loopsโ aligns all loops to a 32-byte boundary. ๐-mno-align-loopsโ do not enforce a 32-byte alignment for loops. This is the default. ๐-missue-rate=numberโ issue number instructions per cycle. number can only be1or2. โญ-mbranch-cost=numberโ number can only be1or2. If it is1then branches are preferred over conditional code, if it is2, then the opposite applies. ๐-mflush-trap=numberโ specifies the trap number to use to flush the cache. The default is12. Valid numbers are between0and15inclusive. ๐-mno-flush-trapโ specifies that the cache cannot be flushed by using a trap. ๐ซ-mflush-func=nameโ specifies the name of the operating system function to call to flush the cache. The default is_flush_cache, but a function call is only used if a trap is not available. โจ-mno-flush-funcโ indicates that there is no OS function for flushing the cache. ๐ญ
๐ M680x0 Options ๐
These are the -m options defined for M680x0 and ColdFire processors, bestie. The default settings depend on which architecture was selected when the compiler was configured; the defaults for the most common choices are given below. ๐ธ
-march=archโ generate code for a specific M680x0 or ColdFire instruction set architecture. Permissible values of arch for M680x0 architectures are:68000,68010,68020,68030,68040,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. no cap ๐
-mcpu=cpuโ generate code for a specific M680x0 or ColdFire processor. The M680x0 cpus are:68000,68010,68020,68030,68040,68060,68302,68332andcpu32. The ColdFire cpus are given by the table below, which also classifies the CPUs into families: ๐- Family
51:5151ac51ag51cn51em51je51jf51jg51jm51mm51qe51qm - Family
5206:520252045206 - Family
5206e:5206e - Family
5208:52075208 - Family
5211a:5210a5211a - Family
5213:521152125213 - Family
5216:52145216 - Family
52235:522305223152232522335223452235 - Family
5225:52245225 - Family
52259:522525225452255522565225852259 - Family
5235:5232523352345235523x - Family
5249:5249 - Family
5250:5250 - Family
5271:52705271 - Family
5272:5272 - Family
5275:52745275 - Family
5282:528052815282528x - Family
53017:53011530125301353014530155301653017 - Family
5307:5307 - Family
5329:532753285329532x - Family
5373:53725373537x - Family
5407:5407 - Family
5475:547054715472547354745475547x548054815482548354845485
- Family
-mcpu=cpu overrides -march=arch if arch is compatible with cpu. Other combinations of -mcpu and -march are rejected. ๐ซ
GCC defines the macro __mcf_cpu_cpu when ColdFire target cpu is selected. It also defines __mcf_family_family, where the value of family is given by the table above. โจ
-mtune=tuneโ tune the code for a particular microarchitecture within the constraints set by-marchand-mcpu. The M680x0 microarchitectures are:68000,68010,68020,68030,68040,68060andcpu32. The ColdFire microarchitectures are:cfv1,cfv2,cfv3,cfv4andcfv4e. ๐
You can also use -mtune=68020-40 for code that needs to run relatively well on 68020, 68030 and 68040 targets. -mtune=68020-60 is similar but includes 68060 targets as well. These two options select the same tuning decisions as -m68020-40 and -m68020-60 respectively. ๐
GCC defines the macros __mcarch and __mcarch__ when tuning for 680x0 architecture arch. It also defines mcarch unless either -ansi or a non-GNU -std option is used. If GCC is tuning for a range of architectures, as selected by -mtune=68020-40 or -mtune=68020-60, it defines the macros for every architecture in the range. ๐
GCC also defines the macro __muarch__ when tuning for ColdFire microarchitecture uarch, where uarch is one of the arguments given above. ๐
-m68000-mc68000
Generate output for a 68000. This is the default when the compiler is configured for 68000-based systems. It is equivalent to -march=68000. โจ
Use this option for microcontrollers with a 68000 or EC000 core, including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356. ๐ฆ
-m68010โ generate output for a 68010. This is the default when the compiler is configured for 68010-based systems. It is equivalent to-march=68010. ๐ธ-m68020-mc68020
Generate output for a 68020. This is the default when the compiler is configured for 68020-based systems. It is equivalent to -march=68020. ๐
-m68030โ generate output for a 68030. This is the default when the compiler is configured for 68030-based systems. It is equivalent to-march=68030. โญ-m68040โ generate output for a 68040. This is the default when the compiler is configured for 68040-based systems. It is equivalent to-march=68040. ๐
This option inhibits the use of 68881/68882 instructions that have to be emulated by software on the 68040. Use this option if your 68040 does not have code to emulate those instructions. ๐ซถ
-m68060โ generate output for a 68060. This is the default when the compiler is configured for 68060-based systems. It is equivalent to-march=68060. ๐
This option inhibits the use of 68020 and 68881/68882 instructions that have to be emulated by software on the 68060. Use this option if your 68060 does not have code to emulate those instructions. ๐ญ
-mcpu32โ generate output for a CPU32. This is the default when the compiler is configured for CPU32-based systems. It is equivalent to-march=cpu32. ๐ฅ
Use this option for microcontrollers with a CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334, 68336, 68340, 68341, 68349 and 68360. ๐
-m5200โ generate output for a 520X ColdFire CPU. This is the default when the compiler is configured for 520X-based systems. It is equivalent to-mcpu=5206, and is now deprecated in favor of that option. ๐
Use this option for microcontroller with a 5200 core, including the MCF5202, MCF5203, MCF5204 and MCF5206. โจ
-m5206eโ generate output for a 5206e ColdFire CPU. The option is now deprecated in favor of the equivalent-mcpu=5206e. ๐-m528xโ generate output for a member of the ColdFire 528X family. The option is now deprecated in favor of the equivalent-mcpu=528x. ๐ธ-m5307โ generate output for a ColdFire 5307 CPU. The option is now deprecated in favor of the equivalent-mcpu=5307. ๐ฆ-m5407โ generate output for a ColdFire 5407 CPU. The option is now deprecated in favor of the equivalent-mcpu=5407. โญ-mcfv4eโ generate output for a ColdFire V4e family CPU (e.g.547x/548x). This includes use of hardware floating-point instructions. The option is equivalent to-mcpu=547x, and is now deprecated in favor of that option. ๐-m68020-40โ generate output for a 68040, without using any of the new instructions. This results in code that can run relatively efficiently on either a 68020/68881 or a 68030 or a 68040. The generated code does use the 68881 instructions that are emulated on the 68040. ๐
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 for68000,68010, and68832targets, and it's also the default for ColdFire devices that have no FPU. no FPU? no problem bestie ๐-mdiv,-mno-divโ generate (or don't 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 gets taken from the target CPU โ either the default CPU or the one you specified with-mcpu. For example, the default is"off"for-mcpu=5206and"on"for-mcpu=5206e.
GCC defines the macro __mcfhwdiv__ when this option is enabled. manifesting โจ
-mshortโ treat typeintas 16 bits wide, likeshort int. Also, parameters passed on the stack get aligned to a 16-bit boundary even on targets whose API mandates promotion to 32-bit. little guys ๐-mno-shortโ do NOT consider typeintto be 16 bits wide. This is the default.-mnobitfield,-mno-bitfieldโ do not use the bit-field instructions. Heads up: the-m68000,-mcpu32and-m5200options imply-mnobitfield.-mbitfieldโ do use the bit-field instructions. The-m68020option implies-mbitfield. This is the default if you use a configuration designed for a 68020. bit-fields are eating fr ๐-mrtdโ use a different function-calling convention, where functions that take a fixed number of arguments return with thertdinstruction, which pops their arguments while returning. This saves one instruction in the caller since there's no need to pop the arguments there. efficiency queen ๐
โ ๏ธ This calling convention is incompatible with the one normally used on Unix, so you can't 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.) not the vibe, bestie ๐ญ
The rtd instruction is supported by the 68010, 68020, 68030, 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
The default is -mno-rtd.
-malign-int,-mno-align-intโ control whether GCC alignsint,long,long long,float,double, andlong doublevariables on a 32-bit boundary (-malign-int) or a 16-bit boundary (-mno-align-int). Aligning variables on 32-bit boundaries produces code that runs somewhat faster on processors with 32-bit busses, at the expense of more memory. trade-offs are so real ๐
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. proceed with caution fr fr ๐
-mpcrelโ use the pc-relative addressing mode of the68000directly, instead of using a global offset table. At present, this option implies-fpic, allowing at most a 16-bit offset for pc-relative addressing.-fPICis not presently supported with-mpcrel, though this could be supported for 68020 and higher processors. yes the manpage just casually drops this one on you ๐ฆ-mno-strict-align,-mstrict-alignโ do not (do) assume that unaligned memory references are handled by the system.-msep-dataโ generate code that lets the data segment live in a different area of memory from the text segment. This allows for execute-in-place in an environment without virtual memory management. This option implies-fPIC. living separately, thriving individually โจ-mno-sep-dataโ generate code that assumes the data segment follows the text segment. This is the default.-mid-shared-libraryโ generate code that supports shared libraries via the library ID method. This allows for execute-in-place and shared libraries in an environment without virtual memory management. This option implies-fPIC. sharing is caring ๐ซถ-mno-id-shared-libraryโ generate code that doesn't assume ID-based shared libraries are being used. This is the default.-mshared-library-id=nโ specifies the identification number of the ID-based shared library being compiled. Specifying a value of0generates more compact code; specifying other values forces the allocation of that number to the current library, but is no more space- or time-efficient than omitting this option. zero is the moment, the rest is just extra ๐-mxgot,-mno-xgotโ when generating position-independent code for ColdFire, generate code that works if the GOT has more than 8192 entries. This code is larger and slower than code generated without this option. On M680x0 processors, this option is not needed;-fPICsuffices.
GCC normally uses a single instruction to load values from the GOT. While this is relatively efficient, it only works if the GOT is smaller than about 64k. Anything larger causes the linker to report an error such as:
relocation truncated to fit: R_68K_GOT16O foobar
If this happens, you should recompile your code with -mxgot. It should then work with very large GOTs. However, code generated with -mxgot is less efficient, since it takes 4 instructions to fetch the value of a global symbol. 4 whole instructions?? the horror ๐ญ
Note that some linkers, including newer versions of the GNU linker, can create multiple GOTs and sort GOT entries. If you have such a linker, you should only need to use -mxgot when compiling a single object file that accesses more than 8192 GOT entries. Very few do. very few fr ๐
These options have no effect unless GCC is generating position-independent code.
-mlong-jump-table-offsetsโ use 32-bit offsets inswitchtables. The default is to use 16-bit offsets.
๐ MCore Options ๐
These are the -m options defined for the Motorola M*Core processors. deep lore incoming ๐ฆ
-mhardlit,-mno-hardlitโ inline constants into the code stream if it can be done in two instructions or less.-mdiv,-mno-divโ use the divide instruction. (Enabled by default).-mrelax-immediate,-mno-relax-immediateโ allow arbitrary-sized immediates in bit operations.-mwide-bitfields,-mno-wide-bitfieldsโ always treat bit-fields asint-sized.-m4byte-functions,-mno-4byte-functionsโ force all functions to be aligned to a 4-byte boundary.-mcallgraph-data,-mno-callgraph-dataโ emit callgraph information.-mslow-bytes,-mno-slow-bytesโ prefer word access when reading byte quantities.-mlittle-endian,-mbig-endianโ generate code for a little-endian target.-m210,-m340โ generate code for the 210 processor.-mno-lsimโ assume that runtime support has been provided and so omit the simulator library (libsim.a) from the linker command line. we don't need it bestie, trust ๐-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. segfault jumpscare ๐ The default value is0x1000.
๐ MeP Options ๐
-mabsdiffโ enables theabsinstruction, which is the absolute difference between two registers.-mall-optsโ enables all the optional instructions---average, multiply, divide, bit operations, leading zero, absolute difference, min/max, clip, and saturation. the everything bagel โจ-maverageโ enables theaveinstruction, which computes the average of two registers.-mbased=nโ variables of size n bytes or smaller are placed in the.basedsection by default. Based variables use the$tpregister as a base register, and there is a 128-byte limit to the.basedsection. 128 bytes, that's it, that's the whole budget ๐-mbitopsโ enables the bit operation instructions---bit test (btstm), set (bsetm), clear (bclrm), invert (bnotm), and test-and-set (tas).-mc=nameโ selects which section constant data is placed in. name may betiny,near, orfar.-mclipโ enables theclipinstruction. Note that-mclipis not useful unless you also provide-mminmax. they're a package deal, no solo acts ๐-mconfig=nameโ selects one of the built-in core configurations. Each MeP chip has one or more modules in it; each module has a core CPU and a variety of coprocessors, optional instructions, and peripherals. TheMeP-Integratortool, not part of GCC, provides these configurations through this option; using this option is the same as using all the corresponding command-line options. The default configuration isdefault.-mcopโ enables the coprocessor instructions. By default, this is a 32-bit coprocessor. Note that the coprocessor is normally enabled via the-mconfig=option.-mcop32โ enables the 32-bit coprocessor's instructions.-mcop64โ enables the 64-bit coprocessor's instructions.-mivc2โ enables IVC2 scheduling. IVC2 is a 64-bit VLIW coprocessor. fancy โจ-mdcโ causes constant variables to be placed in the.nearsection.-mdivโ enables thedivanddivuinstructions.-mebโ generate big-endian code.-melโ generate little-endian code.-mio-volatileโ tells the compiler that any variable marked with theioattribute is to be considered volatile. volatile, the drama queen of keywords ๐-mlโ causes variables to be assigned to the.farsection by default.-mleadzโ enables theleadz(leading zero) instruction.-mmโ causes variables to be assigned to the.nearsection by default.-mminmaxโ enables theminandmaxinstructions.-mmultโ enables the multiplication and multiply-accumulate instructions.-mno-optsโ disables all the optional instructions enabled by-mall-opts. anti-everything-bagel ๐ญ-mrepeatโ enables therepeatanderepeatinstructions, used for low-overhead looping.-msโ causes all variables to default to the.tinysection. Note that there is a 65536-byte limit to this section. Accesses to these variables use the%gpbase register. tiny but mighty ๐ฆ-msaturโ enables the saturation instructions. Note that the compiler does not currently generate these itself, but this option is included for compatibility with other tools, likeas. it's giving "for the homies" ๐ซถ-msdramโ link the SDRAM-based runtime instead of the default ROM-based runtime.-msimโ link the simulator run-time libraries.-msimnovecโ link the simulator runtime libraries, excluding built-in support for reset and exception vectors and tables.-mtfโ bestie this one makes every single function default to the.farsection โจ. Skip it and they all chill in.nearinstead. That's the whole vibe. ๐-mtiny=nโ any variable that'snbytes or smaller gets yeeted into the.tinysection ๐ธ. These cuties use the$gpbase register. The default for this option is4, but heads up โ there's a 65536-byte limit on the.tinysection, so don't get too comfy in there ๐ซถ.
๐ฆ MicroBlaze Options ๐ฆ
-msoft-floatโ use software emulation for floating point. This is the default, no cap ๐.-mhard-floatโ use actual hardware floating-point instructions. Fancy ๐ฅ.-mmemcpyโ do not optimize block moves, just usememcpy. Let the library girlies handle it โจ.-mno-clearbssโ okay so this one is deprecated ๐. Use-fno-zero-initialized-in-bssinstead, periodt.-mcpu=cpu-typeโ use the features of, and schedule code for, the CPU you name. 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. Iconic little naming scheme honestly ๐-mxl-soft-mulโ use software multiply emulation. Default behavior ๐.-mxl-soft-divโ use software emulation for divides. Also the default ๐ซถ.-mxl-barrel-shiftโ use the hardware barrel shifter. Slay ๐ .-mxl-pattern-compareโ use pattern compare instructions โจ.-msmall-dividesโ use table lookup optimization for small signed integer divisions. Lowkey efficient ๐ฅ.-mxl-stack-checkโ deprecated alarm ๐จ! Use-fstack-checkinstead, bestie.-mxl-gp-optโ use GP-relative.sdata/.sbsssections ๐.-mxl-multiply-highโ use multiply high instructions for the high part of a32x32multiply ๐ง.-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 (that's swap and byte reversed load/store, iykyk) ๐.-mxl-mode-app-modelโ select application model app-model. Valid models are:executableโ normal executable (the default), and it uses the startup codecrt0.oโจ.-mpic-data-is-text-relativeโ assume that the displacement between the text and data segments is fixed at static link time. This lets data be referenced by offset from the start of the text address instead of the GOT, since PC-relative addressing isn't supported ๐ซถ.xmdstubโ for use with the Xilinx Microprocessor Debugger (XMD) based software intrusive debug agent called xmdstub. This one uses the startup filecrt1.oand sets the start address of the program to0x800๐ .bootstrapโ for applications that get loaded using a bootloader. This model uses the startup filecrt2.o, which does not contain a processor reset vector handler. Perfect for handing control on a processor reset over to the bootloader instead of the application ๐.novectorsโ for applications that don't need any of the MicroBlaze vectors. This can be handy for applications running inside a monitoring application. This model usescrt3.oas a startup file ๐ง.
Also: option-xl-mode-app-modelis a deprecated alias for-mxl-mode-app-model๐.
๐ MIPS Options ๐
-EBโ generate big-endian code ๐.-ELโ generate little-endian code. This is the default formips*el-*-*configurations ๐.-march=archโ generate code that runs on arch, which can be the name of a generic MIPS ISA, or the name of a particular processor. The ISA names are:mips1,mips2,mips3,mips4,mips32,mips32r2,mips32r3,mips32r5,mips32r6,mips64,mips64r2,mips64r3,mips64r5andmips64r6. The processor names are:4kc,4km,4kp,4ksc,4kec,4kem,4kep,4ksd,5kc,5kf,20kc,24kc,24kf2_1,24kf1_1,24kec,24kef2_1,24kef1_1,34kc,34kf2_1,34kf1_1,34kn,74kc,74kf2_1,74kf1_1,74kf3_2,1004kc,1004kf2_1,1004kf1_1,i6400,i6500,interaptiv,loongson2e,loongson2f,loongson3a,gs464,gs464e,gs264e,m4k,m14k,m14kc,m14ke,m14kec,m5100,m5101,octeon,octeon+,octeon2,octeon3,orion,p5600,p6600,r2000,r3000,r3900,r4000,r4400,r4600,r4650,r4700,r5900,r6000,r8000,rm7000,rm9000,r10000,r12000,r14000,r16000,sb1,sr71000,vr4100,vr4111,vr4120,vr4130,vr4300,vr5000,vr5400,vr5500,xlrandxlp. The special valuefrom-abiselects the most compatible architecture for the selected ABI (that is,mips1for 32-bit ABIs andmips3for 64-bit ABIs) โจ.
The 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 doesn't recognize the processor ๐.
In processor names, a final 000 can be abbreviated as k (for example, -march=r2k) ๐. Prefixes are optional, and vr may be written r.
Names of the form nf2_1 refer to processors with FPUs clocked at half the rate of the core, names of the form nf1_1 refer to processors with FPUs clocked at the same rate as the core, and names of the form nf3_2 refer to processors with FPUs clocked at a ratio of 3:2 with respect to the core ๐ธ. For compatibility reasons, nf is accepted as a synonym for nf2_1 while nx and bfx are accepted as synonyms for nf1_1.
GCC defines two macros based on the value of this option ๐. The first is _MIPS_ARCH, which gives the name of the target architecture, as a string. The second has the form _MIPS_ARCH_foo, where foo is the capitalized value of _MIPS_ARCH. For example, -march=r2000 sets _MIPS_ARCH to "r2000" and defines the macro _MIPS_ARCH_R2000 ๐ฅ.
Note that the _MIPS_ARCH macro uses the processor names given above. In other words, it has the full prefix and does not abbreviate 000 as k. In the case of from-abi, the macro names the resolved architecture (either "mips1" or "mips3"). It names the default architecture when no -march option is given ๐.
-mtune=archโ optimize for arch. Among other things, this option controls the way instructions are scheduled, and the perceived cost of arithmetic operations. The list of arch values is the same as for-marchโจ.
When this option isn't used, GCC optimizes for the processor specified by -march. By using -march and -mtune together, it's possible to generate code that runs on a family of processors, but optimize the code for one particular member of that family ๐ซถ.
-mtune defines the macros _MIPS_TUNE and _MIPS_TUNE_foo, which work in the same way as the -march ones described above ๐
.
-mips1โ equivalent to-march=mips1.-mips2โ equivalent to-march=mips2.-mips3โ equivalent to-march=mips3.-mips4โ equivalent to-march=mips4.-mips32โ equivalent to-march=mips32.-mips32r3โ equivalent to-march=mips32r3.-mips32r5โ equivalent to-march=mips32r5.-mips32r6โ equivalent to-march=mips32r6.-mips64โ equivalent to-march=mips64.-mips64r2โ equivalent to-march=mips64r2.-mips64r3โ equivalent to-march=mips64r3.-mips64r5โ equivalent to-march=mips64r5.-mips64r6โ equivalent to-march=mips64r6.-mips16,-mno-mips16โ generate (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 ๐.
-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 ๐. Testing girlies only.-minterlink-compressed,-mno-interlink-compressedโ require (do not require) that code using the standard (uncompressed) MIPS ISA be link-compatible with MIPS16 and microMIPS code, and vice versa ๐ซถ.
For example, code using the standard ISA encoding cannot jump directly to MIPS16 or microMIPS code; it must either use a call or an indirect jump. -minterlink-compressed therefore disables direct jumps unless GCC knows that the target of the jump is not compressed ๐ธ.
-minterlink-mips16,-mno-interlink-mips16โ aliases of-minterlink-compressedand-mno-interlink-compressed. These options predate the microMIPS ASE and are retained for backwards compatibility ๐.-mabi=32,-mabi=o64,-mabi=n32,-mabi=64,-mabi=eabiโ generate code for the given ABI โจ.
Note that the EABI has a 32-bit and a 64-bit variant. GCC normally generates 64-bit code when you select a 64-bit architecture, but you can use -mgp32 to get 32-bit code instead ๐.
For information about the O64 ABI, see <http://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 (or, with theno-version, do not generate) code that's fully position-independent, so it can get linked into shared libraries. Bestie, this option only does anything to-mabicalls.
All -mabicalls code has traditionally been position-independent, no matter what you pass for stuff like -fPIC and -fpic. But plot twist โจ โ as an extension, the GNU toolchain lets executables use absolute accesses for locally-binding symbols. It can also use shorter GP initialization sequences and generate direct calls to locally-defined functions. You get that mode with -mno-shared.
-mno-shared is highkey needy: it depends on binutils 2.16 or higher, and it generates objects that only the GNU linker can link. It does not touch the ABI of the final executable tho โ it only affects the ABI of relocatable objects. And using -mno-shared generally makes executables both smaller and quicker. slay ๐
-mshared is the default.
-mplt,-mno-pltโ assume (or don't assume) that the static and dynamic linkers support PLTs and copy relocations. Again, this only hits-mno-shared -mabicalls. For the n64 ABI, it does nothing at all without-msym32.
You can make -mplt the default by configuring GCC with --with-mips-plt. Otherwise the default is -mno-plt.
-mxgot,-mno-xgotโ lift (or don't lift) the usual restrictions on how big the global offset table can be.
GCC normally loads values from the GOT with a single instruction. Efficient, yes ๐ซถ โ but it only works if the GOT is smaller than about 64k. Anything bigger and the linker starts screaming at you with an error like:
relocation truncated to fit: R_MIPS_GOT16 foobar
If that happens, recompile your code with -mxgot. It works with very large GOTs, but the code is also less efficient, since it takes three instructions to fetch the value of a global symbol. trade-off queen ๐
Note that some linkers can create multiple GOTs. If you have such a linker, you should only need -mxgot when a single object file accesses more than 64k's worth of GOT entries. Very few do.
These options have no effect unless GCC is generating position independent code.
-mgp32โ assume that general-purpose registers are 32 bits wide.-mgp64โ assume that general-purpose registers are 64 bits wide.-mfp32โ assume that floating-point registers are 32 bits wide.-mfp64โ assume that floating-point registers are 64 bits wide.-mfpxxโ do not assume the width of floating-point registers. mystery era ๐ฎ-mhard-floatโ use floating-point coprocessor instructions.-msoft-floatโ do not use floating-point coprocessor instructions. Implement floating-point calculations using library calls instead.-mno-floatโ equivalent to-msoft-float, but it also asserts that the program being compiled does not perform any floating-point operations. This option is presently supported only by some bare-metal MIPS configurations, where it may select a special set of libraries that lack all floating-point support (including, for example, the floating-pointprintfformats). If code compiled with-mno-floataccidentally contains floating-point operations, it is likely to suffer a link-time or run-time failure. ๐-msingle-floatโ assume that the floating-point coprocessor only supports single-precision operations.-mdouble-floatโ assume that the floating-point coprocessor supports double-precision operations. This is the default.-modd-spreg,-mno-odd-spregโ enable the use of odd-numbered single-precision floating-point registers for the o32 ABI. This is the default for processors that are known to support these registers. When using the o32 FPXX ABI,-mno-odd-spregis set by default.-mabs=2008,-mabs=legacyโ these control how the special not-a-number (NaN) IEEE 754 floating-point data gets treated with theabs.fmtandneg.fmtmachine instructions.
By default, or when -mabs=legacy is used, the legacy treatment is selected. In this case these instructions are considered arithmetic and avoided where correct operation is required and the input operand might be a NaN. A longer sequence of instructions that manipulate the sign bit of floating-point datum manually is used instead โ unless the -ffinite-math-only option has also been specified.
The -mabs=2008 option selects the IEEE 754-2008 treatment. In this case these instructions are considered non-arithmetic and therefore operating correctly in all cases, including in particular where the input operand is a NaN. These instructions are therefore always used for the respective operations. iconic behavior honestly โจ
-mnan=2008,-mnan=legacyโ these control the encoding of the special not-a-number (NaN) IEEE 754 floating-point data.
The -mnan=legacy option selects the legacy encoding. In this case quiet NaNs (qNaNs) are denoted by the first bit of their trailing significand field being 0, whereas signaling NaNs (sNaNs) are denoted by the first bit of their trailing significand field being 1.
The -mnan=2008 option selects the IEEE 754-2008 encoding. In this case qNaNs are denoted by the first bit of their trailing significand field being 1, whereas sNaNs are denoted by the first bit of their trailing significand field being 0. yes bestie, they literally just flipped the bit ๐ธ
The default is -mnan=legacy unless GCC has been configured with --with-nan=2008.
-mllsc,-mno-llscโ use (or don't use)ll,sc, andsyncinstructions to implement atomic memory built-in functions. When neither option is specified, GCC uses the instructions if the target architecture supports them.
-mllsc is useful if the runtime environment can emulate the instructions, and -mno-llsc can be useful when compiling for nonstandard ISAs. You can make either option the default by configuring GCC with --with-llsc and --without-llsc respectively. --with-llsc is the default for some configurations; see the installation documentation for details.
-mdsp,-mno-dspโ use (or don't use) revision 1 of the MIPS DSP ASE. This option defines the preprocessor macro__mips_dsp. It also defines__mips_dsp_revto 1.-mdspr2,-mno-dspr2โ use (or don't use) revision 2 of the MIPS DSP ASE. This option defines the preprocessor macros__mips_dspand__mips_dspr2. It also defines__mips_dsp_revto 2.-msmartmips,-mno-smartmipsโ use (or don't use) the MIPS SmartMIPS ASE.-mpaired-single,-mno-paired-singleโ use (or don't use) paired-single floating-point instructions. This option requires hardware floating-point support to be enabled.-mdmx,-mno-mdmxโ use (or don't use) MIPS Digital Media Extension instructions. This option can only be used when generating 64-bit code and requires hardware floating-point support to be enabled.-mips3d,-mno-mips3dโ use (or don't use) the MIPS-3D ASE. The option-mips3dimplies-mpaired-single. package deal ๐-mmicromips,-mno-micromipsโ generate (or don't generate) microMIPS code.
MicroMIPS code generation can also be controlled on a per-function basis by means of micromips and nomicromips attributes.
-mmt,-mno-mtโ use (or don't use) MT Multithreading instructions.-mmcu,-mno-mcuโ use (or don't use) the MIPS MCU ASE instructions.-meva,-mno-evaโ use (or don't use) the MIPS Enhanced Virtual Addressing instructions.-mvirt,-mno-virtโ use (or don't use) the MIPS Virtualization (VZ) instructions.-mxpa,-mno-xpaโ use (or don't use) the MIPS eXtended Physical Address (XPA) instructions.-mcrc,-mno-crcโ use (or don't use) the MIPS Cyclic Redundancy Check (CRC) instructions.-mginv,-mno-ginvโ use (or don't use) the MIPS Global INValidate (GINV) instructions.-mloongson-mmi,-mno-loongson-mmiโ use (or don't use) the MIPS Loongson MultiMedia extensions Instructions (MMI).-mloongson-ext,-mno-loongson-extโ use (or don't use) the MIPS Loongson EXTensions (EXT) instructions.-mloongson-ext2,-mno-loongson-ext2โ use (or don't use) the MIPS Loongson EXTensions r2 (EXT2) instructions.
-mlong64โ forcelongtypes to be 64 bits wide. See-mlong32for an explanation of the default and the way that the pointer size is determined.-mlong32โ forcelong,int, and pointer types to be 32 bits wide.
The default size of ints, longs and pointers depends on the ABI. All the supported ABIs use 32-bit ints. The n64 ABI uses 64-bit longs, as does the 64-bit EABI; the others use 32-bit longs. Pointers are the same size as longs, or the same size as integer registers, whichever is smaller.
-msym32,-mno-sym32โ assume (or don't assume) that all symbols have 32-bit values, regardless of the selected ABI. This option is useful in combination with-mabi=64and-mno-abicallsbecause it allows GCC to generate shorter and faster references to symbolic addresses. ๐ซ-Gnum โ put definitions of externally-visible data in a small data section if that data is no bigger than num bytes. GCC can then generate more efficient accesses to the data; see-mgpoptfor details.
The default -G option depends on the configuration.
-mlocal-sdata,-mno-local-sdataโ extend (or don't extend) the-Gbehavior to local data too, such as to static variables in C.-mlocal-sdatais the default for all configurations.
If the linker complains that an application is using too much small data, you might want to try rebuilding the less performance-critical parts with -mno-local-sdata. You might also want to build large libraries with -mno-local-sdata, so that the libraries leave more room for the main program.
-mextern-sdata,-mno-extern-sdataโ assume (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 bit is still deep in MIPS land and it's a lot, but it's literally just rules about small data, GP-relative stuff, and every single CPU errata workaround under the sun. Stay with me bestie, it's all here ๐
If you compile a module Mod with -mextern-sdata -G num -mgpopt, and Mod references a variable Var that is no bigger than num bytes, you must make sure that Var is placed in a small data section. If Var is defined by another module, you must either compile that module with a high-enough -G setting or attach a "section" attribute to Var's definition. And if Var is common? You must link the application with a high-enough -G setting. No skipping steps, bestie ๐ซถ
The easiest way of satisfying these restrictions is to compile and link every module with the same -G option. However, you may wish to build a library that supports several different small data limits. You can do this by compiling the library with the highest supported -G setting and additionally using -mno-extern-sdata to stop the library from making assumptions about externally-defined data. Iconic problem-solving energy โจ
-mgpopt,-mno-gpoptโ Use (or don't use, bestie) GP-relative accesses for symbols that are known to be in a small data section; peep-G,-mlocal-sdataand-mextern-sdata.-mgpoptis the default for all configurations, periodt.
-mno-gpopt is useful for cases where the $gp register might not hold the value of "_gp". For example, if the code is part of a library that might be used in a boot monitor, programs that call boot monitor routines pass an unknown value in $gp. (In such situations, the boot monitor itself is usually compiled with -G0.)
Heads up: -mno-gpopt implies -mno-local-sdata and -mno-extern-sdata. It's giving cascade ๐
-membedded-data,-mno-embedded-dataโ Allocate variables to the read-only data section first if possible, then next in the small data section if possible, otherwise in data. This gives slightly slower code than the default, but reduces the amount of RAM required when executing, and thus may be preferred for some embedded systems. Slow and steady, but it slays on memory ๐ธ-muninit-const-in-rodata,-mno-uninit-const-in-rodataโ Put uninitialized"const"variables in the read-only data section. Just so you know: this option is only meaningful in conjunction with-membedded-data. They're a package deal ๐-mcode-readable=setting โ Specify whether GCC may generate code that reads from executable sections. There are three possible settings:-mcode-readable=yesโ Instructions may freely access executable sections. This is the default setting. Live your truth โจ-mcode-readable=pcrelโ MIPS16 PC-relative load instructions can access executable sections, but other instructions must not do so. This option is useful on 4KSc and 4KSd processors when the code TLBs have the Read Inhibit bit set. It is also useful on processors that can be configured to have a dual instruction/data SRAM interface and that, like the M4K, automatically redirect PC-relative loads to the instruction RAM.-mcode-readable=noโ Instructions must not access executable sections. This option can be useful on targets that are configured to have a dual instruction/data SRAM interface but that (unlike the M4K) do not automatically redirect PC-relative loads to the instruction RAM.
-msplit-addresses,-mno-split-addressesโ Enable (disable) use of the%hi()and%lo()assembler relocation operators. Ngl this option has been superseded by-mexplicit-relocsbut it's retained for backwards compatibility. Legacy icon behavior ๐-mexplicit-relocs,-mno-explicit-relocsโ Use (or don't use) assembler relocation operators when dealing with symbolic addresses. The alternative, selected by-mno-explicit-relocs, is to use assembler macros instead.
-mexplicit-relocs is the default if GCC was configured to use an assembler that supports relocation operators.
-mcheck-zero-division,-mno-check-zero-divisionโ Trap (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 is 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. Choose wisely bestie ๐ญ
The default is usually -mdivide-traps, but this can be overridden at configure time using --with-divide=breaks. Divide-by-zero checks can be completely disabled using -mno-check-zero-division.
-mload-store-pairs,-mno-load-store-pairsโ Enable (disable) an optimization that pairs consecutive load or store instructions to enable load/store bonding. This option is enabled by default but only takes effect when the selected architecture is known to support bonding. It's giving efficiency ๐ฅ-mmemcpy,-mno-memcpyโ Force (do not force) the use of"memcpy"for non-trivial block moves. The default is-mno-memcpy, which allows GCC to inline most constant-sized copies.-mlong-calls,-mno-long-callsโ Disable (do not disable) use of the"jal"instruction. Calling functions using"jal"is more efficient but requires the caller and callee to be in the same 256 megabyte segment. Big ask, fr fr.
This option has no effect on abicalls code. The default is -mno-long-calls.
-mmad,-mno-madโ Enable (disable) use of the"mad","madu"and"mul"instructions, as provided by the R4650 ISA.-mimadd,-mno-imaddโ Enable (disable) use of the"madd"and"msub"integer instructions. The default is-mimaddon architectures that support"madd"and"msub"โ except for the 74k architecture where it was found to generate slower code. Not the 74k catching strays ๐-mfused-madd,-mno-fused-maddโ Enable (disable) use of the floating-point multiply-accumulate instructions, when they are 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. No preprocessing, we're raw-dogging the assembler ๐-mfix-24k,-mno-fix-24kโ Work around the 24K E48 (lost data on stores during refill) errata. Just so you know, 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. ๐ญ
Heads up: this option can only be used if the target architecture supports branch-likely instructions. -mfix-r10000 is the default when -march=r10000 is used; -mno-fix-r10000 is the default otherwise.
-mfix-r5900,-mno-fix-r5900โ Do not attempt to schedule the preceding instruction into the delay slot of a branch instruction placed at the end of a short loop of six instructions or fewer and always schedule a"nop"instruction there instead. The short loop bug under certain conditions causes loops to execute only once or twice, due to a hardware bug in the R5900 chip. The workaround is implemented by the assembler rather than by GCC.-mfix-rm7000,-mno-fix-rm7000โ Work around the RM7000"dmult"/"dmultu"errata. The workarounds are implemented by the assembler rather than by GCC.-mfix-vr4120,-mno-fix-vr4120โ Work around certain VR4120 errata:"dmultu"does not always produce the correct result."div"and"ddiv"do not always produce the correct result if one of the operands is negative.
The workarounds for the division errata rely on special functions in libgcc.a. At present, these functions are only provided by the "mips64vr*-elf" configurations.
Other VR4120 errata require a NOP to be inserted between certain pairs of instructions. These errata are handled by the assembler, not by GCC itself.
-mfix-vr4130โ Work around the VR4130"mflo"/"mfhi"errata. The workarounds are implemented by the assembler rather than by GCC, although GCC avoids using"mflo"and"mfhi"if the VR4130"macc","macchi","dmacc"and"dmacchi"instructions are available instead. Sneaky smart, lowkey ๐-mfix-sb1,-mno-fix-sb1โ Work around certain SB-1 CPU core errata. (This flag currently works around the SB-1 revision 2"F1"and"F2"floating-point errata.)-mr10k-cache-barrier=setting โ Specify whether GCC should insert cache barriers to avoid the side effects of speculation on R10K processors.
In common with many processors, the R10K tries to predict the outcome of a conditional branch and speculatively executes instructions from the "taken" branch. It later aborts these instructions if the predicted outcome is wrong. However, on the R10K, even aborted instructions can have side effects. Rude, honestly ๐ญ
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.
This is a real correctness thing, bestie โ those speculatively-executed side effects are not a vibe. If you're on R10K and this applies to you, read the processor manual, fr fr. ๐จ
One workaround is to insert cache barrier instructions before every memory access that might be speculatively executed and that might have side effects even if aborted. -mr10k-cache-barrier=setting controls GCC's implementation of this workaround. It assumes that aborted accesses to any byte in the following regions does not have side effects:
- the memory occupied by the current function's stack frame;
- the memory occupied by an incoming stack argument;
- the memory occupied by an object with a link-time-constant address.
It is the kernel's responsibility to ensure that speculative accesses to these regions are indeed safe. like bestie that's literally your job, not GCC's ๐
If the input program contains a function declaration such as:
void foo (void);
then the implementation of foo must allow j foo and jal foo to be executed speculatively. GCC honors this restriction for functions it compiles itself. It expects non-GCC functions (such as hand-written assembly code) to do the same. so if you're out here hand-writing asm, no cap, you gotta play by the same rules ๐
The option has three forms:
-mr10k-cache-barrier=load-storeโ inserts a cache barrier before a load or store that might be speculatively executed and that might have side effects even if aborted.-mr10k-cache-barrier=storeโ inserts a cache barrier before a store that might be speculatively executed and that might have side effects even if aborted.-mr10k-cache-barrier=noneโ disables the insertion of cache barriers. This is the default setting.
-mflush-func=func-mno-flush-func
Specifies the function to call to flush the I and D caches, or to not call any such function. If called, the function must take the same arguments as the common _flush_func, that is, the address of the memory range for which the cache is being flushed, the size of the memory range, and the number 3 (to flush both caches). The default depends on the target GCC was configured for, but commonly is either _flush_func or __cpu_flush. three whole arguments, and one of them is literally just 3. iconic behavior tbh โจ
mbranch-cost=numโ set the cost of branches to roughly num "simple" instructions. This cost is only a heuristic and is not guaranteed to produce consistent results across releases. A zero cost redundantly selects the default, which is based on the-mtunesetting. heuristic means "we vibes-based it", fr fr-mbranch-likely-mno-branch-likely
Enable or disable use of Branch Likely instructions, regardless of the default for the selected architecture. By default, Branch Likely instructions may be generated if they are supported by the selected architecture. An exception is for the MIPS32 and MIPS64 architectures and processors that implement those architectures; for those, Branch Likely instructions are not be generated by default because the MIPS32 and MIPS64 architectures specifically deprecate their use. deprecated bestie, they said it themselves ๐ซ
-mcompact-branches=never-mcompact-branches=optimal-mcompact-branches=always
These options control which form of branches will be generated. The default is -mcompact-branches=optimal.
The -mcompact-branches=never option ensures that compact branch instructions will never be generated.
The -mcompact-branches=always option ensures that a compact branch instruction will be generated if available. If a compact branch instruction is not available, a delay slot form of the branch will be used instead.
This option is supported from MIPS Release 6 onwards.
The -mcompact-branches=optimal option will cause a delay slot branch to be used if one is available in the current ISA and the delay slot is successfully filled. If the delay slot is not filled, a compact branch will be chosen if one is available. it's giving "I'll take the delay slot if it's free, otherwise whatever" ๐
-mfp-exceptions-mno-fp-exceptions
Specifies whether FP exceptions are enabled. This affects how FP instructions are scheduled for some processors. The default is that FP exceptions are enabled.
For instance, on the SB-1, if FP exceptions are disabled, and we are emitting 64-bit code, then we can use both FP pipes. Otherwise, we can only use one FP pipe. two pipes >>> one pipe, do the math ๐
-mvr4130-align-mno-vr4130-align
The VR4130 pipeline is two-way superscalar, but can only issue two instructions together if the first one is 8-byte aligned. When this option is enabled, GCC aligns pairs of instructions that it thinks should execute in parallel.
This option only has an effect when optimizing for the VR4130. It normally makes code faster, but at the expense of making it bigger. It is enabled by default at optimization level -O3. faster but thicc, the eternal tradeoff ๐
-msynci-mno-synci
Enable (disable) generation of synci instructions on architectures that support it. The synci instructions (if enabled) are generated when __builtin___clear_cache is compiled.
This option defaults to -mno-synci, but the default can be overridden by configuring GCC with --with-synci.
When compiling code for single processor systems, it is generally safe to use synci. However, on many multi-core (SMP) systems, it does not invalidate the instruction caches on all cores and may lead to undefined behavior. UNDEFINED BEHAVIOR bestie, that's the scary one ๐ญ
-mrelax-pic-calls-mno-relax-pic-calls
Try to turn PIC calls that are normally dispatched via register $25 into direct calls. This is only possible if the linker can resolve the destination at link time and if the destination is within range for a direct call.
-mrelax-pic-calls is the default if GCC was configured to use an assembler and a linker that support the .reloc assembly directive and -mexplicit-relocs is in effect. With -mno-explicit-relocs, this optimization can be performed by the assembler and the linker alone without help from the compiler. they handled it themselves, main character energy fr ๐ฆ
-mmcount-ra-address-mno-mcount-ra-address
Emit (do not emit) code that allows _mcount to modify the calling function's return address. When enabled, this option extends the usual _mcount interface with a new ra-address parameter, which has type intptr_t * and is passed in register $12. _mcount can then modify the return address by doing both of the following:
- Returning the new address in register
$31. - Storing the new address in
*ra-address, if ra-address is nonnull.
The default is -mno-mcount-ra-address. two ways to change where you came back to. unhinged. obsessed. ๐
-mframe-header-opt-mno-frame-header-opt
Enable (disable) frame header optimization in the o32 ABI. When using the o32 ABI, calling functions will allocate 16 bytes on the stack for the called function to write out register arguments. When enabled, this optimization will suppress the allocation of the frame header if it can be determined that it is unused.
This optimization is off by default at all optimization levels. off everywhere, even at -O3. it simply does not want to be perceived ๐
-mlxc1-sxc1-mno-lxc1-sxc1
When applicable, enable (disable) the generation of lwxc1, swxc1, ldxc1, sdxc1 instructions. Enabled by default.
-mmadd4-mno-madd4
When applicable, enable (disable) the generation of 4-operand madd.s, madd.d and related instructions. Enabled by default.
๐ MMIX Options ๐
These options are defined for the MMIX: yes the processor is literally named MMIX, slay โญ
-mlibfuncs-mno-libfuncs
Specify that intrinsic library functions are being compiled, passing all values in registers, no matter the size. no matter the size bestie, we don't discriminate ๐ซถ
-mepsilon-mno-epsilon
Generate floating-point comparison instructions that compare with respect to the rE epsilon register.
-mabi=mmixware-mabi=gnu
Generate code that passes function parameters and return values that (in the called function) are seen as registers $0 and up, as opposed to the GNU ABI which uses global registers $231 and up. two entirely different neighborhoods for your registers ๐
-mzero-extend-mno-zero-extend
When reading data from memory in sizes shorter than 64 bits, use (do not use) zero-extending load instructions by default, rather than sign-extending ones.
-mknuthdiv-mno-knuthdiv
Make the result of a division yielding a remainder have the same sign as the divisor. With the default, -mno-knuthdiv, the sign of the remainder follows the sign of the dividend. Both methods are arithmetically valid, the latter being almost exclusively used. named after Knuth himself, we have no choice but to stan ๐
-mtoplevel-symbols-mno-toplevel-symbols
Prepend (do not prepend) a : to all global symbols, so the assembly code can be used with the PREFIX assembly directive.
-melfโ generate an executable in the ELF format, rather than the default mmo format used by the mmix simulator.-mbranch-predict-mno-branch-predict
Use (do not use) the probable-branch instructions, when static branch prediction indicates a probable branch.
-mbase-addresses-mno-base-addresses
Generate (do not generate) code that uses base addresses. Using a base address automatically generates a request (handled by the assembler and the linker) for a constant to be set up in a global register. The register is used for one or more base address requests within the range 0 to 255 from the value held in the register. The generally leads to short and fast code, but the number of different data items that can be addressed is limited. This means that a program that uses lots of static data may require -mno-base-addresses. short and fast but it can only hold so many friends ๐ญ range 0 to 255, that's it
-msingle-exit-mno-single-exit
Force (do not force) generated code to have a single exit point in each function.
๐ MN10300 Options ๐
These -m options are defined for Matsushita MN10300 architectures:
-mmult-bugโ generate code to avoid bugs in the multiply instructions for the MN10300 processors. This is the default.-mno-mult-bugโ do not generate code to avoid bugs in the multiply instructions for the MN10300 processors.-mam33โ generate code using features specific to the AM33 processor.-mno-am33โ do not generate code using features specific to the AM33 processor. This is the default.-mam33-2โ generate code using features specific to the AM33/2.0 processor.-mam34โ generate code using features specific to the AM34 processor.-mtune=cpu-typeโ use the timing characteristics of the indicated CPU type when scheduling instructions. This does not change the targeted processor type. The CPU type must be one ofmn10300,am33,am33-2oram34. four choices, pick your fighter ๐-mreturn-pointer-on-d0โ when a function returns a pointer, it returns it in botha0andd0. Otherwise the pointer only comes back ina0, and the second you try to call one of those functions without a prototypeโฆ errors. ๐ซ Fun fact: this option is on by default, so to turn it off you go-mno-return-pointer-on-d0.-mno-crt0โ do not link in the C run-time initialization object file. that's it. that's the whole vibe. ๐-mrelaxโ tells the linker "bestie pls run a relaxation optimization pass" so it can shorten branches, calls and absolute memory addresses. โจ It only does anything when you use it on the command line for the final link step.
This option makes symbolic debugging impossible. ๐ not a drill.
-mliwโ lets the compiler generate Long Instruction Word instructions if the target is the AM33 or later. This is the default. It also defines the preprocessor macro__LIW__.-mno-liwโ do not let the compiler generate Long Instruction Word instructions. This one defines the preprocessor macro__NO_LIW__.-msetlbโ lets the compiler generate theSETLBandLccinstructions if the target is the AM33 or later. Default behavior. Defines the preprocessor macro__SETLB__.-mno-setlbโ do not generateSETLBorLccinstructions. Defines the preprocessor macro__NO_SETLB__.
๐ฆ Moxie Options ๐ฆ
-mebโ generate big-endian code. This is the default formoxie-*-*configurations.-melโ generate little-endian code.-mmul.xโ generatemul.xandumul.xinstructions. This is the default formoxiebox-*-*configurations.-mno-crt0โ do not link in the C run-time initialization object file. (yes, again. iconic of it.) ๐
๐ MSP430 Options ๐
These options are defined for the MSP430:
-masm-hexโ forces assembly output to always use hex constants. Normally those constants are signed decimals, but this option exists for testsuite and/or aesthetic purposes. ๐-mmcu=โ selects the MCU to target. 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 is then 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. A generic MCU name of msp430 can also be used to select the 430 ISA. Similarly the generic msp430x MCU name selects the 430X ISA.
On top of all that, an MCU-specific linker script gets added to the linker command line. The script's name is the name of the MCU with .ld appended. So specifying -mmcu=xxx on the gcc command line defines the C preprocessor symbol __XXX__ and causes the linker to search for a script called xxx.ld.
The ISA and hardware multiply supported for the different MCUs is hard-coded into GCC. However, an external devices.csv file can be used to extend device support beyond those that have been hard-coded. ๐
GCC searches for the devices.csv file using the following methods in the given precedence order, where the first method takes precedence over the second, which takes precedence over the third:
- Include path specified with
-Iand-Lโdevices.csvwill be searched for in each of the directories specified by include paths and linker library search paths. - Path specified by the environment variable
MSP430_GCC_INCLUDE_DIRโ define the value of the global environment variableMSP430_GCC_INCLUDE_DIRto the full path to the directory containingdevices.csv, and GCC will search this directory fordevices.csv. Ifdevices.csvis found, this directory will also be registered as an include path, and a linker library path. Header files and linker scripts in this directory can therefore be used without manually specifying-Iand-Lon the command line. ๐ - The
msp430-elf{,bare}/include/devicesdirectory โ finally, GCC will examinemsp430-elf{,bare}/include/devicesfrom the toolchain root directory. This directory does not exist in a default installation, but if the user has created it and copieddevices.csvthere, then the MCU data will be read. As above, this directory will also be registered as an include path, and a 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 option enables or disables warnings about conflicts between the MCU name specified by the-mmcuoption and the ISA set by the-mcpuoption and/or the hardware multiply support set by the-mhwmultoption. It also toggles warnings about unrecognized MCU names. This option is on by default.-mcpu=โ specifies the ISA to use. Accepted values aremsp430,msp430xandmsp430xv2. This option is deprecated โ the-mmcu=option is what you should be using to select the ISA. ๐ซถ-msimโ link to the simulator runtime libraries and linker script. Overrides any scripts that would be selected by the-mmcu=option.-mlargeโ use large-model addressing (20-bit pointers, 32-bitsize_t).-msmallโ use small-model addressing (16-bit pointers, 16-bitsize_t).-mrelaxโ this option is passed to the assembler and linker, and allows the linker to perform certain optimizations that cannot be done until the final link.mhwmult=โ describes the type of hardware multiply supported by the target. Accepted values arenonefor no hardware multiply,16bitfor the original 16-bit-only multiply supported by early MCUs,32bitfor the 16/32-bit multiply supported by later MCUs, andf5seriesfor the 16/32-bit multiply supported by F5-series MCUs. A value ofautocan also be given โ this tells GCC to deduce the hardware multiply support based upon the MCU name provided by the-mmcuoption. If no-mmcuoption is specified, or if the MCU name is not 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. When compiling at -O3 or higher, however, the hardware multiplier is invoked inline. This makes for bigger, but faster code. ๐ฅ
The hardware multiply routines disable interrupts whilst running and restore the previous interrupt state when they finish. This makes them safe to use inside interrupt handlers as well as in normal code.
-minrtโ enable the use of a minimum runtime environment โ no static initializers or constructors. This is intended for memory-constrained devices. The compiler includes special symbols in some objects that tell the linker and runtime which code fragments are required.-mtiny-printfโ enable reduced code sizeprintfandputslibrary functions. The tiny implementations of these functions are not reentrant, so they must be used with caution in multi-threaded applications.
Bestie, this one's got caveats, so listen up. ๐
Support for streams has been removed, and the string to be printed will always be sent to stdout via the write syscall. The string is not buffered before it is sent to write.
This option requires Newlib Nano IO, so GCC must be configured with --enable-newlib-nano-formatted-io.
-mcode-region=-mdata-region=โ these options tell the compiler where to place functions and data that do not have one of thelower,upper,eitherorsectionattributes. Possible values arelower,upper,eitherorany. The first three behave like the corresponding attribute. The fourth possible value โanyโ is the default. It leaves placement entirely up to the linker script and how it assigns the standard sections (.text,.data, etc) to the memory regions.-msilicon-errata=โ this option passes on a request to the assembler to enable the fixes for the named silicon errata.-msilicon-errata-warn=โ this option passes on a request to the assembler to enable warning messages when a silicon errata might need to be applied.-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โ generate code in big-endian mode.-mlittle-endianโ generate code in little-endian mode.-mreduced-regsโ use reduced-set registers for register allocation.-mfull-regsโ use full-set registers for register allocation.-mcmovโ generate conditional move instructions.-mno-cmovโ do not generate conditional move instructions.-mext-perfโ generate performance extension instructions.-mno-ext-perfโ do not generate performance extension instructions.-mext-perf2โ generate performance extension 2 instructions.-mno-ext-perf2โ do not generate performance extension 2 instructions.-mext-stringโ generate string extension instructions.-mno-ext-stringโ do not generate string extension instructions.-mv3pushโ generate v3push25/pop25instructions.-mno-v3pushโ do not generate v3push25/pop25instructions.-m16-bitโ generate 16-bit instructions.-mno-16-bitโ do not generate 16-bit instructions.- *
-misr-vector-size=num* โ specify the size of each interrupt vector, which must be4or16. - *
-mcache-block-size=num* โ specify the size of each cache block, which must be a power of 2 between4and512. - *
-march=arch* โ specify the name of the target architecture. - *
-mcmodel=code-model* โ set the code model to one of:smallโ all the data and read-only data segments must be within 512KB addressing space. The text segment must be within 16MB addressing space.mediumโ the data segment must be within 512KB while the read-only data segment can be within 4GB addressing space. The text segment should be still within 16MB addressing space.largeโ all the text and data segments can be within 4GB addressing space.
-mctor-dtorโ enable constructor/destructor feature.-mrelaxโ guide linker to relax instructions.
โญ Nios II Options โญ
-G numโ bestie, this one puts all your global and static objects that arenumbytes or smaller into the small data or BSS sections instead of the regular data or BSS sections. The default fornumis8. โจ-mgpopt=option-mgpopt-mno-gpoptโ these make GCC generate (or not generate) GP-relative accesses. Here's the vibe check on whichoptionnames it actually knows about:noneโ do not generate GP-relative accesses. simple as that ๐localโ generate GP-relative accesses for small data objects that are not external, weak, or uninitialized common symbols. It also uses GP-relative addressing for objects you explicitly placed in a small data section via a"section"attribute.globalโ same aslocal, but it also generates GP-relative accesses for small data objects that are external, weak, or common. ๐จ If you use this, you MUST make sure every part of your program (libraries included, no exceptions) is compiled with the same-Gsetting.dataโ generate GP-relative accesses for all data objects in the program. If you use this, the entire data and BSS segments of your program must fit in 64K of memory, and you must use an appropriate linker script to allocate them within the addressable range of the global pointer.allโ generate GP-relative addresses for function pointers as well as data pointers. If you use this one, the entire text, data, and BSS segments of your program must fit in 64K of memory, and you must use an appropriate linker script to allocate them within the addressable range of the global pointer.
-mgpoptis equivalent to-mgpopt=local, and-mno-gpoptis equivalent to-mgpopt=none.
The default is -mgpopt except when -fpic or -fPIC is specified to generate position-independent code. Also note that the Nios II ABI does not permit GP-relative accesses from shared libraries. periodt.
You may need to specify -mno-gpopt explicitly when building programs that include large amounts of small data, including large GOT data sections. In that case, the 16-bit offset for GP-relative addressing may not be large enough to allow access to the entire small data section. ๐ญ
-mgprel-sec=regexpโ this specifies extra section names that can be accessed via GP-relative addressing. It's most useful alongside"section"attributes on variable declarations and a custom linker script. Theregexpis a POSIX Extended Regular Expression.
Heads up: this option does not affect the behavior of the -G option, and the sections you specify are in addition to the standard ".sdata" and ".sbss" small-data sections that -mgpopt recognizes.
-mr0rel-sec=regexpโ this one specifies names of sections that can be accessed via a 16-bit offset from"r0"โ meaning, in the low 32K or high 32K of the 32-bit address space. Most useful in conjunction with"section"attributes on variable declarations and a custom linker script. Theregexpis a POSIX Extended Regular Expression.
Unlike GP-relative addressing for small data, zero-based addressing is never generated by default, and there are no conventional section names used in standard linker scripts for sections in the low or high areas of memory.
-mel-mebโ generate little-endian (the default) or big-endian (experimental ๐) code, respectively.-march=archโ this names the target Nios II architecture. GCC uses that name to figure out what kind of instructions it's allowed to emit when generating assembly code. Permissible names are:r1,r2.
The preprocessor macro "__nios2_arch__" is available to programs, with value 1 or 2, indicating the targeted ISA level. โจ
-mbypass-cache-mno-bypass-cacheโ force all load and store instructions to always bypass cache by using I/O variants of the instructions. The default is not to bypass the cache.-mno-cache-volatile-mcache-volatileโ volatile memory access bypasses the cache using the I/O variants of the load and store instructions. The default is not to bypass the cache.-mno-fast-sw-div-mfast-sw-divโ do not use table-based fast divide for small numbers. The default is to use the fast divide at-O3and above.-mno-hw-mul-mhw-mul-mno-hw-mulx-mhw-mulx-mno-hw-div-mhw-divโ enable or disable emitting the"mul","mulx"and"div"family of instructions by the compiler. The default is to emit"mul"and not emit"div"and"mulx".-mbmx-mno-bmx-mcdx-mno-cdxโ enable or disable generation of Nios II R2 BMX (bit manipulation) and CDX (code density) instructions. Enabling these also requires-march=r2. Since these instructions are optional extensions to the R2 architecture, the default is not to emit them.-mcustom-insn=N-mno-custom-insnโ each-mcustom-insn=Noption enables use of a custom instruction with encodingNwhen generating code that uses insn. For example,-mcustom-fadds=253generates custom instruction253for single-precision floating-point add operations instead of the default behavior of using a library call. ๐
The following values of insn are supported. Except as otherwise noted, floating-point operations are expected to be implemented with normal IEEE 754 semantics and correspond directly to the C operators or the equivalent GCC built-in functions.
Single-precision floating point:
fadds,fsubs,fdivs,fmulsโ binary arithmetic operations.fnegsโ unary negation.fabssโ unary absolute value.fcmpeqs,fcmpges,fcmpgts,fcmples,fcmplts,fcmpnesโ comparison operations.fmins,fmaxsโ floating-point minimum and maximum. These instructions are only generated if-ffinite-math-onlyis specified.fsqrtsโ unary square root operation.fcoss,fsins,ftans,fatans,fexps,flogsโ floating-point trigonometric and exponential functions. These instructions are only generated if-funsafe-math-optimizationsis also specified.
Double-precision floating point:
faddd,fsubd,fdivd,fmuldโ binary arithmetic operations.fnegdโ unary negation.fabsdโ unary absolute value.fcmpeqd,fcmpged,fcmpgtd,fcmpled,fcmpltd,fcmpnedโ comparison operations.fmind,fmaxdโ double-precision minimum and maximum. These instructions are only generated if-ffinite-math-onlyis specified.fsqrtdโ unary square root operation.fcosd,fsind,ftand,fatand,fexpd,flogdโ double-precision trigonometric and exponential functions. These instructions are only generated if-funsafe-math-optimizationsis also specified.
Conversions:
fextsdโ conversion from single precision to double precision.ftruncdsโ conversion from double precision to single precision.fixsi,fixsu,fixdi,fixduโ conversion from floating point to signed or unsigned integer types, with truncation towards zero.roundโ conversion from single-precision floating point to signed integer, rounding to the nearest integer and ties away from zero. This corresponds to the"__builtin_lroundf"function when-fno-math-errnois used.floatis,floatus,floatid,floatudโ conversion from signed or unsigned integer types to floating-point types.
In addition, all of the following transfer instructions for internal registers X and Y must be provided to use any of the double-precision floating-point instructions. Custom instructions taking two double-precision source operands expect the first operand in the 64-bit register X. The other operand (or only operand of a unary operation) is given to the custom arithmetic instruction with the least significant half in source register src1 and the most significant half in src2. A custom instruction that returns a double-precision result returns the most significant 32 bits in the destination register and the other half in 32-bit register Y. GCC automatically generates the necessary code sequences to write register X and/or read register Y when double-precision floating-point instructions are used. ๐ฆ
fwrxโ writesrc1into the least significant half ofXandsrc2into the most significant half ofX.fwryโ writesrc1intoY.frdxhi,frdxloโ read the most or least (respectively) significant half ofXand store it indest.frdyโ read the value ofYand store it intodest.
Ngl, you can gain more local control over generation of Nios II custom instructions by using the target("custom-insn=N") and target("no-custom-insn") function attributes or pragmas. ๐
-mcustom-fpu-cfg=nameโ this enables a predefined, named set of custom instruction encodings (peep-mcustom-insnabove). Currently, the following sets are defined:
-mcustom-fpu-cfg=60-1 is equivalent to: -mcustom-fmuls=252
-mcustom-fadds=253 -mcustom-fsubs=254 -fsingle-precision-constant
-mcustom-fpu-cfg=60-2 is equivalent to: -mcustom-fmuls=252
-mcustom-fadds=253 -mcustom-fsubs=254 -mcustom-fdivs=255
-fsingle-precision-constant
-mcustom-fpu-cfg=72-3 is equivalent to: -mcustom-floatus=243
-mcustom-fixsi=244 -mcustom-floatis=245 -mcustom-fcmpgts=246
-mcustom-fcmples=249 -mcustom-fcmpeqs=250 -mcustom-fcmpnes=251
-mcustom-fmuls=252 -mcustom-fadds=253 -mcustom-fsubs=254
-mcustom-fdivs=255 -fsingle-precision-constant
Custom instruction assignments given by individual -mcustom-insn= options override those given by -mcustom-fpu-cfg=, regardless of the order of the options on the command line. ๐ฅ
And bestie, you can gain more local control over selection of a FPU configuration by using the target("custom-fpu-cfg=name") function attribute or pragma.
These additional -m options are available for the Altera Nios II ELF (bare-metal) target: ๐
-mhalโ links with the HAL BSP ๐ซ. This one suppresses linking with the C runtime startup and termination code that GCC usually hands you, and it's typically used together with-msys-crt0=to say where the alternate startup code from the HAL BSP lives.-msmallcโ link with a limited version of the C library,-lsmallc, instead of Newlib. smol library, big vibes ๐.- *
-msys-crt0=startfile* โ startfile is the file name of the startfile (crt0) to use when linking. Heads up bestie: this option is only useful in conjunction with-mhal. - *
-msys-lib=systemlib* โ systemlib is the library name of the library that provides the low-level system calls the C library needs, e.g."read"and"write". This is typically used to link with a library provided by a HAL BSP ๐ซถ.
โจ Nvidia PTX Options โจ
These options are defined for Nvidia PTX:
-m32,-m64โ generate code for 32-bit or 64-bit ABI. pick your lane ๐ฆ.- *
-misa=ISA-string* โ generate code for the specified PTX ISA (e.g.sm_35). ISA strings must be lower-case. Valid ISA strings includesm_30andsm_35. The default ISA issm_30. -mmainkernelโ link in code for a__mainkernel. This is for stand-alone execution instead of offloading ๐.-moptimizeโ apply partitioned execution optimizations. This is the default whenever any level of optimization is selected โจ.-msoft-stackโ generate code that does not use".local"memory directly for stack storage. Instead, a per-warp stack pointer is maintained explicitly ๐ . This enables variable-length stack allocation (with variable-length arrays or"alloca"), and when global memory is used for the underlying storage, it 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 so you can test the compiler; to generate code suitable for linking into programs using OpenMP offloading, use option-mgomp.-muniform-simtโ switch to a code generation variant that lets all threads in each warp execute, while keeping memory state and side effects as if only one thread in each warp was active outside of OpenMP SIMD regions ๐. All atomic operations and calls to runtime (malloc,free,vprintf) are conditionally executed (iff current lane index equals the master lane index), and the register being assigned is copied via a shuffle instruction from the master lane. Outside of SIMD regions lane 0 is the master; inside, each thread sees itself as the master. Shared memory array"int __nvptx_uni[]"stores all-zeros or all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD regions). Each thread can bitwise-and the bitmask at position"tid.y"with the current lane index to compute the master lane index ๐ง.-mgompโ generate code for use in OpenMP offloading: enables-msoft-stackand-muniform-simtoptions, and selects the corresponding multilib variant. two options in a trench coat, iconic ๐.
๐ธ OpenRISC Options ๐ธ
These options are defined for OpenRISC:
- *
-mboard=name* โ configure a board specific runtime. This gets passed to the linker for newlib board library linking. The default is"or1ksim". -mnewlibโ this option is ignored; it's for compatibility purposes only ๐. It used to select linker and preprocessor options for use with newlib.-msoft-div,-mhard-divโ select software or hardware divide ("l.div","l.divu") instructions. The default is hardware divide.-msoft-mul,-mhard-mulโ select software or hardware multiply ("l.mul","l.muli") instructions. The default is hardware multiply.-msoft-float,-mhard-floatโ select software or hardware for floating point operations. The default is software.-mdouble-floatโ when-mhard-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 equivalent is 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.
๐ PDP-11 Options ๐
These options are defined for the PDP-11:
-mfpuโ use hardware FPP floating point. This is the default. (FIS floating point on the PDP-11/40 is not supported.) Implies-m45.-msoft-floatโ do not use hardware floating point.-mac0โ return floating-point results in ac0 (fr0 in Unix assembler syntax).-mno-ac0โ return floating-point results in memory. This is the default.-m40โ generate code for a PDP-11/40. Implies-msoft-float -mno-split.-m45โ generate code for a PDP-11/45. This is the default.-m10โ generate code for a PDP-11/10. Implies-msoft-float -mno-split.-mint16,-mno-int32โ use 16-bit"int". This is the default.-mint32,-mno-int16โ use 32-bit"int".-msplitโ target has split instruction and data space. Implies-m45.-munix-asmโ use Unix assembler syntax.-mdec-asmโ use DEC assembler syntax.-mgnu-asmโ use GNU assembler syntax. This is the default.-mlraโ use the new LRA register allocator. By default, the old"reload"allocator is used.
โญ picoChip Options โญ
These -m options are defined for picoChip implementations:
- *
-mae=ae_type* โ set the instruction set, register set, and instruction scheduling parameters for array element type ae_type. Supported values for ae_type areANY,MUL, andMAC.-mae=ANYselects a completely generic AE type. Code generated with this option runs on any of the other AE types. The code is not as efficient as it would be if compiled for a specific AE type, and some types of operation (e.g., multiplication) do not work properly on all types of AE.-mae=MULselects a MUL AE type. This is the most useful AE type for compiled code, and is the default ๐ .-mae=MACselects a DSP-style MAC AE. Code compiled with this option may suffer from poor performance of byte (char) manipulation, since the DSP AE does not provide hardware support for byte load/stores ๐ญ.
-msymbol-as-addressโ enable the compiler to directly use a symbol name as an address in a load/store instruction, without first loading it into a register. Typically, using this option generates larger programs, which run faster than when the option isn't used. However, the results vary from program to program, so it's left as a user option, rather than being permanently enabled.-mno-inefficient-warningsโ disables warnings about the generation of inefficient code. These warnings can show up, for example, when compiling code that performs byte-level memory operations on the MAC AE type. The MAC AE has no hardware support for byte-level memory operations, so all byte load/stores must be synthesized from word load/store operations ๐ฎโ๐จ. This is inefficient and a warning is generated to indicate that you should rewrite the code to avoid byte operations, or target an AE type that has the necessary hardware support. This option disables those warnings.
๐ PowerPC Options ๐
These are listed under
๐ฅ PRU Options ๐ฅ
These command-line options are defined for the PRU target:
-minrtโ link with a minimum runtime environment, with no support for static initializers and constructors. Using this option can significantly reduce the size of the final ELF binary ๐. Beware that the compiler could still generate code with static initializers and constructors. It is up to the programmer to ensure that the source program will not use those features ๐.- *
-mmcu=mcu* โ specify the PRU MCU variant to use. Check Newlib for the exact list of supported MCUs. -mno-relaxโ make GCC pass the--no-relaxcommand-line option to the linker instead of the--relaxoption.-mloopโ allow (or do not allow) GCC to use the LOOP instruction.- *
-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. These are the differences:- Function Pointer Size โ TI ABI specifies that function (code) pointers are 16-bit, whereas GNU supports only 32-bit data and code pointers.
- Optional Return Value Pointer โ function return values larger than 64 bits are passed by using a hidden pointer as the first argument of the function. TI ABI, though, mandates that the pointer can be
NULLin case the caller is not using the returned value. GNU always passes and expects a valid return value pointer.
The current -mabi=ti implementation simply raises a compile error when any of the above code constructs is detected ๐ต. As a consequence the standard C library cannot be built and it is omitted when linking with -mabi=ti.
Relaxation is a GNU feature and for safety reasons is disabled when using -mabi=ti. The TI toolchain does not emit relocations for QBBx instructions, so the GNU linker cannot adjust them when shortening adjacent LDI32 pseudo instructions.
๐ RISC-V Options ๐
These command-line options are defined for RISC-V targets:
-mbranch-cost=nโ sets the cost of branches to roughly n instructions. like, how expensive is a jump, bestie? that many instructions. ๐ธ-mplt,-mno-pltโ when you're generating PIC code, this is your yes/no on letting it use PLTs. Ignored for non-PIC, so don't stress if that's not your situation. The default is-mplt. โจ-mabi=ABI-stringโ ok this one is a whole moment, sit with me. ๐ซถ You're specifying the integer and floating-point calling convention.ABI-stringhas two parts: the size of integer types, and the registers used for floating-point types. So for example,-march=rv64ifd -mabi=lp64dmeans thatlongand pointers are 64-bit (which implicitly definesintto 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, where no floating-point arguments get passed in registers at all. ๐ค
The default for this argument is system dependent, and if you want a specific calling convention you should just say so explicitly, no cap. The valid calling conventions are: ilp32, ilp32f, ilp32d, lp64, lp64f, and lp64d. Some calling conventions are literally 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. ๐ And there's also the ilp32e ABI, which can only be used with the rv32e architecture. That ABI is not well specified at present, and is subject to change โ so, fair warning, it's giving "we'll see". ๐ฆ
-mfdiv,-mno-fdivโ do, or don't, use hardware floating-point divide and square root instructions. This requires the F or D extensions for floating-point registers. The default is to use them if the specified architecture has these instructions. ๐ฅ-mdiv,-mno-divโ do, 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. ๐-march=ISA-stringโ generate code for the given RISC-V ISA (e.g.rv64im). ISA strings must be lower-case, bestie, don't test me on this. Examples includerv64i,rv32g,rv32e, andrv32imaf. ๐ธ-mtune=processor-stringโ optimize the output for the given processor, specified by microarchitecture name. The permissible values for this option are:rocket,sifive-3-series,sifive-5-series,sifive-7-series, andsize. ๐
When -mtune= is not specified, the default is rocket.
The size choice is not intended for use by end-users. It's used when -Os is specified. It overrides the instruction cost info provided by -mtune=, but does not override the pipeline info. This helps reduce code size while still giving good performance. it's giving "small but still fast", iconic. ๐
-mpreferred-stack-boundary=numโ attempt to keep the stack boundary aligned to a 2 raised to num byte boundary. If-mpreferred-stack-boundaryis not specified, the default is 4 (16 bytes or 128-bits).
โ ๏ธ Warning: 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. like, all of them. every single one. don't come crying to me when it breaks. ๐ญ
-msmall-data-limit=nโ put global and static data smaller than n bytes into a special section (on some targets). ๐-msave-restore,-mno-save-restoreโ do, or don't, use smaller but slower prologue and epilogue code that uses library function calls. The default is to use fast inline prologues and epilogues. โก-mstrict-align,-mno-strict-alignโ do not, or do, generate unaligned memory accesses. The default is set depending on whether the processor we're optimizing for supports fast unaligned access or not. ๐ง-mcmodel=medlowโ generate code for the medium-low code model. The program and its statically defined symbols must lie within a single 2 GiB address range and must lie between absolute addresses -2 GiB and +2 GiB. Programs can be statically or dynamically linked. This is the default code model. ๐-mcmodel=medanyโ generate code for the medium-any code model. The program and its statically defined symbols must be within any single 2 GiB address range. Programs can be statically or dynamically linked. ๐-mexplicit-relocs,-mno-exlicit-relocsโ use, or do not use, assembler relocation operators when dealing with symbolic addresses. The alternative is to use assembler macros instead, which may limit optimization. ๐-mrelax,-mno-relaxโ take advantage of linker relaxations to reduce the number of instructions required to materialize symbol addresses. The default is to take advantage of linker relaxations. ๐-memit-attribute,-mno-emit-attributeโ emit (do not emit) RISC-V attribute to record extra information into ELF objects. This feature requires at least binutils 2.32. ๐-malign-data=typeโ control how GCC aligns variables and constants of array, structure, or union types. The supported values for type arexlen, which uses x register width as the alignment value, andnatural, which uses natural alignment.xlenis the 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. So specifying -mcpu=g13 enables the use of the G13 hardware multiply peripheral, and specifying -mcpu=g10 disables the use of hardware multiplications altogether. ๐ฎ
Note: although the RL78/G14 core is the default target, specifying -mcpu=g14 or -mcpu=rl78 on the command line does change the behavior of the toolchain, since it also enables G14 hardware multiply support. If these options are not specified on the command line, then software multiplication routines will be used even though the code targets the RL78 core. This is for backwards compatibility with older toolchains which did not have hardware multiply and divide support. ๐
In addition, a C preprocessor macro is defined based upon the setting of this option. Possible values are: "__RL78_G10__", "__RL78_G13__" or "__RL78_G14__".
-mg10,-mg13,-mg14,-mrl78โ these are aliases for the corresponding-mcpu=option. They're provided for backwards compatibility. ๐ซถ-mallregsโ allow the compiler to use all of the available registers. By default registers"r24..r31"are reserved for use in interrupt handlers. With this option enabled, these registers can be used in ordinary functions as well. ๐-m64bit-doubles,-m32bit-doublesโ make the"double"data type be 64 bits (-m64bit-doubles) or 32 bits (-m32bit-doubles) in size. The default is-m32bit-doubles. ๐ฏ-msave-mduc-in-interrupts,-mno-save-mduc-in-interruptsโ specifies that interrupt handler functions should preserve the MDUC registers. This is only necessary if normal code might use the MDUC registers, for example because it performs multiplication and division operations. The default is to ignore the MDUC registers, since this makes the interrupt handlers faster. The target option-mg13needs to be passed for this to work, as this feature is only available on the G13 target (S2 core). The MDUC registers will only be saved if the interrupt handler performs a multiplication or division operation, or it calls another function. ๐ก๏ธ
๐ IBM RS/6000 and PowerPC Options ๐
These -m options are defined for the IBM RS/6000 and PowerPC:
-mpowerpc-gpopt,-mno-powerpc-gpopt,-mpowerpc-gfxopt,-mno-powerpc-gfxopt,-mpowerpc64,-mno-powerpc64,-mmfcrf,-mno-mfcrf,-mpopcntb,-mno-popcntb,-mpopcntd,-mno-popcntd,-mfprnd,-mno-fprnd,-mcmpb,-mno-cmpb,-mhard-dfp,-mno-hard-dfpโ you use these options to specify which instructions are available on the processor you're using. The default value of these options is determined when configuring GCC. Specifying the-mcpu=cpu_typeoverrides the specification of these options. We recommend you use the-mcpu=cpu_typeoption rather than the options listed above. ๐
Specifying -mpowerpc-gpopt allows GCC to use the optional PowerPC architecture instructions in the General Purpose group, including floating-point square root. Specifying -mpowerpc-gfxopt allows GCC to use the optional PowerPC architecture instructions in the Graphics group, including floating-point select. ๐ธ
The -mmfcrf option lets GCC spit out the move-from-condition-register-field instruction that lives on the POWER4 processor and any other chip that supports the PowerPC V2.01 architecture. โจ The -mpopcntb option lets GCC generate the popcount and double-precision FP reciprocal estimate instruction implemented on the POWER5 processor and other processors that support the PowerPC V2.02 architecture. The -mpopcntd option lets GCC generate the popcount instruction implemented on the POWER7 processor and other processors that support the PowerPC V2.06 architecture. The -mfprnd option lets GCC generate the FP round-to-integer instructions implemented on the POWER5+ processor and other processors that support the PowerPC V2.03 architecture. The -mcmpb option lets GCC generate the compare-bytes instruction implemented on the POWER6 processor and other processors that support the PowerPC V2.05 architecture. And the -mhard-dfp option lets GCC generate the decimal floating-point instructions implemented on some POWER processors. ๐
The -mpowerpc64 option lets GCC generate the extra 64-bit instructions you get in the full PowerPC64 architecture, and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to -mno-powerpc64.
-mcpu=cpu_type โ Sets the architecture type, register usage, and instruction scheduling parameters for machine type cpu_type. The 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,powerpc,powerpc64,powerpc64le, andnative.
-mcpu=powerpc, -mcpu=powerpc64, and -mcpu=powerpc64le specify pure 32-bit PowerPC (either endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC architecture machine types, with an appropriate, generic processor model assumed for scheduling purposes. ๐
Specifying native as the cpu type detects and selects the architecture option that corresponds to the host processor of the system performing the compilation. -mcpu=native has no effect if GCC does not recognize the processor. ๐
The other options specify a specific processor. Code generated under those options runs best on that processor, and may not run at all on others.
The -mcpu options automatically enable or disable the following options:
-maltivec -mfprnd -mhard-float -mmfcrf -mmultiple -mpopcntb
-mpopcntd -mpowerpc64 -mpowerpc-gpopt -mpowerpc-gfxopt -mmulhw
-mdlmzb -mmfpgpr -mvsx -mcrypto -mhtm -mpower8-fusion
-mpower8-vector -mquad-memory -mquad-memory-atomic -mfloat128
-mfloat128-hardware -mprefixed -mpcrel -mmma
Which particular options get set for any particular CPU varies between compiler versions, depending on what setting seems to produce optimal code for that CPU; it doesn't necessarily reflect the actual hardware's capabilities. So if you want to set an individual option to a particular value, you may specify it after the -mcpu option, like -mcpu=970 -mno-altivec. ๐
On AIX, the -maltivec and -mpowerpc64 options are not enabled or disabled by the -mcpu option at present, because AIX does not have full support for these options. You may still enable or disable them individually if you're sure it'll work in your environment.
-mtune=cpu_type โ Sets the instruction scheduling parameters for machine type cpu_type, but does not set the architecture type or register usage, the way-mcpu=cpu_type does. The same values for cpu_type are used for-mtuneas for-mcpu. If both are specified, the code generated uses the architecture and registers set by-mcpu, but the scheduling parameters set by-mtune.-mcmodel=smallโ Generates PowerPC64 code for the small model: the TOC is limited to 64k.-mcmodel=mediumโ Generates PowerPC64 code for the medium model: the TOC and other static data may be up to a total of 4G in size. This is the default for 64-bit Linux.-mcmodel=largeโ Generates PowerPC64 code for the large model: the TOC may be up to 4G in size. Other data and code is only limited by the 64-bit address space.-maltivec-mno-altivecโ Generate code that uses (does not use) AltiVec instructions, and also enable the use of built-in functions that allow more direct access to the AltiVec instruction set. You may also need to set-mabi=altivecto adjust the current ABI with AltiVec ABI enhancements. ๐ฆ
When -maltivec is used, the element order for AltiVec intrinsics such as vec_splat, vec_extract, and vec_insert match array element order corresponding to the endianness of the target. That is, element zero identifies the leftmost element in a vector register when targeting a big-endian platform, and identifies the rightmost element in a vector register when targeting a little-endian platform.
-mvrsave-mno-vrsaveโ Generate VRSAVE instructions when generating AltiVec code.-msecure-pltโ Generate code that allowsldandld.soto build executables and shared libraries with non-executable.pltand.gotsections. This is a PowerPC 32-bit SYSV ABI option.-mbss-pltโ Generate code that uses a BSS.pltsection thatld.sofills in, and requires.pltand.gotsections that are both writable and executable. This is a PowerPC 32-bit SYSV ABI option.-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.-mpower8-vector-mno-power8-vectorโ Generate code that uses (does not use) the vector and scalar instructions that were added in version 2.07 of the PowerPC ISA. Also enable the use of built-in functions that allow more direct access to the vector instructions.-mquad-memory-mno-quad-memoryโ Generate code that uses (does not use) the non-atomic quad word memory instructions. The-mquad-memoryoption requires use of 64-bit mode.-mquad-memory-atomic-mno-quad-memory-atomicโ Generate code that uses (does not use) the atomic quad word memory instructions. The-mquad-memory-atomicoption requires use of 64-bit mode.-mfloat128-mno-float128โ Enable/disable the__float128keyword for IEEE 128-bit floating point and use either software emulation for IEEE 128-bit floating point or hardware instructions.
The VSX instruction set (-mvsx) 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 (-mpower9-vector or -mcpu=power9) on a 64-bit system, the IEEE 128-bit floating point support will also enable the generation of ISA 3.0 IEEE 128-bit floating point instructions. Otherwise, if you do not specify to generate ISA 3.0 instructions or you are targeting a 32-bit big endian system, IEEE 128-bit floating point will be done with software emulation.
-mfloat128-hardware-mno-float128-hardwareโ Enable/disable using ISA 3.0 hardware instructions to support the__float128data type.
The default for -mfloat128-hardware is enabled on PowerPC Linux systems using the ISA 3.0 instruction set, and disabled on other systems.
-m32-m64โ Generate code for 32-bit or 64-bit environments of Darwin and SVR4 targets (including GNU/Linux). The 32-bit environment setsint,longand pointer to 32 bits and generates code that runs on any PowerPC variant. The 64-bit environment setsintto 32 bits andlongand pointer to 64 bits, and generates code for PowerPC64, as for-mpowerpc64.-mfull-toc-mno-fp-in-toc-mno-sum-in-toc-mminimal-tocโ Modify generation of the TOC (Table Of Contents), which is created for every executable file. The-mfull-tocoption is selected by default. In that case, GCC allocates at least one TOC entry for each unique non-automatic variable reference in your program. GCC also places floating-point constants in the TOC. However, only 16,384 entries are available in the TOC. ๐ญ
If you receive a linker error message that saying you have overflowed the available TOC space, you can reduce the amount of TOC space used with the -mno-fp-in-toc and -mno-sum-in-toc options. -mno-fp-in-toc prevents GCC from putting floating-point constants in the TOC and -mno-sum-in-toc forces GCC to generate code to calculate the sum of an address and a constant at run time instead of putting that sum into the TOC. You may specify one or both of these options. Each causes GCC to produce very slightly slower and larger code at the expense of conserving TOC space.
If you still run out of space in the TOC even when you specify both of these options, specify -mminimal-toc instead. This option causes GCC to make only one TOC entry for every file. When you specify this option, GCC produces code that is slower and larger but which uses extremely little TOC space. You may wish to use this option only on files that contain less frequently-executed code. ๐ซถ
-maix64,-maix32โ okay so this one flips the 64-bit AIX ABI and calling convention on or off, bestie: that means 64-bit pointers, a 64-bitlongtype, and the whole infrastructure needed to support them. The way that-maix64works, it implies-mpowerpc64, while-maix32disables the 64-bit ABI and implies-mno-powerpc64. GCC defaults to-maix32. ๐-mxl-compat,-mno-xl-compatโ this produces code that conforms more closely to IBM XL compiler semantics when using the AIX-compatible ABI. It passes floating-point arguments to prototyped functions beyond the register save area (RSA) on the stack in addition to argument FPRs. It does not assume that the most significant double in a 128-bitlong doublevalue is properly rounded when comparing values and converting todouble. It uses XL symbol names forlong doublesupport routines. โจ
Okay, storytime, because this is important: the AIX calling convention was extended but not initially documented to handle an obscure K&R C case of calling a function that takes the address of its arguments with fewer arguments than declared. IBM XL compilers access floating-point arguments that do not fit in the RSA from the stack when a subroutine is compiled without optimization. Because always storing floating-point arguments on the stack is inefficient and rarely needed, this option is not enabled by default and only is necessary when calling subroutines compiled by IBM XL compilers without optimization. ๐ญ
-mpeโ this supports the IBM RS/6000 SP Parallel Environment (PE). It links 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. periodt, they cannot sit together. ๐-malign-natural,-malign-powerโ on AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option-malign-naturaloverrides the ABI-defined alignment of larger types, such as floating-point doubles, on their natural size-based boundary. The option-malign-powerinstructs GCC to follow the ABI-specified alignment rules. GCC defaults to the standard alignment defined in the ABI. ๐ฆ
On 64-bit Darwin, natural alignment is the default, and -malign-power is not supported. so don't try it there, bestie.
-msoft-float,-mhard-floatโ generate code that does not use (uses) the floating-point register set. Software floating-point emulation is provided if you use the-msoft-floatoption, and pass the option to GCC when linking. ๐-mmultiple,-mno-multipleโ 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. lowkey cursed, be careful. ๐ญ-mavoid-indexed-addresses,-mno-avoid-indexed-addressesโ generate code that tries to avoid (not avoid) the use of indexed load or store instructions. These instructions can incur a performance penalty on Power6 processors in certain situations, such as when stepping through large arrays that cross a16Mboundary. This option is enabled by default when targeting Power6 and disabled otherwise. vibe check: Power6 gets the special treatment. โจ-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. iykyk, it got a glow-up. ๐-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. ๐-mdlmzb,-mno-dlmzbโ generate code that uses (does not use) the string-searchdlmzbinstruction on the IBM 405, 440, 464 and 476 processors. This instruction is generated by default when targeting those processors. string-search slay. ๐-mno-bit-align,-mbit-alignโ on System V.4 and embedded PowerPC systems, do not (do) force structures and unions that contain bit-fields to be aligned to the base type of the bit-field. ๐ธ
For example, by default a structure containing nothing but 8 unsigned bit-fields of length 1 is aligned to a 4-byte boundary and has a size of 4 bytes. By using -mno-bit-align, the structure is aligned to a 1-byte boundary and is 1 byte in size. the way that one option changes the whole size, obsessed. ๐
-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. ngl, this is a trust issue. ๐ฆ-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. โจ-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 friendship energy. ๐ซถ-mno-toc,-mtocโ on System V.4 and embedded PowerPC systems, do not (do) assume that register 2 contains a pointer to a global area pointing to the addresses used in the program. ๐-mlittle,-mlittle-endianโ on System V.4 and embedded PowerPC systems, compile code for the processor in little-endian mode. The-mlittle-endianoption is the same as-mlittle. little-endian bestie representation. ๐ธ-mbig,-mbig-endianโ on System V.4 and embedded PowerPC systems, compile code for the processor in big-endian mode. The-mbig-endianoption is the same as-mbig. big-endian main character energy. ๐-mdynamic-no-picโ on Darwin and Mac OS X systems, compile code so that it is not relocatable, but that its external references are relocatable. The resulting code is suitable for applications, but not shared libraries. ๐-msingle-pic-baseโ treat the register used for PIC addressing as read-only, rather than loading it in the prologue for each function. The runtime system is responsible for initializing this register with an appropriate value before execution begins. so the runtime has to handle it, not you. โจ-mprioritize-restricted-insns=priorityโ this option controls the priority that is assigned to dispatch-slot restricted instructions during the second scheduling pass. The argument priority takes the value0,1, or2to assign no, highest, or second-highest (respectively) priority to dispatch-slot restricted instructions. ๐-msched-costly-dep=dependence_typeโ this option controls which dependences are considered costly by the target during instruction scheduling. The argument dependence_type takes one of the following values:noโ no dependence is costly. ๐allโ all dependences are costly. ๐true_store_to_loadโ a true dependence from store to load is costly. ๐ฅstore_to_loadโ any dependence from store to load is costly. ๐- number โ any dependence for which the latency is greater than or equal to number is costly. โญ
-minsert-sched-nops=schemeโ this option controls which NOP insertion scheme is used during the second scheduling pass. The argument scheme takes one of the following values:noโ don't insert NOPs. ๐ซpadโ pad with NOPs any dispatch group that has vacant issue slots, according to the scheduler's grouping. ๐regroup_exactโ insert NOPs to force costly dependent insns into separate groups. Insert exactly as many NOPs as needed to force an insn to a new group, according to the estimated processor grouping. โจ- number โ insert NOPs to force costly dependent insns into separate groups. Insert number NOPs to force an insn to a new group. ๐
-mcall-sysvโ on System V.4 and embedded PowerPC systems, compile code using calling conventions that adhere to the March 1995 draft of the System V Application Binary Interface, PowerPC processor supplement. This is the default unless you configured GCC usingpowerpc-*-eabiaix. ๐-mcall-sysv-eabi,-mcall-eabiโ specify both-mcall-sysvand-meabioptions. ๐ซถ-mcall-sysv-noeabiโ specify both-mcall-sysvand-mno-eabioptions. ๐-mcall-aixdescโ on System V.4 and embedded PowerPC systems, compile code for the AIX operating system. ๐ธ-mcall-linuxโ on System V.4 and embedded PowerPC systems, compile code for the Linux-based GNU system. ๐ง-mcall-freebsdโ on System V.4 and embedded PowerPC systems, compile code for the FreeBSD operating system. ๐-mcall-netbsdโ on System V.4 and embedded PowerPC systems, compile code for the NetBSD operating system. ๐-mcall-openbsdโ on System V.4 and embedded PowerPC systems, compile code for the OpenBSD operating system. ๐ก-mtraceback=traceback_typeโ select the type of traceback table. Valid values for traceback_type arefull,part, andno. pick your fighter. โจ-maix-struct-returnโ return all structures in memory (as specified by the AIX ABI). ๐พ-msvr4-struct-returnโ return structures smaller than 8 bytes in registers (as specified by the SVR4 ABI). ๐-mabi=abi-typeโ the ABI glow-up switch โจ. It extends your current ABI with one specific extension, or yoinks that extension back out if you're over it. The valid values arealtivec,no-altivec,ibmlongdouble,ieeelongdouble,elfv1,elfv2, and, for AIX specifically,vec-extabiandvec-default.-mabi=ibmlongdoubleโ flips the current ABI to use IBM extended-precisionlong double. ngl bestie, this is not likely to work if your system defaults to IEEE extended-precisionlong double. And if you change thelong doubletype away from IEEE extended-precision, the compiler will hit you with a warning unless you pass-Wno-psabi. Requires-mlong-double-128to be enabled.-mabi=ieeelongdoubleโ flips the current ABI to use IEEE extended-precisionlong double. Same vibe check as above: not likely to work if your system defaults to IBM extended-precisionlong double. Change thelong doubletype away from IBM extended-precision and the compiler issues a warning unless you use-Wno-psabi. Requires-mlong-double-128to be enabled.-mabi=elfv1โ swaps the current ABI over to the ELFv1 ABI. That's 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 ๐.-mabi=elfv2โ swaps the current ABI over to the ELFv2 ABI. That's the default ABI for little-endian PowerPC 64-bit Linux. Overriding the default ABI needs special system support and is likely to fail in spectacular ways ๐.-mgnu-attribute,-mno-gnu-attributeโ emit.gnu_attributeassembly directives (or don't) to set tag/value pairs in a.gnu.attributessection that specify ABI variations in function parameters or return values. ๐-mprototype,-mno-prototypeโ on System V.4 and embedded PowerPC systems, assume that all calls to variable argument functions are properly prototyped. Otherwise the compiler 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 that bit.-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. ๐ฆ-mmvmeโ on embedded PowerPC systems, assume the startup module is calledcrt0.oand the standard C libraries arelibmvme.aandlibc.a.-madsโ on embedded PowerPC systems, assume the startup module is calledcrt0.oand the standard C libraries arelibads.aandlibc.a.-myellowknifeโ on embedded PowerPC systems, assume the startup module is calledcrt0.oand the standard C libraries arelibyk.aandlibc.a. (iconic name fr ๐ธ)-mvxworksโ on System V.4 and embedded PowerPC systems, specify that you're compiling for a VxWorks system.-membโ on embedded PowerPC systems, set the"PPC_EMB"bit in the ELF flags header to indicate that eabi extended relocations are used.-meabi,-mno-eabiโ on System V.4 and embedded PowerPC systems, do (or do not) 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 the-msdataoption only uses"r13"to point to a single small data area.-meabiis on by default if you configured GCC using one of thepowerpc*-*-eabi*options.-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, which is pointed to by register"r13". Put small uninitialized global and static data in the.sbsssection, which sits adjacent to.sdata. Heads up:-msdata=eabiis incompatible with-mrelocatable. It also sets-memb.-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, adjacent to.sdata. Also incompatible with-mrelocatable.-msdata=default,-msdataโ on System V.4 and embedded PowerPC systems, if-meabiis used, compile code exactly like-msdata=eabi; otherwise compile it exactly like-msdata=sysv.-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.-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.-mreadonly-in-sdataโ put read-only objects in the.sdatasection too. This is the default. โจ-mblock-move-inline-limit=numโ inline all block moves (think calls to"memcpy"or structure copies) that are less than or equal to num bytes. The minimum value for num is 32 bytes on 32-bit targets and 64 bytes on 64-bit targets. The default value is target-specific.-mblock-compare-inline-limit=numโ generate non-looping inline code for all block compares (think calls to"memcmp"or structure compares) that are less than or equal to num bytes. If num is 0, 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 get compared before"memcmp"is called to compare the rest of the block. The default value is target-specific.-mstring-compare-inline-limit=numโ compare at most num string bytes with inline code. If the difference or the end of the string isn't found by the end of that inline compare, a call to"strcmp"or"strncmp"handles the rest of the comparison. The default is 64 bytes.-G numโ on embedded PowerPC systems, put global and static items that are less than or equal to num bytes into the small data or BSS sections instead of the normal data or BSS section. By default, num is 8. The-G numswitch also gets passed to the linker. All modules should be compiled with the same-G numvalue.-mregnames,-mno-regnamesโ on System V.4 and embedded PowerPC systems, do (or do not) emit register names in the assembly language output using symbolic forms.-mlongcall,-mno-longcallโ by default, assume that all calls are far away, so a longer and more expensive calling sequence is required. This is needed for calls farther than 32 megabytes (33,554,432 bytes) from the current location. A short call gets generated if the compiler knows the call can't be that far away. You can override this setting with the"shortcall"function attribute, or with#pragma longcall(0).
Some linkers can detect out-of-range calls and generate glue code on the fly. On those systems, long calls are unnecessary and generate slower code. As of this writing, the AIX linker can do this, and so can the GNU linker for PowerPC/64. It's planned to add this feature to the GNU linker for 32-bit PowerPC systems too.
On PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, GCC can generate long calls using an inline PLT call sequence (see -mpltseq). PowerPC with -mbss-plt and PowerPC64 ELFv1 (big-endian) do not support inline PLT calls.
On Darwin/PPC systems, #pragma longcall generates jbsr callee, L42, plus a branch island (glue code). The two target addresses represent the callee and the branch island. The Darwin/PPC linker prefers the first address and generates a bl callee if the PPC bl instruction reaches the callee directly; otherwise the linker generates bl L42 to call the branch island. The branch island gets appended to the body of the calling function; 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.
-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 indlopen'd shared libraries. Inline PLT calls are only supported on PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, and they're enabled by default if that support is detected when configuring GCC โ and, for 32-bit PowerPC, if GCC is configured with--enable-secureplt.-mpltseqcode and-mbss-plt32-bit PowerPC relocatable objects may not be linked together.-mtls-markers,-mno-tls-markersโ mark (or don't mark) calls to"__tls_get_addr"with a relocation specifying the function argument. That relocation lets the linker reliably associate a function call with its argument setup instructions for TLS optimization, which in turn lets GCC schedule the sequence better. ๐-mrecip,-mno-recipโ okay so this one lets you use the reciprocal estimate and reciprocal square root estimate instructions, and then it stacks additional Newton-Raphson steps on top to bump the precision back up, instead of doing a whole actual divide โ or a square root and a divide โ for floating-point arguments. You should use the-ffast-mathoption when you're using-mrecip(or at least-funsafe-math-optimizations,-ffinite-math-only,-freciprocal-mathand-fno-trapping-math). Now, heads up: even though the throughput of this whole sequence is generally higher than the throughput of the non-reciprocal instruction, the precision of the sequence can get decreased by up to 2 ulp โ like, the inverse of 1.0 equals 0.99999994 โ for reciprocal square roots. ๐-mrecip=optโ this is the one that controls which reciprocal estimate instructions are allowed to show up.optis a comma-separated list of options, and any of them can be prefixed with a"!"to invert it:allโ enable all estimate instructions. all of them. no notes. ๐defaultโ enable the default instructions, equivalent to-mrecip.noneโ disable all estimate instructions, equivalent to-mno-recip.divโ enable the reciprocal approximation instructions for both single and double precision.divfโ enable the single-precision reciprocal approximation instructions.divdโ enable the double-precision reciprocal approximation instructions.rsqrtโ enable the reciprocal square root approximation instructions for both single and double precision.rsqrtfโ enable the single-precision reciprocal square root approximation instructions.rsqrtdโ enable the double-precision reciprocal square root approximation instructions.
So, for example, -mrecip=all,!rsqrtd enables all of the reciprocal estimate instructions, except for the FRSQRTE, XSRSQRTEDP, and XVRSQRTEDP instructions which handle the double-precision reciprocal square root calculations. it's giving very "everything but the girl" energy ๐
-mrecip-precision,-mno-recip-precisionโ assume (or don't assume) that the reciprocal estimate instructions hand you higher-precision estimates than the PowerPC ABI mandates. Picking-mcpu=power6,-mcpu=power7or-mcpu=power8automatically selects-mrecip-precision. Also fyi the double-precision square root estimate instructions are not generated by default on low-precision machines, because they don't provide an estimate that converges after three steps. ๐ญ-mveclibabi=typeโ this specifies the ABI type to use for vectorizing intrinsics using an external library. The only type supported at present ismass, which specifies to use IBM's Mathematical Acceleration Subsystem (MASS) libraries for vectorizing intrinsics using external libraries. GCC currently emits calls toacosd2,acosf4,acoshd2,acoshf4,asind2,asinf4,asinhd2,asinhf4,atan2d2,atan2f4,atand2,atanf4,atanhd2,atanhf4,cbrtd2,cbrtf4,cosd2,cosf4,coshd2,coshf4,erfcd2,erfcf4,erfd2,erff4,exp2d2,exp2f4,expd2,expf4,expm1d2,expm1f4,hypotd2,hypotf4,lgammad2,lgammaf4,log10d2,log10f4,log1pd2,log1pf4,log2d2,log2f4,logd2,logf4,powd2,powf4,sind2,sinf4,sinhd2,sinhf4,sqrtd2,sqrtf4,tand2,tanf4,tanhd2, andtanhf4when generating code for power7. Both-ftree-vectorizeand-funsafe-math-optimizationsmust also be enabled. And the MASS libraries must be specified at link time. (yeah that's a lot of names, drink some water bestie ๐)-mfriz,-mno-frizโ generate (or don't generate) thefrizinstruction when the-funsafe-math-optimizationsoption is used to optimize rounding of floating-point values to 64-bit integer and back to floating point. Lowkey important caveat: thefrizinstruction does not return the same value if the floating-point number is too large to fit in an integer. ๐ซถ-mpointers-to-nested-functions,-mno-pointers-to-nested-functionsโ generate (or don't generate) code to load up the static chain register (r11) when calling through a pointer on AIX and 64-bit Linux systems where a function pointer points to a 3-word descriptor giving the function address, TOC value to be loaded in registerr2, and static chain value to be loaded in registerr11. The-mpointers-to-nested-functionsis on by default. And real talk: 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. don't. ๐-msave-toc-indirect,-mno-save-toc-indirectโ generate (or don't generate) code to save the TOC value in the reserved stack location in the function prologue if the function calls through a pointer on AIX and 64-bit Linux systems. If the TOC value is not saved in the prologue, it is saved just before the call through the pointer. The-mno-save-toc-indirectoption is the default.-mcompat-align-parm,-mno-compat-align-parmโ generate (or don't generate) code to pass structure parameters with a maximum alignment of 64 bits, for compatibility with older versions of GCC.
Okay so story time: older versions of GCC (prior to 4.9.0) incorrectly did not align a structure parameter on a 128-bit boundary when that structure contained a member requiring 128-bit alignment. This is corrected in more recent versions of GCC. This option may be used to generate code that is compatible with functions compiled with older versions of GCC.
The -mno-compat-align-parm option is the default.
-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offset,-mstack-protector-guard-symbol=symbolโ generate stack protection code using canary atguard. Supported locations areglobalfor global canary ortlsfor per-thread canary in the TLS block (the default with GNU libc version 2.4 or later).
With the latter choice the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which register to use as base register for reading the canary, and from what offset from that base register. The default for those is as specified in the relevant ABI. -mstack-protector-guard-symbol=symbol overrides the offset with a symbol reference to a canary in the TLS block. canary said "protect me" and honestly? valid ๐ค
-mpcrel,-mno-pcrelโ generate (or don't generate) pc-relative addressing. The-mpcreloption requires that the medium code model (-mcmodel=medium) and prefixed addressing (-mprefixed) options are enabled. it's a package deal, no a la carte here โจ-mprefixed,-mno-prefixedโ generate (or don't generate) addressing modes using prefixed load and store instructions. The-mprefixedoption requires that the option-mcpu=power10(or later) is enabled.-mmma,-mno-mmaโ generate (or don't generate) the MMA instructions. The-mmaoption requires that the option-mcpu=power10(or later) is enabled.
โจ RX Options โจ
These command-line options are defined for RX targets:
-m64bit-doubles,-m32bit-doublesโ make thedoubledata type be 64 bits (-m64bit-doubles) or 32 bits (-m32bit-doubles) in size. The default is-m32bit-doubles. Note RX floating-point hardware only works on 32-bit values, which is why the default is-m32bit-doubles. the hardware said "32 bits or nothing" and we respect it ๐-fpu,-nofpuโ enables (-fpu) or disables (-nofpu) the use of RX floating-point hardware. The default is enabled for the RX600 series and disabled for the RX200 series.
Floating-point instructions are only generated for 32-bit floating-point values, however, so the FPU hardware is not used for doubles if the -m64bit-doubles option is used.
Note! If the-fpuoption is enabled then-funsafe-math-optimizationsis also enabled automatically. This is because the RX FPU instructions are themselves unsafe. not me enabling unsafe math behind your back ๐ญ
-mcpu=nameโ selects the type of RX CPU to be targeted. Currently three types are supported, the generic RX600 and RX200 series hardware and the specific RX610 CPU. The default is RX600.
The only difference between RX600 and RX610 is that the RX610 does not support the MVTIPL instruction.
The RX200 series does not have a hardware floating-point unit and so -nofpu is enabled by default when this type is selected.
-mbig-endian-data,-mlittle-endian-dataโ store data (but not code) in the big-endian format. The default is-mlittle-endian-data, i.e. to store data in the little-endian format. code stays out of it, this is a data-only situation ๐ธ-msmall-data-limit=Nโ specifies the maximum size in bytes of global and static variables which can be placed into the small data area. Using the small data area can lead to smaller and faster code, but the size of area is limited and it is up to the programmer to ensure that the area does not overflow. Also when the small data area is used one of the RX's registers (usuallyr13) is reserved for use pointing to this area, so it is no longer available for use by the compiler. This could result in slower and/or larger code if variables are pushed onto the stack instead of being held in this register.
Note, common variables (variables that have not been initialized) and constants are not placed into the small data area as they are assigned to other sections in the output executable.
The default value is zero, which disables this feature. Note, this feature is not enabled by default with higher optimization levels (-O2 etc) because of the potentially detrimental effects of reserving a register. It is up to the programmer to experiment and discover whether this feature is of benefit to their program. See the description of the -mpid option for a description of how the actual register to hold the small data area pointer is chosen. it's giving "you gotta test it yourself, bestie" energy ๐งช
-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 is compatible with Renesas's AS100 assembler. This syntax can also be handled by the GAS assembler, but it has some restrictions so it is not generated by default. ๐ฆ-mmax-constant-size=Nโ bestie, this one sets the maximum size, in bytes, of a constant that's allowed to show up as an operand inside an RX instruction. And yeah, the RX instruction set does let constants up to 4 bytes long ride along in instructions, but a longer value means a longer instruction โ so sometimes it's lowkey beneficial to cap how big those constants get. Constants that are too big get yeeted into a constant pool instead and referenced via register indirection. N can be anywhere from 0 to 4. A value of 0 (that's the default) or 4 means constants of any size are allowed, no cap, periodt. ๐-mrelaxโ turns on linker relaxation. It's a whole process where the linker tries to shrink your program by finding shorter versions of various instructions. It's giving glow-up energy. Disabled by default, bestie. โจ-mint-register=Nโ tells GCC how many registers to reserve for fast interrupt handler functions. N lives between 0 and 4. A value of 1 means register"r13"is reserved for the exclusive use of fast interrupt handlers. A value of 2 reserves"r13"and"r12". A value of 3 reserves"r13","r12"and"r11", and a value of 4 reserves"r13"through"r10". A value of 0 โ the default, obviously โ doesn't reserve any registers at all. ๐-msave-acc-in-interruptsโ says interrupt handler functions should preserve the accumulator register. This is only necessary if normal code might use the accumulator register, like when it does 64-bit multiplications. The default is to ignore the accumulator, because ignoring it makes the interrupt handlers faster. Speed queen behavior. ๐ฅ-mpidโ-mno-pidโ enables the 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 figured out at run time without needing 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. ๐ฆ
Heads up though: using this feature reserves a register, usually "r13", for the constant data base address. That can result in slower and/or larger code, especially in complicated functions. Not the vibe you want in a hot loop, ngl.
The actual register chosen to hold the constant data base address depends on whether the -msmall-data-limit and/or the -mint-register command-line options are enabled. Starting with register "r13" and proceeding downwards, registers are allocated first to satisfy the requirements of -mint-register, then -mpid and finally -msmall-data-limit. So it's totally possible for the small data area register to be "r8" if both -mint-register=4 and -mpid are specified on the command line. Wild, right? ๐ญ
By default this feature is not enabled. The default can be restored via the -mno-pid command-line option.
-mno-warn-multiple-fast-interruptsโ-mwarn-multiple-fast-interruptsโ prevents GCC from issuing a warning message if it finds more than one fast interrupt handler while it's compiling a file. The default is to issue a warning for each extra fast interrupt handler found, because the RX only supports one such interrupt. One. Singular. That's it. ๐-mallow-string-insnsโ-mno-allow-string-insnsโ enables or disables the use of the string manipulation instructions"SMOVF","SCMPU","SMOVB","SMOVU","SUNTIL""SWHILE"and also the"RMPA"instruction. These instructions may prefetch data, which is not safe to do if you're accessing an I/O register. (See section 12.2.7 of the RX62N Group User's Manual for more information.)
The default is to allow these instructions, but it is not possible for GCC to reliably detect all circumstances where a string instruction might be used to access an I/O register, so their use cannot be disabled automatically. Instead it is reliant upon the programmer to use the -mno-allow-string-insns option if their program accesses I/O space. So like, that's on you bestie, GCC can't read your mind. ๐
When the instructions are enabled GCC defines the C preprocessor symbol "__RX_ALLOW_STRING_INSNS__", otherwise it defines the symbol "__RX_DISALLOW_STRING_INSNS__".
-mjsrโ-mno-jsrโ use only (or not only)"JSR"instructions to access functions. This option can be used when code size exceeds the range of"BSR"instructions. Note that-mno-jsrdoes not mean to not use"JSR"but instead means that any type of branch may be used. Sneaky naming, fr fr. ๐
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 ensures that it only uses the registers"r10","r11","r12"and/or"r13"and only provided that the normal use of the corresponding registers have been restricted via the-ffixed-regor-mint-registercommand-line options.
๐ธ S/390 and zSeries Options ๐ธ
These are the -m options defined for the S/390 and zSeries architecture. Let's get into it. ๐
-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"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 -mmo-backchain; however, use of the backchain for debugging purposes usually requires that the whole binary is built with -mbackchain. Note that the combination of -mbackchain, -mpacked-stack and -mhard-float is not supported. In order to build a linux kernel use -msoft-float. ๐
The default is to not maintain the backchain.
-mpacked-stackโ-mno-packed-stackโ use (do not use) the packed stack layout. When-mno-packed-stackis specified, the compiler uses the all fields of the 96/160 byte register save area only for their default purpose; unused fields still take up stack space. When-mpacked-stackis specified, register save slots are densely packed at the top of the register save area; unused space is reused for other purposes, allowing for more efficient use of the available stack space. However, when-mbackchainis also in effect, the topmost word of the save area is always used to store the backchain, and the return address register is always saved two words below the backchain. Efficiency queen behavior, honestly. ๐
As long as the stack frame backchain is not used, code generated with -mpacked-stack is call-compatible with code generated with -mno-packed-stack. Note that some non-FSF releases of GCC 2.95 for S/390 or zSeries generated code that uses the stack frame backchain at run time, not just for debugging purposes. Such code is not call-compatible with code compiled with -mpacked-stack. Also, note that the combination of -mbackchain, -mpacked-stack and -mhard-float is not supported. In order to build a linux kernel use -msoft-float. ๐ฆ
The default is to not use the packed stack layout.
-msmall-execโ-mno-small-execโ generate (or do not generate) code using the"bras"instruction to do subroutine calls. This only works reliably if the total executable size does not exceed 64k. The default is to use the"basr"instruction instead, which does not have this limitation. 64k is giving so last season. ๐-m64โ-m31โ when-m31is specified, generate code compliant to the GNU/Linux for S/390 ABI. When-m64is specified, generate code compliant to the GNU/Linux for zSeries ABI. This allows GCC in particular to generate 64-bit instructions. For the s390 targets, the default is-m31, while the s390x targets default to-m64. Pick your fighter. โญ-mzarchโ-mesaโ when-mzarchis specified, generate code using the instructions available on z/Architecture. When-mesais specified, generate code using the instructions available on ESA/390. Note that-mesais not possible with-m64. When generating code compliant to the GNU/Linux for S/390 ABI, the default is-mesa. When generating code compliant to the GNU/Linux for zSeries ABI, the default is-mzarch.-mhtmโ-mno-htmโ the-mhtmoption enables a set of builtins making use of instructions available with the transactional execution facility introduced with the IBM zEnterprise EC12 machine generation S/390 System z Built-in Functions.-mhtmis enabled by default when using-march=zEC12. ๐ฅ-mvxโ-mno-vxโ when-mvxis specified, generate code using the instructions available with the vector extension facility introduced with the IBM z13 machine generation. This option changes the ABI for some vector type values with regard to alignment and calling conventions. In case vector type values are being used in an ABI-relevant context a GAS.gnu_attributecommand will be added to mark the resulting binary with the ABI used.-mvxis enabled by default when using-march=z13. Iconic. ๐-mzvector,-mno-zvectorโ okay so-mzvectorturns on the vector language extensions AND the builtins that ride on the instructions from the vector extension facility that IBM dropped with the z13 machine generation. It lets you usevectoras a keyword to define vector type variables and arguments ๐ฆ. But bestie, listen:vectoris only available when GNU extensions are enabled โ it will not be expanded when you're asking for strict standard compliance, like with-std=c99. No exceptions, it's giving strict-mode energy. On top of the GCC low-level builtins,-mzvectoralso enables a whole set of builtins added for compatibility with AltiVec-style implementations like Power and Cell โจ. To actually use those builtins you need to include the header filevecintrin.h. And-mzvectoris disabled by default. Periodt.-mmvcle,-mno-mvcleโ generate (or don't generate) code using themvcleinstruction to do block moves. When you say-mno-mvcleit uses amvcloop instead. This is the default unless you're optimizing for size ๐ .-mdebug,-mno-debugโ print (or don't print) extra debug information while compiling. Default is to not print debug information, so if you want the tea you gotta ask for it ๐.- *
-march=cpu-type* โ generate code that runs oncpu-type, which is the name of a system representing a certain processor type. The possible values forcpu-typearez900/arch5,z990/arch6,z9-109,z9-ec/arch7,z10/arch8,z196/arch9,zEC12,z13/arch11,z14/arch12,z15/arch13, andnative๐.
The default is -march=z900.
Specifying native as the cpu type can be used to select the best architecture option for the host processor. Heads up though: -march=native has no effect if GCC does not recognize the processor ๐ญ.
-mtune=cpu-typeโ tune tocpu-typeeverything applicable about the generated code, *except for the ABI and the set of available instructions. The list of *cpu-typevalues is the same as for-march. The default is the value used for-march๐ธ.-mtpf-trace,-mno-tpf-traceโ generate code that adds (does not add) in TPF OS specific branches to trace routines in the operating system. This option is off by default, even when compiling for the TPF OS ๐.-mtpf-trace-skip,-mno-tpf-trace-skipโ generate code that changes (does not change) the default branch targets enabled by-mtpf-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 you're compiling for the TPF OS and specifying-mtpf-trace๐ฎโ๐จ.-mfused-madd,-mno-fused-maddโ generate code that uses (does not use) the floating-point multiply and accumulate instructions. These instructions are generated by default if hardware floating point is used ๐ฅ.- *
-mwarn-framesize=framesize* โ emit a warning if the current function exceeds the given frame size. Because this is a compile-time check it doesn't need to be a real problem when the program runs. It's intended to identify functions that most probably cause a stack overflow ๐ซ . It's useful in an environment with limited stack size, e.g. the linux kernel. -mwarn-dynamicstackโ emit a warning if the function callsallocaor uses dynamically-sized arrays. This is generally a bad idea with a limited stack size, ngl ๐ฉ.-mstack-guard=stack-guard, *-mstack-size=stack-size* โ if these options are provided, the S/390 back end emits additional instructions in the function prologue that trigger a trap if the stack size isstack-guardbytes above thestack-size(remember that the stack on S/390 grows downward, bestie, it goes down ๐). If thestack-guardoption is omitted, the smallest power of 2 larger than the frame size of the compiled function is chosen. These options are meant to help debugging stack overflow problems. The additionally emitted code causes only little overhead and hence can also be used in production-like systems without greater performance degradation โจ. The given values have to be *exact powers of 2, and *stack-sizehas to be greater thanstack-guardwithout exceeding 64k. In order to be efficient, the extra code makes the assumption that the stack starts at an address aligned to the value given bystack-size. And thestack-guardoption can only be used in conjunction withstack-sizeโ ๏ธ.-mhotpatch=pre-halfwords,post-halfwordsโ if the hotpatch option is enabled, a "hot-patching" function prologue is generated for *all functions in the compilation unit. The funtion label is prepended with the given number of two-byte NOP instructions (pre-halfwords*, 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.
๐ฎ Score Options ๐ฎ
These options are defined for Score implementations, bestie:
-mebโ compile code for big-endian mode. This is the default ๐.-melโ compile code for little-endian mode.-mnhwloopโ disable generation ofbcnzinstructions ๐ซ.-mulsโ enable generation of unaligned load and store instructions โจ.-mmacโ enable the use of multiply-accumulate instructions. Disabled by default.-mscore5โ specify theSCORE5as the target architecture.-mscore5uโ specify theSCORE5Uof the target architecture.-mscore7โ specify theSCORE7as the target architecture. This is the default.-mscore7dโ specify theSCORE7Das the target architecture.
๐ SH Options ๐
These -m options are defined for the SH implementations, okay so buckle up because there are a lot of them:
-m1โ generate code for the SH1.-m2โ generate code for the SH2.-m2eโ generate code for the SH2e.-m2a-nofpuโ generate code for the SH2a without FPU, or for a SH2a-FPU in such a way that the floating-point unit is not used ๐ฆ.-m2a-single-onlyโ generate code for the SH2a-FPU, in such a way that no double-precision floating-point operations are used.-m2a-singleโ generate code for the SH2a-FPU assuming the floating-point unit is in single-precision mode by default.-m2aโ generate code for the SH2a-FPU assuming the floating-point unit is in double-precision mode by default.-m3โ generate code for the SH3.-m3eโ generate code for the SH3e.-m4-nofpuโ generate code for the SH4 without a floating-point unit.-m4-single-onlyโ generate code for the SH4 with a floating-point unit that only supports single-precision arithmetic.-m4-singleโ generate code for the SH4 assuming the floating-point unit is in single-precision mode by default.-m4โ generate code for the SH4.-m4-100โ generate code for SH4-100.-m4-100-nofpuโ generate code for SH4-100 in such a way that the floating-point unit is not used.-m4-100-singleโ generate code for SH4-100 assuming the floating-point unit is in single-precision mode by default.-m4-100-single-onlyโ generate code for SH4-100 in such a way that no double-precision floating-point operations are used.-m4-200โ generate code for SH4-200.-m4-200-nofpuโ generate code for SH4-200 without in such a way that the floating-point unit is not used.-m4-200-singleโ generate code for SH4-200 assuming the floating-point unit is in single-precision mode by default.-m4-200-single-onlyโ generate code for SH4-200 in such a way that no double-precision floating-point operations are used.-m4-300โ generate code for SH4-300.-m4-300-nofpuโ generate code for SH4-300 without in such a way that the floating-point unit is not used.-m4-300-singleโ generate code for SH4-300 in such a way that no double-precision floating-point operations are used.-m4-300-single-onlyโ generate code for SH4-300 in such a way that no double-precision floating-point operations are used.-m4-340โ generate code for SH4-340 (no MMU, no FPU).-m4-500โ generate code for SH4-500 (no FPU). Passes-isa=sh4-nofputo the assembler.-m4a-nofpuโ generate code for the SH4al-dsp, or for a SH4a in such a way that the floating-point unit is not used.-m4a-single-onlyโ generate code for the SH4a, in such a way that no double-precision floating-point operations are used.-m4a-singleโ generate code for the SH4a assuming the floating-point unit is in single-precision mode by default.-m4aโ generate code for the SH4a.-m4alโ same as-m4a-nofpu, except that it implicitly passes-dspto the assembler. GCC doesn't generate any DSP instructions at the moment ๐.-mbโ compile code for the processor in big-endian mode.-mlโ compile code for the processor in little-endian mode.-mdalignโ align doubles at 64-bit boundaries. 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โ ๏ธ.-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โ comply with the calling conventions defined by Renesas.-mno-renesasโ comply with the calling conventions defined for GCC before the Renesas conventions were available. This option is the default for all targets of the SH toolchain.-mnomacsaveโ mark 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โ inlines the code that invalidates instruction cache entries after nested function trampolines get set up. Important vibe check tho: this option does nothing if-musermodeis in effect and the code generation option you picked (like-m4) doesn't let you use theicbiinstruction. And if your code generation option doesn't allowicbiand-musermodeisn't in effect, then the inlined code goes and pokes the instruction cache address array directly with an associative write ๐ which not only needs privileged mode at run time, it also fails if the cache line got mapped via the TLB and then became unmapped. iykyk.-misizeโ dumps instruction size and location right into the assembly code. โจ-mpadstructโ bestie, this one is deprecated. It pads structures out to multiples of 4 bytes, which is just not compatible with the SH ABI. ๐-matomic-model=modelโ sets the model for atomic operations plus extra parameters, all as a comma separated list. For the deets on the atomic built-in functions, go peek at__atomic Builtins. Here's everything that's supported:noneโ disables compiler-generated atomic sequences and just emits library calls for atomic ops instead. This is the default if the target is notsh*-*-linux*.soft-gusaโ generates GNU/Linux compatible gUSA software atomic sequences for the atomic built-in functions. Heads up: these generated sequences need extra support from the system's interrupt/exception handling code, and they're only suitable for SH3* and SH4* single-core systems. This one is on by default when the target issh*-*-linux*and it's SH3* or SH4*. And when the target is SH4A, it also partially uses the hardware atomic instructionsmovli.landmovco.lto make more efficient code โ unless you specifystrict.soft-tcbโ generates software atomic sequences that use a variable in the thread control block. It's a variation on the gUSA sequences that also works on SH1* and SH2* targets. Same deal as before: needs extra support from the system's interrupt/exception handling code, and only suitable for single-core systems. When you use this model you have to also specify thegbr-offset=parameter.soft-imaskโ generates software atomic sequences that temporarily disable interrupts by settingSR.IMASK = 1111. This model only works when the program runs in privileged mode and it's only suitable for single-core systems. Good news: no extra support needed from the system's interrupt/exception handling code. This is the default when the target issh*-*-linux*and SH1* or SH2*.hard-llcsโ generates hardware atomic sequences using only themovli.landmovco.linstructions. Only available on SH4A, and it's suitable for multi-core systems. Since those hardware instructions only support 32-bit atomic variable access, 8 or 16 bit variable access gets emulated with 32 bit accesses. Code compiled with this option is also compatible with other software atomic model interrupt/exception handling systems if it runs on an SH4A system. And no extra support from the interrupt/exception handling code is required for this model. ๐ซถgbr-offset=โ this parameter says what the offset in bytes is of the variable in the thread control block structure that the generated atomic sequences should use, but only when thesoft-tcbmodel has been selected. For any other model this parameter is just ignored, no biggie. The value you give must be an integer multiple of four and sit in the range0-1020.strictโ this parameter stops you from mixing multiple atomic models, even the compatible ones, and forces the compiler to generate atomic sequences of the specified model only. no mix-and-match energy. ๐
-mtasโ generates thetas.bopcode for__atomic_test_and_set. But listen: depending on your exact hardware and software config, this can tank overall performance because of the operand cache line flushes thattas.bimplies. And on multi-core SH4A processors you gotta usetas.bwith caution โ it can cause data corruption for certain cache configurations. ๐ญ-mprefergotโ when generating position-independent code, this makes function calls go through 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 wouldn't work in user mode.-musermodeis the default when the target issh*-*-linux*. And if the target is SH1* or SH2*,-musermodehas no effect at all โ because there's literally no user mode to speak of. ๐-multcost=numberโ sets the cost to assume for a multiply instruction.-mdiv=strategyโ sets the division strategy used for integer division operations. strategy can be any one of these:call-div1โ calls a library function that uses the single-step division instructiondiv1to do the thing. Division by zero calculates an unspecified result and doesn't trap. This is the default except for SH4, SH2A and SHcompact.call-fpโ calls a library function that does the operation in double precision floating point. Division by zero causes a floating-point exception. This is the default for SHcompact with FPU. If you specify this for targets that don't have a double precision FPU, it just defaults tocall-div1.call-tableโ calls a library function that uses a lookup table for small divisors and thediv1instruction with case distinction for bigger divisors. Division by zero calculates an unspecified result and doesn't trap. This is the default for SH4. If you specify this for targets without dynamic shift instructions, it defaults tocall-div1.
And when no division strategy has been specified at all, the default strategy gets picked based on the current target. For SH2A the default strategy is to use the divs and divu instructions instead of library function calls. ๐ธ
-maccumulate-outgoing-argsโ reserves space once for outgoing arguments in the function prologue instead of around every single call. Generally a win for performance and size. It's also needed for unwinding, so the stack frame doesn't go changing around conditional code. โจ-mdivsi3_libfunc=nameโ sets the name of the library function used for 32-bit signed division to name. This only affects the name used in the call division strategies, and the compiler still expects the exact same sets of input/output/clobbered registers as if this option weren't there. no sneaky changes. ๐-mfixed-range=register-rangeโ generates code treating the given register range as fixed registers. A fixed register is one the register allocator can't use. Super useful when compiling kernel code. A register range is written as two registers separated by a dash, and you can specify multiple register ranges separated by commas.-mbranch-cost=numโ assumes num is the cost for a branch instruction. Higher numbers make the compiler try to generate more branch-free code when it can. If you don't specify it, the value gets selected depending on the processor type you're compiling for.-mzdcbranch,-mno-zdcbranchโ assume (don't assume) that the zero displacement conditional branch instructionsbtandbfare fast. If-mzdcbranchis specified, the compiler prefers zero displacement branch code sequences. This is enabled by default when generating code for SH4 and SH4A, and you can explicitly turn it off with-mno-zdcbranch.-mcbranch-force-delay-slotโ forces the usage of delay slots for conditional branches, which stuffs the delay slot with anopif no suitable instruction can be found. By default this option is disabled. You can enable it to work around hardware bugs like the ones found in the original SH7055.-mfused-madd,-mno-fused-maddโ generate code that uses (doesn't use) the floating-point multiply and accumulate instructions. These instructions get 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.-mfsca,-mno-fscaโ allow or disallow the compiler to emit thefscainstruction for sine and cosine approximations. The option-mfscamust be used in combination with-funsafe-math-optimizations. It's enabled by default when generating code for SH4A. Using-mno-fscadisables sine and cosine approximations even if-funsafe-math-optimizationsis in effect.-mfsrra,-mno-fsrraโ allow or disallow the compiler to emit thefsrrainstruction for reciprocal square root approximations. The option-mfsrramust be used in combination with-funsafe-math-optimizationsand-ffinite-math-only. It's 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โ prefers zero-displacement conditional branches for conditional move instruction patterns. This can result in faster code on the SH4 processor. ๐ฅ-mfdpicโ generates code using the FDPIC ABI.
โ๏ธ Solaris 2 Options โ๏ธ
These -m options are supported on Solaris 2, bestie:
-mclear-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 that aren't supported by the current machine, but check at runtime whether or not to use them.-mimpure-textโ-mimpure-text, used in addition to-shared, tells the compiler to not pass-z textto the linker when linking a shared object. Using this option, you can link position-dependent code into a shared object. ๐-mimpure-textโ okay so this one's whole job is shushing the linker's "relocations remain against allocatable but non-writable sections" error message. ๐ But bestie, listen โ the relocations it needs trigger copy-on-write, and then your shared object isn't actually shared across processes at all. Which is giving fake sharing energy. So instead of using-mimpure-text, you should compile all your source code with-fpicor-fPIC. Periodt. ๐
These switches are supported in addition to the above on Solaris 2:
-pthreadsโ literally just a synonym for-pthread. Same thing, different name, iconic. โจ
๐ SPARC Options ๐
These -m options are supported on the SPARC:
-mno-app-regs,-mapp-regsโ specify-mapp-regsand GCC generates output using the global registers 2 through 4, which the SPARC SVR4 ABI reserves for applications. Just like global register 1, each of global registers 2 through 4 gets treated as an allocable register that gets clobbered by function calls. This is the default ๐
Now, 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. Yes, seriously. ๐ซถ
-mflat,-mno-flatโ with-mflat, the compiler does not generate save/restore instructions and instead uses a "flat" or single register window model. This model is compatible with the regular register window model. The local registers and the input registers (0--5) are still treated as "call-saved" registers and get saved on the stack as needed.
With -mno-flat (the default), the compiler generates save/restore instructions (except for leaf functions). This is the normal operating mode. ๐ซ
-mfpu,-mhard-floatโ generate output containing floating-point instructions. This is the default. ๐ธ-mno-fpu,-msoft-floatโ generate output containing library calls for floating point.
Warning: the requisite libraries are not available for all SPARC targets. Normally the facilities of the machine's usual C compiler are used, but this 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. ๐ญ
Also -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 in order for this to work. No skipping steps bestie. ๐
-mhard-quad-floatโ generate output containing quad-word (long double) floating-point instructions. ๐ฅ-msoft-quad-floatโ generate output containing library calls for quad-word (long double) floating-point instructions. The functions called are those specified in the SPARC ABI. This is the default.
As of this writing, there are no SPARC implementations that have hardware support for the quad-word floating-point instructions. They all invoke a trap handler for one of these instructions, and then the trap handler emulates the effect of the instruction. Because of the trap handler overhead, this is much slower than calling the ABI library routines. Thus the -msoft-quad-float option is the default. ๐
-mno-unaligned-doubles,-munaligned-doublesโ assume that doubles have 8-byte alignment. This is the default.
With -munaligned-doubles, GCC assumes that doubles have 8-byte alignment only if they are contained in another type, or if they have an absolute address. Otherwise, it assumes they have 4-byte alignment. Specifying this option avoids some rare compatibility problems with code generated by other compilers. It is not the default because it results in a performance loss, especially for floating-point code. ๐
-muser-mode,-mno-user-modeโ do not generate code that can only run in supervisor mode. This is relevant only for the "casa" instruction emitted for the LEON3 processor. This is the default. ๐ง-mfaster-structs,-mno-faster-structsโ with-mfaster-structs, the compiler assumes that structures should have 8-byte alignment. This enables the use of pairs of "ldd" and "std" instructions for copies in structure assignment, in place of twice as many "ld" and "st" pairs. However โ and this is the big 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. ๐
-mlra,-mno-lraโ enable Local Register Allocation. This is the default for SPARC since GCC 7, so-mno-lraneeds to be passed to get old Reload. Nostalgia era, I guess. ๐ญ-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 value native, which selects the best architecture option for the host processor. -mcpu=native has no effect if GCC does not recognize the processor. ๐คทโโ๏ธ
Default instruction scheduling parameters are used for values that select an architecture and not an implementation. These are v7, v8, sparclite, sparclet, v9.
Here is a list of each supported architecture and their supported implementations:
v7โcypress,leon3v7v8โsupersparc,hypersparc,leon,leon3,leon5sparcliteโf930,f934,sparclite86xsparcletโtsc701v9โultrasparc,ultrasparc3,niagara,niagara2,niagara3,niagara4,niagara7,m8
By default (unless configured otherwise), GCC generates code for the V7 variant of the SPARC architecture. With -mcpu=cypress, the compiler additionally optimizes it for the Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series. This is also appropriate for the older SPARCStation 1, 2, IPX etc. ๐
With -mcpu=v8, GCC generates code for the V8 variant of the SPARC architecture. The only difference from V7 code is that the compiler emits the integer multiply and integer divide instructions which exist in SPARC-V8 but not in SPARC-V7. With -mcpu=supersparc, the compiler additionally optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and 2000 series.
With -mcpu=sparclite, GCC generates code for the SPARClite variant of the SPARC architecture. This adds the integer multiply, integer divide step and scan ("ffs") instructions which exist in SPARClite but not in SPARC-V7. With -mcpu=f930, the compiler additionally optimizes it for the Fujitsu MB86930 chip, which is the original SPARClite, with no FPU. With -mcpu=f934, the compiler additionally optimizes it for the Fujitsu MB86934 chip, which is the more recent SPARClite with FPU. โจ
With -mcpu=sparclet, GCC generates code for the SPARClet variant of the SPARC architecture. This adds the integer multiply, multiply/accumulate, integer divide step and scan ("ffs") instructions which exist in SPARClet but not in SPARC-V7. With -mcpu=tsc701, the compiler additionally optimizes it for the TEMIC SPARClet chip.
With -mcpu=v9, GCC generates code for the V9 variant of the SPARC architecture. This adds 64-bit integer and floating-point move instructions, 3 additional floating-point condition code registers and conditional move instructions. With -mcpu=ultrasparc, the compiler additionally optimizes it for the Sun UltraSPARC I/II/IIi chips. With -mcpu=ultrasparc3, the compiler additionally optimizes it for the Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips. With -mcpu=niagara, the compiler additionally optimizes it for Sun UltraSPARC T1 chips. With -mcpu=niagara2, the compiler additionally optimizes it for Sun UltraSPARC T2 chips. With -mcpu=niagara3, the compiler additionally optimizes it for Sun UltraSPARC T3 chips. With -mcpu=niagara4, the compiler additionally optimizes it for Sun UltraSPARC T4 chips. With -mcpu=niagara7, the compiler additionally optimizes it for Oracle SPARC M7 chips. With -mcpu=m8, the compiler additionally optimizes it for Oracle M8 chips. ๐
-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_typedoes. Two different jobs, bestie, don't mix them up. ๐ฆ
The same values for -mcpu=cpu_type can be used for -mtune=cpu_type, but the only useful values are those that select a particular CPU implementation. Those are cypress, supersparc, hypersparc, leon, leon3, leon3v7, leon5, f930, f934, sparclite86x, tsc701, ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7 and m8. With native Solaris and GNU/Linux toolchains, native can also be used. ๐
-mv8plus,-mno-v8plusโ with-mv8plus, GCC generates code for the SPARC-V8+ ABI. The difference from the V8 ABI is that the global and out registers are considered 64 bits wide. This is enabled by default on Solaris in 32-bit mode for all SPARC-V9 processors. ๐-mvis,-mno-visโ with-mvis, GCC generates code that takes advantage of the UltraSPARC Visual Instruction Set extensions. The default is-mno-vis. ๐-mvis2,-mno-vis2โ with-mvis2, GCC generates code that takes advantage of version 2.0 of the UltraSPARC Visual Instruction Set extensions. The default is-mvis2when targeting a cpu that supports such instructions, such as UltraSPARC-III and later. Setting-mvis2also sets-mvis. The stacking, the layering, we love to see it. ๐ซถ-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. It's giving combo deal. ๐ฅ-mvis4,-mno-vis4โ bestie,-mvis4means GCC writes code that eats up version 4.0 of the UltraSPARC Visual Instruction Set extensions ๐ . Default is-mvis4when you're targeting a cpu that supports this stuff, likeniagara-7and later โจ. And the way that-mvis4also turns on-mvis3,-mvis2and-mvis? Obsessed, it's giving package deal ๐-mvis4b,-mno-vis4bโ with-mvis4b, GCC flexes version 4.0 of the UltraSPARC VIS extensions plus the extra VIS instructions that showed up in the Oracle SPARC Architecture 2017 ๐. Default is-mvis4bfor cpus that support it, likem8and later. Setting-mvis4balso sets-mvis4,-mvis3,-mvis2and-mvisโ yes queen, all of them ๐-mcbcond,-mno-cbcondโ-mcbcondlets GCC use the UltraSPARC Compare-and-Branch-on-Condition instructions ๐ฅ. Default is-mcbcondon a CPU that supports them, like Niagara-4 and later.-mfmaf,-mno-fmafโ-mfmaf= GCC takes advantage of the UltraSPARC Fused Multiply-Add Floating-point instructions ๐. Default is-mfmafwhen the CPU supports them, like Niagara-3 and later.-mfsmuld,-mno-fsmuldโ-mfsmuldunlocks the Floating-point Multiply Single to Double (FsMULd) instruction ๐ฆ. Default is-mfsmuldwhen targeting a CPU with architecture versions V8 or V9 and an FPU โ except-mcpu=leon, which said no thanks ๐-mpopc,-mno-popcโ-mpopclets GCC use the UltraSPARC Population Count instruction โจ. Default is-mpopcon a CPU with that instruction, like Niagara-2 and later.-msubxc,-mno-subxcโ-msubxcenables the UltraSPARC Subtract-Extended-with-Carry instruction ๐. Default is-msubxcwhen the CPU supports it, like Niagara-7 and later.-mfix-at697fโ turns on the documented workaround for the single erratum of the Atmel AT697F processor (which is erratum #13 of the AT697E processor, iykyk) ๐-mfix-ut699โ turns on the documented workarounds for the floating-point errata and the data cache nullify errata of the UT699 processor.-mfix-ut700โ turns on the documented workaround for the back-to-back store errata of the UT699E/UT700 processor.-mfix-gr712rcโ turns on the documented workaround for the back-to-back store errata of the GR712RC processor.
And these -m options are supported in addition to the above on SPARC-V9 processors in 64-bit environments ๐
-m32,-m64โ generate code for a 32-bit or 64-bit environment. The 32-bit environment setsint,longand pointer to 32 bits. The 64-bit environment setsintto 32 bits andlongand pointer to 64 bits.-mcmodel=whichโ set the code model to one of these besties: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 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 extra 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.-Qyโ identify the versions of each tool used by the compiler, in a.identassembler directive in the output ๐-Qnโ refrain from adding.identdirectives to the output file (this is the default).-YP,dirsโ search the directories dirs, and no others, for libraries specified with-l.-Ym,dirโ look in the directory dir to find the M4 preprocessor. The assembler uses this option.
๐ฆ TILE-Gx Options ๐ฆ
These -m options are supported on the TILE-Gx:
-mcmodel=smallโ generate code for the small model. The distance for direct calls is limited to 500M in either direction. PC-relative addresses are 32 bits. Absolute addresses support the full address range.-mcmodel=largeโ generate code for the large model. There is no limitation on call distance, pc-relative addresses, or absolute addresses ๐-mcpu=nameโ selects the type of CPU to be targeted. Currently the only supported type istilegx.-m32,-m64โ generate code for a 32-bit or 64-bit environment. The 32-bit environment setsint,long, and pointer to 32 bits. The 64-bit environment setsintto 32 bits andlongand pointer to 64 bits.-mbig-endian,-mlittle-endianโ generate code in big/little endian mode, respectively ๐
๐ TILEPro Options ๐
These -m options are supported on the TILEPro:
-mcpu=nameโ selects the type of CPU to be targeted. Currently the only supported type istilepro.-m32โ generate code for a 32-bit environment, which setsint,long, and pointer to 32 bits. This is the only supported behavior so the flag is essentially ignored ๐ (she's just there for the vibes)
๐ V850 Options ๐
These -m options are defined for V850 implementations:
-mlong-calls,-mno-long-callsโ treat all calls as being far away (near). If calls are assumed to be far away, the compiler always loads the function's address into a register, and calls indirect through the pointer.-mno-ep,-mepโ do not optimize (do optimize) basic blocks that use the same index pointer 4 or more times to copy pointer into theepregister, and use the shortersldandsstinstructions. The-mepoption is on by default if you optimize โจ-mno-prolog-function,-mprolog-functionโ do not use (do use) external functions to save and restore registers at the prologue and epilogue of a function. The external functions are slower, but use less code space if more than one function saves the same number of registers. The-mprolog-functionoption is on by default if you optimize.-mspaceโ try to make the code as small as possible. At present, this just turns on the-mepand-mprolog-functionoptions.-mtda=nโ put static or global variables whose size is n bytes or less into the tiny data area that registereppoints to. The tiny data area can hold up to 256 bytes in total (128 bytes for byte references).-msda=nโ put static or global variables whose size is n bytes or less into the small data area that registergppoints 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.-mv850e3v5โ specify that the target processor is the V850E3V5. The preprocessor constant__v850e3v5__is defined if this option is used.-mv850e2v4โ specify that the target processor is the V850E3V5. This is an alias for the-mv850e3v5option.-mv850e2v3โ specify that the target processor is the V850E2V3. The preprocessor constant__v850e2v3__is defined if this option is used.-mv850e2โ specify that the target processor is the V850E2. The preprocessor constant__v850e2__is defined if this option is used.-mv850e1โ specify that the target processor is the V850E1. The preprocessor constants__v850e1__and__v850e__are defined if this option is used.-mv850esโ specify that the target processor is the V850ES. This is an alias for the-mv850e1option.-mv850eโ 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. Periodt ๐
-mdisable-callt,-mno-disable-calltโ this option suppresses generation of theCALLTinstruction for thev850e,v850e1,v850e2,v850e2v3andv850e3v5flavors 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.-mlong-jumps,-mno-long-jumpsโ disable (or re-enable) the generation of PC-relative jump instructions ๐ธ-msoft-float,-mhard-floatโ turn hardware floating-point instruction generation off (or back on ๐ซถ). Lowkey only matters when the target arch is V850E2V3 or higher, bestie. If hardware FP instructions are being generated, the C preprocessor symbol__FPU_OK__gets defined; otherwise__NO_FPU__is defined. That's the whole vibe check ๐-mloopโ enables use of the e3v5LOOPinstruction. It is not on by default when the e3v5 architecture is selected, because using it is still experimental ๐ (so like, it's giving "we're testing this, don't @ me").-mrh850-abi,-mghsโ enables support for the RH850 version of the V850 ABI. This one is the default. With this ABI version, 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 ABI version 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 ABI version, the rules are:- 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 ABI version is enabled, the C preprocessor symbol __V850_GCC_ABI__ is defined.
-m8byte-align,-mno-8byte-alignโ enables support fordoubleandlong longtypes to be aligned on 8-byte boundaries. The default is to restrict the alignment of all objects to at most 4 bytes. When-m8byte-alignis in effect, the C preprocessor symbol__V850_8BYTE_ALIGN__is defined โจ-mbig-switchโ 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โ this option causesr2andr5to be used in the code generated by the compiler. This setting is the default ๐-mno-app-regsโ this option causesr2andr5to be treated as fixed registers.
๐ VAX Options ๐
These -m options are defined for the VAX:
-munixโ do not output certain jump instructions (aobleqand so on) that the Unix assembler for the VAX cannot handle across long ranges.-mgnuโ do output those jump instructions, on the assumption that the GNU assembler is being used.-mgโ output code for G-format floating-point numbers instead of D-format.
๐ฆ Visium Options ๐ฆ
-mdebugโ a program which performs file I/O and is destined to run on an MCM target should be linked with this option. It causes the librarieslibc.aandlibdebug.ato be linked. The program should be run on the target under the control of the GDB remote debugging stub.-msimโ a program which performs file I/O and is destined to run on the simulator should be linked with option. This causes librarieslibc.aandlibsim.ato be linked.-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, so 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.mcmis a synonym ofgr5, present for backward compatibility.- By default (unless configured otherwise), GCC generates code for the GR5 variant of the Visium architecture.
- With
-mcpu=gr6, GCC generates code for the GR6 variant of the Visium architecture. The only difference from GR5 code is that the compiler will generate block move instructions.
-mtune=cpu_type โ set the *instruction scheduling parameters for machine type *cpu_type, but do not set the instruction set or register set that the option-mcpu=cpu_type would ๐-msv-modeโ generate code for the supervisor mode, where there are no restrictions on the access to general registers. This is the default.-muser-modeโ generate code for the user mode, where access to some general registers is forbidden: on the GR5, registersr24tor31cannot be accessed in this mode; on the GR6, only registersr29tor31are affected ๐
๐ VMS Options ๐
These -m options are defined for the VMS implementations:
-mvms-return-codesโ return VMS condition codes frommain. The default is to return POSIX-style condition (e.g. error) codes.-mdebug-main=prefix โ flag the *first routine whose name starts with *prefix as the main routine for the debugger.-mmalloc64โ default to 64-bit memory allocation routines.-mpointer-size=size โ set the *default size of pointers. Possible options for *size are32orshortfor 32 bit pointers,64orlongfor 64 bit pointers, andnofor supporting only 32 bit pointers. The later option disablespragma pointer_size๐ซถ
๐ VxWorks Options ๐
The options in this section are defined for all VxWorks targets. Options specific to the target hardware are listed with the other options for that target.
-mrtpโ GCC can generate code for both VxWorks kernels and real time processes (RTPs). This option switches from the former to the latter. It also defines the preprocessor macro__RTP__โจ-non-staticโ link an RTP executable against shared libraries rather than static libraries. The options-staticand-sharedcan also be used for RTPs;-staticis the default.-Bstatic,-Bdynamicโ these options are passed down to the linker. They are defined for compatibility with Diab.-Xbind-lazyโ enable lazy binding of function calls. This option is equivalent to-Wl,-z,nowand is defined for compatibility with Diab.-Xbind-nowโ disable lazy binding of function calls. This option is the default and is defined for compatibility with Diab.
๐ x86 Options ๐
These -m options are defined for the x86 family of computers.
-march=cpu-type โ generate instructions for the machine type cpu-type. In contrast to-mtune=cpu-type, which merely tunes the generated code for the specified cpu-type,-march=cpu-type allows GCC to generate code that *may not run at all on processors other than the one indicated ๐ Specifying-march=cpu-type* implies-mtune=cpu-type, except where noted otherwise.
The choices for cpu-type are:
nativeโ this selects the CPU to generate code for at compilation time by determining the processor type of the compiling machine. Using-march=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.x86-64-v2,x86-64-v3,x86-64-v4โ these choices for cpu-type select the corresponding micro-architecture level from the x86-64 psABI. On ABIs other than the x86-64 psABI they select the same CPU features as the x86-64 psABI documents for the particular micro-architecture level.
Since these cpu-type values do not have a corresponding -mtune setting, using -march with these values enables generic tuning. Specific tuning can be enabled using the -mtune=other-cpu-type option with an appropriate other-cpu-type value.
i386โ original Intel i386 CPU.i486โ Intel i486 CPU. (No scheduling is implemented for this chip.)i586,pentiumโ Intel Pentium CPU with no MMX support.lakemontโ Intel Lakemont MCU, based on Intel Pentium CPU.pentium-mmxโ Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.pentiumproโ Intel Pentium Pro CPU.i686โ when used with-march, the Pentium Pro instruction set is used, so the code runs on all i686 family chips. When used with-mtune, it has the same meaning asgeneric.pentium2โ Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set support.pentium3,pentium3mโ Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction set support.pentium-mโ Intel Pentium M; low-power version of Intel Pentium III CPU with MMX, SSE and SSE2 instruction set support. Used by Centrino notebooks ๐pentium4,pentium4mโ Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.prescottโ improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction set support.noconaโ improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE, SSE2 and SSE3 instruction set support.core2โ Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support.nehalemโ Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2 and POPCNT instruction set support.westmereโ Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
sandybridgeโ Intel Sandy Bridge CPU, 64-bit extensions plus MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support. ๐ivybridgeโ Intel Ivy Bridge CPU with 64-bit extensions, and it's serving MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction set support. โจhaswellโ Intel Haswell CPU, 64-bit extensions, walking in with MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2 and F16C instruction set support. ๐ฅbroadwellโ Intel Broadwell CPU, 64-bit extensions, and bestie it has MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED ADCX and PREFETCHW instruction set support. ๐skylakeโ Intel Skylake CPU with 64-bit extensions, bringing MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and XSAVES instruction set support. ๐ธbonnellโ Intel Bonnell CPU, 64-bit extensions, keeping it simple with MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3 instruction set support. ๐ฆsilvermontโ Intel Silvermont CPU with 64-bit extensions, and it's giving MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PREFETCHW, PCLMUL and RDRND instruction set support. ๐goldmontโ Intel Goldmont CPU, 64-bit extensions, and the lineup is MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT and FSGSBASE instruction set support. โจgoldmont-plusโ Intel Goldmont Plus CPU with 64-bit extensions, no cap it has MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX and UMIP instruction set support. ๐tremontโ Intel Tremont CPU, 64-bit extensions, and the way it carries MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, UMIP, GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, CLDEMOTE and WAITPKG instruction set support is iconic. ๐knlโ Intel Knight's Landing CPU with 64-bit extensions, serving MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, PREFETCHWT1, AVX512F, AVX512PF, AVX512ER and AVX512CD instruction set support. ๐knmโ Intel Knights Mill CPU, 64-bit extensions, and it's lowkey stacked with MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, PREFETCHWT1, AVX512F, AVX512PF, AVX512ER, AVX512CD, AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support. ๐skylake-avx512โ Intel Skylake Server CPU with 64-bit extensions, and it ate with MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support. ๐ฅcannonlakeโ Intel Cannonlake Server CPU, 64-bit extensions, and it has MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI, AVX512IFMA, SHA and UMIP instruction set support. ๐icelake-clientโ Intel Icelake Client CPU with 64-bit extensions, and bestie it's main character energy with MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI, AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ, AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support. ๐icelake-serverโ Intel Icelake Server CPU, 64-bit extensions, and it's serving MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI, AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ, AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction set support. โจcascadelakeโ Intel Cascadelake CPU with 64-bit extensions, and it's giving MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, CLWB, AVX512VL, AVX512BW, AVX512DQ, AVX512CD and AVX512VNNI instruction set support. ๐ฆcooperlakeโ Intel cooperlake CPU, 64-bit extensions, holding MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, CLWB, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VNNI and AVX512BF16 instruction set support. ๐tigerlakeโ Intel Tigerlake CPU with 64-bit extensions, and omg it's stacked: MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI, AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ, AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG, WBNOINVD, MOVDIRI, MOVDIR64B, AVX512VP2INTERSECT and KEYLOCKER instruction set support. ๐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 MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit instruction set extensions.) ๐bdver1โ CPUs based on AMD Family 15h cores with x86-64 instruction set support. (This supersets FMA4, AVX, XOP, LWP, AES, PCLMUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.) โจbdver2โ AMD Family 15h core based CPUs with x86-64 instruction set support. (This supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCLMUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.) ๐bdver3โ AMD Family 15h core based CPUs with x86-64 instruction set support. (This supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, PCLMUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.) ๐bdver4โ AMD Family 15h core based CPUs with x86-64 instruction set support. (This supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.) ๐znver1โ AMD Family 17h core based CPUs with x86-64 instruction set support. (This supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit instruction set extensions.) ๐ฅznver2โ AMD Family 17h core based CPUs with x86-64 instruction set support. (This supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, WBNOINVD, and 64-bit instruction set extensions.) ๐znver3โ AMD Family 19h core based CPUs with x86-64 instruction set support. (This supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, WBNOINVD, PKU, VPCLMULQDQ, VAES, and 64-bit instruction set extensions.) โจbtver1โ CPUs based on AMD Family 14h cores with x86-64 instruction set support. (This supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit instruction set extensions.) ๐ธbtver2โ CPUs based on AMD Family 16h cores with x86-64 instruction set support. This includes MOVBE, F16C, BMI, AVX, PCLMUL, AES, SSE4.2, SSE4.1, CX16, ABM, SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions. ๐ฆwinchip-c6โ IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction set support. ๐winchip2โ IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow! instruction set support. ๐c3โ VIA C3 CPU, rocking MMX and 3DNow! instruction set support. (No scheduling is implemented for this chip, bestie, so don't expect it to plan ahead ๐ )c3-2โ VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support. (Again: no scheduling implemented for this chip.)c7โ VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support. (And yes โ no scheduling implemented for this chip. the way VIA said "we'll handle the timing ourselves" ๐ญ)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.)geodeโ AMD Geode embedded processor with MMX and 3DNow! instruction set support. (this one has no "no scheduling" disclaimer, iconic behavior ๐)
-mtune=cpu-typeโ tunes everything applicable about the generated code to cpu-type, except the ABI and the set of available instructions. So likeโฆ it picks the vibe of the scheduling for that chip, but the compiler does not generate any code that can't run on the default machine type โ unless you also pass a-march=cpu-typeoption. Fr fr, here's the tea: if GCC is configured fori686-pc-linux-gnu, then-mtune=pentium4generates code tuned for Pentium 4 that still runs on i686 machines. โจ
The choices for cpu-type are the same as for -march. Plus, -mtune supports 2 extra choices for cpu-type:
genericโ produce code optimized for the most common IA32/AMD64/EM64T processors. If you know the CPU your code will run on, you should use the corresponding-mtuneor-marchoption instead of-mtune=generic. But if you have no idea what CPU your users will have? Yeah, use this one, bestie.
As new processors get deployed in the marketplace, the behavior of this option will change. So if you upgrade to a newer version of GCC, code generation controlled by this option will change to reflect whatever processors were most common at the time that version of GCC was released. (it's giving "moving target", and that's on purpose ๐)
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. Meanwhile -mtune indicates the processor (or, in this case, a whole collection of processors) for which the code is optimized. got it? ๐
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 your code will run on, use the corresponding-mtuneor-marchoption instead of-mtune=intel. But if you want your application to perform better on both Haswell and Silvermont, then use this option.
As new Intel processors are deployed in the marketplace, the behavior of this option will change. Upgrade GCC and code generation controlled by this option shifts to reflect the most current Intel processors at the time that version of GCC was released. ๐ฆ
There is no -march=intel option, because -march indicates the instruction set the compiler can use, and there is no common instruction set applicable to all processors. -mtune, on the other hand, indicates the processor (or collection of processors) for which the code is optimized.
-mcpu=cpu-typeโ a deprecated synonym for-mtune. ๐ญ (use-mtune, she's the main character now)-mfpmath=unitโ generate floating-point arithmetic for the selected unit. The choices for unit are:387โ use the standard 387 floating-point coprocessor present on the majority of chips and emulated otherwise. Code compiled with this option runs almost everywhere. The temporary results are computed in 80-bit precision instead of the precision specified by the type, which gives you slightly different results compared to most other chips. See-ffloat-storefor a more detailed description.
This is the default choice for non-Darwin x86-32 targets.
sseโ use scalar floating-point instructions present in the SSE instruction set. This instruction set is supported by Pentium III and newer chips, and in the AMD line by Athlon-4, Athlon XP and Athlon MP chips. The earlier version of the SSE instruction set supports only single-precision arithmetic, so double and extended-precision arithmetic are still done using387. A later version, present only in Pentium 4 and AMD x86-64 chips, supports double-precision arithmetic too. โจ
For the x86-32 compiler, you must use -march=cpu-type, -msse or -msse2 switches to enable SSE extensions and make this option effective. For the x86-64 compiler, these extensions are enabled by default.
The resulting code should be considerably faster in the majority of cases and avoids the numerical instability problems of 387 code โ but it may break some existing code that expects temporaries to be 80 bits. โ ๏ธ
This is the default choice for the x86-64 compiler, Darwin x86-32 targets, and the default choice for x86-32 targets with the SSE2 instruction set when -ffast-math is enabled.
sse,387sse+387bothโ attempt to utilize both instruction sets at once. This effectively doubles the amount of available registers, and on chips with separate execution units for387and SSE it doubles the execution resources too. Use this option with care, because it's still experimental โ the GCC register allocator does not model separate functional units well, which results in unstable performance. ๐
-masm=dialectโ output assembly instructions using the selected dialect. Also affects which dialect is used for basic"asm"and extended"asm". Supported choices (in dialect order) areattorintel. The default isatt. Darwin does not supportintel. ๐-mieee-fp-mno-ieee-fpโ control whether or not the compiler uses IEEE floating-point comparisons. These correctly handle the case where the result of a comparison is unordered.-m80387-mhard-floatโ generate output containing 80387 instructions for floating point.-mno-80387-msoft-floatโ generate output containing library calls for floating point.
Warning: the requisite libraries are not part of GCC. Normally the facilities of the machine's usual C compiler are used, but this cannot be done directly in cross-compilation. You must make your own arrangements to provide suitable library functions for cross-compilation. ๐ซถ
On machines where a function returns floating-point results in the 80387 register stack, some floating-point opcodes may be emitted even if -msoft-float is used.
-mno-fp-ret-in-387โ do not use the FPU registers for return values of functions.
The usual calling convention has functions return values of types "float" and "double" in an FPU register, even if there is no FPU. The idea is that the operating system should emulate an FPU.
The option -mno-fp-ret-in-387 causes such values to be returned in ordinary CPU registers instead. ๐
-mno-fancy-math-387โ some 387 emulators do not support the"sin","cos"and"sqrt"instructions for the 387. Specify this option to avoid generating those instructions. This option is overridden when-marchindicates that the target CPU always has an FPU and so the instruction does not need emulation. These instructions are not generated unless you also use the-funsafe-math-optimizationsswitch. iykyk ๐ธ-malign-double-mno-align-doubleโ control whether GCC aligns"double","long double"and"long long"variables on a two-word boundary or a one-word boundary. Aligning"double"variables on a two-word boundary produces code that runs somewhat faster on a Pentium, at the expense of more memory.
On x86-64, -malign-double is enabled by default.
Warning: if you use the -malign-double switch, structures containing the above types are aligned differently than the published application binary interface specifications for the x86-32, and are not binary compatible with structures in code compiled without that switch. ๐
-m96bit-long-double-m128bit-long-doubleโ these switches control the size of the"long double"type. The x86-32 application binary interface specifies the size to be 96 bits, so-m96bit-long-doubleis the default in 32-bit mode.
Modern architectures (Pentium and newer) are obsessed with long double sitting pretty on an 8- or 16-byte boundary. But in arrays or structures that conform to the ABI, that literally can't happen. So if you specify -m128bit-long-double, it aligns long double to a 16-byte boundary by padding the long double with an extra 32-bit zero. ๐
In the x86-64 compiler, -m128bit-long-double is the default choice, because its ABI says long double gets aligned on a 16-byte boundary.
Real talk though: neither of these options gives you any extra precision over the x87 standard of 80 bits for a long double. It's giving alignment, not accuracy. ๐
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. So they are not binary-compatible with code compiled without that switch. No cap.
-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 โ and that's the default for 32-bit Bionic C library. A size of 128 bits makes thelong doubletype equivalent to the__float128type โ and that's the default for 64-bit Bionic C library.
Warning: if you override the default value for your target ABI, this changes the size of structures and arrays containinglong doublevariables, as well as modifying the function calling convention for functions takinglong double. Hence they are not binary-compatible with code compiled without that switch. ๐ซถ
-malign-data=typeโ controls 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=mediumis specified, data objects larger than threshold get placed in the large data section. This value must be the same across all objects linked into the binary, and it defaults to65535.-mrtdโ use a different function-calling convention, where 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 using the function attribute stdcall. You can also override the -mrtd option by using the function attribute cdecl.
Warning: this calling convention is incompatible with the one normally used on Unix, so you cannot use it if you need to call libraries compiled with the Unix compiler. ๐ญ
Also, you must provide function prototypes for all functions that take variable numbers of arguments (including printf); otherwise incorrect code is generated for calls to those functions.
In addition, seriously incorrect code results if you call a function with too many arguments. (Normally, extra arguments are harmlessly ignored. Not here bestie. ๐)
-mregparm=numโ controls how many registers are used to pass integer arguments. By default, no registers are used to pass arguments, and at most 3 registers can be used. You can control this behavior for a specific function by using the function attributeregparm.
Warning: if you use this switch, and num is nonzero, then you must build all modules with the same value, including any libraries. This includes the system libraries and startup modules. All of them. Periodt.
-msseregparmโ use SSE register passing conventions for float and double arguments and return values. You can control this behavior for a specific function by using the function attributesseregparm.
Warning: if you use this switch then you must build all modules with the same value, including any libraries. This includes the system libraries and startup modules. ๐
-mvect8-ret-in-memโ return 8-byte vectors in memory instead of MMX registers. This is the default on VxWorks to match the ABI of the Sun Studio compilers until version 12. Only use this option if you need to remain compatible with existing code produced by those previous compiler versions or older versions of GCC. ๐ฆ-mpc32-mpc64-mpc80โ set 80387 floating-point precision to 32, 64 or 80 bits. When-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. ๐
-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. ๐-mpreferred-stack-boundary=numโ attempt to keep the stack boundary aligned to a 2 raised to num byte boundary. If-mpreferred-stack-boundaryis not specified, the default is4(16 bytes or 128 bits).
Warning: when generating code for the x86-64 architecture with SSE extensions disabled,-mpreferred-stack-boundary=3can be used to keep the stack boundary aligned to 8 byte boundary. Since x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and intended to be used in controlled environment where stack space is important limitation. This option leads to wrong code when functions compiled with 16 byte stack alignment (such as functions from a standard library) are called with misaligned stack. In this case, SSE instructions may lead to misaligned memory access traps. In addition, variable arguments are handled incorrectly for 16 byte aligned objects (including x87 long double and__int128), leading to wrong results. You must build all modules with-mpreferred-stack-boundary=3, including any libraries. This includes the system libraries and startup modules. ๐ญ
-mincoming-stack-boundary=numโ assume the incoming stack is aligned to a 2 raised to num byte boundary. If-mincoming-stack-boundaryis not specified, the one specified by-mpreferred-stack-boundaryis used.
On Pentium and Pentium Pro, double and long double values should be aligned to an 8-byte boundary (see -malign-double) or suffer significant run time performance penalties. On Pentium III, the Streaming SIMD Extension (SSE) data type __m128 may not work properly if it is not 16-byte aligned.
To ensure proper alignment of this values on the stack, the stack boundary must be as aligned as that required by any value stored on the stack. Further, every function must be generated such that it keeps the stack aligned. Thus calling a function compiled with a higher preferred stack boundary from a function compiled with a lower preferred stack boundary most likely misaligns the stack. It is recommended that libraries that use callbacks always use the default setting. ๐
This extra alignment does consume extra stack space, and generally increases code size. Code that is sensitive to stack space usage, such as embedded systems and operating system kernels, may want to reduce the preferred alignment to -mpreferred-stack-boundary=2.
โจ The Big Instruction-Set Menu โจ
-mmmx-msse-msse2-msse3-mssse3-msse4-msse4a-msse4.1-msse4.2-mavx-mavx2-mavx512f-mavx512pf-mavx512er-mavx512cd-mavx512vl-mavx512bw-mavx512dq-mavx512ifma-mavx512vbmi-msha-maes-mpclmul-mclflushopt-mclwb-mfsgsbase-mptwrite-mrdrnd-mf16c-mfma-mpconfig-mwbnoinvd-mfma4-mprfchw-mrdpid-mprefetchwt1-mrdseed-msgx-mxop-mlwp-m3dnow-m3dnowa-mpopcnt-mabm-madx-mbmi-mbmi2-mlzcnt-mfxsr-mxsave-mxsaveopt-mxsavec-mxsaves-mrtm-mhle-mtbm-mmwaitx-mclzero-mpku-mavx512vbmi2-mavx512bf16-mgfni-mvaes-mwaitpkg-mvpclmulqdq-mavx512bitalg-mmovdiri-mmovdir64b-menqcmd-mavx512vpopcntdq-mavx512vp2intersect-mavx5124fmaps-mavx512vnni-mavx5124vnniw-mcldemote
These switches enable the use of instructions in the MMX, SSE, SSE2, SSE3, SSSE3, SSE4, SSE4A, SSE4.1, SSE4.2, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD, AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, SHA, AES, PCLMUL, CLFLUSHOPT, CLWB, FSGSBASE, PTWRITE, RDRND, F16C, FMA, PCONFIG, WBNOINVD, FMA4, PREFETCHW, RDPID, PREFETCHWT1, RDSEED, SGX, XOP, LWP, 3DNow!, enhanced 3DNow!, POPCNT, ABM, ADX, BMI, BMI2, LZCNT, FXSR, XSAVE, XSAVEOPT, XSAVEC, XSAVES, RTM, HLE, TBM, MWAITX, CLZERO, PKU, AVX512VBMI2, GFNI, VAES, WAITPKG, VPCLMULQDQ, AVX512BITALG, MOVDIRI, MOVDIR64B, AVX512BF16, ENQCMD, AVX512VPOPCNTDQ, AVX5124FMAPS, AVX512VNNI, AVX5124VNNIW, or CLDEMOTE extended instruction sets. Each one 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. ๐
Okay so if you want SSE/SSE2 instructions to just materialize out of your floating-point code automatically (instead of the dusty old 387 instructions), go peek at -mfpmath=sse. ๐
GCC depresses SSEx instructions the second you use -mavx. It doesn't just leave them lying around โ it generates brand new AVX instructions, or an AVX equivalent, for every SSEx instruction that's needed. Glow up. โจ
These options let GCC flex these extended instructions in generated code, even without -mfpmath=sse. But bestie, listen: apps that do run-time CPU detection have to compile separate files for each supported architecture, using the appropriate flags. And specifically โ the file holding the CPU detection code should be compiled without these options. No cap. ๐ซถ
-mdump-tune-featuresโ tells GCC to dump out the names of the x86 performance tuning features plus their default settings. Those names? They're exactly what you feed into-mtune-ctrl=feature-list. ๐-mtune-ctrl=feature-listโ for fine-grain control of x86 code generation features. feature-list is a comma-separated list of feature names. See also-mdump-tune-features. When you specify one, the feature gets turned on โ unless it's preceded with^, in which case it's turned off. Heads up though:-mtune-ctrl=feature-listis meant for GCC developers. Using it may lead to code paths that aren't covered by testing and can potentially result in compiler ICEs or runtime errors. ๐-mno-defaultโ instructs GCC to turn off all tunable features. See also-mtune-ctrl=feature-listand-mdump-tune-features.-mcldโ makes GCC emit a"cld"instruction in the prologue of functions that use string instructions. String instructions depend on the DF flag to choose between autoincrement or autodecrement mode. While the ABI says the DF flag should be cleared on function entry, some operating systems violate this spec by not clearing the DF flag in their exception dispatchers. So the exception handler can get 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. In that case you can suppress generation of"cld"instructions with the-mno-cldcompiler option.-mvzeroupperโ makes GCC emit a"vzeroupper"instruction before a transfer of control flow out of the function, to minimize the AVX to SSE transition penalty and also to remove unnecessary"zeroupper"intrinsics. ๐ง-mprefer-avx128โ tells GCC to use 128-bit AVX instructions instead of 256-bit AVX instructions in the auto-vectorizer.-mprefer-vector-width=optโ tells GCC to use opt-bit vector width in instructions instead of the default on the selected platform.noneโ no extra limitations applied to GCC other than what the selected platform already defines.128โ prefer 128-bit vector width for instructions.256โ prefer 256-bit vector width for instructions.512โ prefer 512-bit vector width for instructions.
-mcx16โ lets GCC generate"CMPXCHG16B"instructions in 64-bit code to implement compare-and-exchange operations on 16-byte aligned 128-bit objects. So useful for atomic updates of data structures bigger than one machine word. The compiler uses this instruction to implement__syncBuiltins. However โ for__atomicBuiltins operating on 128-bit integers, a library call is always used. Periodt.-msahfโ enables generation of"SAHF"instructions in 64-bit code. Early Intel Pentium 4 CPUs with Intel 64 support, before the Pentium 4 G1 step showed up in December 2005, lacked the"LAHF"and"SAHF"instructions that AMD64 supports. Those are load and store instructions, respectively, for certain status flags. In 64-bit mode, the"SAHF"instruction is used to optimize"fmod","drem", and"remainder"built-in functions; see Other Builtins for details. ๐ฆ-mmovbeโ enables use of the"movbe"instruction to implement__builtin_bswap32and__builtin_bswap64.-mshstkโ the-mshstkoption enables shadow stack built-in functions from x86 Control-flow Enforcement Technology (CET). ๐ฅ-mcrc32โ enables built-in functions__builtin_ia32_crc32qi,__builtin_ia32_crc32hi,__builtin_ia32_crc32siand__builtin_ia32_crc32dito generate the"crc32"machine instruction.-mrecipโ enables use of"RCPSS"and"RSQRTSS"instructions (and their vectorized variants"RCPPS"and"RSQRTPS") with an extra Newton-Raphson step to bump up precision, instead of"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 (i.e. the inverse of 1.0 equals 0.99999994).
Also note that GCC implements 1.0f/sqrtf(x) in terms of "RSQRTSS" (or "RSQRTPS") already with -ffast-math (or the above option combination), and doesn't need -mrecip.
And also note that GCC emits the above sequence with an additional Newton-Raphson step for vectorized single-float division and vectorized sqrtf(x) already with -ffast-math (or the above option combination), and doesn't need -mrecip. ๐
-mrecip=optโ controls which reciprocal estimate instructions may be used. 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.
So, for example, -mrecip=all,!sqrt enables all of the reciprocal approximations, except for square root. ๐
-mveclibabi=typeโ specifies the ABI type to use for vectorizing intrinsics using an external library. Supported values for type aresvmlfor the Intel short vector math library andacmlfor the AMD math core library. To use this option, both-ftree-vectorizeand-funsafe-math-optimizationshave to be enabled, and an SVML or ACML ABI-compatible library must be specified at link time.
GCC currently emits calls to "vmldExp2", "vmldLn2", "vmldLog102", "vmldPow2", "vmldTanh2", "vmldTan2", "vmldAtan2", "vmldAtanh2", "vmldCbrt2", "vmldSinh2", "vmldSin2", "vmldAsinh2", "vmldAsin2", "vmldCosh2", "vmldCos2", "vmldAcosh2", "vmldAcos2", "vmlsExp4", "vmlsLn4", "vmlsLog104", "vmlsPow4", "vmlsTanh4", "vmlsTan4", "vmlsAtan4", "vmlsAtanh4", "vmlsCbrt4", "vmlsSinh4", "vmlsSin4", "vmlsAsinh4", "vmlsAsin4", "vmlsCosh4", "vmlsCos4", "vmlsAcosh4" and "vmlsAcos4" for the corresponding function type when -mveclibabi=svml is used, and "__vrd2_sin", "__vrd2_cos", "__vrd2_exp", "__vrd2_log", "__vrd2_log2", "__vrd2_log10", "__vrs4_sinf", "__vrs4_cosf", "__vrs4_expf", "__vrs4_logf", "__vrs4_log2f", "__vrs4_log10f" and "__vrs4_powf" for the corresponding function type when -mveclibabi=acml is used.
-mabi=nameโ generate code for the specified calling convention. Permissible values aresysvfor the ABI used on GNU/Linux and other systems, andmsfor the Microsoft ABI. The default is to use the Microsoft ABI when targeting Microsoft Windows and the SysV ABI on all other systems. You can control this behavior for specific functions by using the function attributes"ms_abi"and"sysv_abi". ๐-mforce-indirect-callโ force all calls to functions to be indirect. This is useful when using Intel Processor Trace, where it generates more precise timing information for function calls.-mmanual-endbrโ insert ENDBR instruction at function entry only via the"cf_check"function attribute. This is useful when used with the option-fcf-protection=branchto control ENDBR insertion at the function entry.-mcall-ms2sysv-xloguesโ because of differences in 64-bit ABIs, any Microsoft ABI function that calls a System V ABI function must consider RSI, RDI and XMM6-15 as clobbered. By default, the code for saving and restoring these registers is emitted inline, which gives you fairly lengthy prologues and epilogues. Using-mcall-ms2sysv-xloguesemits prologues and epilogues that use stubs in the static portion oflibgccto do these saves and restores, so function size goes down at the cost of a few extra instructions. ๐ซถ-mtls-dialect=typeโ generate code to access thread-local storage using thegnuorgnu2conventions.gnuis the conservative default;gnu2is more efficient, but it may add compile- and run-time requirements that cannot be satisfied on all systems. ๐-mpush-args,-mno-push-argsโ use PUSH operations to store outgoing parameters. This method is shorter and usually equally fast as the method using SUB/MOV operations, and it's enabled by default. In some cases disabling it may improve performance because of improved scheduling and reduced dependencies.-maccumulate-outgoing-argsโ if enabled, the maximum amount of space required for outgoing arguments is computed in the function prologue. This is faster on most modern CPUs 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. This switch implies-mno-push-args. ๐-mthreadsโ support thread-safe exception handling on MinGW. Programs that rely on thread-safe exception handling must compile and link all code with the-mthreadsoption. When compiling,-mthreadsdefines-D_MT; when linking, it links in a special thread helper library-lmingwthrdwhich cleans up per-thread exception-handling data. โจ-mms-bitfields,-mno-ms-bitfieldsโ enable/disable bit-field layout compatible with the native Microsoft Windows compiler. ๐
okay so bestie, we're deep in x86 territory now and it's getting spicy ๐ฅ so buckle up because there's structure layout lore and like twenty more -m flags, and yes, every single one of them matters ๐
If packed gets used on a struct, or if bit-fields are in play, the Microsoft ABI might lay that structure out completely differently than the way GCC normally does it. And specifically when you're moving packed data between functions compiled with GCC and functions compiled with the native Microsoft compiler โ whether that's through a function call or as data sitting in a file โ you may legitimately need to access either format. iykyk ๐ซถ
This option is on by default for Microsoft Windows targets. You can also control this behavior locally with variable attributes or type attributes. For more info, go peek at x86 Variable Attributes and x86 Type Attributes. โจ
The Microsoft structure layout algorithm is pretty simple, except for the bit-field packing, which is where things get feral. The padding and alignment of structure members, and whether a bit-field can straddle a storage-unit boundary, are determined by these rules:
- Structure members are stored sequentially in the order they were declared: the first member has the lowest memory address, and the last member has the highest. ๐
- Every data object has an alignment requirement. For everything except structures, unions, and arrays, that alignment requirement is either the size of the object or the current packing size (whichever one you set with the
alignedattribute or thepackpragma) โ whichever is less. For structures, unions, and arrays, the alignment requirement is the largest alignment requirement among its members. And every object gets allocated an offset so that:
offset % alignment_requirement == 0
- Adjacent bit-fields get packed into the same 1-, 2-, or 4-byte allocation unit, but only if the integral types are the same size <em>and</em> the next bit-field actually 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 gets inserted between two bit-fields that would normally be coalesced, then 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 you removed that zero-length bit-field, t1's size would be 4 bytes. yeah. ๐
- If a zero-length bit-field gets inserted after a bit-field
foo, and the alignment of the zero-length bit-field is greater than that of the member that follows it,bar, thenbaris aligned as the type of the zero-length bit-field. ๐
For example:
struct
{
char foo : 4;
short : 0;
char bar;
} t2;
struct
{
char foo : 4;
short : 0;
double bar;
} t3;
For t2, bar is placed at offset 2, rather than offset 1. Accordingly, the size of t2 is 4. For t3, the zero-length bit-field does not affect the alignment of bar, and therefore doesn't affect the size of the structure either.
Taking this into account, it's important to note the following:
- If a zero-length bit-field follows a normal bit-field, the type of the zero-length bit-field may affect the alignment of the structure as a whole. For example,
t2has a size of 4 bytes, since the zero-length bit-field follows a normal bit-field and is of typeshort. - Even if a zero-length bit-field is not followed by a normal bit-field, it may still affect the alignment of the structure:
struct
{
char foo : 6;
long : 0;
} t4;
Here, t4 takes up 4 bytes. ๐ฆ
- Zero-length bit-fields following non-bit-field members are ignored:
struct
{
char foo;
long : 0;
char bar;
} t5;
Here, t5 takes up 2 bytes. slay ๐ธ
-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 justโฆ doesn't know that yet. ๐-minline-all-stringopsโ by default GCC only inlines string operations when the destination is known to be aligned to at least a 4-byte boundary. This flag enables more inlining and grows your code size, but it may improve performance for code that relies on fastmemcpyandmemsetfor short lengths. It also enables inline expansion ofstrlenfor all pointer alignments. ๐-minline-stringops-dynamicallyโ for string operations of unknown size, use run-time checks: inline code for small blocks, and a library call for large blocks. best of both worlds fr fr โจ-mstringop-strategy=algโ override the internal decision heuristic for which algorithm to use when inlining string operations. The allowed values for alg are:rep_byterep_4byterep_8byteโ expand using the i386repprefix 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 that decides whether__builtin_memcpyshould 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, and max_size specifies the max byte size for which inline algorithm alg is allowed. For the last triplet, max_size must be-1. The max_size values of the triplets in the list must be specified in increasing order. The minimal byte size for alg is 0 for the first triplet, andmax_size + 1of the preceding range for everything after. ๐-mmemset-strategy=strategyโ same energy as-mmemcpy-strategy=except this one controls__builtin_memsetexpansion. ๐ซถ-momit-leaf-frame-pointerโ don't keep the frame pointer in a register for leaf functions. This avoids the instructions to save, set up, and restore frame pointers, and frees up an extra register in leaf functions. Heads up: the-fomit-leaf-frame-pointeroption removes 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 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 a VEX prefix. The-mavxoption turns this on by default. ๐-mfentry/-mno-fentryโ if profiling is active (-pg), put the profiling counter call before the prologue. Note: on x86 architectures the attributems_hook_prologueisn't possible at the moment for-mfentryand-pg. ๐-mrecord-mcount/-mno-record-mcountโ if profiling is active (-pg), generate a__mcount_locsection containing pointers to each profiling call. This is useful for automatically patching and out calls. ๐ฏ-mnop-mcount/-mno-nop-mcountโ if profiling is active (-pg), generate the calls to the profiling functions as NOPs. Useful when they should be patched in later, dynamically. This is likely only useful together with-mrecord-mcount. ๐ง-minstrument-return=typeโ instrument function exit in-pg-mfentryinstrumented functions with a call to the specified function. This only instruments true returns ending withret, but not sibling calls ending withjump. Valid *type*s arenoneto not instrument,callto generate a call to__return__, ornop5to generate a 5 byte nop. ๐-mrecord-return/-mno-record-returnโ generate a__return_locsection pointing to all return instrumentation code. ๐-mfentry-name=nameโ set the name of the__fentry__symbol that gets called at function entry for-pg-mfentryfunctions. โญ-mfentry-section=nameโ set the name of the section used to record-mrecord-mcountcalls (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. ๐ฆ
Warning: since the RAX register is used to avoid unnecessarily saving vector registers on the stack when passing variable arguments, the impacts of this option are that callees may waste some stack space, misbehave, or jump to a random location. ๐ฑ GCC 4.4 or newer doesn't have those issues, regardless of the RAX register value.
-m8bit-idiv/-mno-8bit-idivโ on some processors, like Intel Atom, 8-bit unsigned integer divide is much faster than 32-bit/64-bit integer divide. This option generates a run-time check. If both the dividend and the divisor are within the range 0 to 255, an 8-bit unsigned integer divide is used instead of a 32-bit/64-bit integer divide. ๐ฅ-mavx256-split-unaligned-load/-mavx256-split-unaligned-storeโ split 32-byte AVX unaligned load and store. โจ-mstack-protector-guard=guard,-mstack-protector-guard-reg=reg,-mstack-protector-guard-offset=offsetโ generate stack protection code using a canary at guard. Supported locations areglobalfor a global canary, ortlsfor a per-thread canary in the TLS block (that one's the default). This option only has an effect when-fstack-protectoror-fstack-protector-allis specified. ๐
With the latter choice the options -mstack-protector-guard-reg=reg and -mstack-protector-guard-offset=offset furthermore specify which segment register (%fs or %gs) to use as base register for reading the canary, and from what offset from that base register. The default for those is as specified in the relevant ABI. ๐
-mgeneral-regs-onlyโ generates code that uses only the general-purpose registers, bestie. It stops the compiler from using floating-point, vector, mask and bound registers. No cap. ๐-mindirect-branch=choiceโ converts indirect call and jump with choice. The default iskeep, which keeps indirect call and jump unmodified.thunkconverts indirect call and jump to call and return thunk.thunk-inlineconverts indirect call and jump to inlined call and return thunk.thunk-externconverts indirect call and jump to external call and return thunk provided in a separate object file. You can control this behavior for a specific function by using the function attributeindirect_branch.
Note that-mcmodel=largeis incompatible with-mindirect-branch=thunkand-mindirect-branch=thunk-externsince the thunk function may not be reachable in the large code model. ๐ญ
Note that-mindirect-branch=thunk-externis compatible with-fcf-protection=branchsince the external thunk can be made to enable control-flow check. โจ
-mfunction-return=choiceโ converts function return with choice. The default iskeep, which keeps function return unmodified.thunkconverts function return to call and return thunk.thunk-inlineconverts function return to inlined call and return thunk.thunk-externconverts function return to external call and return thunk provided in a separate object file. You can control this behavior for a specific function by using the function attributefunction_return.
Note that-mindirect-return=thunk-externis compatible with-fcf-protection=branchsince the external thunk can be made to enable control-flow check.
Note that-mcmodel=largeis incompatible with-mfunction-return=thunkand-mfunction-return=thunk-externsince the thunk function may not be reachable in the large code model. ๐
-mindirect-branch-registerโ force indirect call and jump via register. Periodt. ๐-mharden-sls=choiceโ generates code to mitigate against straight line speculation (SLS) with choice. The default isnonewhich disables all SLS hardening.returnenables SLS hardening for function returns.indirect-jmpenables SLS hardening for indirect jumps.allenables all SLS hardening. ๐ฆ-mindirect-branch-cs-prefixโ adds CS prefix to call and jmp to indirect thunk with branch target in r8-r15 registers so that the call and jmp instruction length is 6 bytes to allow them to be replaced withlfence; call *%r8-r15orlfence; jmp *%r8-r15at run-time. โญ
These -m switches are supported in addition to the above on x86-64 processors in 64-bit environments.
-m32-m64-mx32-m16-miamcuโ generate code for a 16-bit, 32-bit or 64-bit environment. The-m32option setsint,long, and pointer types to 32 bits, and generates code that runs in 32-bit mode.
The -m64 option sets int to 32 bits and long and pointer types to 64 bits, and generates code for the x86-64 architecture. For Darwin only the -m64 option also turns off the -fno-pic and -mdynamic-no-pic options. ๐
The -mx32 option sets int, long, and pointer types to 32 bits, and generates code for the x86-64 architecture.
The -m16 option is the same as -m32, except for that it outputs the .code16gcc assembly directive at the beginning of the assembly output so that the binary can run in 16-bit mode.
The -miamcu option generates code which conforms to Intel MCU psABI. It requires the -m32 option to be turned on. ๐
-mno-red-zoneโ do not use a so-called "red zone" for x86-64 code. The red zone is mandated by the x86-64 ABI; it is a 128-byte area beyond the location of the stack pointer that is not modified by signal or interrupt handlers and therefore can be used for temporary data without adjusting the stack pointer. The flag-mno-red-zonedisables this red zone. ๐-mcmodel=smallโ generate code for the small code model: the program and its symbols must be linked in the lower 2 GB of the address space. Pointers are 64 bits. Programs can be statically or dynamically linked. This is the default code model. ๐-mcmodel=kernelโ generate code for the kernel code model. The kernel runs in the negative 2 GB of the address space. This model has to be used for Linux kernel code. ๐ง-mcmodel=mediumโ generate code for the medium model: the program is linked in the lower 2 GB of the address space. Small symbols are also placed there. Symbols with sizes larger than-mlarge-data-thresholdare put into large data or BSS sections and can be located above 2GB. Programs can be statically or dynamically linked.-mcmodel=largeโ generate code for the large model. This model makes no assumptions about addresses and sizes of sections.-maddress-mode=longโ generate code for long address mode. This is only supported for 64-bit and x32 environments. It is the default address mode for 64-bit environments.-maddress-mode=shortโ generate code for short address mode. This is only supported for 32-bit and x32 environments. It is the default address mode for 32-bit and x32 environments. โจ
๐ธ x86 Windows Options ๐ธ
These additional options are available for Microsoft Windows targets:
-mconsoleโ this option specifies that a console application is to be generated, by instructing the linker to set the PE header subsystem type required for console applications. This option is available for Cygwin and MinGW targets and is enabled by default on those targets. ๐ป-mdllโ this option is available for Cygwin and MinGW targets. It specifies that a DLLโa dynamic link libraryโis to be generated, enabling the selection of the required runtime startup object and entry point. ๐ฆ-mnop-fun-dllimportโ this option is available for Cygwin and MinGW targets. It specifies that thedllimportattribute should be ignored.-mthreadโ this option is available for MinGW targets. It specifies that MinGW-specific thread support is to be used. ๐งต-municodeโ this option is available for MinGW-w64 targets. It causes theUNICODEpreprocessor macro to be predefined, and chooses Unicode-capable runtime startup code.-mwin32โ this option is available for Cygwin and MinGW targets. It specifies that the typical Microsoft Windows predefined macros are to be set in the pre-processor, but does not influence the choice of runtime library/startup code.-mwindowsโ this option is available for Cygwin and MinGW targets. It specifies that a GUI application is to be generated by instructing the linker to set the PE header subsystem type appropriately. ๐ช-fno-set-stack-executableโ this option is available for MinGW targets. It specifies that the executable flag for the stack used by nested functions isn't set. This is necessary for binaries running in kernel mode of Microsoft Windows, as there the User32 API, which is used to set executable privileges, isn't available.-fwritable-relocated-rdataโ this option is available for MinGW and Cygwin targets. It specifies that relocated-data in read-only section is put into the.datasection. This is a necessary for older runtimes not supporting modification of.rdatasections for pseudo-relocation.-mpe-aligned-commonsโ this option is available for Cygwin and MinGW targets. It specifies that the GNU extension to the PE file format that permits the correct alignment of COMMON variables should be used when generating code. It is enabled by default if GCC detects that the target assembler found during configuration supports the feature. ๐
See also under x86 Options for standard options. ๐
๐ธ Xstormy16 Options ๐ธ
These options are defined for Xstormy16:
-msimโ choose startup files and linker script suitable for the simulator. ๐ฎ
๐ธ Xtensa Options ๐ธ
These options are supported for Xtensa targets:
-mconst16-mno-const16โ enable or disable use ofCONST16instructions for loading constant values. TheCONST16instruction is currently not a standard option from Tensilica. When enabled,CONST16instructions are always used in place of the standardL32Rinstructions. The use ofCONST16is enabled by default only if theL32Rinstruction is not available. ๐ซ-mfused-madd-mno-fused-maddโ enable or disable use of fused multiply/add and multiply/subtract instructions in the floating-point option. This has no effect if the floating-point option is not also enabled. Disabling fused multiply/add and multiply/subtract instructions forces the compiler to use separate instructions for the multiply and add/subtract operations. This may be desirable in some cases where strict IEEE 754-compliant results are required: the fused multiply add/subtract instructions do not round the intermediate result, thereby producing results with more bits of precision than specified by the IEEE standard. Disabling fused multiply add/subtract instructions also ensures that the program output is not sensitive to the compiler's ability to combine multiply and add/subtract operations. ๐ฅ-mserialize-volatile-mno-serialize-volatileโ when this option is enabled, GCC insertsMEMWinstructions beforevolatilememory references to guarantee sequential consistency. The default is-mserialize-volatile. Use-mno-serialize-volatileto omit theMEMWinstructions. โก-mforce-no-picโ for targets, like GNU/Linux, where all user-mode Xtensa code must be position-independent code (PIC), this option disables PIC for compiling kernel code. ๐ง-mtext-section-literals,-mno-text-section-literalsโ bestie, these two control how we treat literal pools โจ The default is-mno-text-section-literals, which chucks the literals into their own separate section in the output file. Why is that cute? Because it lets the literal pool live in a data RAM/ROM, and it also lets the linker merge literal pools from different object files together โ bye bye redundant literals, hiiii smaller code ๐ With-mtext-section-literals, the literals get interspersed in the text section so they stay as close as they possibly can to the things that reference them. That might be straight-up necessary for big assembly files. And where do the literals for each function go? Right before that function. iconic placement honestly ๐-mauto-litpools,-mno-auto-litpoolsโ okay so, again with the literal pools ๐ธ default is-mno-auto-litpools, which puts literals in a separate section in the output file unless-mtext-section-literalsis in play. With-mauto-litpools, the literals get interspersed in the text section by the assembler instead. The compiler does not produce explicit".literal"directives, and it loads literals into registers with"MOVI"instructions instead of"L32R"โ all so the assembler can do its relaxation thing and place literals wherever they need to go. This lets the assembler create several literal pools per function and assemble very big functions, which lowkey might not be possible with-mtext-section-literals๐-mtarget-align,-mno-target-alignโ turn this on and GCC tells the assembler to auto-align instructions, trading a lil code density for fewer branch penalties ๐ The assembler tries to widen density instructions so branch targets line up, plus the instructions that come after call instructions. If there aren't enough preceding safe density instructions to align a target, then no widening happens, periodt. Default is-mtarget-align. Oh and heads up โ these options don't touch auto-aligned instructions like"LOOP", because the assembler always aligns those, either by widening density instructions or by insertingNOPinstructions. No exceptions, no cap ๐ฆ-mlongcalls,-mno-longcallsโ enable this and GCC tells the assembler to translate direct calls into indirect calls, unless it can figure out that the target of a direct call is within the range the call instruction allows ๐ This translation typically kicks in for calls to functions in other source files. Specifically, the assembler turns a direct"CALL"instruction into an"L32R"followed by a"CALLX"instruction. Default is-mno-longcalls. Use this in programs where the call target could potentially be out of range. Now the important tea: this option is implemented in the assembler, not the compiler, so the assembly code GCC generates still shows direct call instructions โ go peek at the disassembled object code to see the actual instructions ๐ And note that the assembler uses an indirect call for every cross-file call, not just the ones that are actually out of range. extra for no reason but okay ๐
๐ zSeries Options ๐
These are listed under
๐ ENVIRONMENT ๐
okay bestie, this section is all about the env vars that make GCC do its thing. some of them are like "where do I look for files?" and some are like "how should I compile?" ๐
Also note: you can totally specify search places with options like -B, -I, and -L. Those win over env vars, and env vars win over whatever GCC's configuration says. Precedence, periodt. ๐
โจ LANG, LC_CTYPE, LC_MESSAGES, LC_ALL โจ
These four control localization, so GCC can vibe with different national conventions. GCC checks locale categories LC_CTYPE and LC_MESSAGES if it was configured to do so. You can set them to anything your install supports. A typical value is en_GB.UTF-8 for English in the UK encoded in UTF-8. ๐ฌ๐ง
LC_CTYPE is all about character classification. GCC uses it to figure out character boundaries in a string; this matters for some multibyte encodings that have quote and escape characters that would otherwise be read as a string end or escape. ๐ญ
LC_MESSAGES tells GCC what language to use in diagnostic messages.
If LC_ALL is set, it overrides LC_CTYPE and LC_MESSAGES. Otherwise, LC_CTYPE and LC_MESSAGES default to the value of LANG. If none of these are set, GCC defaults to traditional C English behavior. ๐
TMPDIR
If TMPDIR is set, it says where to put temporary files. GCC uses temp files to hold the output of one compilation stage that's gonna be input to the next stage โ like, the preprocessor's output is the compiler proper's input. ๐
GCC_COMPARE_DEBUG
Setting GCC_COMPARE_DEBUG is almost the same as passing -fcompare-debug to the compiler driver. Check that option's docs for more. ๐
GCC_EXEC_PREFIX
If GCC_EXEC_PREFIX is set, it's a prefix used in the names of subprograms that the compiler executes. No slash gets added when this prefix combines with a subprogram name, but you can specify a prefix that ends with a slash if you want. โจ
If GCC_EXEC_PREFIX isn't set, GCC tries to figure out a good prefix from the pathname it was invoked with.
If GCC can't find the subprogram using that prefix, it looks in the usual places.
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 given with -B take precedence over this prefix.
This prefix is also used to find files like crt0.o that are used for linking.
Also, the prefix is used in a weird way when finding header search directories. For each standard directory whose name normally begins with /usr/local/lib/gcc (more precisely, with the value of GCC_INCLUDE_DIR), GCC tries replacing that beginning with the specified prefix to make an alternate directory name. So with -Bfoo/, GCC searches foo/bar just before it searches the standard directory /usr/local/lib/bar. If a standard directory begins with the configured prefix, then the value of prefix is replaced by GCC_EXEC_PREFIX when looking for header files. ๐คฏ
COMPILER_PATH
COMPILER_PATH is a colon-separated list of directories, kinda like PATH. GCC tries these when searching for subprograms, if it can't find them using GCC_EXEC_PREFIX. ๐
LIBRARY_PATH
LIBRARY_PATH is also a colon-separated list of directories, much like PATH. When GCC is configured as a native compiler, it tries these when searching for special linker files, if it can't find them using GCC_EXEC_PREFIX. Linking with GCC also uses these directories when searching for ordinary libraries for the -l option (but directories specified with -L come first). ๐
LANG
This variable passes locale info to the compiler. One way it's used: to determine the character set for parsing character literals, string literals, and comments in C and C++. When the compiler is configured to allow multibyte characters, these LANG values are recognized:
C-JISโ Recognize JIS characters.C-SJISโ Recognize SJIS characters.C-EUCJPโ Recognize EUCJP characters.
If LANG isn't defined, or has some other value, then the compiler uses "mblen" and "mbtowc" as defined by the default locale to recognize and translate multibyte characters. ๐ธ
Some extra env vars affect the preprocessor's behavior.
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, where GCC looks for header files. The special character, "PATH_SEPARATOR", is target-dependent and set when GCC is built. For Microsoft Windows-based targets it's a semicolon, and for almost all other targets it's a colon. ๐ช
CPATH is a list of directories searched as if specified with -I, but after any paths given with -I options on the command line. This env var is used no matter which language is being preprocessed.
The remaining env vars apply only when preprocessing the particular language indicated. Each one is a list of directories searched as if specified with -isystem, but after any paths given with -isystem options on the command line.
In all these variables, an empty element tells the compiler to search its current working directory. Empty elements can be at the beginning or end of a path. For instance, if CPATH is :/special/include, that's the same as -I. -I/special/include. ๐ก
DEPENDENCIES_OUTPUT
If this variable is set, its value says how to output dependencies for Make based on the non-system header files the compiler processes. 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 go to that file, and GCC guesses the target name from the source file name. Or the value can be in the form file target, in which case rules go to file file using target as the target name.
In other words, this env var is equivalent to combining -MM and -MF, with an optional -MT switch too. ๐ฏ
SUNPRO_DEPENDENCIES
Same as DEPENDENCIES_OUTPUT (above), except system header files are not ignored, so it implies -M rather than -MM. However, the dependence on the main input file is omitted. ๐
SOURCE_DATE_EPOCH
If this variable is set, its value is a UNIX timestamp used instead of the current date and time in the "__DATE__" and "__TIME__" macros, so embedded timestamps become reproducible. โณ
The value of SOURCE_DATE_EPOCH must be a UNIX timestamp, defined as the number of seconds (excluding leap seconds) since 01 Jan 1970 00:00:00, represented in ASCII; identical to the output of @command{date +%s} on GNU/Linux and other systems that support the %s extension in the "date" command.
The value should be a known timestamp, like the last modification time of the source or package, and it should be set by the build process. ๐ฐ๏ธ
๐ BUGS ๐
For instructions on reporting bugs, see <https://gcc.gnu.org/bugs/>. ๐
๐ FOOTNOTES ๐
- 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. ๐
๐ SEE ALSO ๐
gpl(7), gfdl(7), fsf-funding(7), cpp(1), gcov(1), as(1), ld(1), gdb(1), dbx(1) and the Info entries for gcc, cpp, as, ld, binutils and gdb. ๐
๐ AUTHOR ๐
See the Info entry for gcc, or <http://gcc.gnu.org/onlinedocs/gcc/Contributors.html>, for contributors to GCC. ๐ซถ
๐ COPYRIGHT ๐
Copyright (c) 1988-2020 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with the Invariant Sections being "GNU General Public License" and "Funding Free Software", the Front-Cover texts being (a) (see below), and with the Back-Cover Texts being (b) (see below). A copy of the license is included in the gfdl(7) man page.
(a) The FSF's Front-Cover Text is:
A GNU Manual
(b) The FSF's Back-Cover Text is:
You have freedom to copy and modify this GNU Manual, like GNU
software. Copies published by the Free Software Foundation raise
funds for GNU development.
okay bestie that's the whole vibe. this iconic page is from gcc-10, dated 2023-07-07. slay, you made it to the end. ๐
โจ
๐ฆ where this page comes from
- ubuntu noble: gcc-10-offload-nvptx 10.5.0-4ubuntu2
- ubuntu noble: gcc-10-offload-nvptx 10.5.0-4ubuntu2.1
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms