MODULARIZE(1)

✨ modularize 💅

okay bestie, buckle up, because modularize is a User Command from the modularize 16 era and it has a LOT of options. like, an unreasonable amount. this is part 1 of 3 so drink some water and stretch, we're going on a journey 🦋

---

🌸 NAME 🌸

modularize — manual page for modularize 16

---

💖 DESCRIPTION 💖

OVERVIEW: modularize. that's it, that's the overview, the page really said "you know what, short and sweet" 😭

USAGE:

modularize [options] <list of one or more header list files> <arguments to be passed to front end>...

so you feed it options, then one or more header list files, and then arguments to be passed to front end. iconic. slay. 💅

OPTIONS:

---

🎀 Color Options 🎀

• --color — use colors in output (default=autodetect). let it cook, or don't, it figures it out itself.

---

✨ General options ✨

heads up bestie: a few of these have literally no description on the page. i'm telling you, not making anything up. no cap.

• -I <path> — include path for the coverage check.
• --aarch64-neon-syntax=<value> — choose the style of NEON code to emit from the AArch64 backend:
  • =generic — emit generic NEON assembly
  • =apple — emit Apple-style NEON assembly
• --aarch64-use-aa — enable the use of AA during codegen.
• --abort-on-max-devirt-iterations-reached — abort when the max iterations for devirtualization CGSCC repeat pass is reached.
• --allow-ginsert-as-artifact — allow G_INSERT to be considered an artifact. it's a hack around AMDGPU test infinite loops 🫠
• --amdgpu-bypass-slow-div — skip 64-bit divide for dynamic 32-bit values
• --amdgpu-disable-loop-alignment — do not align and prefetch loops
• --amdgpu-dpp-combine — enable DPP combiner
• --amdgpu-dump-hsa-metadata — dump AMDGPU HSA Metadata
• --amdgpu-enable-merge-m0 — merge and hoist M0 initializations
• --amdgpu-enable-power-sched — enable scheduling to minimize mAI power bursts
• --amdgpu-promote-alloca-to-vector-limit=<uint> — maximum byte size to consider promote alloca to vector
• --amdgpu-sdwa-peephole — enable SDWA peepholer
• --amdgpu-use-aa-in-codegen — enable the use of AA during codegen.
• --amdgpu-verify-hsa-metadata — verify AMDGPU HSA Metadata
• --amdgpu-vgpr-index-mode — use GPR indexing mode instead of movrel for vector indexing
• --arm-add-build-attributes — (no description on the page, bestie, it's giving mystery 🕵️)
• --arm-implicit-it=<value> — allow conditional instructions outdside of an IT block (yes, "outdside", the page said what it said, i'm keeping it exactly 💀)
  • =always — accept in both ISAs, emit implicit ITs in Thumb
  • =never — warn in ARM, reject in Thumb
  • =arm — accept in ARM, reject in Thumb
  • =thumb — warn in ARM, emit implicit ITs in Thumb
• --asm-show-inst — emit internal instruction representation to assembly file
• --atomic-counter-update-promoted — do counter update using atomic fetch add for promoted counters only
• --atomic-first-counter — use atomic fetch add for first counter in a function (usually the entry counter)
• --block-check-header-list-only — only warn if #include directives are inside extern or namespace blocks if the included header is in the header list.
• --bounds-checking-single-trap — use one trap block per function
• --cfg-hide-cold-paths=<number> — hide blocks with relative frequency below the given value
• --cfg-hide-deoptimize-paths — (no description given 🙈)
• --cfg-hide-unreachable-paths — (also no description 🙈)
• --cost-kind=<value> — target cost kind
  • =throughput — reciprocal throughput
  • =latency — instruction latency
  • =code-size — code size
  • =size-latency — code size and latency
• --coverage-check-only — only do the coverage check.
• --cs-profile-generate — perform context sensitive PGO instrumentation
• --cs-profile-path=<string> — context sensitive profile file path
• --debug-info-correlate — use debug info to correlate profiles.
• --debugify-func-limit=<ulong> — set max number of processed functions per pass.
• --debugify-level=<value> — kind of debug info to add
  • =locations — locations only
  • =location+variables — locations and variables
• --debugify-quiet — suppress verbose debugify output
• --disable-i2p-p2i-opt — disables inttoptr/ptrtoint roundtrip optimization
• --disable-promote-alloca-to-lds — disable promote alloca to LDS
• --disable-promote-alloca-to-vector — disable promote alloca to vector
• --display-file-lists — display lists of good files (no compile errors), problem files, and a combined list with problem files preceded by a '#'.
• --do-counter-promotion — do counter register promotion
• --dot-cfg-mssa=<file name for generated dot file> — file name for generated dot file
• --dwarf-version=<int> — Dwarf version
• --dwarf64 — generate debugging info in the 64-bit DWARF format
• --emit-dwarf-unwind=<value> — whether to emit DWARF EH frame entries.
  • =always — always emit EH frame entries
  • =no-compact-unwind — only emit EH frame entries when compact unwind is not available
  • =default — use target platform default
• --emscripten-cxx-exceptions-allowed=<string> — the list of function names in which Emscripten-style exception handling is enabled (see emscripten EMSCRIPTEN_CATCHING_ALLOWED options)
• --enable-cse-in-irtranslator — should enable CSE in irtranslator
• --enable-cse-in-legalizer — should enable CSE in Legalizer
• --enable-emscripten-cxx-exceptions — WebAssembly Emscripten-style exception handling
• --enable-emscripten-sjlj — WebAssembly Emscripten-style setjmp/longjmp handling
• --enable-gvn-hoist — enable the GVN hoisting pass (default = off)
• --enable-gvn-memdep — (no description, the page left us on read 😭)
• --enable-gvn-sink — enable the GVN sinking pass (default = off)
• --enable-load-in-loop-pre — (no description 🙈)
• --enable-load-pre — (no description 🙈)
• --enable-loop-simplifycfg-term-folding — (no description 🙈)
• --enable-name-compression — enable name/filename string compression
• --enable-split-backedge-in-load-pre — (no description 🙈)
• --execute-concurrency=<uint> — the number of threads used to process all files in parallel. set to 0 for hardware concurrency. this flag only applies to all-TUs.
• --executor=<string> — the name of the executor to use.
• --experimental-debug-variable-locations — use experimental new value-tracking variable locations
• --fatal-warnings — treat warnings as errors
• --filter=<string> — only process files that match this filter. this flag only applies to all-TUs.
• --fs-profile-debug-bw-threshold=<uint> — only show debug message if the source branch weight is greater than this value.
• --fs-profile-debug-prob-diff-threshold=<uint> — only show debug message if the branch probility is greater than this value (in percentage). (yes, "probility", keeping it exactly as printed 💀)
• --generate-merged-base-profiles — when generating nested context-sensitive profiles, always generate extra base profile for function with all its context profiles merged into it.
• --gpsize=<uint> — global Pointer Addressing Size. the default size is 8.
• --hash-based-counter-split — rename counter variable of a comdat function based on cfg hash
• --hot-cold-split — enable hot-cold splitting pass
• --import-all-index — import all external functions in index.
• --incremental-linker-compatible — when used with filetype=obj, emit an object file which can be used with an incremental linker
• --instcombine-code-sinking — enable code sinking
• --instcombine-guard-widening-window=<uint> — how wide an instruction window to bypass looking for another guard
• --instcombine-max-iterations=<uint> — limit the maximum number of instruction combining iterations
• --instcombine-max-num-phis=<uint> — maximum number phis to handle in intptr/ptrint folding
• --instcombine-max-sink-users=<uint> — maximum number of undroppable users for instruction sinking
• --instcombine-maxarray-size=<uint> — maximum array size considered when doing a combine
• --instcombine-negator-enabled — should we attempt to sink negations?
• --instcombine-negator-max-depth=<uint> — what is the maximal lookup depth when trying to check for viability of negation sinking.
• --instrprof-atomic-counter-update-all — make all profile counter updates atomic (for testing only)
• --internalize-public-api-file=<filename> — a file containing list of symbol names to preserve
• --internalize-public-api-list=<list> — a list of symbol names to preserve
• --iterative-counter-promotion — allow counter promotion across the whole loop nest.
• --lto-aix-system-assembler=<path> — path to a system assembler, picked up on AIX only
• --lto-embed-bitcode=<value> — embed LLVM bitcode in object files produced by LTO
  • =none — do not embed
  • =optimized — embed after all optimization passes
  • =post-merge-pre-opt — embed post merge, but before optimizations
• --lto-pass-remarks-filter=<regex> — only record optimization remarks from passes whose names match the given regular expression

---

and that's where part 1 ends bestie, we're not even close to done, more is coming 👑

okay so the options marathon continues and we are not stopping, bestie — every single flag gets its moment 💅

• --lto-pass-remarks-format=<format> — the format used for serializing remarks (default: YAML)
• --lto-pass-remarks-output=<filename> — output filename for pass remarks
• --matrix-default-layout=<value> — sets the default matrix layout
  • =column-major — use column-major layout
  • =row-major — use row-major layout
• --matrix-print-after-transpose-opt — no description, just a name and a dream 🙈
• --max-counter-promotions=<int> — max number of allowed counter promotions
• --max-counter-promotions-per-loop=<uint> — max number counter promotions per loop, so register pressure doesn't get cranked up too much
• --mc-relax-all — when used with filetype=obj, relax all fixups in the emitted object file
• --mcabac — tbd (yes literally tbd, the devs left us on read 😭)
• --merror-missing-parenthesis — error for missing parenthesis around predicate registers
• --merror-noncontigious-register — error for register names that aren't contigious
• --mhvx — enable Hexagon Vector eXtensions
• --mhvx=<value> — enable Hexagon Vector eXtensions
  • =v60 — build for HVX v60
  • =v62 — build for HVX v62
  • =v65 — build for HVX v65
  • =v66 — build for HVX v66
  • =v67 — build for HVX v67
  • =v68 — build for HVX v68
  • =v69 — build for HVX v69
  • =v71 — build for HVX v71
  • =v73 — build for HVX v73
• --mips-compact-branches=<value> — MIPS Specific: compact branch policy.
  • =never — do not use compact branches if possible.
  • =optimal — use compact branches where appropriate (default).
  • =always — always use compact branches if possible.
• --mips16-constant-islands — enable mips16 constant islands.
• --mips16-hard-float — enable mips16 hard float.
• --mir-strip-debugify-only — should mir-strip-debug only strip debug info from debugified modules by default
• --misexpect-tolerance=<uint> — prevents emiting diagnostics when profile counts are within N% of the threshold.. (two dots, we keep them, no notes 💀)
• --mno-compound — disable looking for compound instructions for Hexagon
• --mno-fixup — disable fixing up resolved relocations for Hexagon
• --mno-ldc1-sdc1 — expand double precision loads and stores to their single precision counterparts
• --mno-pairing — disable looking for duplex instructions for Hexagon
• --module-map-path=<string> — turn on module map output and specify output path or file name. If no path is specified and if prefix option is specified, use prefix for file path.
• --mwarn-missing-parenthesis — warn for missing parenthesis around predicate registers
• --mwarn-noncontigious-register — warn for register names that arent contigious
• --mwarn-sign-mismatch — warn for mismatching a signed and unsigned value
• --no-coverage-check — don't do the coverage check.
• --no-deprecated-warn — suppress all deprecated warnings
• --no-discriminators — disable generation of discriminator information.
• --no-type-check — suppress type errors (Wasm)
• --no-warn — suppress all warnings
• --nvptx-sched4reg — NVPTX Specific: schedule for register pressue
• --opaque-pointers — use opaque pointers
• --poison-checking-function-local — check that returns are non-poison (for testing)
• --prefix=<string> — prepend header file paths with this prefix. If not specified, the files are considered to be relative to the header list file.
• --print-pipeline-passes — print a -passes compatible string describing the pipeline (best-effort only).
• --problem-files-list=<string> — list of files with compilation or modularization problems for assistant mode. This will be excluded.
• --r600-ir-structurize — use StructurizeCFG IR pass
• --rdf-dump — description? not found. it's giving mystery 💅
• --rdf-limit=<uint> — again no description, we love a secretive flag
• --root-module=<string> — specify the name of the root module.
• --runtime-counter-relocation — enable relocating counters at runtime.
• --safepoint-ir-verifier-print-only — no description either, mysterious king 👑
• --sample-profile-check-record-coverage=<N> — emit a warning if less than N% of records in the input profile are matched to the IR.
• --sample-profile-check-sample-coverage=<N> — emit a warning if less than N% of samples in the input profile are matched to the IR.
• --sample-profile-max-propagate-iterations=<uint> — maximum number of iterations to go through when propagating sample block/edge weights through the CFG.
• --sanitizer-early-opt-ep — insert sanitizers on OptimizerEarlyEP.
• --skip-ret-exit-block — suppress counter promotion if exit blocks contain ret.
• --speculative-counter-promotion-max-exiting=<uint> — the max number of exiting blocks of a loop to allow speculative counter promotion
• --speculative-counter-promotion-to-loop — when the option is false, if the target block is in a loop, the promotion will be disallowed unless the promoted counter update can be further/iteratively promoted into an acyclic region.
• --summary-file=<string> — the summary file to use for function importing.
• --sve-tail-folding=<string> — control the use of vectorisation using tail-folding for SVE:
  • disabled — no loop types will vectorize using tail-folding
  • default — uses the default tail-folding settings for the target CPU
  • all — all legal loop types will vectorize using tail-folding
  • simple — use tail-folding for simple loops (not reductions or recurrences)
  • reductions — use tail-folding for loops containing reductions
  • recurrences — use tail-folding for loops containing fixed order recurrences
• --tail-predication=<value> — MVE tail-predication pass options
  • =disabled — don't tail-predicate loops
  • =enabled-no-reductions — enable tail-predication, but not for reduction loops
  • =enabled — enable tail-predication, including reduction loops
  • =force-enabled-no-reductions — enable tail-predication, but not for reduction loops, and force this which might be unsafe
  • =force-enabled — enable tail-predication, including reduction loops, and force this which might be unsafe

bestie, those two force- ones? the manpage literally says might be unsafe. respect the warning, don't just vibe your way into them 🙏

• --thinlto-assume-merged — assume the input has already undergone ThinLTO function importing and the other pre-optimization pipeline changes.
• --threads=<int> — no description provided — the silence is the vibe 💀
• --type-based-intrinsic-cost — calculate intrinsics cost based only on argument types
• --verify-region-info — verify region info (time consuming)
• --vp-counters-per-site=<number> — the average number of profile counters allocated per value profiling site.
• --vp-static-alloc — do static counter allocation for value profiler
• --wasm-enable-eh — WebAssembly exception handling
• --wasm-enable-sjlj — WebAssembly setjmp/longjmp handling
• --x86-align-branch=<string> — specify types of branches to align (plus separated list of types):
  • jcc — indicates conditional jumps
  • fused — indicates fused conditional jumps
  • jmp — indicates direct unconditional jumps
  • call — indicates direct and indirect calls
  • ret — indicates rets
  • indirect — indicates indirect unconditional jumps
• --x86-align-branch-boundary=<uint> — control how the assembler should align branches with NOP. If the boundary's size is not 0, it should be a power of 2 and no less than 32. Branches will be aligned to prevent from being across or against the boundary of specified size. The default value 0 does not align branches.
• --x86-branches-within-32B-boundaries — align selected instructions to mitigate negative performance impact of Intel's micro code update for errata skx102. May break assumptions about labels corresponding to particular instructions, and should be used with caution.

⚠️ okay that "may break assumptions about labels corresponding to particular instructions" part? use with caution, fr fr. not a drill.

• --x86-pad-max-prefix-size=<uint> — maximum number of prefixes to use for padding

---

✨ Generic Options ✨

• --help — display available options (--help-hidden for more)
• --help-list — display list of available options (--help-list-hidden for more)
• --version — display the version of this program

---

🦋 Polly Options: Configure the polly loop optimizer 🦋

• --polly — enable the polly optimizer (with -O1, -O2 or -O3)
• --polly-2nd-level-tiling — enable a 2nd level loop of loop tiling
• --polly-ast-print-accesses — print memory access functions
• --polly-context=<isl parameter set> — provide additional constraints on the context parameters
• --polly-dce-precise-steps=<int> — the number of precise steps between two approximating iterations. (A value of -1 schedules another approximation stage before the actual dead code elimination.
• --polly-delicm-max-ops=<int> — the max number of isl operations you're willing to throw at lifetime analysis 💸. Set it to 0 and it's no limit, go feral.
• --polly-detect-full-functions — lets the detection of full functions happen. yes queen, whole functions 💅
• --polly-dump-after — dumps the module after Polly transformations into a file suffixed with -after 🎀
• --polly-dump-after-file=<string> — same energy, but you pick the file: dumps the module after Polly transformations to the given file 📁
• --polly-dump-before — dumps the module before Polly transformations into a file suffixed with -before 🦋
• --polly-dump-before-file=<string> — dumps the module before Polly transformations to the given file, your choice, your name 📁
• --polly-enable-simplify — simplifies the SCoP after optimizations. tidy up bestie ✨
• --polly-ignore-func=<string> — ignores functions that match a regex. you can comma separate multiple regexes, and scop detection will ignore all functions that match ANY of the regexes you provided 🚫
• --polly-isl-arg=<argument> — an option passed straight to ISL 📨
• --polly-matmul-opt — performs optimizations of matrix multiplications based on pattern matching 🔥
• --polly-on-isl-error-abort — aborts if an isl error is encountered. it's giving no patience, and honestly? valid 💀
• --polly-only-func=<string> — only runs on functions that match a regex. multiple regexes can be comma separated, and scop detection will run on all functions that match ANY of the regexes provided 🎯
• --polly-only-region=<identifier> — only runs on certain regions, and the identifier you provide must appear in the name of the region's entry block 📍
• --polly-only-scop-detection — only runs scop detection, but no other optimizations. detection era only, no notes 🙈
• --polly-optimized-scops — Polly dumps the polyhedral description of Scops optimized with the isl scheduling optimizer, and the set of post-scheduling transformations is applied on the schedule tree 🌈
• --polly-parallel — generates thread parallel code, isl codegen only 🧵
• --polly-parallel-force — forces generation of thread parallel code, ignoring any cost model. it does not care about your budget ✋
• --polly-pattern-matching-based-opts — performs optimizations based on pattern matching 🔍
• --polly-postopts — applies post-rescheduling optimizations such as tiling, and it requires -polly-reschedule ⚠️
• --polly-pragma-based-opts — applies user-directed transformation from metadata 🪄
• --polly-pragma-ignore-depcheck — skips the dependency check for pragma-based transformations 🏃‍♀️
• --polly-process-unprofitable — processes scops that are unlikely to benefit from Polly optimizations. messy but brave 💪
• --polly-register-tiling — enables register tiling 📦
• --polly-report — prints information about the activities of Polly. it's the receipts, fr fr 🧾
• --polly-reschedule — optimizes SCoPs using ISL 👑
• --polly-show — highlights the code regions that will be optimized in a (CFG BBs and LLVM-IR instructions) ✨
• --polly-show-only — highlights the code regions that will be optimized in a (CFG only BBs) 💜
• --polly-stmt-granularity=<value> — the algorithm to use for splitting basic blocks into multiple statements 🍰
  • =bb — one statement per basic block
  • =scalar-indep — scalar independence heuristic
  • =store — store-level granularity
• --polly-tc-opt — performs optimizations of tensor contractions based on pattern matching 🌀
• --polly-tiling — enables loop tiling 🧱
• --polly-vectorizer=<value> — selects the vectorization strategy 🚀
  • =none — no Vectorization
  • =polly — Polly internal vectorizer
  • =stripmine — strip-mine outer loops for the loop-vectorizer to trigger

---

okay that's the whole list, you made it bestie 🫶 this page is modularize version 16, dated October 2023 — so if your build is older than that, don't come for me 💖 no cap, go optimize something iconic 👑