SANCOV(1)

📦
version 14.0.6 · 5 versions
, in ubuntu questing

💅 SANCOV(1) — User Commands 💅

okay bestie, gather round, because we're reading the manual page for sancov 14, and it's a lot but I got you 🫶

✨ NAME ✨

sancov — manual page for sancov 14. That's it, that's the name, no notes. 💖

🌸 DESCRIPTION 🌸

OVERVIEW: Sanitizer Coverage Processing Tool (sancov) 👑

so like, this tool is the main character of coverage info, and it can extract all kinds of coverage-related gossip from:

  • coverage-instrumented binary files
  • raw .sancov files
  • and their symbolized .symcov version ✨

Depending on which action you pick, the tool expects different input files, so pay attention bestie:

  • -print-coverage-pcs — wants coverage-instrumented binary files
  • -print-coverage — wants .sancov files
  • <other actions> — wants .sancov files & the corresponding binary files, or .symcov files

USAGE:

sancov [options] <action> <binary files...> <.sancov files...> <.symcov files...>

🎀 OPTIONS 🎀

🌈 Color Options 🌈

  • --color — Use colors in output (default=autodetect). yes queen, make it pretty 🌸

💜 General options 💜

  • --aarch64-neon-syntax=<value> — Choose style of NEON code to emit from 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. 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-disable-power-sched — Disable scheduling to minimize mAI power bursts
  • --amdgpu-dpp-combine — Enable DPP combiner
  • --amdgpu-dump-hsa-metadata — Dump AMDGPU HSA Metadata
  • --amdgpu-enable-flat-scratch — Use flat scratch instructions
  • --amdgpu-enable-merge-m0 — Merge and hoist M0 initializations
  • --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 in the original, it's giving mystery 🕵️♀️)
  • --arm-implicit-it=<value> — Allow conditional instructions outdside of an IT block (yes, "outdside", I said what I said, that's verbatim) 🙈
    • =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)
  • --blacklist=<string> — Blacklist file (sanitizer blacklist format).
  • --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, iconic silence 🤐)
  • --cfg-hide-unreachable-paths — (also no description, matching energy 💅)
  • --cost-kind=<value> — Target cost kind
    • =throughput — Reciprocal throughput
    • =latency — Instruction latency
    • =code-size — Code size
    • =size-latency — Code size and latency

👑 Action (required) 👑

bestie, this one is required. not optional. not a suggestion. you need an action. periodt. 🔥
  • --print — Print coverage addresses
  • --print-coverage-pcs — Print coverage instrumentation points addresses.
  • --covered-functions — Print all covered funcions. (again, verbatim spelling, don't come for me 😭)
  • --not-covered-functions — Print all not covered funcions.
  • --print-coverage-stats — Print coverage statistics.
  • --html-report — REMOVED. Use -symbolize & coverage-report-server.py. 🪦 rip bestie, she's gone
  • --symbolize — Produces a symbolized JSON report from binary report.
  • --merge — Merges reports.
  • --debug-info-correlate — Use debug info to correlate profiles.
  • --debugify-level=<value> — Kind of debug info to add
    • =locations — Locations only
    • =location+variables — Locations and Variables
  • --debugify-quiet — Suppress verbose debugify output
  • --demangle — Print demangled function name.
  • --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
  • --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
  • --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, just vibes 🌈)
  • --enable-gvn-sink — Enable the GVN sinking pass (default = off)
  • --enable-load-in-loop-pre — (no description, mysterious era ✨)
  • --enable-load-pre — (no description either)
  • --enable-loop-simplifycfg-term-folding — (nope, no description here either 🎀)
  • --enable-name-compression — Enable name/filename string compression
  • --enable-split-backedge-in-load-pre — (still no description, it's giving enigmatic)
  • --experimental-debug-variable-locations — Use experimental new value-tracking variable locations
  • --fatal-warnings — Treat warnings as errors
  • --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" — original text, keeping it fr fr)
  • --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-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) ⚠️ (testing only, bestie, don't be chaotic)
  • --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-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
  • --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

and that's part 1, bestie — more is coming, do NOT go anywhere 🦋

  • =column-major — use column-major layout 💅
  • =row-major — use row-major layout 💅
  • --max-counter-promotions=<int> — the max number of counter promotions we're allowed to do, no more, we're capping it 🎀
  • --max-counter-promotions-per-loop=<uint> — max number of counter promotions per loop, so we don't crank the register pressure up way too much 😮‍💨
  • --mc-relax-all — when you use it with filetype=obj, it relaxes all the fixups in the emitted object file ✨
  • --mcabac — tbd 🙈 (that's it. that's the description. the manpage said tbd and I respect the honesty)
  • --merror-missing-parenthesis — throw an error for a missing parenthesis around predicate registers 💀
  • --merror-noncontigious-register — throw an error for register names that aren't contigious 🚨
  • --mhvx — enable Hexagon Vector eXtensions 🦋
  • --mhvx=<value> — enable Hexagon Vector eXtensions, but pick your vibe:
    • =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
  • --mips-compact-branches=<value> — MIPS specific: compact branch policy. pick your girl:
    • =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? that's the question it's asking 🎀
  • --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 into their single precision counterparts 🍓
  • --mno-pairing — disable looking for duplex instructions for Hexagon 🚫
  • --mwarn-missing-parenthesis — warn for a missing parenthesis around predicate registers ⚠️
  • --mwarn-noncontigious-register — warn for register names that arent contigious ⚠️
  • --mwarn-sign-mismatch — warn when a signed and unsigned value don't match up ⚠️
  • --no-deprecated-warn — suppress all the deprecated warnings 🤫
  • --no-discriminators — disable generation of discriminator information 🚫
  • --no-type-check — suppress type errors (Wasm) 🤫
  • --no-warn — suppress all the warnings, we're in our no-warnings era 🤫
  • --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) 🧪
  • --print-pipeline-passes — print a -passes compatible string that describes the pipeline. and bestie, they said it themselves: (best-effort only) 😭
  • --r600-ir-structurize — use the StructurizeCFG IR pass ✨
  • --rdf-dump — the manpage gives us literally nothing here 💀
  • --rdf-limit=<uint> — also nothing. empty. a ghost. 👻
  • --runtime-counter-relocation — enable relocating counters at runtime 🏃
  • --safepoint-ir-verifier-print-only — once again, no description in the source. we move. 💅
  • --sample-profile-check-record-coverage=<N> — emit a warning if less than N% of the records in the input profile got matched to the IR ⚠️
  • --sample-profile-check-sample-coverage=<N> — emit a warning if less than N% of the samples in the input profile got 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 🔁
  • --skip-dead-files — do not list dead source files in reports 🪦
  • --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 this option is false, if the target block is in a loop, the promotion gets disallowed unless the promoted counter update can be further/iteratively promoted into an acyclic region 🌀
  • --strip_path_prefix=<string> — strip this prefix from file paths in reports ✂️
  • --summary-file=<string> — the summary file to use for function importing 📄
  • --tail-predication=<value> — MVE tail-predication pass options, choose wisely:
    • =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 💀
  • --thinlto-assume-merged — assume the input has already undergone ThinLTO function importing and the other pre-optimization pipeline changes 🫶
  • --threads=<int> — no description. just vibes. 🤷
  • --verify-region-info — verify region info. and heads up: it's 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 the 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 (a 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 the negative performance impact of Intel's micro code update for errata skx102 🧠
⚠️ this one may break assumptions about labels corresponding to particular instructions, and should be used with caution. no cap. 🙈
  • --x86-pad-max-prefix-size=<uint> — maximum number of prefixes to use for padding 📏

✨ Generic Options ✨

the "just tell me stuff" options, iconic behavior 🫶

  • --help — display available options (use --help-hidden for more 👀)
  • --help-list — display a list of available options (use --help-list-hidden for more 👀)
  • --version — display the version of this program 🏷️

🦋 Polly Options 🦋

configure the polly loop optimizer 💜

  • --polly — enable the polly optimizer (works 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> — maximum number of isl operations to invest for lifetime analysis; 0 = no limit 🔢
  • --polly-detect-full-functions — allow the detection of full functions 🔍
  • --polly-dump-after — dump the module after Polly transformations into a file suffixed with "-after" 📤
  • --polly-dump-after-file=<string> — dump the module after Polly transformations to the given file 📄
  • --polly-dump-before — dump the module before Polly transformations into a file suffixed with "-before" 📥
  • --polly-dump-before-file=<string> — dump the module before Polly transformations to the given file 📄
  • --polly-enable-simplify — simplify SCoP after optimizations 🧼
  • --polly-ignore-func=<string> — ignore functions that match a regex. multiple regexes can be comma separated. scop detection will ignore all functions that match ANY of the regexes provided 🚫
  • --polly-isl-arg=<argument> — option passed to ISL 🎁
  • --polly-on-isl-error-abort — abort if an isl error is encountered 💥
  • --polly-only-func=<string> — only run on functions that match a regex. multiple regexes can be comma separated. scop detection will run on all functions that match ANY of the regexes provided 🎯
  • --polly-only-region=<identifier> — only run on certain regions (the provided identifier must appear in the name of the region's entry block 🎀
  • --polly-only-scop-detection — only run scop detection, but no other optimizations 👀
  • --polly-optimized-scops — Polly: dump out the polyhedral description of Scops that got optimized with the isl scheduling optimizer, plus the whole set of post-scheduling transformations that ends up applied on the schedule tree 💅
  • --polly-parallel — generate thread parallel code (isl codegen only, bestie)
  • --polly-parallel-force — force that thread parallel code to be generated, ignoring any cost model like it simply doesn't exist 😤
  • --polly-pattern-matching-based-opts — perform optimizations based on pattern matching
  • --polly-postopts — apply post-rescheduling optimizations such as tiling. heads up tho, this one requires -polly-reschedule 🫶
  • --polly-pragma-based-opts — apply user-directed transformation from metadata
  • --polly-pragma-ignore-depcheck — skip the dependency check for pragma-based transformations 🙈
  • --polly-process-unprofitable — process scops that are unlikely to benefit from Polly optimizations.
  • --polly-register-tiling — enable register tiling
  • --polly-report — print information about the activities of Polly
  • --polly-reschedule — optimize SCoPs using ISL ✨
  • --polly-show — highlight the code regions that will be optimized in a (CFG BBs and LLVM-IR instructions)
  • --polly-show-only — highlight the code regions that will be optimized in a (CFG only BBs)
  • --polly-stmt-granularity=<value> — which 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-target=<value> — the hardware to target
    • cpu — generate CPU code
  • --polly-tiling — enable loop tiling 🎀
  • --polly-vectorizer=<value> — select the vectorization strategy
    • none — No Vectorization
    • polly — Polly internal vectorizer
    • stripmine — Strip-mine outer loops for the loop-vectorizer to trigger

and that's the whole list bestie, we ate and left absolutely zero crumbs 💖 this page is sancov 14, dated May 2025, and it lives in the SANCOV(1) section of the manual 🦋 slay, go forth and read your docs 👑

📦 where this page comes from